connectors

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

Overview

Name	connectors
Type	Resource
Id	azure.service_connector.connectors

Fields

vw_connectors

Name	Datatype	Description
auth_info	text	field from the properties object
client_type	text	field from the properties object
configuration_info	text	field from the properties object
connectorName	text	field from the properties object
location	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_solution	text	field from the properties object
resourceGroupName	text	field from the properties object
scope	text	field from the properties object
secret_store	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
target_service	text	field from the properties object
vnet_solution	text	field from the properties object

connectors

Name	Datatype	Description
properties	object	The properties of the Linker.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectorName, location, resourceGroupName, subscriptionId	Returns Connector resource for a given name.
list	SELECT	location, resourceGroupName, subscriptionId	Returns list of connector which connects to the resource, which supports to config the target service during the resource provision.
create_or_update	INSERT	connectorName, location, resourceGroupName, subscriptionId, data__properties	Create or update Connector resource.
delete	DELETE	connectorName, location, resourceGroupName, subscriptionId	Delete a Connector.
update	UPDATE	connectorName, location, resourceGroupName, subscriptionId	Operation to update an existing Connector.
generate_configurations	EXEC	connectorName, location, resourceGroupName, subscriptionId	Generate configurations for a Connector.
validate	EXEC	connectorName, location, resourceGroupName, subscriptionId	Validate a Connector.

SELECT examples

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

vw_connectors

SELECT
auth_info,
client_type,
configuration_info,
connectorName,
location,
provisioning_state,
public_network_solution,
resourceGroupName,
scope,
secret_store,
subscriptionId,
system_data,
target_service,
vnet_solution
FROM azure.service_connector.vw_connectors
WHERE location = '{{ location }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

connectors

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

INSERT example

Use the following StackQL query and manifest file to create a new connectors resource.

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: targetService
          value:
            - name: type
              value: []
        - name: authInfo
          value:
            - name: authType
              value: []
            - name: authMode
              value: []
        - name: clientType
          value: []
        - name: provisioningState
          value: string
        - name: vNetSolution
          value:
            - name: type
              value: string
            - name: deleteOrUpdateBehavior
              value: []
        - name: secretStore
          value:
            - name: keyVaultId
              value: string
            - name: keyVaultSecretName
              value: string
        - name: scope
          value: string
        - name: publicNetworkSolution
          value:
            - name: action
              value: []
            - name: firewallRules
              value:
                - name: ipRanges
                  value:
                    - string
                - name: azureServices
                  value: []
        - name: configurationInfo
          value:
            - name: customizedKeys
              value: object
            - name: daprProperties
              value:
                - name: version
                  value: string
                - name: componentType
                  value: string
                - name: secretStoreComponent
                  value: string
                - name: metadata
                  value:
                    - - name: name
                        value: string
                      - name: value
                        value: string
                      - name: secretRef
                        value: string
                      - name: description
                        value: string
                      - name: required
                        value: string
                - name: scopes
                  value:
                    - string
                - name: runtimeVersion
                  value: string
                - name: bindingComponentDirection
                  value: string
            - name: additionalConfigurations
              value: object
            - name: additionalConnectionStringProperties
              value: object
            - name: configurationStore
              value:
                - name: appConfigurationId
                  value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a connectors resource.

/*+ update */
UPDATE azure.service_connector.connectors
SET 
properties = '{{ properties }}'
WHERE 
connectorName = '{{ connectorName }}'
AND location = '{{ location }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified connectors resource.

/*+ delete */
DELETE FROM azure.service_connector.connectors
WHERE connectorName = '{{ connectorName }}'
AND location = '{{ location }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';