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

vw_share_subscriptions

Name	Datatype	Description
id	text	The resource id of the azure resource
name	text	Name of the azure resource
accountName	text	field from the properties object
created_at	text	field from the properties object
expiration_date	text	field from the properties object
invitation_id	text	field from the properties object
provider_email	text	field from the properties object
provider_name	text	field from the properties object
provider_tenant_name	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
shareSubscriptionName	text	field from the properties object
share_description	text	field from the properties object
share_kind	text	field from the properties object
share_name	text	field from the properties object
share_subscription_status	text	field from the properties object
share_terms	text	field from the properties object
source_share_location	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	Type of the azure resource
user_email	text	field from the properties object
user_name	text	field from the properties object

share_subscriptions

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Share subscription property bag.
systemData	object	Metadata pertaining to creation and last modification of the resource.
type	string	Type of the azure resource

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, resourceGroupName, shareSubscriptionName, subscriptionId	Get a shareSubscription in an account
list_by_account	SELECT	accountName, resourceGroupName, subscriptionId	List share subscriptions in an account
create	INSERT	accountName, resourceGroupName, shareSubscriptionName, subscriptionId, data__properties	Create a shareSubscription in an account
delete	DELETE	accountName, resourceGroupName, shareSubscriptionName, subscriptionId	Delete a shareSubscription in an account
cancel_synchronization	EXEC	accountName, resourceGroupName, shareSubscriptionName, subscriptionId, data__synchronizationId	Request to cancel a synchronization.
synchronize	EXEC	accountName, resourceGroupName, shareSubscriptionName, subscriptionId	Initiate a copy

SELECT examples

List share subscriptions in an account

vw_share_subscriptions

SELECT
id,
name,
accountName,
created_at,
expiration_date,
invitation_id,
provider_email,
provider_name,
provider_tenant_name,
provisioning_state,
resourceGroupName,
shareSubscriptionName,
share_description,
share_kind,
share_name,
share_subscription_status,
share_terms,
source_share_location,
subscriptionId,
system_data,
type,
user_email,
user_name
FROM azure.data_share.vw_share_subscriptions
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

share_subscriptions

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

INSERT example

Use the following StackQL query and manifest file to create a new share_subscriptions resource.

All Properties

/*+ create */
INSERT INTO azure.data_share.share_subscriptions (
accountName,
resourceGroupName,
shareSubscriptionName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ accountName }}',
'{{ resourceGroupName }}',
'{{ shareSubscriptionName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: systemData
      value:
        - name: createdAt
          value: string
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: lastModifiedAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: createdAt
          value: string
        - name: expirationDate
          value: string
        - name: invitationId
          value: string
        - name: providerEmail
          value: string
        - name: providerName
          value: string
        - name: providerTenantName
          value: string
        - name: provisioningState
          value: string
        - name: shareDescription
          value: string
        - name: shareKind
          value: string
        - name: shareName
          value: string
        - name: shareSubscriptionStatus
          value: string
        - name: shareTerms
          value: string
        - name: sourceShareLocation
          value: string
        - name: userEmail
          value: string
        - name: userName
          value: string

DELETE example

Deletes the specified share_subscriptions resource.

/*+ delete */
DELETE FROM azure.data_share.share_subscriptions
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND shareSubscriptionName = '{{ shareSubscriptionName }}'
AND subscriptionId = '{{ subscriptionId }}';