Partager via


Get-AzureKeyVaultSecret

Obtient les secrets 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

Get-AzureKeyVaultSecret
   [-VaultName] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-Version] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-VaultName] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [[-Name] <String>]
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-Version] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-ResourceId] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-ResourceId] <String>
   [-Name] <String>
   [-Version] <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureKeyVaultSecret
   [-ResourceId] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

L’applet de commande Get-AzureKeyVaultSecret obtient des secrets dans un coffre de clés. Cette applet de commande obtient un secret spécifique ou tous les secrets d’un coffre de clés.

Exemples

Exemple 1 : Obtenir toutes les versions actuelles de tous les secrets dans un coffre de clés

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso'

Vault Name   : contoso
Name         : secret1
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret1
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret2
Version      :
Id           : https://contoso.vault.azure.net:443/secrets/secret2
Enabled      : True
Expires      :
Not Before   :
Created      : 4/11/2018 11:45:06 PM
Updated      : 4/11/2018 11:45:06 PM
Content Type :
Tags         :

Cette commande obtient les versions actuelles de tous les secrets dans le coffre de clés nommé Contoso.

Exemple 2 : Obtenir toutes les versions d’un secret spécifique

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -IncludeVersions

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

Cette commande obtient toutes les versions du secret nommé secret1 dans le coffre de clés nommé Contoso.

Exemple 3 : Obtenir la version actuelle d’un secret spécifique

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1'

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

Cette commande obtient la version actuelle du secret nommé secret1 dans le coffre de clés nommé Contoso.

Exemple 4 : Obtenir une version spécifique d’un secret spécifique

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'secret1' -Version '5d1a74ba2c454439886fb8509b6cab3c'

Vault Name   : contoso
Name         : secret1
Version      : 5d1a74ba2c454439886fb8509b6cab3c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/5d1a74ba2c454439886fb8509b6cab3c
Enabled      : True
Expires      :
Not Before   :
Created      : 4/5/2018 11:44:50 PM
Updated      : 4/5/2018 11:44:50 PM
Content Type :
Tags         :

Cette commande obtient une version spécifique du secret nommé secret1 dans le coffre de clés nommé Contoso.

Exemple 5 : Obtenir la valeur de texte brut de la version actuelle d’un secret spécifique

PS C:\> $secret = Get-AzureKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret'
PS C:\> Write-Host "Secret Value is:" $secret.SecretValueText

Secret Value is: P@ssw0rd

Ces commandes obtiennent la version actuelle d’un secret nommé ITSecret, puis affichent la valeur de texte brut de ce secret.

Exemple 6 : Obtenez tous les secrets qui ont été supprimés, mais qui n’ont pas été vidés pour ce coffre de clés.

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Id                   : https://contoso.vault.azure.net:443/secrets/secret1
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

Vault Name           : contoso
Name                 : secret2
Id                   : https://contoso.vault.azure.net:443/secrets/secret2
Deleted Date         : 5/7/2018 7:56:34 PM
Scheduled Purge Date : 8/5/2018 7:56:34 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/6/2018 8:39:15 PM
Updated              : 4/6/2018 10:11:24 PM
Content Type         : 
Tags                 :

Cette commande obtient tous les secrets qui ont été précédemment supprimés, mais pas vidés, dans le coffre de clés nommé Contoso.

Exemple 7 : Obtient le secret ITSecret qui a été supprimé, mais qui n’a pas été vidé pour ce coffre de clés.

PS C:\> Get-AzureKeyVaultSecret -VaultName 'Contoso' -KeyName 'secret1' -InRemovedState

Vault Name           : contoso
Name                 : secret1
Version              : 689d23346e9c42a2a64f4e3d75094dcc
Id                   : https://contoso.vault.azure.net:443/secrets/secret1/689d23346e9c42a2a64f4e3d75094dcc
Deleted Date         : 4/4/2018 8:51:58 PM
Scheduled Purge Date : 7/3/2018 8:51:58 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 4/4/2018 8:51:03 PM
Updated              : 4/4/2018 8:51:03 PM
Content Type         :
Tags                 :

Cette commande obtient le secret « secret1 » qui a été précédemment supprimé, mais pas vidé, dans le coffre de clés nommé Contoso. Cette commande retourne des métadonnées telles que la date de suppression et la date de purge planifiée de ce secret supprimé.

Paramètres

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
valeur par défaut:None
Obligatoire:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeVersions

Indique que cette applet de commande obtient toutes les versions d’un secret. La version actuelle d’un secret est la première de la liste. Si vous spécifiez ce paramètre, vous devez également spécifier les paramètres Name et VaultName . Si vous ne spécifiez pas le paramètre IncludeVersions, cette applet de commande obtient la version actuelle du secret avec le nom spécifié.

Type:SwitchParameter
Position:Named
valeur par défaut:None
Obligatoire:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

KeyVault, objet.

Type:PSKeyVault
Position:0
valeur par défaut:None
Obligatoire:True
Accept pipeline input:True
Accept wildcard characters:False

-InRemovedState

Spécifie s’il faut afficher les secrets précédemment supprimés dans la sortie

Type:SwitchParameter
Position:Named
valeur par défaut:None
Obligatoire:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Spécifie le nom du secret à obtenir.

Type:String
Aliases:SecretName
Position:1
valeur par défaut:None
Obligatoire:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

ID de ressource KeyVault.

Type:String
Position:0
valeur par défaut:None
Obligatoire:True
Accept pipeline input:True
Accept wildcard characters:False

-VaultName

Spécifie le nom du coffre de clés auquel appartient le secret. Cette applet de commande construit le nom de domaine complet (FQDN) d’un coffre de clés en fonction du nom spécifié par ce paramètre et de votre environnement actuel.

Type:String
Position:0
valeur par défaut:None
Obligatoire:True
Accept pipeline input:False
Accept wildcard characters:False

-Version

Spécifie la version secrète. Cette applet de commande construit le nom de domaine complet d’un secret en fonction du nom du coffre de clés, de votre environnement actuellement sélectionné, du nom du secret et de la version secrète.

Type:String
Aliases:SecretVersion
Position:2
valeur par défaut:None
Obligatoire:True
Accept pipeline input:False
Accept wildcard characters:False

Entrées

PSKeyVault

Paramètres : InputObject (ByValue)

String

Sorties

PSKeyVaultSecretIdentityItem

PSKeyVaultSecret

PSDeletedKeyVaultSecretIdentityItem

PSDeletedKeyVaultSecret