Share via

az site-recovery protectable-item

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 protectable-item command. Learn more about extensions.

Manage Protectable Item.

Commands

Name Description Type Status
az site-recovery protectable-item list

List the protectable items in a protection container.

 Extension GA
az site-recovery protectable-item show

Get operation to get the details of a protectable item.

 Extension GA

az site-recovery protectable-item list

List the protectable items in a protection container.

az site-recovery protectable-item list --fabric-name
                                       --protection-container --protection-container-name
                                       --resource-group
                                       --vault-name
                                       [--filter]
                                       [--max-items]
                                       [--next-token]
                                       [--skip-token]
                                       [--take]

Examples

protectable-item list

az site-recovery protectable-item list --fabric-name "fabric" --protection-container "container_name" -g "rg_name" --vault-name "vault_name"

Required Parameters

--fabric-name

Fabric name.

--protection-container --protection-container-name

Protection container name.

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

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

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

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

SkipToken OData query parameter.

--take

Take OData query parameter.

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 site-recovery protectable-item show

Get operation to get the details of a protectable item.

az site-recovery protectable-item show [--fabric-name]
                                       [--ids]
                                       [--name --protectable-item-name]
                                       [--protection-container --protection-container-name]
                                       [--resource-group]
                                       [--subscription]
                                       [--vault-name]

Examples

protectable-item show

az site-recovery protectable-item show --fabric-name "fabric" --protection-container "container_name" -g "rg_name" --vault-name "vault_name" -n "protectable_item_name"

Optional Parameters

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

--fabric-name

Fabric name.

Property Value
Parameter group: Resource Id 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
--name --protectable-item-name -n

Protectable item name.

Property Value
Parameter group: Resource Id Arguments
--protection-container --protection-container-name

Protection container name.

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

The name of the recovery services vault.

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