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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
syncGroupStatus	string	Sync group status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueId	string	Unique Id.

list_by_storage_sync_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
syncGroupStatus	string	Sync group status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uniqueId	string	Unique Id.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, storage_sync_service_name, sync_group_name, subscription_id		Get a given SyncGroup.
list_by_storage_sync_service	select	resource_group_name, storage_sync_service_name, subscription_id		Get a SyncGroup List.
create	insert	resource_group_name, storage_sync_service_name, sync_group_name, subscription_id		Create a new SyncGroup.
delete	delete	resource_group_name, storage_sync_service_name, sync_group_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
storage_sync_service_name	string	Name of Storage Sync Service resource. Required.
subscription_id	string
sync_group_name	string	Name of Sync Group resource. Required.

SELECT examples

get

Get a given SyncGroup.

SELECT
id,
name,
syncGroupStatus,
systemData,
type,
uniqueId
FROM azure.storage_sync.sync_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND sync_group_name = '{{ sync_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_storage_sync_service

Get a SyncGroup List.

SELECT
id,
name,
syncGroupStatus,
systemData,
type,
uniqueId
FROM azure.storage_sync.sync_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a new SyncGroup.

INSERT INTO azure.storage_sync.sync_groups (
properties,
resource_group_name,
storage_sync_service_name,
sync_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ storage_sync_service_name }}',
'{{ sync_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sync_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sync_groups resource.
  - name: storage_sync_service_name
    value: "{{ storage_sync_service_name }}"
    description: Required parameter for the sync_groups resource.
  - name: sync_group_name
    value: "{{ sync_group_name }}"
    description: Required parameter for the sync_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sync_groups resource.
  - name: properties
    value: "{{ properties }}"
    description: |
      The parameters used to create the sync group.

DELETE examples

delete

Delete a given SyncGroup.

DELETE FROM azure.storage_sync.sync_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND storage_sync_service_name = '{{ storage_sync_service_name }}' --required
AND sync_group_name = '{{ sync_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;