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

--name -n

The name of server endpoint.

--registered-server-id --server-id

The resource id or GUID of the registered server.

--server-local-path

The local path of the registered server.

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cloud-tiering

A switch to enable or disable cloud tiering. With cloud tiering, infrequently used or accessed files can be tiered to Azure Files.

Property	Value
Accepted values:	off, on

--no-wait

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

Property	Value
Default value:	False

--offline-data-transfer

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.

Property	Value
Accepted values:	off, on

--offline-data-transfer-share-name

The name of Azure file share that is used to transfer data offline.

--resource-group -g

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

--tier-files-older-than-days

The days that the files are older than will be tiered.

--volume-free-space-percent

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

--name -n

The name of server endpoint.

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

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

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

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

--name -n

The name of server endpoint.

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

--name -n

The name of server endpoint.

--storage-sync-service

The name or ID of storage sync service.

--sync-group-name

The name of sync group.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cloud-tiering

A switch to enable or disable cloud tiering. With cloud tiering, infrequently used or accessed files can be tiered to Azure Files.

Property	Value
Accepted values:	off, on

--no-wait

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

Property	Value
Default value:	False

--offline-data-transfer

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.

Property	Value
Accepted values:	off, on

--offline-data-transfer-share-name

The name of Azure file share that is used to transfer data offline.

--resource-group -g

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

--tier-files-older-than-days

The days that the files are older than will be tiered.

--volume-free-space-percent

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

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

Required Parameters

--name -n

The name of server 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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False