Share via

az site-recovery fabric

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

Manage Fabric.

Commands

Name Description Type Status
az site-recovery fabric create

Create operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).

 Extension GA
az site-recovery fabric delete

Delete operation to purge(force delete) an Azure Site Recovery fabric.

 Extension GA
az site-recovery fabric list

List a list of the Azure Site Recovery fabrics in the vault.

 Extension GA
az site-recovery fabric remove

The operation to delete or remove an Azure Site Recovery fabric.

 Extension GA
az site-recovery fabric show

Get the details of an Azure Site Recovery fabric.

 Extension GA
az site-recovery fabric update

Update operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).

 Extension GA

az site-recovery fabric create

Create operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).

az site-recovery fabric create --fabric-name
                               --resource-group
                               --vault-name
                               [--custom-details]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

fabric create for A2A

az site-recovery fabric create -n fabric1_name -g rg --vault-name vault_name --custom-details '{azure:{location:eastus}}'

Required Parameters

--fabric-name --name -n

Name of the ASR fabric.

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

--custom-details

Fabric provider specific creation input. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

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

Delete operation to purge(force delete) an Azure Site Recovery fabric.

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

Examples

fabric delete

az site-recovery fabric delete -n fabric1_name -g rg --vault-name vault_name

Optional Parameters

--fabric-name --name -n

ASR fabric to purge.

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

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

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

List a list of the Azure Site Recovery fabrics in the vault.

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

Examples

fabric list

az site-recovery fabric 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

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

The operation to delete or remove an Azure Site Recovery fabric.

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

Examples

fabric remove

az site-recovery fabric remove -n fabric_source_name -g rg --vault-name vault_name

Optional Parameters

--fabric-name --name -n

ASR fabric to delete.

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

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

Get the details of an Azure Site Recovery fabric.

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

Examples

fabric show

az site-recovery fabric show -n fabric1_name -g rg --vault-name vault_name

Optional Parameters

--fabric-name --name -n

Fabric name.

--filter

OData filter options.

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

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

Update operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site).

az site-recovery fabric update [--add]
                               [--custom-details]
                               [--fabric-name]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--subscription]
                               [--vault-name]

Examples

fabric update

az site-recovery fabric update -n fabric_source_name -g rg --vault-name vault_name --custom-details '{azure:{location:eastus}}'

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

--custom-details

Fabric provider specific creation input. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--fabric-name --name -n

Fabric name.

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

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