shares

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

Overview

Name	shares
Type	Resource
Id	azure.data_share.shares

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.
createdAt	string (date-time)	Time at which the share was created.
description	string	Share description.
provisioningState	string	Gets or sets the provisioning state. Known values are: "Succeeded", "Creating", "Deleting", "Moving", and "Failed".
shareKind	string	Share kind. Known values are: "CopyBased" and "InPlace".
systemData	object	System Data of the Azure resource.
terms	string	Share terms.
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_by_account

Name	Datatype	Description
id	string	The resource id of the azure resource.
name	string	Name of the azure resource.
createdAt	string (date-time)	Time at which the share was created.
description	string	Share description.
provisioningState	string	Gets or sets the provisioning state. Known values are: "Succeeded", "Creating", "Deleting", "Moving", and "Failed".
shareKind	string	Share kind. Known values are: "CopyBased" and "InPlace".
systemData	object	System Data of the Azure resource.
terms	string	Share terms.
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	resource_group_name, account_name, share_name, subscription_id		Get a specified share. Get a share.
list_by_account	select	resource_group_name, account_name, subscription_id	$skipToken, $filter, $orderby	List of available shares under an account. List shares in an account.
create	insert	resource_group_name, account_name, share_name, subscription_id		Create a share in the given account. Create a share.
delete	delete	resource_group_name, account_name, share_name, subscription_id		Deletes a share. Delete a share.
list_synchronization_details	exec	resource_group_name, account_name, share_name, subscription_id	$skipToken, $filter, $orderby	List data set level details for a share synchronization. List synchronization details.
list_synchronizations	exec	resource_group_name, account_name, share_name, subscription_id	$skipToken, $filter, $orderby	List Synchronizations in a share. List synchronizations of 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
account_name	string	The name of the share account. Required.
resource_group_name	string	The resource group name. Required.
share_name	string	The name of the share. Required.
subscription_id	string
$filter	string	Filters the results using OData syntax. Default value is None.
$orderby	string	Sorts the results using OData syntax. Default value is None.
$skipToken	string	Continuation token. Default value is None.

SELECT examples

get

Get a specified share. Get a share.

SELECT
id,
name,
createdAt,
description,
provisioningState,
shareKind,
systemData,
terms,
type,
userEmail,
userName
FROM azure.data_share.shares
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_name = '{{ share_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_account

List of available shares under an account. List shares in an account.

SELECT
id,
name,
createdAt,
description,
provisioningState,
shareKind,
systemData,
terms,
type,
userEmail,
userName
FROM azure.data_share.shares
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
;

INSERT examples

create

Create a share in the given account. Create a share.

INSERT INTO azure.data_share.shares (
properties,
resource_group_name,
account_name,
share_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ share_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: shares
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the shares resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the shares resource.
  - name: share_name
    value: "{{ share_name }}"
    description: Required parameter for the shares resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the shares resource.
  - name: properties
    value:
      description: "{{ description }}"
      shareKind: "{{ shareKind }}"
      terms: "{{ terms }}"

DELETE examples

delete

Deletes a share. Delete a share.

DELETE FROM azure.data_share.shares
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND share_name = '{{ share_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_synchronization_details

List data set level details for a share synchronization. List synchronization details.

EXEC azure.data_share.shares.list_synchronization_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_name='{{ share_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$skipToken='{{ $skipToken }}', 
@$filter='{{ $filter }}', 
@$orderby='{{ $orderby }}' 
@@json=
'{
"consumerEmail": "{{ consumerEmail }}", 
"consumerName": "{{ consumerName }}", 
"consumerTenantName": "{{ consumerTenantName }}", 
"durationMs": {{ durationMs }}, 
"endTime": "{{ endTime }}", 
"message": "{{ message }}", 
"startTime": "{{ startTime }}", 
"status": "{{ status }}", 
"synchronizationId": "{{ synchronizationId }}"
}'
;

list_synchronizations

List Synchronizations in a share. List synchronizations of a share.

EXEC azure.data_share.shares.list_synchronizations 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@share_name='{{ share_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@$skipToken='{{ $skipToken }}', 
@$filter='{{ $filter }}', 
@$orderby='{{ $orderby }}'
;