az site-recovery job

  • Reference

Note

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

Manage Azure Site Recovery Jobs for the vault.

Commands

Name Description Type Status
az site-recovery job cancel

The operation to cancel an Azure Site Recovery job.

 Extension GA
az site-recovery job export

The operation to export the details of the Azure Site Recovery jobs of the vault.

 Extension GA
az site-recovery job list

List the list of Azure Site Recovery Jobs for the vault.

 Extension GA
az site-recovery job restart

The operation to restart an Azure Site Recovery job.

 Extension GA
az site-recovery job resume

The operation to resume an Azure Site Recovery job.

 Extension GA
az site-recovery job show

Get the details of an Azure Site Recovery job.

 Extension GA

az site-recovery job cancel

The operation to cancel an Azure Site Recovery job.

az site-recovery job cancel [--ids]
                            [--job-name]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--vault-name]

Examples

job cancel

az site-recovery job cancel --job-name job_id -g rg --vault-name vault_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-name --name -n

Job identifier.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--vault-name

The name of the recovery services vault.

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 site-recovery job export

The operation to export the details of the Azure Site Recovery jobs of the vault.

az site-recovery job export [--affected-object-types]
                            [--end-time]
                            [--fabric-id]
                            [--ids]
                            [--job-name]
                            [--job-output-type {Excel, Json, Xml}]
                            [--job-status]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--start-time]
                            [--subscription]
                            [--timezone-offset]
                            [--vault-name]

Examples

job export

az site-recovery job export -g rg --vault-name vault_name

Optional Parameters

--affected-object-types

The type of objects.

--end-time

Date time to get jobs upto.

--fabric-id

The Id of the fabric to search jobs under.

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

The job Name.

--job-output-type

The output type of the jobs.

Accepted values: Excel, Json, Xml
--job-status

The states of the job to be filtered can be in.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--start-time

Date time to get jobs from.

--subscription

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

--timezone-offset

The timezone offset for the location of the request (in minutes).

--vault-name

The name of the recovery services vault.

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 site-recovery job list

List the list of Azure Site Recovery Jobs for the vault.

az site-recovery job list --resource-group
                          --vault-name
                          [--filter]
                          [--max-items]
                          [--next-token]

Examples

job list

az site-recovery job list -g rg --vault-name vault_name

Required Parameters

--resource-group -g

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

--vault-name

The name of the recovery services vault.

Optional Parameters

--filter

OData filter options.

--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 site-recovery job restart

The operation to restart an Azure Site Recovery job.

az site-recovery job restart [--ids]
                             [--job-name]
                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                             [--resource-group]
                             [--subscription]
                             [--vault-name]

Examples

job restart

az site-recovery job restart --job-name job_id -g rg --vault-name vault_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-name --name -n

Job identifier.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--vault-name

The name of the recovery services vault.

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 site-recovery job resume

The operation to resume an Azure Site Recovery job.

az site-recovery job resume [--comments]
                            [--ids]
                            [--job-name]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--vault-name]

Examples

job resume

az site-recovery job resume --job-name job_id -g rg --vault-name vault_name

Optional Parameters

--comments

Resume job comments.

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

Job identifier.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--vault-name

The name of the recovery services vault.

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 site-recovery job show

Get the details of an Azure Site Recovery job.

az site-recovery job show [--ids]
                          [--job-name]
                          [--resource-group]
                          [--subscription]
                          [--vault-name]

Examples

job show

az site-recovery job show -g rg --vault-name vault_name --job-name job_id

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

Job identifier.

--resource-group -g

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

--subscription

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

--vault-name

The name of the recovery services vault.

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.