az storagesync sync-group cloud-endpoint
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
The name of cloud endpoint.
The name or ID of storage sync service.
The name of sync group.
Optional Parameters
The name of Azure file share.
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>.
The name or ID of the storage account.
The id of the tenant that the storage account is in.
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 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
The name of cloud endpoint.
The name or ID of storage sync service.
The name of sync group.
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 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
The name or ID of storage sync service.
The name of sync group.
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 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
The name of cloud endpoint.
The name or ID of storage sync service.
The name of sync group.
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 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. Applies to a directory specified in directoryPath parameter.
Name of Cloud Endpoint object.
Relative path to a directory Azure File share for which change detection is to be performed.
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.
Do not wait for the long-running operation to finish.
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.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of Storage Sync Service resource.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Name of Sync Group resource.
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 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" --createdRequired Parameters
The name of cloud endpoint.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name of Storage Sync Service resource.
Name of Sync Group 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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for