connectors

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

Overview

Name	connectors
Type	Resource
Id	azure.service_connector.connectors

Fields

The following fields are returned by SELECT queries:

get

Connector details.

Name	Datatype	Description
properties	object	The properties of the Linker.
systemData	object	The system data.

list

Connector details.

Name	Datatype	Description
properties	object	The properties of the Linker.
systemData	object	The system data.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, location, connectorName		Returns Connector resource for a given name.
list	select	subscriptionId, resourceGroupName, location		Returns list of connector which connects to the resource, which supports to config the target service during the resource provision.
create_or_update	insert	subscriptionId, resourceGroupName, location, connectorName, data__properties		Create or update Connector resource.
update	update	subscriptionId, resourceGroupName, location, connectorName		Operation to update an existing Connector.
delete	delete	subscriptionId, resourceGroupName, location, connectorName		Delete a Connector.
validate	exec	subscriptionId, resourceGroupName, location, connectorName		Validate a Connector.
generate_configurations	exec	subscriptionId, resourceGroupName, location, connectorName		Generate configurations for a 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 resource.
location	string	The name of Azure region.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns Connector resource for a given name.

SELECT
properties,
systemData
FROM azure.service_connector.connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND connectorName = '{{ connectorName }}' -- required
;

list

Returns list of connector which connects to the resource, which supports to config the target service during the resource provision.

SELECT
properties,
systemData
FROM azure.service_connector.connectors
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
;

INSERT examples

create_or_update

Create or update Connector resource.

INSERT INTO azure.service_connector.connectors (
data__properties,
subscriptionId,
resourceGroupName,
location,
connectorName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ location }}',
'{{ connectorName }}'
RETURNING
properties,
systemData
;

Manifest

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

UPDATE examples

update

Operation to update an existing Connector.

UPDATE azure.service_connector.connectors
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND location = '{{ location }}' --required
AND connectorName = '{{ connectorName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Delete a Connector.

DELETE FROM azure.service_connector.connectors
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND location = '{{ location }}' --required
AND connectorName = '{{ connectorName }}' --required
;

Lifecycle Methods

validate

Validate a Connector.

EXEC azure.service_connector.connectors.validate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@connectorName='{{ connectorName }}' --required
;

generate_configurations

Generate configurations for a Connector.

EXEC azure.service_connector.connectors.generate_configurations 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@connectorName='{{ connectorName }}' --required 
@@json=
'{
"deleteOrUpdateBehavior": "{{ deleteOrUpdateBehavior }}", 
"action": "{{ action }}", 
"customizedKeys": "{{ customizedKeys }}", 
"daprProperties": "{{ daprProperties }}", 
"additionalConfigurations": "{{ additionalConfigurations }}", 
"additionalConnectionStringProperties": "{{ additionalConnectionStringProperties }}", 
"configurationStore": "{{ configurationStore }}"
}'
;