az storagesync sync-group server-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 server-endpoint command. Learn more about extensions.
Manage server endpoint.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az storagesync sync-group server-endpoint create |
Create a new server endpoint. |
Extension | GA |
| az storagesync sync-group server-endpoint delete |
Delete a given server endpoint. |
Extension | GA |
| az storagesync sync-group server-endpoint list |
List all server endpoints in a sync group. |
Extension | GA |
| az storagesync sync-group server-endpoint show |
Show the properties for a given server endpoint. |
Extension | GA |
| az storagesync sync-group server-endpoint update |
Update the properties for a given server endpoint. |
Extension | GA |
| az storagesync sync-group server-endpoint wait |
Place the CLI in a waiting state until a condition of a server endpoint is met. |
Extension | GA |
az storagesync sync-group server-endpoint create
Create a new server endpoint.
az storagesync sync-group server-endpoint create --name
--registered-server-id
--server-local-path
--storage-sync-service
--sync-group-name
[--cloud-tiering {off, on}]
[--no-wait]
[--offline-data-transfer {off, on}]
[--offline-data-transfer-share-name]
[--resource-group]
[--tier-files-older-than-days]
[--volume-free-space-percent]Examples
Create a new server endpoint "SampleServerEndpoint" in sync group "SampleSyncGroup".
az storagesync sync-group server-endpoint create --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleServerEndpoint" --server-id 91beed22-7e9e-4bda-9313-fec96cf286e0 \
--server-local-path "d:\abc" --cloud-tiering "off" --volume-free-space-percent 80 --tier-files-older-than-days 20 \
--offline-data-transfer "on" --offline-data-transfer-share-name "myfileshare"Required Parameters
The name of server endpoint.
The resource id or GUID of the registered server.
The local path of the registered server.
The name or ID of storage sync service.
The name of sync group.
Optional Parameters
A switch to enable or disable cloud tiering. With cloud tiering, infrequently used or accessed files can be tiered to Azure Files.
Do not wait for the long-running operation to finish.
A switch to enable or disable offline data transfer. With offline data transfer, you can use alternative means, like Azure Data Box, to transport large amounts of files into Azure without network.
The name of Azure file share that is used to transfer data offline.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The days that the files are older than will be tiered.
The amount of free space to reserve on the volume on which the server endpoint is located. For example, if volume free space is set to 50% on a volume that has a single server endpoint, roughly half the amount of data is tiered to Azure Files. Regardless of whether cloud tiering is enabled, your Azure file share always has a complete copy of the data in the sync group.
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 server-endpoint delete
Delete a given server endpoint.
az storagesync sync-group server-endpoint delete --name
--storage-sync-service
--sync-group-name
[--no-wait]
[--resource-group]
[--yes]Examples
Delete a server endpoint "SampleServerEndpoint".
az storagesync sync-group server-endpoint delete --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleServerEndpoint"Required Parameters
The name of server 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 server-endpoint list
List all server endpoints in a sync group.
az storagesync sync-group server-endpoint list --storage-sync-service
--sync-group-name
[--resource-group]Examples
List all server endpoints in sync group "SampleSyncGroup".
az storagesync sync-group server-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 server-endpoint show
Show the properties for a given server endpoint.
az storagesync sync-group server-endpoint show --name
--storage-sync-service
--sync-group-name
[--resource-group]Examples
Show the properties for server endpoint "SampleServerEndpoint".
az storagesync sync-group server-endpoint show --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleServerEndpoint"Required Parameters
The name of server 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 server-endpoint update
Update the properties for a given server endpoint.
az storagesync sync-group server-endpoint update --name
--storage-sync-service
--sync-group-name
[--cloud-tiering {off, on}]
[--no-wait]
[--offline-data-transfer {off, on}]
[--offline-data-transfer-share-name]
[--resource-group]
[--tier-files-older-than-days]
[--volume-free-space-percent]Examples
Update the properties for server endpoint "SampleServerEndpoint".
az storagesync sync-group server-endpoint update --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleServerEndpoint" --cloud-tiering "off" \
--volume-free-space-percent "100" --tier-files-older-than-days "0" \
--offline-data-transfer "off"Required Parameters
The name of server endpoint.
The name or ID of storage sync service.
The name of sync group.
Optional Parameters
A switch to enable or disable cloud tiering. With cloud tiering, infrequently used or accessed files can be tiered to Azure Files.
Do not wait for the long-running operation to finish.
A switch to enable or disable offline data transfer. With offline data transfer, you can use alternative means, like Azure Data Box, to transport large amounts of files into Azure without network.
The name of Azure file share that is used to transfer data offline.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The days that the files are older than will be tiered.
The amount of free space to reserve on the volume on which the server endpoint is located. For example, if volume free space is set to 50% on a volume that has a single server endpoint, roughly half the amount of data is tiered to Azure Files. Regardless of whether cloud tiering is enabled, your Azure file share always has a complete copy of the data in the sync group.
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 server-endpoint wait
Place the CLI in a waiting state until a condition of a server endpoint is met.
az storagesync sync-group server-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 server endpoint is created.
az storagesync sync-group server-endpoint wait --resource-group "SampleResourceGroup" \
--storage-sync-service "SampleStorageSyncService" --sync-group-name \
"SampleSyncGroup" --name "SampleServerEndpoint" --createdRequired Parameters
The name of server 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.
Tilbakemeldinger
Kommer snart: Gjennom 2024 faser vi ut GitHub Issues som tilbakemeldingsmekanisme for innhold, og erstatter det med et nytt system for tilbakemeldinger. Hvis du vil ha mer informasjon, kan du se: https://aka.ms/ContentUserFeedback.
Send inn og vis tilbakemelding for