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.
consumerEmail	string	Email of the consumer who created the share subscription.
consumerName	string	Name of the consumer who created the share subscription.
consumerTenantName	string	Tenant name of the consumer who created the share subscription.
createdAt	string (date-time)	created at.
expirationDate	string (date-time)	Expiration date of the share subscription in UTC format.
providerEmail	string	Email of the provider who created the share.
providerName	string	Name of the provider who created the share.
shareSubscriptionObjectId	string	share Subscription Object Id.
shareSubscriptionStatus	string	Gets the status of share subscription. Known values are: "Active", "Revoked", "SourceDeleted", and "Revoking".
sharedAt	string (date-time)	Shared at.
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.
consumerEmail	string	Email of the consumer who created the share subscription.
consumerName	string	Name of the consumer who created the share subscription.
consumerTenantName	string	Tenant name of the consumer who created the share subscription.
createdAt	string (date-time)	created at.
expirationDate	string (date-time)	Expiration date of the share subscription in UTC format.
providerEmail	string	Email of the provider who created the share.
providerName	string	Name of the provider who created the share.
shareSubscriptionObjectId	string	share Subscription Object Id.
shareSubscriptionStatus	string	Gets the status of share subscription. Known values are: "Active", "Revoked", "SourceDeleted", and "Revoking".
sharedAt	string (date-time)	Shared at.
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	resource_group_name, account_name, share_name, provider_share_subscription_id, subscription_id		Get share subscription in a provider share. Get share subscription in a provider share.
list_by_share	select	resource_group_name, account_name, share_name, subscription_id	$skipToken	List of available share subscriptions to a provider share. List share subscriptions in a provider share.
adjust	exec	resource_group_name, account_name, share_name, provider_share_subscription_id, subscription_id		Adjust the expiration date of a share subscription in a provider share. Adjust a share subscription's expiration date in a provider share.
reinstate	exec	resource_group_name, account_name, share_name, provider_share_subscription_id, subscription_id		Reinstate share subscription in a provider share. Reinstate share subscription in a provider share.
revoke	exec	resource_group_name, account_name, share_name, provider_share_subscription_id, subscription_id		Revoke share subscription in a provider share. 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
account_name	string	The name of the share account. Required.
provider_share_subscription_id	string	To locate shareSubscription. Required.
resource_group_name	string	The resource group name. Required.
share_name	string	The name of the share. Required.
subscription_id	string
$skipToken	string	Continuation Token. Default value is None.

SELECT examples

get_by_share

Get share subscription in a provider share. Get share subscription in a provider share.

SELECT
id,
name,
consumerEmail,
consumerName,
consumerTenantName,
createdAt,
expirationDate,
providerEmail,
providerName,
shareSubscriptionObjectId,
shareSubscriptionStatus,
sharedAt,
systemData,
type
FROM azure.data_share.provider_share_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_name = '{{ share_name }}' -- required
AND provider_share_subscription_id = '{{ provider_share_subscription_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_share

List of available share subscriptions to a provider share. List share subscriptions in a provider share.

SELECT
id,
name,
consumerEmail,
consumerName,
consumerTenantName,
createdAt,
expirationDate,
providerEmail,
providerName,
shareSubscriptionObjectId,
shareSubscriptionStatus,
sharedAt,
systemData,
type
FROM azure.data_share.provider_share_subscriptions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_name = '{{ share_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
;

Lifecycle Methods

adjust

Adjust the expiration date of a share subscription in a provider share. Adjust a share subscription's expiration date in a provider share.

EXEC azure.data_share.provider_share_subscriptions.adjust 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_name='{{ share_name }}' --required, 
@provider_share_subscription_id='{{ provider_share_subscription_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

reinstate

Reinstate share subscription in a provider share. Reinstate share subscription in a provider share.

EXEC azure.data_share.provider_share_subscriptions.reinstate 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_name='{{ share_name }}' --required, 
@provider_share_subscription_id='{{ provider_share_subscription_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

revoke

Revoke share subscription in a provider share. Revoke share subscription in a provider share.

EXEC azure.data_share.provider_share_subscriptions.revoke 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_name='{{ share_name }}' --required, 
@provider_share_subscription_id='{{ provider_share_subscription_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;