Share via

az storage-mover endpoint

  • Reference

Note

This reference is part of the storage-mover extension for the Azure CLI (version 2.57.0 or higher). The extension will automatically install the first time you run an az storage-mover endpoint command. Learn more about extensions.

Manage Endpoint resource, which represents a data transfer source or destination.

Commands

Name Description Type Status
az storage-mover endpoint create-for-nfs

Creates an Endpoint resource for nfs.

 Extension GA
az storage-mover endpoint create-for-smb

Creates an Endpoint resource for smb mount.

 Extension GA
az storage-mover endpoint create-for-storage-container

Creates an Endpoint resource for storage blob container.

 Extension GA
az storage-mover endpoint create-for-storage-smb-file-share

Creates an Endpoint resource for storage smb file share.

 Extension GA
az storage-mover endpoint delete

Deletes an Endpoint resource.

 Extension GA
az storage-mover endpoint list

Lists all Endpoints in a Storage Mover.

 Extension GA
az storage-mover endpoint show

Gets an Endpoint resource.

 Extension GA
az storage-mover endpoint update-for-nfs

Updates an Endpoint resource for nfs.

 Extension GA
az storage-mover endpoint update-for-smb

Updates an Endpoint resource for smb mount.

 Extension GA
az storage-mover endpoint update-for-storage-container

Updates an Endpoint resource for storage blob container.

 Extension GA
az storage-mover endpoint update-for-storage-smb-file-share

Updates an Endpoint resource for storage smb file share.

 Extension GA
az storage-mover endpoint wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az storage-mover endpoint create-for-nfs

Creates an Endpoint resource for nfs.

az storage-mover endpoint create-for-nfs --endpoint-name
                                         --export
                                         --host
                                         --resource-group
                                         --storage-mover-name
                                         [--description]
                                         [--nfs-version {NFSauto, NFSv3, NFSv4}]

Examples

endpoint create-for-nfs

az storage-mover endpoint create-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDesc --export exportfolder --nfs-version NFSv4 --host "vm_ip"

Required Parameters

--endpoint-name --name -n

The name of the endpoint resource.

--export

The directory being exported from the server.

--host

The host name or IP address of the server exporting the file system.

--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

--nfs-version

The NFS protocol version.

Accepted values: NFSauto, NFSv3, NFSv4
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 storage-mover endpoint create-for-smb

Creates an Endpoint resource for smb mount.

az storage-mover endpoint create-for-smb --endpoint-name
                                         --host
                                         --resource-group
                                         --share-name
                                         --storage-mover-name
                                         [--description]
                                         [--password-uri]
                                         [--username-uri]

Examples

endpoint create-for-smb

az storage-mover endpoint create-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDesc --share-name "smb_share_name" --username-uri username --password-uri Password!23 --host "vm_ip"

Required Parameters

--endpoint-name --name -n

The name of the endpoint resource.

--host

The host name or IP address of the server exporting the file system.

--resource-group -g

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

--share-name

The name of the SMB share being exported from the server.

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

--password-uri

The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.

--username-uri

The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.

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 storage-mover endpoint create-for-storage-container

Creates an Endpoint resource for storage blob container.

az storage-mover endpoint create-for-storage-container --container-name
                                                       --endpoint-name
                                                       --resource-group
                                                       --storage-account-id
                                                       --storage-mover-name
                                                       [--description]

Examples

endpoint create-for-storage-container

az storage-mover endpoint create-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --container-name "container_name" --storage-account-id "account_id" --description endpointDesc

Required Parameters

--container-name

The name of the Storage blob container that is the target destination.

--endpoint-name --name -n

The name of the endpoint resource.

--resource-group -g

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

--storage-account-id

The Azure Resource ID of the storage account that is the target destination.

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

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 storage-mover endpoint create-for-storage-smb-file-share

Creates an Endpoint resource for storage smb file share.

az storage-mover endpoint create-for-storage-smb-file-share --endpoint-name
                                                            --file-share-name
                                                            --resource-group
                                                            --storage-account-id
                                                            --storage-mover-name
                                                            [--description]

Examples

endpoint create-for-storage-smb-file-share

az storage-mover endpoint create-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --file-share-name "file_share_name" --storage-account-id "account_id" --description endpointFileShareDesc

