Partager via

Backup-AzKeyVaultKey

Module:
Az.KeyVault Module

Sauvegarde une clé dans un coffre de clés.

Syntaxe

ByKeyName (Par défaut) 

Backup-AzKeyVaultKey
    [-VaultName] <String>
    [-Name] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

HsmByKeyName 

Backup-AzKeyVaultKey
    [-Name] <String>
    [[-OutputFile] <String>]
    -HsmName <String>
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByKey 

Backup-AzKeyVaultKey
    [-InputObject] <PSKeyVaultKeyIdentityItem>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

L’applet de commande Backup-AzKeyVaultKey sauvegarde une clé spécifiée dans un coffre de clés en la téléchargeant et en la stockant dans un fichier. S’il existe plusieurs versions de la clé, toutes les versions sont incluses dans la sauvegarde. Étant donné que le contenu téléchargé est chiffré, il ne peut pas être utilisé en dehors d’Azure Key Vault. Vous pouvez restaurer une clé sauvegardée dans n’importe quel coffre de clés de l’abonnement à partir duquel elle a été sauvegardée. Les raisons courantes d’utiliser cette applet de commande sont les suivantes :

  • Vous souhaitez supprimer une copie de votre clé afin de disposer d’une copie hors connexion si vous supprimez accidentellement votre clé dans votre coffre de clés.

  • Vous avez créé une clé à l’aide de Key Vault et souhaitez maintenant cloner la clé dans une autre région Azure, afin de pouvoir l’utiliser à partir de toutes les instances de votre application distribuée. Utilisez l’applet de commande Backup-AzKeyVaultKey pour récupérer la clé au format chiffré, puis utilisez l’applet de commande Restore-AzKeyVaultKey et spécifiez un coffre de clés dans la deuxième région.

Exemples

Exemple 1 : Sauvegarder une clé avec un nom de fichier généré automatiquement

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'

C:\Users\username\mykeyvault-mykey-1527029447.01191

Cette commande récupère la clé nommée MyKey à partir du coffre de clés nommé MyKeyVault et enregistre une sauvegarde de cette clé dans un fichier qui est automatiquement nommé pour vous et affiche le nom du fichier.

Exemple 2 : Sauvegarder une clé dans un nom de fichier spécifié

Backup-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey' -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Cette commande récupère la clé nommée MyKey à partir du coffre de clés nommé MyKeyVault et enregistre une sauvegarde de cette clé dans un fichier nommé Backup.blob.

Exemple 3 : Sauvegardez une clé précédemment récupérée dans un nom de fichier spécifié, en remplaçant le fichier de destination sans demander d’invite.

$key = Get-AzKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
Backup-AzKeyVaultKey -Key $key -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Cette commande crée une sauvegarde de la clé nommée $key. Nom dans le coffre nommé $key. VaultName dans un fichier nommé Backup.blob, en mode silencieux, en remplaçant le fichier s’il existe déjà.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure

Propriétés du paramètre

Type:IAzureContextContainer
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:AzContext, AzureRmContext, AzureCredential

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Force

Remplacer le fichier donné s’il existe

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-HsmName

Nom du module HSM. L’applet de commande construit le nom de domaine complet d’un HSM managé en fonction du nom et de l’environnement actuellement sélectionné.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

HsmByKeyName
Position:Named
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

Bundle de clés pour sauvegarder, pipeline dans la sortie d’un appel de récupération.

Propriétés du paramètre

Type:PSKeyVaultKeyIdentityItem
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Key

Jeux de paramètres

ByKey
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Name

Spécifie le nom de la clé à sauvegarder.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:KeyName

Jeux de paramètres

ByKeyName
Position:1
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False
HsmByKeyName
Position:1
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-OutputFile

Spécifie le fichier de sortie dans lequel l’objet blob de sauvegarde est stocké. Si vous ne spécifiez pas ce paramètre, cette applet de commande génère un nom de fichier pour vous. Si vous spécifiez le nom d’un fichier de sortie existant, l’opération ne se termine pas et retourne un message d’erreur indiquant que le fichier de sauvegarde existe déjà.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:2
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-VaultName

Spécifie le nom du coffre de clés qui contient la clé à sauvegarder.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

ByKeyName
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PSKeyVaultKeyIdentityItem

Sorties

String