invitations

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

Overview

Name	invitations
Type	Resource
Id	azure.data_share.invitations

Fields

vw_invitations

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
expiration_date	text	field from the properties object
invitationName	text	field from the properties object
invitation_id	text	field from the properties object
invitation_status	text	field from the properties object
resourceGroupName	text	field from the properties object
responded_at	text	field from the properties object
sent_at	text	field from the properties object
shareName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
target_active_directory_id	text	field from the properties object
target_email	text	field from the properties object
target_object_id	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

invitations

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Invitation 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, invitationName, resourceGroupName, shareName, subscriptionId	Get an invitation in a share
list_by_share	SELECT	accountName, resourceGroupName, shareName, subscriptionId	List invitations in a share
create	INSERT	accountName, invitationName, resourceGroupName, shareName, subscriptionId	Create an invitation
delete	DELETE	accountName, invitationName, resourceGroupName, shareName, subscriptionId	Delete an invitation in a share

SELECT examples

List invitations in a share

vw_invitations

SELECT
id,
name,
accountName,
expiration_date,
invitationName,
invitation_id,
invitation_status,
resourceGroupName,
responded_at,
sent_at,
shareName,
subscriptionId,
system_data,
target_active_directory_id,
target_email,
target_object_id,
type,
user_email,
user_name
FROM azure.data_share.vw_invitations
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND shareName = '{{ shareName }}'
AND subscriptionId = '{{ subscriptionId }}';

invitations

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.data_share.invitations (
accountName,
invitationName,
resourceGroupName,
shareName,
subscriptionId,
properties
)
SELECT 
'{{ accountName }}',
'{{ invitationName }}',
'{{ resourceGroupName }}',
'{{ shareName }}',
'{{ subscriptionId }}',
'{{ 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: expirationDate
          value: string
        - name: invitationId
          value: string
        - name: invitationStatus
          value: string
        - name: respondedAt
          value: string
        - name: sentAt
          value: string
        - name: targetActiveDirectoryId
          value: string
        - name: targetEmail
          value: string
        - name: targetObjectId
          value: string
        - name: userEmail
          value: string
        - name: userName
          value: string

DELETE example

Deletes the specified invitations resource.

/*+ delete */
DELETE FROM azure.data_share.invitations
WHERE accountName = '{{ accountName }}'
AND invitationName = '{{ invitationName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND shareName = '{{ shareName }}'
AND subscriptionId = '{{ subscriptionId }}';