share_subscriptions

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

Overview

Name	share_subscriptions
Type	Resource
Id	azure.data_share.share_subscriptions

Fields

The following fields are returned by SELECT queries:

list_synchronization_details

Name	Datatype	Description
name	string	Name of the data set.
dataSetId	string	Id of data set.
dataSetType	string	Type of the data set. Known values are: "Blob", "Container", "BlobFolder", "AdlsGen2FileSystem", "AdlsGen2Folder", "AdlsGen2File", "AdlsGen1Folder", "AdlsGen1File", "KustoCluster", "KustoDatabase", "SqlDBTable", "SqlDWTable", and "SynapseWorkspaceSqlPoolTable".
durationMs	integer	Duration of data set level copy.
endTime	string (date-time)	End time of data set level copy.
filesRead	integer	The number of files read from the source data set.
filesWritten	integer	The number of files written into the sink data set.
message	string	Error message if any.
rowsCopied	integer	The number of files copied into the sink data set.
rowsRead	integer	The number of rows read from the source data set.
sizeRead	integer	The size of the data read from the source data set in bytes.
sizeWritten	integer	The size of the data written into the sink data set in bytes.
startTime	string (date-time)	Start time of data set level copy.
status	string	Raw Status.
vCore	integer	The vCore units consumed for the data set synchronization.

get

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
createdAt	string (date-time)	Time at which the share subscription was created.
expirationDate	string (date-time)	The expiration date of the share subscription.
invitationId	string	The invitation id. Required.
providerEmail	string	Email of the provider who created the resource.
providerName	string	Name of the provider who created the resource.
providerTenantName	string	Tenant name of the provider who created the resource.
provisioningState	string	Provisioning state of the share subscription. Known values are: "Succeeded", "Creating", "Deleting", "Moving", and "Failed".
shareDescription	string	Description of share.
shareKind	string	Kind of share. Known values are: "CopyBased" and "InPlace".
shareName	string	Name of the share.
shareSubscriptionStatus	string	Gets the current status of share subscription. Known values are: "Active", "Revoked", "SourceDeleted", and "Revoking".
shareTerms	string	Terms of a share.
sourceShareLocation	string	Source share location. Required.
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource.
userEmail	string	Email of the user who created the resource.
userName	string	Name of the user who created the resource.

list_by_account

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
createdAt	string (date-time)	Time at which the share subscription was created.
expirationDate	string (date-time)	The expiration date of the share subscription.
invitationId	string	The invitation id. Required.
providerEmail	string	Email of the provider who created the resource.
providerName	string	Name of the provider who created the resource.
providerTenantName	string	Tenant name of the provider who created the resource.
provisioningState	string	Provisioning state of the share subscription. Known values are: "Succeeded", "Creating", "Deleting", "Moving", and "Failed".
shareDescription	string	Description of share.
shareKind	string	Kind of share. Known values are: "CopyBased" and "InPlace".
shareName	string	Name of the share.
shareSubscriptionStatus	string	Gets the current status of share subscription. Known values are: "Active", "Revoked", "SourceDeleted", and "Revoking".
shareTerms	string	Terms of a share.
sourceShareLocation	string	Source share location. Required.
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource.
userEmail	string	Email of the user who created the resource.
userName	string	Name of the user who created the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_synchronization_details	select	resource_group_name, account_name, share_subscription_name, subscription_id	$skipToken, $filter, $orderby	List data set level details for a share subscription synchronization. List synchronization details.
get	select	resource_group_name, account_name, share_subscription_name, subscription_id		Get shareSubscription in an account. Get a shareSubscription in an account.
list_by_account	select	resource_group_name, account_name, subscription_id	$skipToken, $filter, $orderby	List of available share subscriptions under an account. List share subscriptions in an account.
create	insert	resource_group_name, account_name, share_subscription_name, subscription_id, properties		Create shareSubscription in an account. Create a shareSubscription in an account.
delete	delete	resource_group_name, account_name, share_subscription_name, subscription_id		Delete shareSubscription in an account. Delete a shareSubscription in an account.
list_source_share_synchronization_settings	exec	resource_group_name, account_name, share_subscription_name, subscription_id	$skipToken	Get source share synchronization settings for a shareSubscription. Get synchronization settings set on a share.
list_synchronizations	exec	resource_group_name, account_name, share_subscription_name, subscription_id	$skipToken, $filter, $orderby	List Synchronizations in a share subscription. List synchronizations of a share subscription.
cancel_synchronization	exec	resource_group_name, account_name, share_subscription_name, subscription_id, synchronizationId		Request cancellation of a data share snapshot. Request to cancel a synchronization.
synchronize	exec	resource_group_name, account_name, share_subscription_name, subscription_id		Initiate an asynchronous data share job. Initiate a copy.

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 share account. Required.
resource_group_name	string	The resource group name. Required.
share_subscription_name	string	The name of share subscription. Required.
subscription_id	string
$filter	string	Filters the results using OData syntax. Default value is None.
$orderby	string	Sorts the results using OData syntax. Default value is None.
$skipToken	string	Continuation token. Default value is None.

