connector

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

Overview

Name	connector
Type	Resource
Id	azure.service_linker.connector

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
authInfo	object	The authentication type.
clientType	string	The application client type. Known values are: "none", "dotnet", "java", "python", "go", "php", "ruby", "django", "nodejs", "springBoot", "kafka-springBoot", "jms-springBoot", and "dapr".
configurationInfo	object	The connection information consumed by applications, including secrets, connection strings.
provisioningState	string	The provisioning state.
publicNetworkSolution	object	The network solution.
scope	string	connection scope in source service.
secretStore	object	An option to store secret value in secure place.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetService	object	The target service properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vNetSolution	object	The VNet solution.

get_dryrun

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
operationPreviews	array	the preview of the operations for creation.
parameters	object	The parameters of the dryrun.
prerequisiteResults	array	the result of the dryrun.
provisioningState	string	The provisioning state.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
authInfo	object	The authentication type.
clientType	string	The application client type. Known values are: "none", "dotnet", "java", "python", "go", "php", "ruby", "django", "nodejs", "springBoot", "kafka-springBoot", "jms-springBoot", and "dapr".
configurationInfo	object	The connection information consumed by applications, including secrets, connection strings.
provisioningState	string	The provisioning state.
publicNetworkSolution	object	The network solution.
scope	string	connection scope in source service.
secretStore	object	An option to store secret value in secure place.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
targetService	object	The target service properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vNetSolution	object	The VNet solution.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscription_id, resource_group_name, location, connector_name		Returns Connector resource for a given name.
get_dryrun	select	subscription_id, resource_group_name, location, dryrun_name		get a dryrun job.
list	select	subscription_id, resource_group_name, 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	subscription_id, resource_group_name, location, connector_name		Create or update Connector resource.
update	update	subscription_id, resource_group_name, location, connector_name		Operation to update an existing Connector.
create_or_update	replace	subscription_id, resource_group_name, location, connector_name		Create or update Connector resource.
delete	delete	subscription_id, resource_group_name, location, connector_name		Delete a Connector.
list_dryrun	exec	subscription_id, resource_group_name, location		list dryrun jobs.
create_dryrun	exec	subscription_id, resource_group_name, location, dryrun_name		create a dryrun job to do necessary check before actual creation.
update_dryrun	exec	subscription_id, resource_group_name, location, dryrun_name		update a dryrun job to do necessary check before actual creation.
delete_dryrun	exec	subscription_id, resource_group_name, location, dryrun_name		delete a dryrun job.
validate	exec	subscription_id, resource_group_name, location, connector_name		Validate a Connector.
generate_configurations	exec	subscription_id, resource_group_name, location, connector_name		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
connector_name	string	The name of resource. Required.
dryrun_name	string	The name of dryrun. Required.
location	string	The name of Azure region. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string	The ID of the target subscription. Required.

SELECT examples

get

Returns Connector resource for a given name.

SELECT
id,
name,
authInfo,
clientType,
configurationInfo,
provisioningState,
publicNetworkSolution,
scope,
secretStore,
systemData,
targetService,
type,
vNetSolution
FROM azure.service_linker.connector
WHERE subscription_id = '{{ subscription_id }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND location = '{{ location }}' -- required
AND connector_name = '{{ connector_name }}' -- required
;

get_dryrun

get a dryrun job.

SELECT
id,
name,
operationPreviews,
parameters,
prerequisiteResults,
provisioningState,
systemData,
type
FROM azure.service_linker.connector
WHERE subscription_id = '{{ subscription_id }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND location = '{{ location }}' -- required
AND dryrun_name = '{{ dryrun_name }}' -- required
;

list

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

SELECT
id,
name,
authInfo,
clientType,
configurationInfo,
provisioningState,
publicNetworkSolution,
scope,
secretStore,
systemData,
targetService,
type,
vNetSolution
FROM azure.service_linker.connector
WHERE subscription_id = '{{ subscription_id }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND location = '{{ location }}' -- required
;

INSERT examples

create_or_update

Create or update Connector resource.

