az keyvault region

Manage MHSM multi-regions.

Commands

Name	Description	Type	Status
az keyvault region add	Add regions for the managed HSM Pool.	Core	GA
az keyvault region list	Get regions information associated with the managed HSM Pool.	Core	GA
az keyvault region remove	Remove regions for the managed HSM Pool.	Core	GA
az keyvault region wait	Place the CLI in a waiting state until a condition of the HSM is met.	Core	GA

az keyvault region add

Add regions for the managed HSM Pool.

az keyvault region add --hsm-name
                       --region
                       [--no-wait]
                       [--resource-group]

Examples

Add regions for the managed HSM.

az keyvault region add --region-name westus2 --hsm-name myhsm --resource-group myrg

Required Parameters

--hsm-name

Name of the HSM.

--region --region-name -r

The region name.

Optional Parameters

--no-wait

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

Default value: False

--resource-group -g

Proceed only if Key Vault belongs to the specified resource group.

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 keyvault region list

Get regions information associated with the managed HSM Pool.

az keyvault region list --hsm-name
                        [--resource-group]

Required Parameters

--hsm-name

Name of the HSM.

Optional Parameters

--resource-group -g

Proceed only if Key Vault belongs to the specified resource group.

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 keyvault region remove

Remove regions for the managed HSM Pool.

az keyvault region remove --hsm-name
                          --region
                          [--no-wait]
                          [--resource-group]

Examples

Remove regions for the managed HSM.

az keyvault region remove --region-name westus2 --hsm-name myhsm --resource-group myrg

Required Parameters

--hsm-name

Name of the HSM.

--region --region-name -r

The region name.

Optional Parameters

--no-wait

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

Default value: False

--resource-group -g

Proceed only if Key Vault belongs to the specified resource group.

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 keyvault region wait

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

az keyvault region wait --hsm-name
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

Examples

Pause CLI until the regions are updated.

az keyvault region wait --hsm-name myhsm --updated

Required Parameters

--hsm-name

Name of the HSM.

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

--interval

Polling interval in seconds.

Default value: 30

--resource-group -g

Proceed only if Key Vault belongs to the specified resource group.

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