az storagesync sync-group

Note

This reference is part of the storagesync extension for Azure CLI and requires version 2.3.1 or higher. The extension will automatically install the first time you run an az storagesync sync-group command. Learn more about extensions.

Manage sync group.

Commands

az storagesync sync-group cloud-endpoint

Manage cloud endpoint.

az storagesync sync-group cloud-endpoint create

Create a new cloud endpoint.

az storagesync sync-group cloud-endpoint delete

Delete a given cloud endpoint.

az storagesync sync-group cloud-endpoint list

List all cloud endpoints in a sync group.

az storagesync sync-group cloud-endpoint show

Show the properties for a given cloud endpoint.

az storagesync sync-group cloud-endpoint wait

Place the CLI in a waiting state until a condition of a cloud endpoint is met.

az storagesync sync-group create

Create a new sync group.

az storagesync sync-group delete

Delete a given sync group.

az storagesync sync-group list

List all sync groups in a storage sync service.

az storagesync sync-group server-endpoint

Manage server endpoint.

az storagesync sync-group server-endpoint create

Create a new server endpoint.

az storagesync sync-group server-endpoint delete

Delete a given server endpoint.

az storagesync sync-group server-endpoint list

List all server endpoints in a sync group.

az storagesync sync-group server-endpoint show

Show the properties for a given server endpoint.

az storagesync sync-group server-endpoint update

Update the properties for a given server endpoint.

az storagesync sync-group server-endpoint wait

Place the CLI in a waiting state until a condition of a server endpoint is met.

az storagesync sync-group show

Show the properties for a given sync group.

az storagesync sync-group create

Create a new sync group.

az storagesync sync-group create --name
                                 --storage-sync-service
                                 [--resource-group]

Examples

Create a new sync group "SampleSyncGroup" in storage sync service "SampleStorageSyncService".

az storagesync sync-group create --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --name "SampleSyncGroup"

Required Parameters

--name -n

The name of sync group.

--storage-sync-service

The name or ID of storage sync service.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az storagesync sync-group delete

Delete a given sync group.

az storagesync sync-group delete --name
                                 --storage-sync-service
                                 [--resource-group]
                                 [--yes]

Examples

Delete sync group "SampleSyncGroup" in storage sync service "SampleStorageSyncService".

az storagesync sync-group delete --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --name "SampleSyncGroup"

Required Parameters

--name -n

The name of sync group.

--storage-sync-service

The name or ID of storage sync service.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

az storagesync sync-group list

List all sync groups in a storage sync service.

az storagesync sync-group list --storage-sync-service
                               [--resource-group]

Examples

List all sync groups in storage sync service "SampleStorageSyncService".

az storagesync sync-group list --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService"

Required Parameters

--storage-sync-service

The name or ID of storage sync service.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

az storagesync sync-group show

Show the properties for a given sync group.

az storagesync sync-group show --name
                               --storage-sync-service
                               [--resource-group]

Examples

Show the properties for sync group "SampleSyncGroup" in storage sync service "SampleStorageSyncService".

az storagesync sync-group show --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --name "SampleSyncGroup"

Required Parameters

--name -n

The name of sync group.

--storage-sync-service

The name or ID of storage sync service.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.