az storagesync registered-server

Manage registered server.

Commands

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

--no-wait

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

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

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

--resource-group -g

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

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

--resource-group -g

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

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

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.