az storagesync sync-group cloud-endpoint

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 sync-group cloud-endpoint command. Learn more about extensions.

Manage cloud endpoint.

Commands

Name	Description	Type	Status
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 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.

Default value: False

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

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

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.

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

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

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

az storagesync sync-group cloud-endpoint trigger-change-detection [--change-detection-mode {Default, Recursive}]
                                                                  [--cloud-endpoint-name]
                                                                  [--directory-path]
                                                                  [--ids]
                                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                                  [--paths]
                                                                  [--resource-group]
                                                                  [--storage-sync-service]
                                                                  [--subscription]
                                                                  [--sync-group-name]

Optional Parameters

--change-detection-mode

Change Detection Mode. Applies to a directory specified in directoryPath parameter.

Accepted values: Default, Recursive

--cloud-endpoint-name --name -n

Name of Cloud Endpoint object.

--directory-path

Relative path to a directory Azure File share for which change detection is to be performed.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--paths

Array of relative paths on the Azure File share to be included in the change detection. Can be files and directories. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-group -g

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

--storage-sync-service --storage-sync-service-name

Name of Storage Sync Service resource.

--subscription

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

--sync-group-name

Name of Sync Group resource.

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--interval

Polling interval in seconds.

Default value: 30

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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

Commands

az storagesync sync-group cloud-endpoint create

Examples

Required Parameters

Optional Parameters

az storagesync sync-group cloud-endpoint delete

Examples

Required Parameters

Optional Parameters

az storagesync sync-group cloud-endpoint list

Examples

Required Parameters

Optional Parameters

az storagesync sync-group cloud-endpoint show

Examples

Required Parameters

Optional Parameters

az storagesync sync-group cloud-endpoint trigger-change-detection

Optional Parameters

az storagesync sync-group cloud-endpoint wait

Examples

Required Parameters

Optional Parameters

แหล่งทรัพยากรเพิ่มเติม