received_shares

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

Overview

Name	received_shares
Type	Resource
Id	azure.purview_sharing.received_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	received_share_id, endpoint		Create or replace a received share. Update changes to a received share.
create_or_replace	replace	received_share_id, endpoint		Create or replace a received share. Update changes to a received share.
delete	delete	received_share_id, endpoint		Deletes a received share. Delete a received share.
get_raw	exec	received_share_id, endpoint		Get a received share by unique id. Get a received share.
list_attached	exec	referenceName, endpoint	filter, orderby	Get a list of attached received shares. List attached received shares.
list_detached	exec	endpoint	filter, orderby	Get a list of detached received shares. List detached received shares.
activate_tenant_email_registration	exec	endpoint	repeatability-request-id	Activates the tenant and email combination using the activation code received. Activates the email registration for current tenant.
register_tenant_email_registration	exec	endpoint	repeatability-request-id	Registers the tenant and email combination for activation. Register an email for the current tenant.

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: )
received_share_id	string	Id of the received share. Required.
referenceName	string	A name that references a data store. 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 received share. Update changes to a received share.

INSERT INTO azure.purview_sharing.received_shares (
received_share_id,
endpoint
)
SELECT 
'{{ received_share_id }}',
'{{ endpoint }}'
;

Manifest

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

REPLACE examples

create_or_replace

Create or replace a received share. Update changes to a received share.

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

DELETE examples

delete

Deletes a received share. Delete a received share.

DELETE FROM azure.purview_sharing.received_shares
WHERE received_share_id = '{{ received_share_id }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

get_raw

Get a received share by unique id. Get a received share.

EXEC azure.purview_sharing.received_shares.get_raw 
@received_share_id='{{ received_share_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

list_attached

Get a list of attached received shares. List attached received shares.

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

list_detached

Get a list of detached received shares. List detached received shares.

EXEC azure.purview_sharing.received_shares.list_detached 
@endpoint='{{ endpoint }}' --required, 
@filter='{{ filter }}', 
@orderby='{{ orderby }}'
;

activate_tenant_email_registration

Activates the tenant and email combination using the activation code received. Activates the email registration for current tenant.

EXEC azure.purview_sharing.received_shares.activate_tenant_email_registration 
@endpoint='{{ endpoint }}' --required, 
@repeatability-request-id='{{ repeatability-request-id }}'
;

register_tenant_email_registration

Registers the tenant and email combination for activation. Register an email for the current tenant.

EXEC azure.purview_sharing.received_shares.register_tenant_email_registration 
@endpoint='{{ endpoint }}' --required, 
@repeatability-request-id='{{ repeatability-request-id }}'
;