sync_groups

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

Overview

Name	sync_groups
Type	Resource
Id	azure.storage_sync.sync_groups

Fields

The following fields are returned by SELECT queries:

get

Sync Group object

Name	Datatype	Description
properties	object	SyncGroup properties.

list_by_storage_sync_service

Array of Sync Group resources in Storage Sync Service

Name	Datatype	Description
properties	object	SyncGroup properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName		Get a given SyncGroup.
list_by_storage_sync_service	select	subscriptionId, resourceGroupName, storageSyncServiceName		Get a SyncGroup List.
create	insert	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName		Create a new SyncGroup.
delete	delete	subscriptionId, resourceGroupName, storageSyncServiceName, syncGroupName		Delete a given SyncGroup.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
storageSyncServiceName	string	Name of Storage Sync Service resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
syncGroupName	string	Name of Sync Group resource.

SELECT examples

get

Get a given SyncGroup.

SELECT
properties
FROM azure.storage_sync.sync_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' -- required
AND syncGroupName = '{{ syncGroupName }}' -- required
;

list_by_storage_sync_service

Get a SyncGroup List.

SELECT
properties
FROM azure.storage_sync.sync_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' -- required
;

INSERT examples

create

Create a new SyncGroup.

INSERT INTO azure.storage_sync.sync_groups (
data__properties,
subscriptionId,
resourceGroupName,
storageSyncServiceName,
syncGroupName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ storageSyncServiceName }}',
'{{ syncGroupName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sync_groups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the sync_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sync_groups resource.
    - name: storageSyncServiceName
      value: string
      description: Required parameter for the sync_groups resource.
    - name: syncGroupName
      value: string
      description: Required parameter for the sync_groups resource.
    - name: properties
      value: object
      description: |
        The parameters used to create the sync group

DELETE examples

delete

Delete a given SyncGroup.

DELETE FROM azure.storage_sync.sync_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND storageSyncServiceName = '{{ storageSyncServiceName }}' --required
AND syncGroupName = '{{ syncGroupName }}' --required
;