az storagesync
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 command. Learn more about extensions.
Manage Azure File Sync.
Commands
| az storagesync create |
Create a new storage sync service. |
| az storagesync delete |
Delete a given storage sync service. |
| az storagesync list |
List all storage sync services in a resource group or a subscription. |
| az storagesync registered-server |
Manage registered server. |
| az storagesync registered-server delete |
Unregister an on-premises server from it's storage sync service. |
| az storagesync registered-server list |
List all registered servers for a given storage sync service. |
| az storagesync registered-server show |
Show the properties for a given registered server. |
| az storagesync registered-server wait |
Place the CLI in a waiting state until a condition of a registered server is met. |
| az storagesync show |
Show the properties for a given storage sync service. |
| az storagesync sync-group |
Manage sync group. |
| 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 create
Create a new storage sync service.
az storagesync create --name
--resource-group
[--location]
[--tags]Examples
Create a new storage sync service "SampleStorageSyncService" in resource group 'SampleResourceGroup'.
az storagesync create --resource-group "SampleResourceGroup" \
--name "SampleStorageSyncService" --location "WestUS" --tags key1=value1Required Parameters
The name of storage sync service.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az storagesync delete
Delete a given storage sync service.
az storagesync delete --name
[--resource-group]
[--yes]Examples
Delete a storage sync service "SampleStorageSyncService" in resource group 'SampleResourceGroup'.
az storagesync delete --resource-group "SampleResourceGroup" \
--name "SampleStorageSyncService"Required Parameters
The name of storage sync service.
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az storagesync list
List all storage sync services in a resource group or a subscription.
az storagesync list [--resource-group]Examples
List all storage sync services in a resource group "SampleResourceGroup".
az storagesync list --resource-group "SampleResourceGroup"List all storage sync services in current subscription
az storagesync listOptional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az storagesync show
Show the properties for a given storage sync service.
az storagesync show --name
[--resource-group]Examples
Show the properties for storage sync service "SampleStorageSyncService" in resource group 'SampleResourceGroup'.
az storagesync show --resource-group "SampleResourceGroup" --name \
"SampleStorageSyncService"Required Parameters
The name of storage sync service.
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.