INSERT INTO azure.service_linker.connector (
properties,
subscription_id,
resource_group_name,
location,
connector_name
)
SELECT 
'{{ properties }}',
'{{ subscription_id }}',
'{{ resource_group_name }}',
'{{ location }}',
'{{ connector_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connector
props:
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connector resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connector resource.
  - name: location
    value: "{{ location }}"
    description: Required parameter for the connector resource.
  - name: connector_name
    value: "{{ connector_name }}"
    description: Required parameter for the connector resource.
  - name: properties
    value:
      targetService:
        type: "{{ type }}"
      authInfo:
        authType: "{{ authType }}"
        authMode: "{{ authMode }}"
      clientType: "{{ clientType }}"
      vNetSolution:
        type: "{{ type }}"
        deleteOrUpdateBehavior: "{{ deleteOrUpdateBehavior }}"
      secretStore:
        keyVaultId: "{{ keyVaultId }}"
        keyVaultSecretName: "{{ keyVaultSecretName }}"
      scope: "{{ scope }}"
      publicNetworkSolution:
        deleteOrUpdateBehavior: "{{ deleteOrUpdateBehavior }}"
        action: "{{ action }}"
        firewallRules:
          ipRanges:
            - "{{ ipRanges }}"
          azureServices: "{{ azureServices }}"
          callerClientIP: "{{ callerClientIP }}"
      configurationInfo:
        deleteOrUpdateBehavior: "{{ deleteOrUpdateBehavior }}"
        action: "{{ action }}"
        customizedKeys: "{{ customizedKeys }}"
        daprProperties:
          version: "{{ version }}"
          componentType: "{{ componentType }}"
          secretStoreComponent: "{{ secretStoreComponent }}"
          metadata:
            - name: "{{ name }}"
              value: "{{ value }}"
              secretRef: "{{ secretRef }}"
              description: "{{ description }}"
              required: "{{ required }}"
          scopes:
            - "{{ scopes }}"
          runtimeVersion: "{{ runtimeVersion }}"
          bindingComponentDirection: "{{ bindingComponentDirection }}"
        additionalConfigurations: "{{ additionalConfigurations }}"
        additionalConnectionStringProperties: "{{ additionalConnectionStringProperties }}"
        configurationStore:
          appConfigurationId: "{{ appConfigurationId }}"

UPDATE examples

update

Operation to update an existing Connector.

UPDATE azure.service_linker.connector
SET 
properties = '{{ properties }}'
WHERE 
subscription_id = '{{ subscription_id }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND location = '{{ location }}' --required
AND connector_name = '{{ connector_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update Connector resource.

REPLACE azure.service_linker.connector
SET 
properties = '{{ properties }}'
WHERE 
subscription_id = '{{ subscription_id }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND location = '{{ location }}' --required
AND connector_name = '{{ connector_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Connector.

DELETE FROM azure.service_linker.connector
WHERE subscription_id = '{{ subscription_id }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND location = '{{ location }}' --required
AND connector_name = '{{ connector_name }}' --required
;

Lifecycle Methods

list_dryrun

list dryrun jobs.

EXEC azure.service_linker.connector.list_dryrun 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required
;

create_dryrun

create a dryrun job to do necessary check before actual creation.

EXEC azure.service_linker.connector.create_dryrun 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@dryrun_name='{{ dryrun_name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_dryrun

update a dryrun job to do necessary check before actual creation.

EXEC azure.service_linker.connector.update_dryrun 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@dryrun_name='{{ dryrun_name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_dryrun

delete a dryrun job.

EXEC azure.service_linker.connector.delete_dryrun 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@dryrun_name='{{ dryrun_name }}' --required
;

validate

Validate a Connector.

EXEC azure.service_linker.connector.validate 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@connector_name='{{ connector_name }}' --required
;

generate_configurations

Generate configurations for a Connector.

EXEC azure.service_linker.connector.generate_configurations 
@subscription_id='{{ subscription_id }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@location='{{ location }}' --required, 
@connector_name='{{ connector_name }}' --required 
@@json=
'{
"deleteOrUpdateBehavior": "{{ deleteOrUpdateBehavior }}", 
"action": "{{ action }}", 
"customizedKeys": "{{ customizedKeys }}", 
"daprProperties": "{{ daprProperties }}", 
"additionalConfigurations": "{{ additionalConfigurations }}", 
"additionalConnectionStringProperties": "{{ additionalConnectionStringProperties }}", 
"configurationStore": "{{ configurationStore }}"
}'
;