connectors

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

Overview

Name	connectors
Type	Resource
Id	azure_extras.customer_insights.connectors

Fields

The following fields are returned by SELECT queries:

get

OK. Successfully get the connector.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Properties of connector.
type	string	Resource type.

list_by_hub

OK. Successfully get all the connectors in the hub.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Properties of connector.
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, subscriptionId		Gets a connector in the hub.
list_by_hub	select	resourceGroupName, hubName, subscriptionId		Gets all the connectors in the specified hub.
create_or_update	insert	resourceGroupName, hubName, connectorName, subscriptionId		Creates a connector or updates an existing connector in the hub.
delete	delete	resourceGroupName, hubName, connectorName, subscriptionId		Deletes a connector in the hub.

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.
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 in the hub.

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

list_by_hub

Gets all the connectors in the specified hub.

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

INSERT examples

create_or_update

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

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

Manifest

# Description fields are for documentation purposes
- name: connectors
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the connectors resource.
    - name: hubName
      value: string
      description: Required parameter for the connectors resource.
    - name: connectorName
      value: string
      description: Required parameter for the connectors resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the connectors resource.
    - name: properties
      value: object
      description: |
        Properties of connector.

DELETE examples

delete

Deletes a connector in the hub.

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