az storagesync sync-group

Reference

Note

This reference is part of the storagesync extension for the Azure CLI (version 2.55.0 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

Name	Description	Type	Status
az storagesync sync-group cloud-endpoint	Manage cloud endpoint.	Extension	GA
az storagesync sync-group cloud-endpoint create	Create a new cloud endpoint.	Extension	GA
az storagesync sync-group cloud-endpoint delete	Delete a given cloud endpoint.	Extension	GA
az storagesync sync-group cloud-endpoint list	List all cloud endpoints in a sync group.	Extension	GA
az storagesync sync-group cloud-endpoint show	Show the properties for a given cloud endpoint.	Extension	GA
az storagesync sync-group cloud-endpoint trigger-change-detection	Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.	Extension	GA
az storagesync sync-group cloud-endpoint wait	Place the CLI in a waiting state until a condition of a cloud endpoint is met.	Extension	GA
az storagesync sync-group create	Create a new sync group.	Extension	GA
az storagesync sync-group delete	Delete a given sync group.	Extension	GA
az storagesync sync-group list	List all sync groups in a storage sync service.	Extension	GA
az storagesync sync-group server-endpoint	Manage server endpoint.	Extension	GA
az storagesync sync-group server-endpoint create	Create a new server endpoint.	Extension	GA
az storagesync sync-group server-endpoint delete	Delete a given server endpoint.	Extension	GA
az storagesync sync-group server-endpoint list	List all server endpoints in a sync group.	Extension	GA
az storagesync sync-group server-endpoint show	Show the properties for a given server endpoint.	Extension	GA
az storagesync sync-group server-endpoint update	Update the properties for a given server endpoint.	Extension	GA
az storagesync sync-group server-endpoint wait	Place the CLI in a waiting state until a condition of a server endpoint is met.	Extension	GA
az storagesync sync-group show	Show the properties for a given sync group.	Extension	GA

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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

مشاركة عبر

az storagesync sync-group

Commands

az storagesync sync-group create

Examples

Required Parameters

Optional Parameters

az storagesync sync-group delete

Examples

Required Parameters

Optional Parameters

az storagesync sync-group list

Examples

Required Parameters

Optional Parameters

az storagesync sync-group show

Examples

Required Parameters

Optional Parameters

الموارد الإضافية