sent_shares

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

Overview

Name	sent_shares
Type	Resource
Id	azure.purview_sharing.sent_shares

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_or_replace	insert	sent_share_id, endpoint		Create or replace a sent share. Create or replace a sent share.
create_or_replace	replace	sent_share_id, endpoint		Create or replace a sent share. Create or replace a sent share.
delete	delete	sent_share_id, endpoint		Deletes a sent share. Delete a sent share.
get_raw	exec	sent_share_id, endpoint		Get a sent share by guid. Get a sent share.
list_raw	exec	referenceName, endpoint	filter, orderby	Get a list of sent shares. List sent shares.
list_invitations	exec	sent_share_id, endpoint	filter, orderby	List all sent share invitations in a sent share. List sent share recipients.
get_invitation	exec	sent_share_id, sent_share_invitation_id, endpoint		Get sent share invitation for a given sent share. Get recipient for a given sent share.
create_invitation	exec	sent_share_id, sent_share_invitation_id, endpoint		Create a sent share invitation. Create a recipient for a given sent share.
delete_invitation	exec	sent_share_id, sent_share_invitation_id, endpoint		Delete Invitation in a share. Delete a sent share invitation.
notify_user_invitation	exec	sent_share_id, sent_share_invitation_id, endpoint	repeatability-request-id	Notifies the recipient of the sent share invitation. Notifies the user recipient of the sent share invitation, does not apply to service invitations.

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
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
referenceName	string	A name that references a data store. Required.
sent_share_id	string	Id of the sent share. Required.
sent_share_invitation_id	string	Id of the sent share invitation. Required.
filter	string	Filters the results using OData syntax. Default value is None.
orderby	string	Sorts the results using OData syntax. Default value is None.
repeatability-request-id	string	If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. Default value is None.

INSERT examples

create_or_replace

Create or replace a sent share. Create or replace a sent share.

INSERT INTO azure.purview_sharing.sent_shares (
sent_share_id,
endpoint
)
SELECT 
'{{ sent_share_id }}',
'{{ endpoint }}'
;

Manifest

# Description fields are for documentation purposes
- name: sent_shares
props:
  - name: sent_share_id
    value: "{{ sent_share_id }}"
    description: Required parameter for the sent_shares resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the sent_shares resource.

REPLACE examples

create_or_replace

Create or replace a sent share. Create or replace a sent share.

REPLACE azure.purview_sharing.sent_shares
SET 
-- No updatable properties
WHERE 
sent_share_id = '{{ sent_share_id }}' --required
AND endpoint = '{{ endpoint }}' --required;

DELETE examples

delete

Deletes a sent share. Delete a sent share.

DELETE FROM azure.purview_sharing.sent_shares
WHERE sent_share_id = '{{ sent_share_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Get a sent share by guid. Get a sent share.

EXEC azure.purview_sharing.sent_shares.get_raw 
@sent_share_id='{{ sent_share_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_raw

Get a list of sent shares. List sent shares.

EXEC azure.purview_sharing.sent_shares.list_raw 
@referenceName='{{ referenceName }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@orderby='{{ orderby }}'
;

list_invitations

List all sent share invitations in a sent share. List sent share recipients.

EXEC azure.purview_sharing.sent_shares.list_invitations 
@sent_share_id='{{ sent_share_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@orderby='{{ orderby }}'
;

get_invitation

Get sent share invitation for a given sent share. Get recipient for a given sent share.

EXEC azure.purview_sharing.sent_shares.get_invitation 
@sent_share_id='{{ sent_share_id }}' --required, 
@sent_share_invitation_id='{{ sent_share_invitation_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

create_invitation

Create a sent share invitation. Create a recipient for a given sent share.

EXEC azure.purview_sharing.sent_shares.create_invitation 
@sent_share_id='{{ sent_share_id }}' --required, 
@sent_share_invitation_id='{{ sent_share_invitation_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

delete_invitation

Delete Invitation in a share. Delete a sent share invitation.

EXEC azure.purview_sharing.sent_shares.delete_invitation 
@sent_share_id='{{ sent_share_id }}' --required, 
@sent_share_invitation_id='{{ sent_share_invitation_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

notify_user_invitation

Notifies the recipient of the sent share invitation. Notifies the user recipient of the sent share invitation, does not apply to service invitations.

EXEC azure.purview_sharing.sent_shares.notify_user_invitation 
@sent_share_id='{{ sent_share_id }}' --required, 
@sent_share_invitation_id='{{ sent_share_invitation_id }}' --required, 
@endpoint='{{ endpoint }}' --required, 
@repeatability-request-id='{{ repeatability-request-id }}'
;