provider_share_subscriptions

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

Overview

Name	provider_share_subscriptions
Type	Resource
Id	azure.data_share.provider_share_subscriptions

Fields

The following fields are returned by SELECT queries:

get_by_share

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

list_by_share

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	properties of providerShareSubscription
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_by_share	select	subscriptionId, resourceGroupName, accountName, shareName, providerShareSubscriptionId	api-version	Get share subscription in a provider share
list_by_share	select	subscriptionId, resourceGroupName, accountName, shareName	api-version, $skipToken	List share subscriptions in a provider share
adjust	exec	subscriptionId, resourceGroupName, accountName, shareName, providerShareSubscriptionId	api-version	Adjust a share subscription's expiration date in a provider share
reinstate	exec	subscriptionId, resourceGroupName, accountName, shareName, providerShareSubscriptionId	api-version	Reinstate share subscription in a provider share
revoke	exec	subscriptionId, resourceGroupName, accountName, shareName, providerShareSubscriptionId	api-version	Revoke share subscription in a provider share

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.
providerShareSubscriptionId	string	To locate shareSubscription
resourceGroupName	string	The resource group name.
shareName	string	The name of the share.
subscriptionId	string	The subscription identifier
$skipToken	string	Continuation Token
api-version	string	The api version to use.

SELECT examples

get_by_share

Get share subscription in a provider share

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

list_by_share

List share subscriptions in a provider share

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

Lifecycle Methods

adjust

Adjust a share subscription's expiration date in a provider share

EXEC azure.data_share.provider_share_subscriptions.adjust 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@shareName='{{ shareName }}' --required, 
@providerShareSubscriptionId='{{ providerShareSubscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

reinstate

Reinstate share subscription in a provider share

EXEC azure.data_share.provider_share_subscriptions.reinstate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@shareName='{{ shareName }}' --required, 
@providerShareSubscriptionId='{{ providerShareSubscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

revoke

Revoke share subscription in a provider share

EXEC azure.data_share.provider_share_subscriptions.revoke 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@shareName='{{ shareName }}' --required, 
@providerShareSubscriptionId='{{ providerShareSubscriptionId }}' --required, 
@api-version='{{ api-version }}'
;