Get-AzKeyVaultKey

Reference

Modul:: Az.KeyVault

Získá klíče služby Key Vault. Upozorňujeme, že podrobné informace o klíči, jako je typ klíče nebo velikost klíče, jsou k dispozici pouze při dotazování na konkrétní verzi klíče.

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

Rutina Get-AzKeyVaultKey získá klíče služby Azure Key Vault. Tato rutina získá konkrétní microsoft.Azure.Commands.KeyVault.Models.KeyBundle nebo seznam všech objektů KeyBundle v trezoru klíčů nebo podle verze.

Příklady

Příklad 1: Získání všech klíčů v trezoru klíčů

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           :

Tento příkaz získá všechny klíče v trezoru klíčů s názvem Contoso.

Příklad 2: Získání aktuální verze klíče

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           :

Tento příkaz získá aktuální verzi klíče s názvem test1 v trezoru klíčů s názvem Contoso.

Příklad 3: Získání všech verzí klíče

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           :

Tento příkaz získá všechny verze klíče s názvem ITPfx v trezoru klíčů s názvem Contoso.

Příklad 4: Získání konkrétní verze klíče

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           :

Tento příkaz získá konkrétní verzi klíče s názvem test1 v trezoru klíčů s názvem Contoso. Po spuštění tohoto příkazu můžete zkontrolovat různé vlastnosti klíče tak, že přejdete na objekt $Key.

Příklad 5: Získání všech klíčů, které byly odstraněny, ale nebyly vyprázdněny pro tento trezor klíčů

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                 :

Tento příkaz získá všechny klíče, které byly dříve odstraněny, ale ne vyprázdněné, v trezoru klíčů s názvem Contoso.

Příklad 6: Získá klíč ITPfx, který byl odstraněn, ale není vyprázdněný pro tento trezor klíčů.

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                 :

Tento příkaz získá test klíče, který byl dříve odstraněn, ale není vyprázdněný, v trezoru klíčů s názvem Contoso. Tento příkaz vrátí metadata, jako je datum odstranění, a plánované datum vymazání tohoto odstraněného klíče.

Příklad 7: Získání všech klíčů v trezoru klíčů pomocí filtrování

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           :

Tento příkaz získá všechny klíče v trezoru klíčů s názvem Contoso, který začíná na "test".

Příklad 8: Stažení veřejného klíče jako souboru .pem

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

Veřejný klíč klíče RSA si můžete stáhnout zadáním parametru -OutFile . Jedná se o jeden krok importu klíčů chráněných HSM do služby Azure Key Vault. Viz https://learn.microsoft.com/azure/key-vault/keys/hsm-protected-keys.

Parametry

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure

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

-HsmName

Název HSM. Rutina vytvoří plně kvalifikovaný název domény spravovaného HSM na základě názvu a aktuálně vybraného prostředí.

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

-HsmObject

Objekt HSM.

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

-HsmResourceId

ID prostředku HSM.

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

-IncludeVersions

Označuje, že tato rutina získá všechny verze klíče. Aktuální verze klíče je první verze v seznamu. Pokud zadáte tento parametr, musíte také zadat parametry Name a VaultName . Pokud nezadáte parametr IncludeVersions , získá tato rutina aktuální verzi klíče se zadaným názvem.

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

Určuje, jestli se mají ve výstupu zobrazit dříve odstraněné klíče.

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

-Name

Určuje název sady klíčů, který se má získat.

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

-OutFile

Určuje výstupní soubor, pro který tato rutina klíč uloží. Veřejný klíč se ve výchozím nastavení uloží ve formátu PEM.

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

-ResourceId

ID prostředku služby KeyVault

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

-VaultName

Určuje název trezoru klíčů, ze kterého tato rutina získá klíče. Tato rutina vytvoří plně kvalifikovaný název domény (FQDN) trezoru klíčů na základě názvu, který tento parametr určuje, a vybraného prostředí.

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

-Version

Určuje verzi klíče. Tato rutina vytvoří plně kvalifikovaný název domény klíče na základě názvu trezoru klíčů, aktuálně vybraného prostředí, názvu klíče a verze klíče.

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

Vstupy

PSKeyVault

String

Výstupy

PSKeyVaultKeyIdentityItem

PSKeyVaultKey

PSDeletedKeyVaultKeyIdentityItem

PSDeletedKeyVaultKey

Get-AzKeyVaultKey

Syntax

Description

Příklady

Příklad 1: Získání všech klíčů v trezoru klíčů

Příklad 2: Získání aktuální verze klíče

Příklad 3: Získání všech verzí klíče

Příklad 4: Získání konkrétní verze klíče

Příklad 5: Získání všech klíčů, které byly odstraněny, ale nebyly vyprázdněny pro tento trezor klíčů

Příklad 6: Získá klíč ITPfx, který byl odstraněn, ale není vyprázdněný pro tento trezor klíčů.

Příklad 7: Získání všech klíčů v trezoru klíčů pomocí filtrování

Příklad 8: Stažení veřejného klíče jako souboru .pem

Parametry

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Vstupy

Výstupy

Váš názor

Další materiály

Get-AzKeyVaultKey

Syntax

Description

Příklady

Příklad 1: Získání všech klíčů v trezoru klíčů

Příklad 2: Získání aktuální verze klíče

Příklad 3: Získání všech verzí klíče

Příklad 4: Získání konkrétní verze klíče

Příklad 5: Získání všech klíčů, které byly odstraněny, ale nebyly vyprázdněny pro tento trezor klíčů

Příklad 6: Získá klíč ITPfx, který byl odstraněn, ale není vyprázdněný pro tento trezor klíčů.

Příklad 7: Získání všech klíčů v trezoru klíčů pomocí filtrování

Příklad 8: Stažení veřejného klíče jako souboru .pem

Parametry

-DefaultProfile

-HsmName

-HsmObject

-HsmResourceId

-IncludeVersions

-InputObject

-InRemovedState

-Name

-OutFile

-ResourceId

-VaultName

-Version

Vstupy

Výstupy

Související odkazy

Váš názor

Další materiály