SELECT examples

list_synchronization_details

List data set level details for a share subscription synchronization. List synchronization details.

SELECT
name,
dataSetId,
dataSetType,
durationMs,
endTime,
filesRead,
filesWritten,
message,
rowsCopied,
rowsRead,
sizeRead,
sizeWritten,
startTime,
status,
vCore
FROM azure.data_share.share_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_subscription_name = '{{ share_subscription_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

get

Get shareSubscription in an account. Get a shareSubscription in an account.

SELECT
id,
name,
createdAt,
expirationDate,
invitationId,
providerEmail,
providerName,
providerTenantName,
provisioningState,
shareDescription,
shareKind,
shareName,
shareSubscriptionStatus,
shareTerms,
sourceShareLocation,
systemData,
type,
userEmail,
userName
FROM azure.data_share.share_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_subscription_name = '{{ share_subscription_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

List of available share subscriptions under an account. List share subscriptions in an account.

SELECT
id,
name,
createdAt,
expirationDate,
invitationId,
providerEmail,
providerName,
providerTenantName,
provisioningState,
shareDescription,
shareKind,
shareName,
shareSubscriptionStatus,
shareTerms,
sourceShareLocation,
systemData,
type,
userEmail,
userName
FROM azure.data_share.share_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create shareSubscription in an account. Create a shareSubscription in an account.

INSERT INTO azure.data_share.share_subscriptions (
properties,
resource_group_name,
account_name,
share_subscription_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ share_subscription_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: share_subscriptions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the share_subscriptions resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the share_subscriptions resource.
  - name: share_subscription_name
    value: "{{ share_subscription_name }}"
    description: Required parameter for the share_subscriptions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the share_subscriptions resource.
  - name: properties
    value:
      expirationDate: "{{ expirationDate }}"
      invitationId: "{{ invitationId }}"
      sourceShareLocation: "{{ sourceShareLocation }}"

DELETE examples

delete

Delete shareSubscription in an account. Delete a shareSubscription in an account.

DELETE FROM azure.data_share.share_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND share_subscription_name = '{{ share_subscription_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_source_share_synchronization_settings

Get source share synchronization settings for a shareSubscription. Get synchronization settings set on a share.

EXEC azure.data_share.share_subscriptions.list_source_share_synchronization_settings 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_subscription_name='{{ share_subscription_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$skipToken='{{ $skipToken }}'
;

list_synchronizations

List Synchronizations in a share subscription. List synchronizations of a share subscription.

EXEC azure.data_share.share_subscriptions.list_synchronizations 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_subscription_name='{{ share_subscription_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$skipToken='{{ $skipToken }}', 
@$filter='{{ $filter }}', 
@$orderby='{{ $orderby }}'
;

cancel_synchronization

Request cancellation of a data share snapshot. Request to cancel a synchronization.

EXEC azure.data_share.share_subscriptions.cancel_synchronization 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_subscription_name='{{ share_subscription_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"synchronizationId": "{{ synchronizationId }}"
}'
;

synchronize

Initiate an asynchronous data share job. Initiate a copy.

EXEC azure.data_share.share_subscriptions.synchronize 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_subscription_name='{{ share_subscription_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"synchronizationMode": "{{ synchronizationMode }}"
}'
;