Partager via

Backup-AzKeyVaultSecret

Module:
Az.KeyVault Module

Sauvegarde un secret dans un coffre de clés.

Syntaxe

BySecretName (Par défaut) 

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

BySecretUri 

Backup-AzKeyVaultSecret
    [-Id] <String>
    [[-OutputFile] <String>]
    [-Force]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

BySecret 

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

Description

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

Backup-AzKeyVaultSecret -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

Backup-AzKeyVaultSecret -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é

$secret = Get-AzKeyVaultSecret -VaultName 'MyKeyVault' -Name 'MySecret'
Backup-AzKeyVaultSecret -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.

Exemple 4 : Sauvegarder un secret avec un nom de fichier généré automatiquement (à l’aide de l’URI)

Backup-AzKeyVaultSecret -Id 'https://MyKeyVault.vault.azure.net:443/secrets/MySecret'

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:False
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

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

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
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

-Id

URI du secret KeyVault. Assurez-vous qu’il suit le format suivant : https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

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:SecretId

Jeux de paramètres

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

-InputObject

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

Propriétés du paramètre

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

Jeux de paramètres

BySecret
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 du secret à 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:SecretName

Jeux de paramètres

BySecretName
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 le secret à 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

BySecretName
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:False
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

PSKeyVaultSecretIdentityItem

Sorties

String