linkers

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

Overview

Name	linkers
Type	Resource
Id	azure.service_connector.linkers

Fields

The following fields are returned by SELECT queries:

get

Linker details.

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

list

Linker 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	resourceUri, linkerName		Returns Linker resource for a given name.
list	select	resourceUri		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	resourceUri, linkerName, data__properties		Create or update Linker resource.
update	update	resourceUri, linkerName		Operation to update an existing Linker.
delete	delete	resourceUri, linkerName		Delete a Linker.
validate	exec	resourceUri, linkerName		Validate a Linker.
generate_configurations	exec	resourceUri, linkerName		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
linkerName	string	The name Linker resource.
resourceUri	string	The fully qualified Azure Resource manager identifier of the resource to be connected.

SELECT examples

get

Returns Linker resource for a given name.

SELECT
properties,
systemData
FROM azure.service_connector.linkers
WHERE resourceUri = '{{ resourceUri }}' -- required
AND linkerName = '{{ linkerName }}' -- 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
properties,
systemData
FROM azure.service_connector.linkers
WHERE resourceUri = '{{ resourceUri }}' -- required
;

INSERT examples

create_or_update

Create or update Linker resource.

INSERT INTO azure.service_connector.linkers (
data__properties,
resourceUri,
linkerName
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceUri }}',
'{{ linkerName }}'
RETURNING
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: linkers
  props:
    - name: resourceUri
      value: string
      description: Required parameter for the linkers resource.
    - name: linkerName
      value: string
      description: Required parameter for the linkers resource.
    - name: properties
      value: object
      description: |
        The properties of the Linker.

UPDATE examples

update

Operation to update an existing Linker.

UPDATE azure.service_connector.linkers
SET 
data__properties = '{{ properties }}'
WHERE 
resourceUri = '{{ resourceUri }}' --required
AND linkerName = '{{ linkerName }}' --required
RETURNING
properties,
systemData;

DELETE examples

delete

Delete a Linker.

DELETE FROM azure.service_connector.linkers
WHERE resourceUri = '{{ resourceUri }}' --required
AND linkerName = '{{ linkerName }}' --required
;

Lifecycle Methods

validate

Validate a Linker.

EXEC azure.service_connector.linkers.validate 
@resourceUri='{{ resourceUri }}' --required, 
@linkerName='{{ linkerName }}' --required
;

generate_configurations

Generate configurations for a Linker.

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