az storage-mover
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 command. Learn more about extensions.
Manage top-level Storage Mover resource.
Name | Description | Type | Status |
---|---|---|---|
az storage-mover agent |
Manage Agent resource, which references a hybrid compute machine that can run jobs. |
Extension | GA |
az storage-mover agent list |
Lists all Agents in a Storage Mover. |
Extension | GA |
az storage-mover agent show |
Gets an Agent resource. |
Extension | GA |
az storage-mover agent unregister |
Unregisters an Agent resource. |
Extension | GA |
az storage-mover agent update |
Update an Agent resource, which references a hybrid compute machine that can run jobs. |
Extension | GA |
az storage-mover agent wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az storage-mover create |
Creates a top-level Storage Mover resource. |
Extension | GA |
az storage-mover delete |
Deletes a Storage Mover resource. |
Extension | GA |
az storage-mover endpoint |
Manage Endpoint resource, which represents a data transfer source or destination. |
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-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 job-definition |
Manage Job Definition resource, which contains configuration for a single unit of managed data transfer. |
Extension | GA |
az storage-mover job-definition create |
Creates a Job Definition resource, which contains configuration for a single unit of managed data transfer. |
Extension | GA |
az storage-mover job-definition delete |
Deletes a Job Definition resource. |
Extension | GA |
az storage-mover job-definition list |
Lists all Job Definitions in a Project. |
Extension | GA |
az storage-mover job-definition show |
Gets a Job Definition resource. |
Extension | GA |
az storage-mover job-definition start-job |
Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource. |
Extension | GA |
az storage-mover job-definition stop-job |
Requests the Agent of any active instance of this Job Definition to stop. |
Extension | GA |
az storage-mover job-definition update |
Update a Job Definition resource, which contains configuration for a single unit of managed data transfer. |
Extension | GA |
az storage-mover job-definition wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az storage-mover job-run |
Manage Job Run resource. |
Extension | GA |
az storage-mover job-run list |
Lists all Job Runs in a Job Definition. |
Extension | GA |
az storage-mover job-run show |
Gets a Job Run resource. |
Extension | GA |
az storage-mover list |
Lists all Storage Movers in a subscription. |
Extension | GA |
az storage-mover project |
Manage Project resource, which is a logical grouping of related jobs. |
Extension | GA |
az storage-mover project create |
Creates a Project resource, which is a logical grouping of related jobs. |
Extension | GA |
az storage-mover project delete |
Deletes a Project resource. |
Extension | GA |
az storage-mover project list |
Lists all Projects in a Storage Mover. |
Extension | GA |
az storage-mover project show |
Gets a Project resource. |
Extension | GA |
az storage-mover project update |
Update a Project resource, which is a logical grouping of related jobs. |
Extension | GA |
az storage-mover project wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az storage-mover show |
Gets a Storage Mover resource. |
Extension | GA |
az storage-mover update |
Update a top-level Storage Mover resource. |
Extension | GA |
az storage-mover wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
Creates a top-level Storage Mover resource.
az storage-mover create --name
--resource-group
[--description]
[--location]
[--tags]
storage-mover create
az storage-mover create -g {rg} -n {mover_name} -l eastus2 --tags {{key1:value1}} --description ExampleDesc
The name of the Storage Mover resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
A description for the Storage Mover.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Deletes a Storage Mover resource.
az storage-mover delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
storage-mover delete
az storage-mover delete -g {rg} -n {mover_name}
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.
The name of the Storage Mover resource.
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>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Lists all Storage Movers in a subscription.
az storage-mover list [--max-items]
[--next-token]
[--resource-group]
storage-mover list
az storage-mover list -g {rg}
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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.
Gets a Storage Mover resource.
az storage-mover show [--ids]
[--name]
[--resource-group]
[--subscription]
storage-mover show
az storage-mover show -g {rg} -n {mover_name}
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.
The name of the Storage Mover resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Update a top-level Storage Mover resource.
az storage-mover update [--add]
[--description]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]
storage-mover update
az storage-mover update -g {rg} -n {mover_name} --tags {{key2:value2}} --description ExampleDesc2
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
A description for the Storage Mover.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
The name of the Storage Mover resource.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Place the CLI in a waiting state until a condition is met.
az storage-mover wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
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.
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.
Polling interval in seconds.
The name of the Storage Mover resource.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
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.
Azure CLI feedback
Azure CLI is an open source project. Select a link to provide feedback: