Share via

az keyvault restore

  • Reference

Manage full HSM restore.

Commands

Name Description Type Status
az keyvault restore start

Restore a full backup of a HSM.

 Core GA

az keyvault restore start

Edit

Restore a full backup of a HSM.

az keyvault restore start --backup-folder
                          [--blob-container-name]
                          [--hsm-name]
                          [--id]
                          [--key]
                          [--storage-account-name]
                          [--storage-container-SAS-token]
                          [--storage-resource-uri]
                          [--use-managed-identity {false, true}]

Required Parameters

--backup-folder

Name of the blob container which contains the backup.

Optional Parameters

--blob-container-name

Name of Blob Container.

--hsm-name

Name of the HSM. Can be omitted if --id is specified.

--id

Full URI of the HSM.

--key --key-name

Name of a single key in the backup. When set, only this key will be restored.

--storage-account-name

Name of Azure Storage Account.

--storage-container-SAS-token -t

The SAS token pointing to an Azure Blob storage container.

--storage-resource-uri

Azure Blob storage container Uri. If specified all other 'Storage Id' arguments should be omitted.

--use-managed-identity

If True, Managed HSM will use the configured user-assigned managed identity to authenticate with Azure Storage. Otherwise, a sas_token has to be specified.

Accepted values: false, true
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.