az storagesync

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 command. Learn more about extensions.

Manage Azure File Sync.

Commands

Name	Description	Type	Status
az storagesync check-name-availability	Check the give namespace name availability.	Extension	GA
az storagesync create	Create a new storage sync service.	Extension	GA
az storagesync delete	Delete a given storage sync service.	Extension	GA
az storagesync list	List all storage sync services in a resource group or a subscription.	Extension	GA
az storagesync private-endpoint-connection	Manage private endpoint connection.	Extension	GA
az storagesync private-endpoint-connection list	List a PrivateEndpointConnection List.	Extension	GA
az storagesync registered-server	Manage registered server.	Extension	GA
az storagesync registered-server delete	Unregister an on-premises server from it's storage sync service.	Extension	GA
az storagesync registered-server list	List all registered servers for a given storage sync service.	Extension	GA
az storagesync registered-server show	Show the properties for a given registered server.	Extension	GA
az storagesync registered-server wait	Place the CLI in a waiting state until a condition of a registered server is met.	Extension	GA
az storagesync show	Show the properties for a given storage sync service.	Extension	GA
az storagesync sync-group	Manage sync group.	Extension	GA
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 check-name-availability

Check the give namespace name availability.

az storagesync check-name-availability --name
                                       --type {Microsoft.StorageSync/storageSyncServices}
                                       [--ids]
                                       [--location-name]
                                       [--subscription]

Required Parameters

--name

The name to check for availability.

--type

The resource type. Must be set to Microsoft.StorageSync/storageSyncServices.

Accepted values: Microsoft.StorageSync/storageSyncServices

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--location-name

The desired region for the name check.

--subscription

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

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 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=value1

Required Parameters

--name -n

The name of storage sync service.

--resource-group -g

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

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Default value: {}

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 delete

Delete a given storage sync service.

az storagesync delete [--ids]
                      [--name]
                      [--resource-group]
                      [--subscription]
                      [--yes]

Examples

Delete a storage sync service "SampleStorageSyncService" in resource group 'SampleResourceGroup'.

az storagesync delete --resource-group "SampleResourceGroup" \
--name "SampleStorageSyncService"

Optional Parameters

--ids

--name -n

The name of storage sync service.

--resource-group -g

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

--subscription

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

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

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 show

Show the properties for a given storage sync service.

az storagesync show [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

Examples

Show the properties for storage sync service "SampleStorageSyncService" in resource group 'SampleResourceGroup'.

az storagesync show --resource-group "SampleResourceGroup" --name \
"SampleStorageSyncService"

Optional Parameters

--ids

--name -n

The name of storage sync service.

--resource-group -g

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

--subscription

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

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.

Share via

az storagesync

Commands

az storagesync check-name-availability

Required Parameters

Optional Parameters

az storagesync create

Examples

Required Parameters

Optional Parameters

az storagesync delete

Examples

Optional Parameters

az storagesync list

Examples

Optional Parameters

az storagesync show

Examples

Optional Parameters

Additional resources