consumer_invitations

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

Overview

Name	consumer_invitations
Type	Resource
Id	azure.data_share.consumer_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.
dataSetCount	integer	Number of data sets in a share.
description	string	Description shared when the invitation was created.
expirationDate	string (date-time)	The expiration date for the share subscription created by accepting the invitation.
invitationId	string	Unique id of the invitation. Required.
invitationStatus	string	The status of the invitation. Known values are: "Pending", "Accepted", "Rejected", and "Withdrawn".
location	string	invitation location.
providerEmail	string	Email of the provider who created the resource.
providerName	string	Name of the provider who created the resource.
providerTenantName	string	Tenant name of the provider who created the resource.
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.
shareName	string	Gets the source share Name.
systemData	object	System Data of the Azure resource.
termsOfUse	string	Terms of use shared when the invitation was created.
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_invitations

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
dataSetCount	integer	Number of data sets in a share.
description	string	Description shared when the invitation was created.
expirationDate	string (date-time)	The expiration date for the share subscription created by accepting the invitation.
invitationId	string	Unique id of the invitation. Required.
invitationStatus	string	The status of the invitation. Known values are: "Pending", "Accepted", "Rejected", and "Withdrawn".
location	string	invitation location.
providerEmail	string	Email of the provider who created the resource.
providerName	string	Name of the provider who created the resource.
providerTenantName	string	Tenant name of the provider who created the resource.
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.
shareName	string	Gets the source share Name.
systemData	object	System Data of the Azure resource.
termsOfUse	string	Terms of use shared when the invitation was created.
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	location, invitation_id		Gets the invitation identified by invitationId. Get an invitation.
list_invitations	select		$skipToken	List the invitations. Lists invitations.
reject_invitation	exec	location, properties		Rejects the invitation identified by invitationId. Reject an invitation.

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
invitation_id	string	An invitation id. Required.
location	string	Location of the invitation. Required.
$skipToken	string	The continuation token. Default value is None.

SELECT examples

get

Gets the invitation identified by invitationId. Get an invitation.

SELECT
id,
name,
dataSetCount,
description,
expirationDate,
invitationId,
invitationStatus,
location,
providerEmail,
providerName,
providerTenantName,
respondedAt,
sentAt,
shareName,
systemData,
termsOfUse,
type,
userEmail,
userName
FROM azure.data_share.consumer_invitations
WHERE location = '{{ location }}' -- required
AND invitation_id = '{{ invitation_id }}' -- required
;

list_invitations

List the invitations. Lists invitations.

SELECT
id,
name,
dataSetCount,
description,
expirationDate,
invitationId,
invitationStatus,
location,
providerEmail,
providerName,
providerTenantName,
respondedAt,
sentAt,
shareName,
systemData,
termsOfUse,
type,
userEmail,
userName
FROM azure.data_share.consumer_invitations
WHERE $skipToken = '{{ $skipToken }}'
;

Lifecycle Methods

reject_invitation

Rejects the invitation identified by invitationId. Reject an invitation.

EXEC azure.data_share.consumer_invitations.reject_invitation 
@location='{{ location }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;