az storage-mover endpoint
Note
This reference is part of the storage-mover extension for the Azure CLI (version 2.75.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-multi-cloud-connector |
Creates an Endpoint resource for multi cloud connector. |
Extension | GA |
| 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-nfs-file-share |
Creates an Endpoint resource for storage nfs file share. |
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 identity |
Manage Identity. |
Extension | GA |
| az storage-mover endpoint identity assign |
Assign the user or system managed identities. |
Extension | GA |
| az storage-mover endpoint identity remove |
Remove the user or system managed identities. |
Extension | GA |
| az storage-mover endpoint identity show |
Show the details of managed identities. |
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-multi-cloud-connector |
Updates an Endpoint resource for multi cloud connector. |
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-nfs-file-share |
Updates an Endpoint resource for storage nfs file share. |
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-multi-cloud-connector
Creates an Endpoint resource for multi cloud connector.
az storage-mover endpoint create-for-multi-cloud-connector --aws-s3-bucket-id
--connector-id --multi-cloud-connector-id
--endpoint-name --name
--resource-group
--storage-mover-name
[--description]
Examples
endpoint create-for-multi-cloud-connector
az storage-mover endpoint create-for-multi-cloud-connector -g "rg" --storage-mover-name "mover_name" -n "endpoint_multi_cloud_connector" --multi-cloud-connector-id "connector_id" --aws-s3-bucket-id "bucket_id" --description endpointMultiCloudConnectorDesc
Required Parameters
The ID of the AWS S3 bucket.
The Azure Resource ID of the multi-cloud connector resource associated with the AWS account.
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint create-for-nfs
Creates an Endpoint resource for nfs.
az storage-mover endpoint create-for-nfs --endpoint-name --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
The name of the endpoint resource.
The directory being exported from the server.
The host name or IP address of the server exporting the file system.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
The NFS protocol version.
| Property | Value |
|---|---|
| Accepted values: | NFSauto, NFSv3, NFSv4 |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint create-for-smb
Creates an Endpoint resource for smb mount.
az storage-mover endpoint create-for-smb --endpoint-name --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
The name of the endpoint resource.
The host name or IP address of the server exporting the file system.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the SMB share being exported from the server.
The name of the Storage Mover 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.
A description for the Endpoint.
The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
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 --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
The name of the Storage blob container that is the target destination.
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The Azure Resource ID of the storage account that is the target destination.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint create-for-storage-nfs-file-share
Creates an Endpoint resource for storage nfs file share.
az storage-mover endpoint create-for-storage-nfs-file-share --endpoint-name --name
--file-share-name
--resource-group
--storage-account-id
--storage-mover-name
[--description]
Examples
endpoint create-for-storage-nfs-file-share
az storage-mover endpoint create-for-storage-nfs-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs_file_share" --file-share-name "file_share_name" --storage-account-id "account_id" --description endpointNfsFileShareDesc
Required Parameters
The name of the endpoint resource.
The name of the Azure Storage file share.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The Azure Resource ID of the storage account that is the target destination.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
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 --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
The name of the endpoint resource.
The name of the Azure Storage file share.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The Azure Resource ID of the storage account that is the target destination.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint delete
Deletes an Endpoint resource.
az storage-mover endpoint delete [--endpoint-name --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the Endpoint resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name of the Storage Mover resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
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
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
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.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint show
Gets an Endpoint resource.
az storage-mover endpoint show [--endpoint-name --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The name of the Endpoint resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name of the Storage Mover resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint update-for-multi-cloud-connector
Updates an Endpoint resource for multi cloud connector.
az storage-mover endpoint update-for-multi-cloud-connector --endpoint-name --name
--resource-group
--storage-mover-name
[--description]
Examples
endpoint update-for-multi-cloud-connector
az storage-mover endpoint update-for-multi-cloud-connector -g "rg" --storage-mover-name "mover_name" -n "endpoint_multi_cloud_connector" --description endpointMultiCloudConnectorDescUpdate
Required Parameters
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint update-for-nfs
Updates an Endpoint resource for nfs.
az storage-mover endpoint update-for-nfs --endpoint-name --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
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint update-for-smb
Updates an Endpoint resource for smb mount.
az storage-mover endpoint update-for-smb --endpoint-name --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
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
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 --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
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az storage-mover endpoint update-for-storage-nfs-file-share
Updates an Endpoint resource for storage nfs file share.
az storage-mover endpoint update-for-storage-nfs-file-share --endpoint-name --name
--resource-group
--storage-mover-name
[--description]
Examples
endpoint update-for-storage-nfs-file-share
az storage-mover endpoint update-for-storage-nfs-file-share -g "rg" --storage-mover-name "mover_name" -n "endpoint_nfs_file_share" --description endpointNfsFileShareDescUpdate
Required Parameters
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
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 --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
The name of the endpoint resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the Storage Mover 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.
A description for the Endpoint.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
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 --name]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--storage-mover-name]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until created with 'provisioningState' at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Wait until deleted.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
The name of the Endpoint resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Wait until the resource exists.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Polling interval in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
The name of the Storage Mover resource.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Maximum wait in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |