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
properties	object	Properties on the account
systemData	object	System Data of the Azure resource.
type	string	Type of the azure resource

list_invitations

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Properties on the account
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	select	location, invitationId	api-version	Get an invitation
list_invitations	select		api-version, $skipToken	Lists invitations
reject_invitation	exec	location, properties	api-version	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
invitationId	string	An invitation id
location	string	Location of the invitation
$skipToken	string	The continuation token
api-version	string	The api version to use.

SELECT examples

get

Get an invitation

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_share.consumer_invitations
WHERE location = '{{ location }}' -- required
AND invitationId = '{{ invitationId }}' -- required
AND api-version = '{{ api-version }}'
;

list_invitations

Lists invitations

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_share.consumer_invitations
WHERE api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
;

Lifecycle Methods

reject_invitation

Reject an invitation

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