Delen via

Get-AzKeyVaultSecret

  • Referentie
Module:
Az.KeyVault

Haalt de geheimen op in een sleutelkluis.

Syntax

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

Description

De cmdlet Get-AzKeyVaultSecret haalt geheimen op in een sleutelkluis. Met deze cmdlet wordt een specifiek geheim of alle geheimen in een sleutelkluis opgehaald.

Voorbeelden

Voorbeeld 1: alle huidige versies van alle geheimen in een sleutelkluis ophalen

Get-AzKeyVaultSecret -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         :

Met deze opdracht worden de huidige versies van alle geheimen opgehaald in de sleutelkluis met de naam Contoso.

Voorbeeld 2: Alle versies van een specifiek geheim ophalen

Get-AzKeyVaultSecret -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         :

Met deze opdracht worden alle versies van het geheim geheim met de naam geheim1 opgehaald in de sleutelkluis met de naam Contoso.

Voorbeeld 3: de huidige versie van een specifiek geheim ophalen

Get-AzKeyVaultSecret -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         :

Met deze opdracht wordt de huidige versie van het geheim met de naam secret1 opgehaald in de sleutelkluis met de naam Contoso.

Voorbeeld 4: Een specifieke versie van een specifiek geheim ophalen

Get-AzKeyVaultSecret -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         :

Met deze opdracht wordt een specifieke versie van het geheim met de naam geheim1 opgehaald in de sleutelkluis met de naam Contoso.

Voorbeeld 5: De waarde voor tekst zonder opmaak ophalen van de huidige versie van een specifiek geheim

$secretText = Get-AzKeyVaultSecret -VaultName 'Contoso' -Name 'ITSecret' -AsPlainText

De cmdlet retourneert het geheim als een tekenreeks wanneer -AsPlainText deze wordt toegepast.

Opmerking: bij het vermelden van geheimen, d.w.w.v. het niet verstrekken -Name, wordt het -AsPlainText genegeerd.

Voorbeeld 6: Haal alle geheimen op die zijn verwijderd, maar die niet zijn opgeschoond voor deze sleutelkluis.

Get-AzKeyVaultSecret -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                 :

Met deze opdracht worden alle geheimen opgehaald die eerder zijn verwijderd, maar niet zijn verwijderd, in de sleutelkluis met de naam Contoso.

Voorbeeld 7: Haalt het geheime ITSecret op dat is verwijderd, maar niet is verwijderd voor deze sleutelkluis.

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name '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                 :

Met deze opdracht wordt het geheim 'secret1' opgehaald dat eerder is verwijderd, maar niet is verwijderd, in de sleutelkluis met de naam Contoso. Met deze opdracht worden metagegevens geretourneerd, zoals de verwijderingsdatum en de geplande opschoondatum van dit verwijderde geheim.

Voorbeeld 8: alle huidige versies van alle geheimen in een sleutelkluis ophalen met behulp van filteren

Get-AzKeyVaultSecret -VaultName 'Contoso' -Name "secret*"

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         :

Met deze opdracht worden de huidige versies van alle geheimen opgehaald in de sleutelkluis met de naam Contoso die beginnen met 'geheim'.

Voorbeeld 9: Een geheim ophalen in Azure Key Vault met de opdracht Get-Secret in module Microsoft.PowerShell.SecretManagement

# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "Password" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure 
Get-Secret -Vault AzKeyVault -Name secureSecret -AsPlainText

Password

In dit voorbeeld wordt een geheim opgehaald met de naam secureSecret in Azure Key Vault met de opdracht test-kvGet-Secret in de module Microsoft.PowerShell.SecretManagement.

Parameters

-AsPlainText

Wanneer deze optie is ingesteld, converteert de cmdlet het geheim in een beveiligde tekenreeks naar de ontsleutelde tekenreeks zonder opmaak als uitvoer.

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

-DefaultProfile

De referenties, het account, de tenant en het abonnement dat wordt gebruikt voor communicatie met Azure

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

-IncludeVersions

Geeft aan dat deze cmdlet alle versies van een geheim ophaalt. De huidige versie van een geheim is de eerste in de lijst. Als u deze parameter opgeeft, moet u ook de parameters Name en VaultName opgeven. Als u de parameter IncludeVersions niet opgeeft, haalt deze cmdlet de huidige versie van het geheim op met de opgegeven naam.

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

-InputObject

KeyVault-object.

Type:PSKeyVault
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InRemovedState

Hiermee geeft u op of de eerder verwijderde geheimen in de uitvoer moeten worden weergegeven

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

-Name

Hiermee geeft u de naam van het geheim dat moet worden opgehaald.

Type:String
Aliases:SecretName
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-ResourceId

KeyVault-resource-id.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VaultName

Hiermee geeft u de naam van de sleutelkluis waartoe het geheim behoort. Met deze cmdlet wordt de FQDN (Fully Qualified Domain Name) van een sleutelkluis samengesteld op basis van de naam die met deze parameter wordt opgegeven en uw huidige omgeving.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Version

Hiermee geeft u de geheime versie. Met deze cmdlet wordt de FQDN van een geheim samengesteld op basis van de naam van de sleutelkluis, de momenteel geselecteerde omgeving, de geheime naam en de geheime versie.

Type:String
Aliases:SecretVersion
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Invoerwaarden

PSKeyVault

String

Uitvoerwaarden

PSKeyVaultSecretIdentityItem

PSKeyVaultSecret

PSDeletedKeyVaultSecretIdentityItem

PSDeletedKeyVaultSecret