linker

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

Overview

Name	linker
Type	Resource
Id	azure.service_linker.linker

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.

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	resource_uri, linker_name		Returns Linker resource for a given name.
list	select	resource_uri		Returns list of Linkers which connects to the resource. which supports to config both application and target service during the resource provision.
create_or_update	insert	resource_uri, linker_name		Create or update Linker resource.
update	update	resource_uri, linker_name		Operation to update an existing Linker.
create_or_update	replace	resource_uri, linker_name		Create or update Linker resource.
delete	delete	resource_uri, linker_name		Delete a Linker.
list_configurations	exec	resource_uri, linker_name		list source configurations for a Linker.
validate	exec	resource_uri, linker_name		Validate a Linker.

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
linker_name	string	The name Linker resource. Required.
resource_uri	string	The fully qualified Azure Resource manager identifier of the resource to be connected. Required.

SELECT examples

get

Returns Linker resource for a given name.

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

list

Returns list of Linkers which connects to the resource. which supports to config both application and target service during the resource provision.

SELECT
id,
name,
authInfo,
clientType,
configurationInfo,
provisioningState,
publicNetworkSolution,
scope,
secretStore,
systemData,
targetService,
type,
vNetSolution
FROM azure.service_linker.linker
WHERE resource_uri = '{{ resource_uri }}' -- required
;

INSERT examples

create_or_update

Create or update Linker resource.

INSERT INTO azure.service_linker.linker (
properties,
resource_uri,
linker_name
)
SELECT 
'{{ properties }}',
'{{ resource_uri }}',
'{{ linker_name }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: linker
props:
  - name: resource_uri
    value: "{{ resource_uri }}"
    description: Required parameter for the linker resource.
  - name: linker_name
    value: "{{ linker_name }}"
    description: Required parameter for the linker 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 Linker.

UPDATE azure.service_linker.linker
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND linker_name = '{{ linker_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create or update Linker resource.

REPLACE azure.service_linker.linker
SET 
properties = '{{ properties }}'
WHERE 
resource_uri = '{{ resource_uri }}' --required
AND linker_name = '{{ linker_name }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a Linker.

DELETE FROM azure.service_linker.linker
WHERE resource_uri = '{{ resource_uri }}' --required
AND linker_name = '{{ linker_name }}' --required
;

Lifecycle Methods

list_configurations

list source configurations for a Linker.

EXEC azure.service_linker.linker.list_configurations 
@resource_uri='{{ resource_uri }}' --required, 
@linker_name='{{ linker_name }}' --required
;

validate

Validate a Linker.

EXEC azure.service_linker.linker.validate 
@resource_uri='{{ resource_uri }}' --required, 
@linker_name='{{ linker_name }}' --required
;