Partager via

Backup-AzureKeyVaultKey

  • Référence
Module:
AzureRM.KeyVault

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

Avertissement

Le module AzureRM PowerShell a été officiellement déconseillé depuis le 29 février 2024. Les utilisateurs sont invités à migrer d’AzureRM vers le module Az PowerShell afin de s’assurer d’une prise en charge et des mises à jour continues.

Bien que le module AzureRM puisse toujours fonctionner, il n’est plus conservé ou pris en charge, plaçant toute utilisation continue à la discrétion et au risque de l’utilisateur. Consultez nos ressources sur la migration pour obtenir des conseils sur la transition vers le module Az.

Syntaxe

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

Description

L’applet de commande Backup-AzureKeyVaultKey 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-AzureKeyVaultKey pour récupérer la clé au format chiffré, puis utilisez l’applet de commande Restore-AzureKeyVaultKey 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

PS C:\Users\username\> Backup-AzureKeyVaultKey -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é

PS C:\> Backup-AzureKeyVaultKey -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.

PS C:\> $key = Get-AzureKeyVaultKey -VaultName 'MyKeyVault' -Name 'MyKey'
PS C:\> Backup-AzureKeyVaultKey -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 demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

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

Type:IAzureContextContainer
Alias:AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Remplacer le fichier donné s’il existe

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InputObject

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

Type:PSKeyVaultKeyIdentityItem
Alias:Key
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Name

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

Type:String
Alias:KeyName
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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à.

Type:String
Position:2
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-VaultName

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

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PSKeyVaultKeyIdentityItem

Paramètres : InputObject (ByValue)

Sorties

String