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:

get

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Properties on the share subscription
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource

list_by_account

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Properties on the share subscription
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, shareSubscriptionName	api-version	Get a shareSubscription in an account
list_by_account	select	subscriptionId, resourceGroupName, accountName	api-version, $skipToken, $filter, $orderby	List share subscriptions in an account
create	insert	subscriptionId, resourceGroupName, accountName, shareSubscriptionName, data__properties	api-version	Create a shareSubscription in an account
delete	delete	subscriptionId, resourceGroupName, accountName, shareSubscriptionName	api-version	Delete a shareSubscription in an account
cancel_synchronization	exec	subscriptionId, resourceGroupName, accountName, shareSubscriptionName, synchronizationId	api-version	Request to cancel a synchronization.
synchronize	exec	subscriptionId, resourceGroupName, accountName, shareSubscriptionName	api-version	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
accountName	string	The name of the share account.
resourceGroupName	string	The resource group name.
shareSubscriptionName	string	The name of share subscription
subscriptionId	string	The subscription identifier
$filter	string	Filters the results using OData syntax.
$orderby	string	Sorts the results using OData syntax.
$skipToken	string	Continuation Token
api-version	string	The api version to use.

SELECT examples

get

Get a shareSubscription in an account

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_share.share_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareSubscriptionName = '{{ shareSubscriptionName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_account

List share subscriptions in an account

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_share.share_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create a shareSubscription in an account

INSERT INTO azure.data_share.share_subscriptions (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
shareSubscriptionName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ shareSubscriptionName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: share_subscriptions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the share_subscriptions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the share_subscriptions resource.
    - name: accountName
      value: string
      description: Required parameter for the share_subscriptions resource.
    - name: shareSubscriptionName
      value: string
      description: Required parameter for the share_subscriptions resource.
    - name: properties
      value: object
      description: |
        Properties on the share subscription
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Delete a shareSubscription in an account

DELETE FROM azure.data_share.share_subscriptions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareSubscriptionName = '{{ shareSubscriptionName }}' --required
AND api-version = '{{ api-version }}'
;

Lifecycle Methods

cancel_synchronization

Request to cancel a synchronization.

EXEC azure.data_share.share_subscriptions.cancel_synchronization 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@shareSubscriptionName='{{ shareSubscriptionName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"synchronizationId": "{{ synchronizationId }}"
}'
;

synchronize

Initiate a copy

EXEC azure.data_share.share_subscriptions.synchronize 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@shareSubscriptionName='{{ shareSubscriptionName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"synchronizationMode": "{{ synchronizationMode }}"
}'
;