connectors

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

Overview

Name	connectors
Type	Resource
Id	azure.storage.connectors

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.
creationTime	string	System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
dataSourceType	string	The type of backing data source for this Storage Connector. Required. "Azure_DataShare" (Azure_DataShare)
description	string	Arbitrary description of this Storage Connector. Max 250 characters.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Represents the provisioning state of the storage connector. Known values are: "Accepted", "Creating", "Succeeded", "Deleting", "Canceled", and "Failed". (Accepted, Creating, Succeeded, Deleting, Canceled, Failed)
source	object	Information about how to communicate with and authenticate to the backing data store. Required.
state	string	State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise. Known values are: "Active" and "Inactive". (Active, Inactive)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
testConnection	boolean	Test connection to backing data source before creating the storage connector.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueId	string	System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.

list_by_storage_account

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.
creationTime	string	System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). Not a valid input parameter during creating.
dataSourceType	string	The type of backing data source for this Storage Connector. Required. "Azure_DataShare" (Azure_DataShare)
description	string	Arbitrary description of this Storage Connector. Max 250 characters.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Represents the provisioning state of the storage connector. Known values are: "Accepted", "Creating", "Succeeded", "Deleting", "Canceled", and "Failed". (Accepted, Creating, Succeeded, Deleting, Canceled, Failed)
source	object	Information about how to communicate with and authenticate to the backing data store. Required.
state	string	State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise. Known values are: "Active" and "Inactive". (Active, Inactive)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
testConnection	boolean	Test connection to backing data source before creating the storage connector.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueId	string	System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, connector_name, subscription_id		Get the specified Storage Connector.
list_by_storage_account	select	resource_group_name, account_name, subscription_id		List all Storage Connectors in a Storage Account.
create	insert	resource_group_name, account_name, connector_name, subscription_id, location, properties		Create a Storage Connector if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.
update	update	resource_group_name, account_name, connector_name, subscription_id		Update a Storage Connector.
delete	delete	resource_group_name, account_name, connector_name, subscription_id		Delete a Storage Connector.
test_existing_connection	exec	resource_group_name, account_name, connector_name, subscription_id, uniqueId		This method is used to verify that the connection to the backing data store works. This API is designed to be used for monitoring and debugging purposes. From the caller’s perspective, this method does the following: Calls List on the backing data store, attempting to list up to one blob/object/etc. If the above succeeds, and if a blob/object/etc is found, calls Get on that object, attempting to download one byte.

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
account_name	string	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. Required.
connector_name	string	The name of the Storage Connector. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the specified Storage Connector.

SELECT
id,
name,
creationTime,
dataSourceType,
description,
location,
provisioningState,
source,
state,
systemData,
tags,
testConnection,
type,
uniqueId
FROM azure.storage.connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND connector_name = '{{ connector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_storage_account

List all Storage Connectors in a Storage Account.

SELECT
id,
name,
creationTime,
dataSourceType,
description,
location,
provisioningState,
source,
state,
systemData,
tags,
testConnection,
type,
uniqueId
FROM azure.storage.connectors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a Storage Connector if it does not already exist; otherwise, error out. This API will not allow you to replace an already existing resource.

INSERT INTO azure.storage.connectors (
tags,
location,
properties,
resource_group_name,
account_name,
connector_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ connector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the connectors resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the connectors resource.
  - name: connector_name
    value: "{{ connector_name }}"
    description: Required parameter for the connectors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the connectors resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The properties of the Storage Connector. Required.
    value:
      uniqueId: "{{ uniqueId }}"
      state: "{{ state }}"
      creationTime: "{{ creationTime }}"
      description: "{{ description }}"
      testConnection: {{ testConnection }}
      dataSourceType: "{{ dataSourceType }}"
      source:
        type: "{{ type }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a Storage Connector.

UPDATE azure.storage.connectors
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Storage Connector.

DELETE FROM azure.storage.connectors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND connector_name = '{{ connector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

test_existing_connection

This method is used to verify that the connection to the backing data store works. This API is designed to be used for monitoring and debugging purposes. From the caller’s perspective, this method does the following: Calls List on the backing data store, attempting to list up to one blob/object/etc. If the above succeeds, and if a blob/object/etc is found, calls Get on that object, attempting to download one byte.

EXEC azure.storage.connectors.test_existing_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@connector_name='{{ connector_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"uniqueId": "{{ uniqueId }}"
}'
;