linkers

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

Overview

Name	linkers
Type	Resource
Id	azure.service_linker.linkers

Fields

The following fields are returned by SELECT queries:

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_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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dryrun	select	resource_uri, dryrun_name		get a dryrun job.
list_dryrun	select	resource_uri		list dryrun jobs.
list_dapr_configurations	exec	resource_uri		List the dapr configuration supported by Service Connector.
create_dryrun	exec	resource_uri, dryrun_name		create a dryrun job to do necessary check before actual creation.
update_dryrun	exec	resource_uri, dryrun_name		add a dryrun job to do necessary check before actual creation.
delete_dryrun	exec	resource_uri, dryrun_name		delete a dryrun job.
generate_configurations	exec	resource_uri, linker_name		Generate configurations for 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
dryrun_name	string	The name of dryrun. Required.
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_dryrun

get a dryrun job.

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

list_dryrun

list dryrun jobs.

SELECT
id,
name,
operationPreviews,
parameters,
prerequisiteResults,
provisioningState,
systemData,
type
FROM azure.service_linker.linkers
WHERE resource_uri = '{{ resource_uri }}' -- required
;

Lifecycle Methods

list_dapr_configurations

List the dapr configuration supported by Service Connector.

EXEC azure.service_linker.linkers.list_dapr_configurations 
@resource_uri='{{ resource_uri }}' --required
;

create_dryrun

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

EXEC azure.service_linker.linkers.create_dryrun 
@resource_uri='{{ resource_uri }}' --required, 
@dryrun_name='{{ dryrun_name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_dryrun

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

EXEC azure.service_linker.linkers.update_dryrun 
@resource_uri='{{ resource_uri }}' --required, 
@dryrun_name='{{ dryrun_name }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_dryrun

delete a dryrun job.

EXEC azure.service_linker.linkers.delete_dryrun 
@resource_uri='{{ resource_uri }}' --required, 
@dryrun_name='{{ dryrun_name }}' --required
;

generate_configurations

Generate configurations for a Linker.

EXEC azure.service_linker.linkers.generate_configurations 
@resource_uri='{{ resource_uri }}' --required, 
@linker_name='{{ linker_name }}' --required 
@@json=
'{
"deleteOrUpdateBehavior": "{{ deleteOrUpdateBehavior }}", 
"action": "{{ action }}", 
"customizedKeys": "{{ customizedKeys }}", 
"daprProperties": "{{ daprProperties }}", 
"additionalConfigurations": "{{ additionalConfigurations }}", 
"additionalConnectionStringProperties": "{{ additionalConnectionStringProperties }}", 
"configurationStore": "{{ configurationStore }}"
}'
;