synchronization_settings

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

Overview

Name	synchronization_settings
Type	Resource
Id	azure.data_share.synchronization_settings

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
kind	string	Kind of synchronization setting.
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
kind	string	Kind of synchronization setting.
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, synchronizationSettingName	api-version	Get a synchronizationSetting in a share
list_by_share	select	subscriptionId, resourceGroupName, accountName, shareName	api-version, $skipToken	List synchronizationSettings in a share
create	insert	subscriptionId, resourceGroupName, accountName, shareName, synchronizationSettingName, data__kind	api-version	Create a synchronizationSetting
delete	delete	subscriptionId, resourceGroupName, accountName, shareName, synchronizationSettingName	api-version	Delete a synchronizationSetting 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.
resourceGroupName	string	The resource group name.
shareName	string	The name of the share.
subscriptionId	string	The subscription identifier
synchronizationSettingName	string	The name of the synchronizationSetting .
$skipToken	string	continuation token
api-version	string	The api version to use.

SELECT examples

get

Get a synchronizationSetting in a share

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

list_by_share

List synchronizationSettings in a share

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

INSERT examples

create

Create a synchronizationSetting

INSERT INTO azure.data_share.synchronization_settings (
data__kind,
subscriptionId,
resourceGroupName,
accountName,
shareName,
synchronizationSettingName,
api-version
)
SELECT 
'{{ kind }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ shareName }}',
'{{ synchronizationSettingName }}',
'{{ api-version }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: synchronization_settings
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the synchronization_settings resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the synchronization_settings resource.
    - name: accountName
      value: string
      description: Required parameter for the synchronization_settings resource.
    - name: shareName
      value: string
      description: Required parameter for the synchronization_settings resource.
    - name: synchronizationSettingName
      value: string
      description: Required parameter for the synchronization_settings resource.
    - name: kind
      value: string
      description: |
        Kind of synchronization setting.
      valid_values: ['ScheduleBased']
    - name: api-version
      value: string
      description: The api version to use.

DELETE examples

delete

Delete a synchronizationSetting in a share

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