წაკითხვა ინგლისურად

გაზიარება არხიდან:

az site-recovery vault

  • 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 vault command. Learn more about extensions.

Manage Vault.

Commands

Name Description Type Status
az site-recovery vault health

Manage the health details of the vault.

 Extension GA
az site-recovery vault health refresh-default

Refresh default for the health of the vault.

 Extension GA
az site-recovery vault health show

Get the health details of the vault.

 Extension GA
az site-recovery vault list-appliance

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

 Extension GA
az site-recovery vault list-migration-item

Get the list of ASR replication migration items in the vault.

 Extension GA
az site-recovery vault list-network

List the networks available in a vault.

 Extension GA
az site-recovery vault list-network-mapping

List all ASR network mappings in the vault.

 Extension GA
az site-recovery vault list-protected-item

List the list of ASR replication protected items in the vault.

 Extension GA
az site-recovery vault list-protection-container

List the protection containers in a vault.

 Extension GA
az site-recovery vault list-protection-container-mapping

List the protection container mappings in the vault.

 Extension GA
az site-recovery vault list-recovery-services-provider

List the registered recovery services providers in the vault.

 Extension GA
az site-recovery vault list-storage-classification

List the storage classifications in the vault.

 Extension GA
az site-recovery vault list-storage-classification-mapping

List the storage classification mappings in the vault.

 Extension GA
az site-recovery vault list-v-center

List the vCenter servers registered in the vault.

 Extension GA
az site-recovery vault show-supported-operating-system

Show the supported operating system for the vault.

 Extension GA

az site-recovery vault list-appliance

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

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

Examples

list-appliance for vault

az site-recovery vault list-appliance -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 vault list-migration-item

Get the list of ASR replication migration items in the vault.

az site-recovery vault list-migration-item --resource-group
                                           --vault-name
                                           [--filter]
                                           [--max-items]
                                           [--next-token]
                                           [--skip-token]
                                           [--take-token]

Examples

list-migration-item

az site-recovery vault list-migration-item -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.

--skip-token

The pagination token.

--take-token

The page size.

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 vault list-network

List the networks available in a vault.

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

Examples

list-network

az site-recovery vault list-network -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

--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 vault list-network-mapping

List all ASR network mappings in the vault.

az site-recovery vault list-network-mapping --resource-group
                                            --vault-name
                                            [--max-items]
                                            [--next-token]

Examples

list-network-mapping

az site-recovery vault list-network-mapping -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

--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 vault list-protected-item

List the list of ASR replication protected items in the vault.

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

Examples

list-protected-item

az site-recovery vault list-protected-item -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.

--skip-token

The pagination token. Possible values: "FabricId" or "FabricId_CloudId" or null.

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 vault list-protection-container

List the protection containers in a vault.

az site-recovery vault list-protection-container --resource-group
                                                 --vault-name
                                                 [--max-items]
                                                 [--next-token]

Examples

list-protection-container

az site-recovery vault list-protection-container -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

--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 vault list-protection-container-mapping

List the protection container mappings in the vault.

az site-recovery vault list-protection-container-mapping --resource-group
                                                         --vault-name
                                                         [--max-items]
                                                         [--next-token]

Examples

list-protection-container-mapping

az site-recovery vault list-protection-container-mapping -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

--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 vault list-recovery-services-provider

List the registered recovery services providers in the vault.

az site-recovery vault list-recovery-services-provider --resource-group
                                                       --vault-name
                                                       [--max-items]
                                                       [--next-token]

Examples

list-recovery-services-provider

az site-recovery vault list-recovery-services-provider -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

--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 vault list-storage-classification

List the storage classifications in the vault.

az site-recovery vault list-storage-classification --resource-group
                                                   --vault-name
                                                   [--max-items]
                                                   [--next-token]

Examples

list-storage-classification

az site-recovery vault list-storage-classification -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

--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 vault list-storage-classification-mapping

List the storage classification mappings in the vault.

az site-recovery vault list-storage-classification-mapping --resource-group
                                                           --vault-name
                                                           [--max-items]
                                                           [--next-token]

Examples

list-storage-classification-mapping

az site-recovery vault list-storage-classification-mapping -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

--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 vault list-v-center

List the vCenter servers registered in the vault.

az site-recovery vault list-v-center --resource-group
                                     --vault-name
                                     [--max-items]
                                     [--next-token]

Examples

list-v-center

az site-recovery vault list-v-center -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

--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 vault show-supported-operating-system

Show the supported operating system for the vault.

az site-recovery vault show-supported-operating-system [--ids]
                                                       [--instance-type]
                                                       [--resource-group]
                                                       [--subscription]
                                                       [--vault-name]

Examples

show-supported-operating-system

az site-recovery vault show-supported-operating-system -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.

--instance-type

The instance type.

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