az storagesync sync-group cloud-endpoint

Manage cloud endpoint.

Commands

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 cloud-endpoint create

Create a new cloud endpoint.

az storagesync sync-group cloud-endpoint create --name
                                                --storage-sync-service
                                                --sync-group-name
                                                [--azure-file-share-name]
                                                [--no-wait]
                                                [--resource-group]
                                                [--storage-account]
                                                [--storage-account-tenant-id]

Examples

Create a new cloud endpoint "SampleCloudEndpoint" in sync group "SampleSyncGroup".

az storagesync sync-group cloud-endpoint create --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleCloudEndpoint" --storage-account storageaccountnameorid --azure-file-share-name \
"cvcloud-afscv-0719-058-a94a1354-a1fd-4e9a-9a50-919fad8c4ba4"

Required Parameters

--name -n

The name of cloud endpoint.

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

--azure-file-share-name

The name of Azure file share.

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

--storage-account

The name or ID of the storage account.

--storage-account-tenant-id

The id of the tenant that the storage account is in.

az storagesync sync-group cloud-endpoint delete

Delete a given cloud endpoint.

az storagesync sync-group cloud-endpoint delete --name
                                                --storage-sync-service
                                                --sync-group-name
                                                [--no-wait]
                                                [--resource-group]
                                                [--yes]

Examples

Delete cloud endpoint "SampleCloudEndpoint".

az storagesync sync-group cloud-endpoint delete --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleCloudEndpoint"

Required Parameters

--name -n

The name of cloud endpoint.

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

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 sync-group cloud-endpoint list

List all cloud endpoints in a sync group.

az storagesync sync-group cloud-endpoint list --storage-sync-service
                                              --sync-group-name
                                              [--resource-group]

Examples

List all cloud endpoints in sync group "SampleSyncGroup".

az storagesync sync-group cloud-endpoint list --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup"

Required Parameters

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

--resource-group -g

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

az storagesync sync-group cloud-endpoint show

Show the properties for a given cloud endpoint.

az storagesync sync-group cloud-endpoint show --name
                                              --storage-sync-service
                                              --sync-group-name
                                              [--resource-group]

Examples

Show the properties for cloud endpoint "SampleCloudEndpoint".

az storagesync sync-group cloud-endpoint show --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleCloudEndpoint"

Required Parameters

--name -n

The name of cloud endpoint.

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

--resource-group -g

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

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 cloud-endpoint wait --name
                                              --resource-group
                                              --storage-sync-service-name
                                              --sync-group-name
                                              [--created]
                                              [--custom]
                                              [--deleted]
                                              [--exists]
                                              [--interval]
                                              [--timeout]
                                              [--updated]

Examples

Place the CLI in a waiting state until a condition of a cloud endpoint is created.

az storagesync sync-group cloud-endpoint wait --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleCloudEndpoint" --created

Required Parameters

--name -n

The name of cloud endpoint.

--resource-group -g

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

--storage-sync-service-name

Name of Storage Sync Service resource.

--sync-group-name

Name of Sync Group 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'.