invitations

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

Overview

Name	invitations
Type	Resource
Id	azure.data_share.invitations

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.
expirationDate	string (date-time)	The expiration date for the invitation and share subscription.
invitationId	string	unique invitation id.
invitationStatus	string	The status of the invitation. Known values are: "Pending", "Accepted", "Rejected", and "Withdrawn".
respondedAt	string (date-time)	The time the recipient responded to the invitation.
sentAt	string (date-time)	Gets the time at which the invitation was sent.
systemData	object	System Data of the Azure resource.
targetActiveDirectoryId	string	The target Azure AD Id. Can't be combined with email.
targetEmail	string	The email the invitation is directed to.
targetObjectId	string	The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.
type	string	Type of the azure resource.
userEmail	string	Email of the user who created the resource.
userName	string	Name of the user who created the resource.

list_by_share

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
expirationDate	string (date-time)	The expiration date for the invitation and share subscription.
invitationId	string	unique invitation id.
invitationStatus	string	The status of the invitation. Known values are: "Pending", "Accepted", "Rejected", and "Withdrawn".
respondedAt	string (date-time)	The time the recipient responded to the invitation.
sentAt	string (date-time)	Gets the time at which the invitation was sent.
systemData	object	System Data of the Azure resource.
targetActiveDirectoryId	string	The target Azure AD Id. Can't be combined with email.
targetEmail	string	The email the invitation is directed to.
targetObjectId	string	The target user or application Id that invitation is being sent to. Must be specified along TargetActiveDirectoryId. This enables sending invitations to specific users or applications in an AD tenant.
type	string	Type of the azure resource.
userEmail	string	Email of the user who created the resource.
userName	string	Name of the user who created the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, share_name, invitation_name, subscription_id		Get Invitation in a share. Get an invitation in a share.
list_by_share	select	resource_group_name, account_name, share_name, subscription_id	$skipToken, $filter, $orderby	List all Invitations in a share. List invitations in a share.
create	insert	resource_group_name, account_name, share_name, invitation_name, subscription_id		Sends a new invitation to a recipient to access a share. Create an invitation.
delete	delete	resource_group_name, account_name, share_name, invitation_name, subscription_id		Delete Invitation in a share. Delete an invitation in a 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.
invitation_name	string	The name of the invitation. Required.
resource_group_name	string	The resource group name. Required.
share_name	string	The name of the share. Required.
subscription_id	string
$filter	string	Filters the results using OData syntax. Default value is None.
$orderby	string	Sorts the results using OData syntax. Default value is None.
$skipToken	string	The continuation token. Default value is None.

SELECT examples

get

Get Invitation in a share. Get an invitation in a share.

SELECT
id,
name,
expirationDate,
invitationId,
invitationStatus,
respondedAt,
sentAt,
systemData,
targetActiveDirectoryId,
targetEmail,
targetObjectId,
type,
userEmail,
userName
FROM azure.data_share.invitations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_name = '{{ share_name }}' -- required
AND invitation_name = '{{ invitation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_share

List all Invitations in a share. List invitations in a share.

SELECT
id,
name,
expirationDate,
invitationId,
invitationStatus,
respondedAt,
sentAt,
systemData,
targetActiveDirectoryId,
targetEmail,
targetObjectId,
type,
userEmail,
userName
FROM azure.data_share.invitations
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 }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Sends a new invitation to a recipient to access a share. Create an invitation.

INSERT INTO azure.data_share.invitations (
properties,
resource_group_name,
account_name,
share_name,
invitation_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ share_name }}',
'{{ invitation_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: invitations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the invitations resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the invitations resource.
  - name: share_name
    value: "{{ share_name }}"
    description: Required parameter for the invitations resource.
  - name: invitation_name
    value: "{{ invitation_name }}"
    description: Required parameter for the invitations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the invitations resource.
  - name: properties
    value:
      expirationDate: "{{ expirationDate }}"
      targetActiveDirectoryId: "{{ targetActiveDirectoryId }}"
      targetEmail: "{{ targetEmail }}"
      targetObjectId: "{{ targetObjectId }}"

DELETE examples

delete

Delete Invitation in a share. Delete an invitation in a share.

DELETE FROM azure.data_share.invitations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND share_name = '{{ share_name }}' --required
AND invitation_name = '{{ invitation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;