connectors
Creates, updates, deletes, gets or lists a connectors
resource.
Overview
Name | connectors |
Type | Resource |
Id | azure_extras.customer_insights.connectors |
Fields
- vw_connectors
- connectors
Name | Datatype | Description |
---|---|---|
id | text | Resource ID. |
name | text | Resource name. |
description | text | field from the properties object |
connectorName | text | field from the properties object |
connector_id | text | field from the properties object |
connector_name | text | field from the properties object |
connector_properties | text | field from the properties object |
connector_type | text | field from the properties object |
created | text | field from the properties object |
display_name | text | field from the properties object |
hubName | text | field from the properties object |
is_internal | text | field from the properties object |
last_modified | text | field from the properties object |
resourceGroupName | text | field from the properties object |
state | text | field from the properties object |
subscriptionId | text | field from the properties object |
tenant_id | text | field from the properties object |
type | text | Resource type. |
Name | Datatype | Description |
---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
properties | object | Properties of connector. |
type | string | Resource type. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | connectorName, hubName, resourceGroupName, subscriptionId | Gets a connector in the hub. |
list_by_hub | SELECT | hubName, resourceGroupName, subscriptionId | Gets all the connectors in the specified hub. |
create_or_update | INSERT | connectorName, hubName, resourceGroupName, subscriptionId | Creates a connector or updates an existing connector in the hub. |
delete | DELETE | connectorName, hubName, resourceGroupName, subscriptionId | Deletes a connector in the hub. |
SELECT
examples
Gets all the connectors in the specified hub.
- vw_connectors
- connectors
SELECT
id,
name,
description,
connectorName,
connector_id,
connector_name,
connector_properties,
connector_type,
created,
display_name,
hubName,
is_internal,
last_modified,
resourceGroupName,
state,
subscriptionId,
tenant_id,
type
FROM azure_extras.customer_insights.vw_connectors
WHERE hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
properties,
type
FROM azure_extras.customer_insights.connectors
WHERE hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new connectors
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure_extras.customer_insights.connectors (
connectorName,
hubName,
resourceGroupName,
subscriptionId,
properties
)
SELECT
'{{ connectorName }}',
'{{ hubName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: properties
value:
- name: connectorId
value: integer
- name: connectorName
value: string
- name: connectorType
value: []
- name: displayName
value: string
- name: description
value: string
- name: connectorProperties
value: object
- name: created
value: string
- name: lastModified
value: string
- name: state
value: string
- name: tenantId
value: string
- name: isInternal
value: boolean
- name: id
value: string
- name: name
value: string
- name: type
value: string
DELETE
example
Deletes the specified connectors
resource.
/*+ delete */
DELETE FROM azure_extras.customer_insights.connectors
WHERE connectorName = '{{ connectorName }}'
AND hubName = '{{ hubName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';