Backup-AzureKeyVaultSecret

  • Référence
Module:
AzureRM.KeyVault

Sauvegarde un secret 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.

Syntax

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

Description

L’applet de commande Backup-AzureKeyVaultSecret sauvegarde un secret spécifié dans un coffre de clés en le téléchargeant et en le stockant dans un fichier. S’il existe plusieurs versions du secret, 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 un secret sauvegardé dans n’importe quel coffre de clés de l’abonnement à partir duquel il a été sauvegardé. Les raisons courantes d’utiliser cette applet de commande sont les suivantes :

  • Vous souhaitez supprimer une copie de votre secret afin de disposer d’une copie hors connexion si vous supprimez accidentellement votre secret dans votre coffre de clés.
  • Vous avez ajouté un secret à un coffre de clés et souhaitez maintenant cloner le secret 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-AzureKeyVaultSecret pour récupérer le secret au format chiffré, puis utilisez l’applet de commande Restore-AzureKeyVaultSecret et spécifiez un coffre de clés dans la deuxième région. (Notez que les régions doivent appartenir à la même zone géographique.)

Exemples

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

PS C:\Users\username\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'

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

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

Exemple 2 : Sauvegarder un secret dans un nom de fichier spécifié, en remplaçant le fichier existant sans inviter

PS C:\> Backup-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret' -OutputFile 'C:\Backup.blob' -Force

C:\Backup.blob

Cette commande récupère le secret nommé MySecret à partir du coffre de clés nommé MyKeyVault et enregistre une sauvegarde de ce secret dans un fichier nommé Backup.blob.

Exemple 3 : Sauvegarder un secret précédemment récupéré dans un nom de fichier spécifié

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
PS C:\> Backup-AzureKeyVaultSecret -Secret $secret -OutputFile 'C:\Backup.blob'

C:\Backup.blob

Cette commande utilise le nom et le nom du coffre de l’objet $secret pour récupérer le secret et enregistrer sa sauvegarde dans un fichier nommé Backup.blob.

Paramètres

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Vous invite à confirmer avant de remplacer le fichier de sortie, le cas échéant.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Secret à sauvegarder, pipeline dans la sortie d’un appel de récupération.

Type:PSKeyVaultSecretIdentityItem
Aliases:Secret
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Spécifie le nom du secret à sauvegarder.

Type:String
Aliases:SecretName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VaultName

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

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters: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
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

PSKeyVaultSecretIdentityItem

Paramètres : InputObject (ByValue)

Sorties

String