az storagesync registered-server
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 registered-server command. Learn more about extensions.
Manage registered server.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 registered-server delete
Unregister an on-premises server from it's storage sync service.
Unregister an on-premises server from it's storage sync service which will result in cascading deletes of all server endpoints on this server.
az storagesync registered-server delete --server-id
--storage-sync-service
[--no-wait]
[--resource-group]
[--yes]Examples
Unregister an on-premises server "41166691-ab03-43e9-ab3e-0330eda162ac" from it's storage sync service "SampleStorageSyncService".
az storagesync registered-server delete --resource-group "SampleResourceGroup" --storage-sync-service \
"SampleStorageSyncService" --server-id "41166691-ab03-43e9-ab3e-0330eda162ac"Required Parameters
GUID identifying the on-premises server.
The name or ID of storage sync service.
Optional Parameters
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Do not prompt for confirmation.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storagesync registered-server list
List all registered servers for a given storage sync service.
az storagesync registered-server list --storage-sync-service
[--resource-group]Examples
List all registered servers for storage sync service "SampleStorageSyncService".
az storagesync registered-server list --resource-group "SampleResourceGroup" --storage-sync-service \
"SampleStorageSyncService"Required Parameters
The name or ID of storage sync service.
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storagesync registered-server show
Show the properties for a given registered server.
az storagesync registered-server show --server-id
--storage-sync-service
[--resource-group]Examples
Show the properties for registered server "080d4133-bdb5-40a0-96a0-71a6057bfe9a".
az storagesync registered-server show --resource-group "SampleResourceGroup" --storage-sync-service \
"SampleStorageSyncService" --server-id "080d4133-bdb5-40a0-96a0-71a6057bfe9a"Required Parameters
GUID identifying the on-premises server.
The name or ID of storage sync service.
Optional Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az storagesync registered-server wait
Place the CLI in a waiting state until a condition of a registered server is met.
az storagesync registered-server wait --resource-group
--server-id
--storage-sync-service-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]Examples
Place the CLI in a waiting state until a condition of a registered server is deleted.
az storagesync registered-server wait --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" \
--server-id "080d4133-bdb5-40a0-96a0-71a6057bfe9a" --deletedRequired Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
GUID identifying the on-premises server.
Name of Storage Sync Service resource.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI