connections

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

Overview

Name	connections
Type	Resource
Id	azure.data_transfer.connections

Fields

vw_connections

Name	Datatype	Description
approver	text	field from the properties object
connectionName	text	field from the properties object
date_submitted	text	field from the properties object
direction	text	field from the properties object
flow_types	text	field from the properties object
justification	text	field from the properties object
link_status	text	field from the properties object
linked_connection_id	text	field from the properties object
location	text	The geo-location where the resource lives
pin	text	field from the properties object
pipeline	text	field from the properties object
policies	text	field from the properties object
primary_contact	text	field from the properties object
provisioning_state	text	field from the properties object
remote_subscription_id	text	field from the properties object
requirement_id	text	field from the properties object
resourceGroupName	text	field from the properties object
schemas	text	field from the properties object
secondary_contacts	text	field from the properties object
status	text	field from the properties object
status_reason	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

connections

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	connectionName, resourceGroupName, subscriptionId	Gets connection resource.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets connections in a resource group.
list_by_subscription	SELECT	subscriptionId	Gets connections in a subscription.
create_or_update	INSERT	connectionName, resourceGroupName, subscriptionId, data__location	Creates or updates the connection resource.
delete	DELETE	connectionName, resourceGroupName, subscriptionId	Deletes the connection resource.
update	UPDATE	connectionName, resourceGroupName, subscriptionId	Updates the connection resource.
link	EXEC	connectionName, resourceGroupName, subscriptionId, data__id	Links the connection to its pending connection.

SELECT examples

Gets connections in a subscription.

vw_connections

SELECT
approver,
connectionName,
date_submitted,
direction,
flow_types,
justification,
link_status,
linked_connection_id,
location,
pin,
pipeline,
policies,
primary_contact,
provisioning_state,
remote_subscription_id,
requirement_id,
resourceGroupName,
schemas,
secondary_contacts,
status,
status_reason,
subscriptionId,
tags
FROM azure.data_transfer.vw_connections
WHERE subscriptionId = '{{ subscriptionId }}';

connections

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_transfer.connections (
connectionName,
resourceGroupName,
subscriptionId,
data__location,
properties,
tags,
location
)
SELECT 
'{{ connectionName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: pipeline
          value: string
        - name: direction
          value: string
        - name: justification
          value: string
        - name: status
          value: string
        - name: statusReason
          value: string
        - name: linkStatus
          value: string
        - name: linkedConnectionId
          value: string
        - name: flowTypes
          value: []
        - name: requirementId
          value: string
        - name: remoteSubscriptionId
          value: string
        - name: approver
          value: string
        - name: pin
          value: string
        - name: dateSubmitted
          value: string
        - name: primaryContact
          value: string
        - name: secondaryContacts
          value:
            - string
        - name: provisioningState
          value: string
        - name: policies
          value:
            - string
        - name: schemas
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a connections resource.

/*+ update */
UPDATE azure.data_transfer.connections
SET 
tags = '{{ tags }}'
WHERE 
connectionName = '{{ connectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified connections resource.

/*+ delete */
DELETE FROM azure.data_transfer.connections
WHERE connectionName = '{{ connectionName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';