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

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	Metadata pertaining to creation and last modification of the resource.
type	string	Type of the azure resource

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, resourceGroupName, shareName, subscriptionId, synchronizationSettingName	Get a synchronizationSetting in a share
list_by_share	SELECT	accountName, resourceGroupName, shareName, subscriptionId	List synchronizationSettings in a share
create	INSERT	accountName, resourceGroupName, shareName, subscriptionId, synchronizationSettingName, data__kind	Create a synchronizationSetting
delete	DELETE	accountName, resourceGroupName, shareName, subscriptionId, synchronizationSettingName	Delete a synchronizationSetting in a share

SELECT examples

List synchronizationSettings in a share

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

INSERT example

Use the following StackQL query and manifest file to create a new synchronization_settings resource.

All Properties

/*+ create */
INSERT INTO azure.data_share.synchronization_settings (
accountName,
resourceGroupName,
shareName,
subscriptionId,
synchronizationSettingName,
data__kind,
kind
)
SELECT 
'{{ accountName }}',
'{{ resourceGroupName }}',
'{{ shareName }}',
'{{ subscriptionId }}',
'{{ synchronizationSettingName }}',
'{{ data__kind }}',
'{{ kind }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: systemData
      value:
        - name: createdAt
          value: string
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: lastModifiedAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
    - name: type
      value: string
    - name: kind
      value: string

DELETE example

Deletes the specified synchronization_settings resource.

/*+ delete */
DELETE FROM azure.data_share.synchronization_settings
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND shareName = '{{ shareName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND synchronizationSettingName = '{{ synchronizationSettingName }}';