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

list_by_share

Name	Datatype	Description
id	string	The resource id of the azure resource
name	string	Name of the azure resource
properties	object	Properties on the Invitation
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	subscriptionId, resourceGroupName, accountName, shareName, invitationName	api-version	Get an invitation in a share
list_by_share	select	subscriptionId, resourceGroupName, accountName, shareName	api-version, $skipToken, $filter, $orderby	List invitations in a share
create	insert	subscriptionId, resourceGroupName, accountName, shareName, invitationName	api-version	Create an invitation
delete	delete	subscriptionId, resourceGroupName, accountName, shareName, invitationName	api-version	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
accountName	string	The name of the share account.
invitationName	string	The name of the invitation.
resourceGroupName	string	The resource group name.
shareName	string	The name of the share.
subscriptionId	string	The subscription identifier
$filter	string	Filters the results using OData syntax.
$orderby	string	Sorts the results using OData syntax.
$skipToken	string	The continuation token
api-version	string	The api version to use.

SELECT examples

get

Get an invitation in a share

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

list_by_share

List invitations in a share

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_share.invitations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND shareName = '{{ shareName }}' -- required
AND api-version = '{{ api-version }}'
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create an invitation

INSERT INTO azure.data_share.invitations (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
shareName,
invitationName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ shareName }}',
'{{ invitationName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: invitations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the invitations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the invitations resource.
    - name: accountName
      value: string
      description: Required parameter for the invitations resource.
    - name: shareName
      value: string
      description: Required parameter for the invitations resource.
    - name: invitationName
      value: string
      description: Required parameter for the invitations resource.
    - name: properties
      value: object
      description: |
        Properties on the Invitation
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Delete an invitation in a share

DELETE FROM azure.data_share.invitations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND shareName = '{{ shareName }}' --required
AND invitationName = '{{ invitationName }}' --required
AND api-version = '{{ api-version }}'
;