Del via

az storage-mover job-definition

  • Reference

Note

This reference is part of the storage-mover extension for the Azure CLI (version 2.51.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 resource, which contains configuration for a single unit of managed data transfer.

Commands

Name Description Type Status
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-definition create

Creates 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
                                       --project-name
                                       --resource-group
                                       --source-name
                                       --storage-mover-name
                                       --target-name
                                       [--agent-name]
                                       [--description]
                                       [--source-subpath]
                                       [--target-subpath]

Examples

job-definition create

az storage-mover job-definition create -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name} --copy-mode Additive --source-name {source_endpoint} --target-name {target_endpoint} --agent-name {agent_name} --description JobDefinitionDescription --source-subpath path1 --target-subpath path2

Required Parameters

--copy-mode

Strategy to use for copy.

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.

--storage-mover-name

The name of the Storage Mover resource.

--target-name

The name of the target Endpoint.

Optional Parameters

--agent-name

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

--description

A description for the Job Definition.

--source-subpath

The subpath to use when reading from the source Endpoint.

--target-subpath

The subpath to use when writing to the target 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 job-definition delete

Deletes a Job Definition resource.

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

Examples

job-definition delete

az storage-mover job-definition delete -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name}

Optional Parameters

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

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

The name of the Job Definition resource.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

--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 job-definition list

Lists all Job Definitions in a Project.

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

Examples

job-definition list

az storage-mover job-definition list -g {rg} --project-name {project_name} --storage-mover-name {mover_name}

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

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

Gets a Job Definition resource.

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

Examples

job-definition show

az storage-mover job-definition show -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name}

Optional Parameters

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

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

--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 job-definition start-job

Requests an Agent to start a new instance of this Job Definition, generating a new Job Run resource.

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

Examples

job-definition start-job

az storage-mover job-definition start-job -g {rg} --job-definition-name {job_definition} --project-name {project_name} --storage-mover-name {mover_name}

Optional Parameters

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

--job-definition-name

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

--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 job-definition stop-job

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

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

Examples

job-definition stop-job

az storage-mover job-definition stop-job -g {rg} --job-definition-name {job_definition} --project-name {project_name} --storage-mover-name {mover_name}

Optional Parameters

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

--job-definition-name

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

--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 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 [--add]
                                       [--agent-name]
                                       [--copy-mode {Additive, Mirror}]
                                       [--description]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--job-definition-name]
                                       [--project-name]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--storage-mover-name]
                                       [--subscription]

Examples

job-definition update

az storage-mover job-definition update -g {rg} -n {job_definition} --project-name {project_name} --storage-mover-name {mover_name} --copy-mode Mirror --agent-name {agent_name} --description JobDefinitionDescription2

Optional Parameters

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

--agent-name

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

--copy-mode

Strategy to use for copy.

accepted values: Additive, Mirror
--description

A description for the Job Definition.

--force-string

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

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.

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

The name of the Job Definition resource.

--project-name

The name of the Project resource.

--remove

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

--resource-group -g

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

--set

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

--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 job-definition wait

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

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

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