connector_mappings

Creates, updates, deletes, gets or lists a connector_mappings resource.

Overview

Name	connector_mappings
Type	Resource
Id	azure_extras.customer_insights.connector_mappings

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the connector mapping.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The connector mapping definition.
type	string	Resource type.

list_by_connector

OK. Successfully get all the connector mappings in the connector.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	The connector mapping definition.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, hubName, connectorName, mappingName, subscriptionId		Gets a connector mapping in the connector.
list_by_connector	select	resourceGroupName, hubName, connectorName, subscriptionId		Gets all the connector mappings in the specified connector.
create_or_update	insert	resourceGroupName, hubName, connectorName, mappingName, subscriptionId		Creates a connector mapping or updates an existing connector mapping in the connector.
delete	delete	resourceGroupName, hubName, connectorName, mappingName, subscriptionId		Deletes a connector mapping in the connector.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
connectorName	string	The name of the connector.
hubName	string	The name of the hub.
mappingName	string	The name of the connector mapping.
resourceGroupName	string	The name of the resource group.
subscriptionId	string	Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets a connector mapping in the connector.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.connector_mappings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND connectorName = '{{ connectorName }}' -- required
AND mappingName = '{{ mappingName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_connector

Gets all the connector mappings in the specified connector.

SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.connector_mappings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND hubName = '{{ hubName }}' -- required
AND connectorName = '{{ connectorName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates a connector mapping or updates an existing connector mapping in the connector.

INSERT INTO azure_extras.customer_insights.connector_mappings (
data__properties,
resourceGroupName,
hubName,
connectorName,
mappingName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ hubName }}',
'{{ connectorName }}',
'{{ mappingName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: connector_mappings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the connector_mappings resource.
    - name: hubName
      value: string
      description: Required parameter for the connector_mappings resource.
    - name: connectorName
      value: string
      description: Required parameter for the connector_mappings resource.
    - name: mappingName
      value: string
      description: Required parameter for the connector_mappings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the connector_mappings resource.
    - name: properties
      value: object
      description: |
        The connector mapping definition.

DELETE examples

delete

Deletes a connector mapping in the connector.

DELETE FROM azure_extras.customer_insights.connector_mappings
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND hubName = '{{ hubName }}' --required
AND connectorName = '{{ connectorName }}' --required
AND mappingName = '{{ mappingName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;