Compartilhar via

Restore-AzKeyVault

Módulo:
Az.KeyVault Module

Restaura totalmente um HSM gerenciado do backup.

Sintaxe

InteractiveStorageName (Default) 

Restore-AzKeyVault
    [-HsmName] <String>
    -BackupFolder <String>
    -StorageAccountName <String>
    -StorageContainerName <String>
    [-KeyName <String>]
    [-PassThru]
    [-SasToken <SecureString>]
    [-UseUserManagedIdentity]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InteractiveStorageUri 

Restore-AzKeyVault
    [-HsmName] <String>
    -BackupFolder <String>
    -StorageContainerUri <Uri>
    [-KeyName <String>]
    [-PassThru]
    [-SasToken <SecureString>]
    [-UseUserManagedIdentity]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectStorageUri 

Restore-AzKeyVault
    -BackupFolder <String>
    -StorageContainerUri <Uri>
    -HsmObject <PSManagedHsm>
    [-KeyName <String>]
    [-PassThru]
    [-SasToken <SecureString>]
    [-UseUserManagedIdentity]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

InputObjectStorageName 

Restore-AzKeyVault
    -BackupFolder <String>
    -StorageAccountName <String>
    -StorageContainerName <String>
    -HsmObject <PSManagedHsm>
    [-KeyName <String>]
    [-PassThru]
    [-SasToken <SecureString>]
    [-UseUserManagedIdentity]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Restaura totalmente um HSM gerenciado de um backup armazenado em uma conta de armazenamento. Use Backup-AzKeyVault para fazer backup.

Exemplos

Exemplo 1 Restaurar um Key Vault

$sasToken = ConvertTo-SecureString -AsPlainText -Force "?sv=2019-12-12&ss=bfqt&srt=sco&sp=rwdlacupx&se=2020-10-12T14:42:19Z&st=2020-10-12T06:42:19Z&spr=https&sig=******"
Restore-AzKeyVault -HsmName myHsm -StorageContainerUri "https://{accountName}.blob.core.windows.net/{containerName}" -BackupFolder "mhsm-myHsm-2020101308504935" -SasToken $sasToken

O exemplo restaura um backup armazenado em uma pasta chamada "mhsm-myHsm-2020101308504935" de um contêiner de armazenamento "https://{accountName}.blob.core.windows.net/{containerName}".

Exemplo 2 Restaurar um Key Vault por meio da Autenticação de Identidade Gerenciada Atribuída pelo Usuário

# Make sure an identity is assigned to the Hsm
Update-AzKeyVaultManagedHsm -UserAssignedIdentity "/subscriptions/{sub-id}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}"
Restore-AzKeyVault -HsmName myHsm -StorageContainerUri "https://{accountName}.blob.core.windows.net/{containerName}" -BackupFolder "mhsm-myHsm-2020101308504935" -UseUserManagedIdentity

O exemplo restaura um HSM por meio da Autenticação de Identidade Gerenciada Atribuída pelo Usuário.

Parâmetros

-BackupFolder

Nome da pasta do backup, por exemplo, 'mhsm-2020101309020403'. Ele também pode ser aninhado, como 'backups/mhsm-2020101309020403'.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usadas para comunicação com Azure.

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HsmName

Nome do HSM.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InteractiveStorageName
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
InteractiveStorageUri
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-HsmObject

Objeto HSM gerenciado

Propriedades do parâmetro

Tipo:PSManagedHsm
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InputObjectStorageUri
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
InputObjectStorageName
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-KeyName

Nome da chave a ser restaurado.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

Retornar true quando o HSM for restaurado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SasToken

O token SAS (assinatura de acesso compartilhado) para autenticar a conta de armazenamento.

Propriedades do parâmetro

Tipo:SecureString
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-StorageAccountName

Nome da conta de armazenamento em que o backup será armazenado.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InteractiveStorageName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
InputObjectStorageName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-StorageContainerName

Nome do contêiner de blob em que o backup será armazenado.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InteractiveStorageName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
InputObjectStorageName
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-StorageContainerUri

URI do contêiner de armazenamento em que o backup será armazenado.

Propriedades do parâmetro

Tipo:Uri
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InteractiveStorageUri
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False
InputObjectStorageUri
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UseUserManagedIdentity

Especificado para usar a Identidade Gerenciada do Usuário para autenticar a conta de armazenamento. Válido somente quando SasToken não estiver definido.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Saídas

Boolean