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

--server-id

GUID identifying the on-premises server.

--storage-sync-service

The name or ID of storage sync service.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

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

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

--storage-sync-service

The name or ID of storage sync service.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

--server-id

GUID identifying the on-premises server.

--storage-sync-service

The name or ID of storage sync service.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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" --deleted

Required Parameters

--resource-group -g

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

--server-id

GUID identifying the on-premises server.

--storage-sync-service-name

Name of Storage Sync Service resource.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

Share via

az storagesync registered-server

Commands

az storagesync registered-server delete

Examples

Required Parameters

Optional Parameters

az storagesync registered-server list

Examples

Required Parameters

Optional Parameters

az storagesync registered-server show

Examples

Required Parameters

Optional Parameters

az storagesync registered-server wait

Examples

Required Parameters

Optional Parameters

Feedback