connections

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

Overview

Name	connections
Type	Resource
Id	azure.storage_mover.connections

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}.
name	string	The name of the resource.
connectionStatus	string	The connection status. Known values are: "Approved", "Rejected", "Disconnected", "Pending", and "Stale". (Approved, Rejected, Disconnected, Pending, Stale)
description	string	A description for the Connection.
jobList	array	List of job definitions associated with this connection.
privateEndpointName	string	The PrivateEndpointName associated with the connection.
privateEndpointResourceId	string	The privateEndpoint resource Id.
privateLinkServiceId	string	The PrivateLinkServiceId for the connection. Required.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectionStatus	string	The connection status. Known values are: "Approved", "Rejected", "Disconnected", "Pending", and "Stale". (Approved, Rejected, Disconnected, Pending, Stale)
description	string	A description for the Connection.
jobList	array	List of job definitions associated with this connection.
privateEndpointName	string	The PrivateEndpointName associated with the connection.
privateEndpointResourceId	string	The privateEndpoint resource Id.
privateLinkServiceId	string	The PrivateLinkServiceId for the connection. Required.
provisioningState	string	The provisioning state of this resource. Known values are: "Succeeded", "Canceled", "Failed", and "Deleting". (Succeeded, Canceled, Failed, Deleting)
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	select	resource_group_name, storage_mover_name, connection_name, subscription_id		Gets a Connection resource.
list	select	resource_group_name, storage_mover_name, subscription_id		Lists all Connections in a Storage Mover.
create_or_update	insert	resource_group_name, storage_mover_name, connection_name, subscription_id, properties		Creates or updates a Connection resource.
create_or_update	replace	resource_group_name, storage_mover_name, connection_name, subscription_id, properties		Creates or updates a Connection resource.
delete	delete	resource_group_name, storage_mover_name, connection_name, subscription_id		Deletes a Connection resource. Returns 409 if there are active jobs using this 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
connection_name	string	The name of the Connection resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_mover_name	string	The name of the Storage Mover resource. Required.
subscription_id	string

SELECT examples

get

Gets a Connection resource.

SELECT
id,
name,
connectionStatus,
description,
jobList,
privateEndpointName,
privateEndpointResourceId,
privateLinkServiceId,
provisioningState,
systemData,
type
FROM azure.storage_mover.connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_mover_name = '{{ storage_mover_name }}' -- required
AND connection_name = '{{ connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists all Connections in a Storage Mover.

SELECT
id,
name,
connectionStatus,
description,
jobList,
privateEndpointName,
privateEndpointResourceId,
privateLinkServiceId,
provisioningState,
systemData,
type
FROM azure.storage_mover.connections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_mover_name = '{{ storage_mover_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Connection resource.

INSERT INTO azure.storage_mover.connections (
properties,
resource_group_name,
storage_mover_name,
connection_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ storage_mover_name }}',
'{{ connection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: connections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connections resource.
  - name: storage_mover_name
    value: "{{ storage_mover_name }}"
    description: Required parameter for the connections resource.
  - name: connection_name
    value: "{{ connection_name }}"
    description: Required parameter for the connections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connections resource.
  - name: properties
    description: |
      Connection properties. Required.
    value:
      description: "{{ description }}"
      connectionStatus: "{{ connectionStatus }}"
      privateLinkServiceId: "{{ privateLinkServiceId }}"
      privateEndpointName: "{{ privateEndpointName }}"
      privateEndpointResourceId: "{{ privateEndpointResourceId }}"
      jobList:
        - "{{ jobList }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a Connection resource.

REPLACE azure.storage_mover.connections
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes a Connection resource. Returns 409 if there are active jobs using this connection.

DELETE FROM azure.storage_mover.connections
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_mover_name = '{{ storage_mover_name }}' --required
AND connection_name = '{{ connection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;