connections

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

Overview

Name	connections
Type	Resource
Id	azure.data_transfer.connections

Fields

The following fields are returned by SELECT queries:

get

Retrieved the connections resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of connection
tags	object	Resource tags.

list_by_resource_group

Listed all connections under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of connection
tags	object	Resource tags.

list_by_subscription

Listed all connections under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of connection
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, connectionName		Gets connection resource.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets connections in a resource group.
list_by_subscription	select	subscriptionId		Gets connections in a subscription.
create_or_update	insert	subscriptionId, resourceGroupName, connectionName, data__location		Creates or updates the connection resource.
update	update	subscriptionId, resourceGroupName, connectionName		Updates the connection resource.
delete	delete	subscriptionId, resourceGroupName, connectionName		Deletes the connection resource.
link	exec	subscriptionId, resourceGroupName, connectionName, id		Links the connection to its pending connection.

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
connectionName	string	The name for the connection that is to be requested.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets connection resource.

SELECT
location,
properties,
tags
FROM azure.data_transfer.connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND connectionName = '{{ connectionName }}' -- required
;

list_by_resource_group

Gets connections in a resource group.

SELECT
location,
properties,
tags
FROM azure.data_transfer.connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Gets connections in a subscription.

SELECT
location,
properties,
tags
FROM azure.data_transfer.connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the connection resource.

INSERT INTO azure.data_transfer.connections (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
connectionName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ connectionName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: connections
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the connections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the connections resource.
    - name: connectionName
      value: string
      description: Required parameter for the connections resource.
    - name: properties
      value: object
      description: |
        Properties of connection
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates the connection resource.

UPDATE azure.data_transfer.connections
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND connectionName = '{{ connectionName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes the connection resource.

DELETE FROM azure.data_transfer.connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND connectionName = '{{ connectionName }}' --required
;

Lifecycle Methods

link

Links the connection to its pending connection.

EXEC azure.data_transfer.connections.link 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@connectionName='{{ connectionName }}' --required 
@@json=
'{
"id": "{{ id }}", 
"statusReason": "{{ statusReason }}"
}'
;