az storage-mover job-definition

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 job-definition command. Learn more about extensions.

Manage Job Definition.

Commands

Name	Description	Type	Status
az storage-mover job-definition create	Create a Job Definition resource, which contains configuration for a single unit of managed data transfer.	Extension	GA
az storage-mover job-definition delete	Delete a Job Definition resource.	Extension	GA
az storage-mover job-definition list	List all Job Definitions in a Project.	Extension	GA
az storage-mover job-definition show	Get a Job Definition resource.	Extension	GA
az storage-mover job-definition start-job	Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.	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-definition create

Create a Job Definition resource, which contains configuration for a single unit of managed data transfer.

az storage-mover job-definition create --copy-mode {Additive, Mirror}
                                       --job-definition-name --name
                                       --project-name
                                       --resource-group
                                       --source-name
                                       --storage-mover-name
                                       --target-name
                                       [--acquire-policy-token]
                                       [--agent-name]
                                       [--change-reference]
                                       [--connections]
                                       [--data-integrity-validation --data-validation {None, SaveFileMD5, SaveVerifyFileMD5}]
                                       [--description]
                                       [--job-type {CloudToCloud, OnPremToCloud}]
                                       [--preserve-permissions {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--schedule]
                                       [--source-subpath]
                                       [--target-subpath]

Required Parameters

--copy-mode

Strategy to use for copy.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Additive, Mirror

--job-definition-name --name -n

The name of the Job Definition resource.

--project-name

The name of the Project resource.

--resource-group -g

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

--source-name

The name of the source Endpoint.

Property	Value
Parameter group:	Properties Arguments

--storage-mover-name

The name of the Storage Mover resource.

--target-name

The name of the target Endpoint.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--agent-name

Name of the Agent to assign for new Job Runs of this Job Definition.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--connections

List of connections associated to this job Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--data-integrity-validation --data-validation

The checksum validation mode for the job definition.

Property	Value
Parameter group:	Properties Arguments
Default value:	None
Accepted values:	None, SaveFileMD5, SaveVerifyFileMD5

--description

A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.

Property	Value
Parameter group:	Properties Arguments

--job-type

The type of the Job.

Property	Value
Parameter group:	Properties Arguments
Default value:	OnPremToCloud
Accepted values:	CloudToCloud, OnPremToCloud

--preserve-permissions

Boolean to preserve permissions or not.

Property	Value
Parameter group:	Properties Arguments
Default value:	True
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--schedule

Schedule information for the Job Definition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--source-subpath

The subpath to use when reading from the source Endpoint.

Property	Value
Parameter group:	Properties Arguments

--target-subpath

The subpath to use when writing to the target Endpoint.

Property	Value
Parameter group:	Properties Arguments

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 storage-mover job-definition delete

Delete a Job Definition resource.

az storage-mover job-definition delete [--acquire-policy-token]
                                       [--change-reference]
                                       [--ids]
                                       [--job-definition-name --name]
                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--project-name]
                                       [--resource-group]
                                       [--storage-mover-name]
                                       [--subscription]
                                       [--yes]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--job-definition-name --name -n

The name of the Job Definition resource.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--project-name

The name of the Project resource.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--storage-mover-name

The name of the Storage Mover resource.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az storage-mover job-definition list

List all Job Definitions in a Project.

az storage-mover job-definition list --project-name
                                     --resource-group
                                     --storage-mover-name
                                     [--max-items]
                                     [--next-token]

Required Parameters

--project-name

The name of the Project 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

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

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

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

--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 storage-mover job-definition show

Get a Job Definition resource.

az storage-mover job-definition show [--ids]
                                     [--job-definition-name --name]
                                     [--project-name]
                                     [--resource-group]
                                     [--storage-mover-name]
                                     [--subscription]

Optional Parameters

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

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

Property	Value
Parameter group:	Resource Id Arguments

--job-definition-name --name -n

The name of the Job Definition resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

The name of the Project resource.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--storage-mover-name

The name of the Storage Mover resource.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az storage-mover job-definition start-job

Creates a new Job Run resource for the specified Job Definition and passes it to the Agent for execution.

az storage-mover job-definition start-job [--acquire-policy-token]
                                          [--change-reference]
                                          [--ids]
                                          [--job-definition-name]
                                          [--project-name]
                                          [--resource-group]
                                          [--storage-mover-name]
                                          [--subscription]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--job-definition-name

The name of the Job Definition resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

The name of the Project resource.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--storage-mover-name

The name of the Storage Mover resource.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az storage-mover job-definition stop-job

Requests the Agent of any active instance of this Job Definition to stop.

az storage-mover job-definition stop-job [--acquire-policy-token]
                                         [--change-reference]
                                         [--ids]
                                         [--job-definition-name]
                                         [--project-name]
                                         [--resource-group]
                                         [--storage-mover-name]
                                         [--subscription]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--job-definition-name

The name of the Job Definition resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

The name of the Project resource.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--storage-mover-name

The name of the Storage Mover resource.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az storage-mover job-definition update

Update a Job Definition resource, which contains configuration for a single unit of managed data transfer.

az storage-mover job-definition update [--acquire-policy-token]
                                       [--add]
                                       [--agent-name]
                                       [--change-reference]
                                       [--connections]
                                       [--copy-mode {Additive, Mirror}]
                                       [--data-integrity-validation --data-validation {None, SaveFileMD5, SaveVerifyFileMD5}]
                                       [--description]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--job-definition-name --name]
                                       [--job-type {CloudToCloud, OnPremToCloud}]
                                       [--preserve-permissions {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--project-name]
                                       [--remove]
                                       [--resource-group]
                                       [--schedule]
                                       [--set]
                                       [--storage-mover-name]
                                       [--subscription]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

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

Property	Value
Parameter group:	Generic Update Arguments

--agent-name

Name of the Agent to assign for new Job Runs of this Job Definition.

Property	Value
Parameter group:	Properties Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--connections

List of connections associated to this job Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--copy-mode

Strategy to use for copy.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Additive, Mirror

--data-integrity-validation --data-validation

The checksum validation mode for the job definition.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	None, SaveFileMD5, SaveVerifyFileMD5

--description

A description for the Job Definition. OnPremToCloud is for migrating data from on-premises to cloud. CloudToCloud is for migrating data between cloud to cloud.

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

Property	Value
Parameter group:	Resource Id Arguments

--job-definition-name --name -n

The name of the Job Definition resource.

Property	Value
Parameter group:	Resource Id Arguments

--job-type

The type of the Job.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	CloudToCloud, OnPremToCloud

--preserve-permissions

Boolean to preserve permissions or not.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--project-name

The name of the Project resource.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--schedule

Schedule information for the Job Definition. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--storage-mover-name

The name of the Storage Mover resource.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az storage-mover job-definition wait

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

az storage-mover job-definition wait [--acquire-policy-token]
                                     [--change-reference]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--ids]
                                     [--interval]
                                     [--job-definition-name --name]
                                     [--project-name]
                                     [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

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

--job-definition-name --name -n

The name of the Job Definition resource.

Property	Value
Parameter group:	Resource Id Arguments

--project-name

The name of the Project resource.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--storage-mover-name

The name of the Storage Mover resource.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False