Get-AzKeyVaultKey

Referens

Modul:: Az.KeyVault

Hämtar Key Vault-nycklar. Observera att detaljerad information om en nyckel, till exempel nyckeltyp eller nyckelstorlek, endast är tillgänglig när du kör frågor mot en specifik nyckelversion.

Syntax

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

Cmdleten Get-AzKeyVaultKey hämtar Azure Key Vault-nycklar. Den här cmdleten hämtar en specifik Microsoft.Azure.Commands.KeyVault.Models.KeyBundle eller en lista över alla KeyBundle-objekt i ett nyckelvalv eller efter version.

Exempel

Exempel 1: Hämta alla nycklar i ett nyckelvalv

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           :

Det här kommandot hämtar alla nycklar i nyckelvalvet med namnet Contoso.

Exempel 2: Hämta den aktuella versionen av en nyckel

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           :

Det här kommandot hämtar den aktuella versionen av nyckeln med namnet test1 i nyckelvalvet med namnet Contoso.

Exempel 3: Hämta alla versioner av en nyckel

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           :

Det här kommandot hämtar alla versioner av nyckeln med namnet ITPfx i nyckelvalvet med namnet Contoso.

Exempel 4: Hämta en specifik version av en nyckel

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           :

Det här kommandot hämtar en specifik version av nyckeln med namnet test1 i nyckelvalvet med namnet Contoso. När du har kört det här kommandot kan du granska olika egenskaper för nyckeln genom att navigera i $Key-objektet.

Exempel 5: Hämta alla nycklar som har tagits bort men inte rensats för det här nyckelvalvet

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                 :

Det här kommandot hämtar alla nycklar som tidigare har tagits bort, men inte rensats, i nyckelvalvet med namnet Contoso.

Exempel 6: Hämtar nyckeln ITPfx som har tagits bort men inte rensats för det här nyckelvalvet.

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                 :

Det här kommandot hämtar nyckeltest3 som tidigare har tagits bort, men inte rensats, i nyckelvalvet med namnet Contoso. Det här kommandot returnerar metadata, till exempel borttagningsdatumet och det schemalagda rensningsdatumet för den borttagna nyckeln.

Exempel 7: Hämta alla nycklar i ett nyckelvalv med filtrering

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           :

Det här kommandot hämtar alla nycklar i nyckelvalvet med namnet Contoso som börjar med "test".

Exempel 8: Ladda ned en offentlig nyckel som en .pem-fil

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

Du kan ladda ned den offentliga nyckeln för en RSA-nyckel genom att ange parametern -OutFile . Det här är ett steg när du importerar HSM-skyddade nycklar till Azure Key Vault. Se https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys

Parametrar

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure

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

-HsmName

HSM-namn. Cmdleten konstruerar FQDN för en hanterad HSM baserat på namnet och den valda miljön.

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

-HsmObject

HSM-objekt.

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

-HsmResourceId

HSM-resurs-ID.

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

-IncludeVersions

Anger att den här cmdleten hämtar alla versioner av en nyckel. Den aktuella versionen av en nyckel är den första i listan. Om du anger den här parametern måste du också ange parametrarna Namn och Valvnamn . Om du inte anger parametern IncludeVersions hämtar den här cmdleten den aktuella versionen av nyckeln med det angivna namnet.

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

-InputObject

KeyVault-objekt.

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

-InRemovedState

Anger om de tidigare borttagna nycklarna ska visas i utdata

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

-Name

Anger namnet på nyckelpaketet som ska hämtas.

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

-OutFile

Anger den utdatafil som den här cmdleten sparar nyckeln för. Den offentliga nyckeln sparas som standard i PEM-format.

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

-ResourceId

KeyVault-resurs-ID.

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

-VaultName

Anger namnet på nyckelvalvet som den här cmdleten hämtar nycklar från. Den här cmdleten konstruerar det fullständigt kvalificerade domännamnet (FQDN) för ett nyckelvalv baserat på det namn som den här parametern anger och din valda miljö.

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

-Version

Anger nyckelversionen. Den här cmdleten konstruerar FQDN för en nyckel baserat på nyckelvalvets namn, din aktuella miljö, nyckelnamnet och nyckelversionen.

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

Indata

PSKeyVault

String

Utdata

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey

Get-AzKeyVaultKey

Syntax

Description

Exempel

Exempel 1: Hämta alla nycklar i ett nyckelvalv

Exempel 2: Hämta den aktuella versionen av en nyckel

Exempel 3: Hämta alla versioner av en nyckel

Exempel 4: Hämta en specifik version av en nyckel

Exempel 5: Hämta alla nycklar som har tagits bort men inte rensats för det här nyckelvalvet

Exempel 6: Hämtar nyckeln ITPfx som har tagits bort men inte rensats för det här nyckelvalvet.

Exempel 7: Hämta alla nycklar i ett nyckelvalv med filtrering

Exempel 8: Ladda ned en offentlig nyckel som en .pem-fil

Parametrar

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Indata

Utdata

Feedback

Ytterligare resurser

Get-AzKeyVaultKey

Syntax

Description

Exempel

Exempel 1: Hämta alla nycklar i ett nyckelvalv

Exempel 2: Hämta den aktuella versionen av en nyckel

Exempel 3: Hämta alla versioner av en nyckel

Exempel 4: Hämta en specifik version av en nyckel

Exempel 5: Hämta alla nycklar som har tagits bort men inte rensats för det här nyckelvalvet

Exempel 6: Hämtar nyckeln ITPfx som har tagits bort men inte rensats för det här nyckelvalvet.

Exempel 7: Hämta alla nycklar i ett nyckelvalv med filtrering

Exempel 8: Ladda ned en offentlig nyckel som en .pem-fil

Parametrar

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Indata

Utdata

Relaterade länkar

Feedback

Ytterligare resurser