shares_synchronizations

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

Overview

Name	shares_synchronizations
Type	Resource
Id	azure.data_share.shares_synchronizations

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
consumerEmail	string	Email of the user who created the synchronization
consumerName	string	Name of the user who created the synchronization
consumerTenantName	string	Tenant name of the consumer who created the synchronization
durationMs	integer (int32)	synchronization duration
endTime	string (date-time)	End time of synchronization
message	string	message of synchronization
startTime	string (date-time)	start time of synchronization
status	string	Raw Status
synchronizationId	string	Synchronization id
synchronizationMode	string	Synchronization mode

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	subscriptionId, resourceGroupName, accountName, shareName	api-version, $skipToken, $filter, $orderby	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
accountName	string	The name of the share account.
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	Continuation token
api-version	string	The api version to use.

SELECT examples

list

List synchronizations of a share

SELECT
consumerEmail,
consumerName,
consumerTenantName,
durationMs,
endTime,
message,
startTime,
status,
synchronizationId,
synchronizationMode
FROM azure.data_share.shares_synchronizations
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 }}'
;