Get-AzKeyVaultKey

Module:

Az.KeyVault

Hiermee haalt u Key Vault-sleutels op. Houd er rekening mee dat gedetailleerde informatie over een sleutel, zoals sleuteltype of sleutelgrootte, alleen beschikbaar is bij het uitvoeren van een query op een specifieke sleutelversie.

Syntaxis

Get-AzKeyVaultKey
   [-VaultName] <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-VaultName] <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-VaultName] <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmName <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmName <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmName <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-InputObject] <PSKeyVault>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   [-HsmObject] <PSManagedHsm>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -ResourceId <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -ResourceId <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -ResourceId <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmResourceId <String>
   [[-Name] <String>]
   [-InRemovedState]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <String>
   [-Version] <String>
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzKeyVaultKey
   -HsmResourceId <String>
   [-Name] <String>
   [-IncludeVersions]
   [-OutFile <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Met de cmdlet Get-AzKeyVaultKey worden Azure Key Vault-sleutels opgehaald. Met deze cmdlet wordt een specifieke Microsoft.Azure.Commands.KeyVault.Models.KeyBundle of een lijst met alle KeyBundle-objecten in een sleutelkluis of op basis van versie opgehaald.

Voorbeelden

Voorbeeld 1: Alle sleutels in een sleutelkluis ophalen

Get-AzKeyVaultKey -VaultName 'contoso'

Vault/HSM Name : contoso
Name           : test1
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test1
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault Name     : contoso
Name           : test2
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test2
Enabled        : True
Expires        : 11/24/2018 6:09:44 PM
Not Before     : 5/24/2018 5:59:44 PM
Created        : 5/24/2018 6:09:44 PM
Updated        : 5/24/2018 6:09:44 PM
Purge Disabled : False
Tags           :

Met deze opdracht worden alle sleutels opgehaald in de sleutelkluis met de naam Contoso.

Voorbeeld 2: de huidige versie van een sleutel ophalen

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1'

Vault/HSM Name : contoso
Name           : test1
Key Type       : RSA
Key Size       : 2048
Version        : 7fe415d5518240c1a6fce89986b8d334
Id             : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Met deze opdracht wordt de huidige versie van de sleutel met de naam test1 opgehaald in de sleutelkluis met de naam Contoso.

Voorbeeld 3: Alle versies van een sleutel ophalen

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -IncludeVersions

Vault/HSM Name : contoso
Name           : test1
Version        : 7fe415d5518240c1a6fce89986b8d334
Id             : https://contoso.vault.azure.net:443/keys/test1/7fe415d5518240c1a6fce89986b8d334
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault/HSM Name     : contoso
Name           : test1
Version        : e4e95940e669407fbdb4298bc21a3e1d
Id             : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
Enabled        : False
Expires        : 11/24/2018 6:08:08 PM
Not Before     : 5/24/2018 5:58:08 PM
Created        : 5/24/2018 6:08:08 PM
Updated        : 5/24/2018 6:08:08 PM
Purge Disabled : False
Tags           :

Met deze opdracht worden alle versies opgehaald van de sleutel met de naam ITPfx in de sleutelkluis met de naam Contoso.

Voorbeeld 4: Een specifieke versie van een sleutel ophalen

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test1' -Version 'e4e95940e669407fbdb4298bc21a3e1d'

Vault/HSM Name : contoso
Name           : test1
Key Type       : RSA
Key Size       : 2048
Version        : e4e95940e669407fbdb4298bc21a3e1d
Id             : https://contoso.vault.azure.net:443/keys/test1/e4e95940e669407fbdb4298bc21a3e1d
Enabled        : False
Expires        : 11/24/2018 6:08:08 PM
Not Before     : 5/24/2018 5:58:08 PM
Created        : 5/24/2018 6:08:08 PM
Updated        : 5/24/2018 6:08:08 PM
Purge Disabled : False
Tags           :

Met deze opdracht wordt een specifieke versie van de sleutel met de naam test1 opgehaald in de sleutelkluis met de naam Contoso. Nadat u deze opdracht hebt uitgevoerd, kunt u verschillende eigenschappen van de sleutel controleren door het $Key-object te navigeren.

Voorbeeld 5: Alle sleutels ophalen die zijn verwijderd, maar die niet zijn opgeschoond voor deze sleutelkluis

Get-AzKeyVaultKey -VaultName 'contoso' -InRemovedState

Vault/HSM Name       : contoso
Name                 : test3
Id                   : https://contoso.vault.azure.net:443/keys/test3
Deleted Date         : 5/24/2018 8:32:42 PM
Scheduled Purge Date : 8/22/2018 8:32:42 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 5/24/2018 8:32:27 PM
Updated              : 5/24/2018 8:32:27 PM
Purge Disabled       : False
Tags                 :

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

Voorbeeld 6: Haalt de SLEUTEL ITPfx op die is verwijderd, maar niet is verwijderd voor deze sleutelkluis.

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName 'test3' -InRemovedState

Vault/HSM Name       : contoso
Name                 : test3
Id                   : https://contoso.vault.azure.net:443/keys/test3/1af807cc331a49d0b52b7c75e1b2366e
Deleted Date         : 5/24/2018 8:32:42 PM
Scheduled Purge Date : 8/22/2018 8:32:42 PM
Enabled              : True
Expires              :
Not Before           :
Created              : 5/24/2018 8:32:27 PM
Updated              : 5/24/2018 8:32:27 PM
Purge Disabled       : False
Tags                 :

Met deze opdracht wordt de sleuteltest3 opgehaald die 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 deze verwijderde sleutel.

Voorbeeld 7: Alle sleutels in een sleutelkluis ophalen met behulp van filteren

Get-AzKeyVaultKey -VaultName 'contoso' -KeyName "test*"

Vault/HSM Name : contoso
Name           : test1
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test1
Enabled        : True
Expires        : 11/24/2018 6:08:13 PM
Not Before     : 5/24/2018 5:58:13 PM
Created        : 5/24/2018 6:08:13 PM
Updated        : 5/24/2018 6:08:13 PM
Purge Disabled : False
Tags           :

Vault/HSM Name : contoso
Name           : test2
Version        :
Id             : https://contoso.vault.azure.net:443/keys/test2
Enabled        : True
Expires        : 11/24/2018 6:09:44 PM
Not Before     : 5/24/2018 5:59:44 PM
Created        : 5/24/2018 6:09:44 PM
Updated        : 5/24/2018 6:09:44 PM
Purge Disabled : False
Tags           :

Met deze opdracht worden alle sleutels opgehaald in de sleutelkluis met de naam Contoso die beginnen met 'test'.

Voorbeeld 8: Een openbare sleutel downloaden als een PEM-bestand

$path = "D:\public.pem"
Get-AzKeyVaultKey -VaultName $vaultName -KeyName $keyName -OutFile $path

U kunt de openbare sleutel van een RSA-sleutel downloaden door de -OutFile parameter op te geven. Dit is een stap van het importeren van met HSM beveiligde sleutels naar Azure Key Vault. Zie https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

Parameters

-DefaultProfile

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

Type:	IAzureContextContainer
Aliassen:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-HsmName

HSM-naam. Cmdlet bouwt de FQDN van een beheerde HSM op basis van de naam en momenteel geselecteerde omgeving.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-HsmObject

HSM-object.

Type:	PSManagedHsm
Position:	0
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-HsmResourceId

HSM-resource-id.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-IncludeVersions

Geeft aan dat deze cmdlet alle versies van een sleutel ophaalt. De huidige versie van een sleutel 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 de sleutel op met de opgegeven naam.

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-InputObject

KeyVault-object.

Type:	PSKeyVault
Position:	0
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-InRemovedState

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

Type:	SwitchParameter
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Name

Hiermee geeft u de naam van de sleutelbundel die moet worden get.

Type:	String
Aliassen:	KeyName
Position:	1
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	True

-OutFile

Hiermee geeft u het uitvoerbestand waarvoor deze cmdlet de sleutel opslaat. De openbare sleutel wordt standaard opgeslagen in PEM-indeling.

Type:	String
Position:	Named
Default value:	None
Vereist:	False
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-ResourceId

KeyVault-resource-id.

Type:	String
Position:	Named
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	True
Jokertekens accepteren:	False

-VaultName

Hiermee geeft u de naam op van de sleutelkluis waaruit deze cmdlet sleutels ophaalt. 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 de geselecteerde omgeving.

Type:	String
Position:	0
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

-Version

Hiermee geeft u de sleutelversie. Met deze cmdlet wordt de FQDN van een sleutel samengesteld op basis van de naam van de sleutelkluis, de momenteel geselecteerde omgeving, de sleutelnaam en de sleutelversie.

Type:	String
Aliassen:	KeyVersion
Position:	2
Default value:	None
Vereist:	True
Pijplijninvoer accepteren:	False
Jokertekens accepteren:	False

Invoerwaarden

PSKeyVault

String

Uitvoerwaarden

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey

Verwante koppelingen

• Add-AzKeyVaultKey
• Remove-AzKeyVaultKey
• Ongedaan maken-AzKeyVaultKeyRemoval