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. Required. "ScheduleBased"
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. Required. "ScheduleBased"
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	resource_group_name, account_name, share_name, synchronization_setting_name, subscription_id		Get synchronizationSetting in a share. Get a synchronizationSetting in a share.
list_by_share	select	resource_group_name, account_name, share_name, subscription_id	$skipToken	List synchronizationSettings in a share. List synchronizationSettings in a share.
create	insert	resource_group_name, account_name, share_name, synchronization_setting_name, subscription_id, kind		Adds a new synchronization setting to an existing share. Create a synchronizationSetting.
delete	delete	resource_group_name, account_name, share_name, synchronization_setting_name, subscription_id		Delete synchronizationSetting in a share. 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
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
synchronization_setting_name	string	The name of the synchronizationSetting . Required.
$skipToken	string	continuation token. Default value is None.

SELECT examples

get

Get synchronizationSetting in a share. Get a synchronizationSetting in a share.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.synchronization_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND share_name = '{{ share_name }}' -- required
AND synchronization_setting_name = '{{ synchronization_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_share

List synchronizationSettings in a share. List synchronizationSettings in a share.

SELECT
id,
name,
kind,
systemData,
type
FROM azure.data_share.synchronization_settings
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
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create

Adds a new synchronization setting to an existing share. Create a synchronizationSetting.

INSERT INTO azure.data_share.synchronization_settings (
kind,
resource_group_name,
account_name,
share_name,
synchronization_setting_name,
subscription_id
)
SELECT 
'{{ kind }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ share_name }}',
'{{ synchronization_setting_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: synchronization_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the synchronization_settings resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the synchronization_settings resource.
  - name: share_name
    value: "{{ share_name }}"
    description: Required parameter for the synchronization_settings resource.
  - name: synchronization_setting_name
    value: "{{ synchronization_setting_name }}"
    description: Required parameter for the synchronization_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the synchronization_settings resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Kind of synchronization setting. Required. "ScheduleBased"

DELETE examples

delete

Delete synchronizationSetting in a share. Delete a synchronizationSetting in a share.

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