Required Parameters

--endpoint-name --name -n

The name of the endpoint resource.

--file-share-name

The name of the Azure Storage file share.

--resource-group -g

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

--storage-account-id

The Azure Resource ID of the storage account that is the target destination.

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

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 storage-mover endpoint delete

Deletes an Endpoint resource.

az storage-mover endpoint delete [--endpoint-name]
                                 [--ids]
                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                 [--resource-group]
                                 [--storage-mover-name]
                                 [--subscription]
                                 [--yes]

Examples

endpoint delete

az storage-mover endpoint delete -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs}

Optional Parameters

--endpoint-name --name -n

The name of the Endpoint resource.

--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
--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

--subscription

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

--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 storage-mover endpoint list

Lists all Endpoints in a Storage Mover.

az storage-mover endpoint list --resource-group
                               --storage-mover-name
                               [--max-items]
                               [--next-token]

Examples

endpoint list

az storage-mover endpoint list -g {rg} --storage-mover-name {mover_name}

Required Parameters

--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

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 storage-mover endpoint show

Gets an Endpoint resource.

az storage-mover endpoint show [--endpoint-name]
                               [--ids]
                               [--resource-group]
                               [--storage-mover-name]
                               [--subscription]

Examples

endpoint show

az storage-mover endpoint show -g {rg} --storage-mover-name {mover_name} -n {endpoint_nfs}

Optional Parameters

--endpoint-name --name -n

The name of the Endpoint resource.

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

--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

--subscription

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

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 storage-mover endpoint update-for-nfs

Updates an Endpoint resource for nfs.

az storage-mover endpoint update-for-nfs --endpoint-name
                                         --resource-group
                                         --storage-mover-name
                                         [--description]

Examples

endpoint update-for-nfs

az storage-mover endpoint update-for-nfs -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs" --description endpointDescUpdate

Required Parameters

--endpoint-name --name -n

The name of the endpoint resource.

--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

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 storage-mover endpoint update-for-smb

Updates an Endpoint resource for smb mount.

az storage-mover endpoint update-for-smb --endpoint-name
                                         --resource-group
                                         --storage-mover-name
                                         [--description]
                                         [--password-uri]
                                         [--username-uri]

Examples

endpoint update-for-smb

az storage-mover endpoint update-for-smb -g "rg" --storage-mover-name "mover_name" -n "endpoint_smb" --description endpointSmbDescUpdate

Required Parameters

--endpoint-name --name -n

The name of the endpoint resource.

--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

--password-uri

The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.

--username-uri

The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.

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 storage-mover endpoint update-for-storage-container

Updates an Endpoint resource for storage blob container.

az storage-mover endpoint update-for-storage-container --endpoint-name
                                                       --resource-group
                                                       --storage-mover-name
                                                       [--description]

Examples

endpoint update-for-storage-container

az storage-mover endpoint update-for-storage-container -g "rg" --storage-mover-name "mover_name" -n "endpoint_container" --description endpointDescUpdate

Required Parameters

--endpoint-name --name -n

The name of the endpoint resource.

--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

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 storage-mover endpoint update-for-storage-smb-file-share

Updates an Endpoint resource for storage smb file share.

az storage-mover endpoint update-for-storage-smb-file-share --endpoint-name
                                                            --resource-group
                                                            --storage-mover-name
                                                            [--description]

Examples

endpoint update-for-storage-smb-file-share

az storage-mover endpoint update-for-storage-smb-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_file_share" --description endpointFileShareDescUpdate

Required Parameters

--endpoint-name --name -n

The name of the endpoint resource.

--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

Optional Parameters

--description

A description for the Endpoint.

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 storage-mover endpoint wait

Place the CLI in a waiting state until a condition is met.

az storage-mover endpoint wait [--created]
                               [--custom]
                               [--deleted]
                               [--endpoint-name]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--resource-group]
                               [--storage-mover-name]
                               [--subscription]
                               [--timeout]
                               [--updated]

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
--endpoint-name --name -n

The name of the Endpoint resource.

--exists

Wait until the resource exists.

Default value: False
--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.

--interval

Polling interval in seconds.

Default value: 30
--resource-group -g

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

--storage-mover-name

The name of the Storage Mover resource.

--subscription

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

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