Get-AzKeyVaultKey
Získá Key Vault klíče. 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
ByVaultName (Výchozí)
Get-AzKeyVaultKey
[-VaultName] <String>
[[-Name] <String>]
[-InRemovedState]
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByKeyName
Get-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[-Version] <String>
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByKeyVersions
Get-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[-IncludeVersions]
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
HsmByKeyName
Get-AzKeyVaultKey
[-Name] <String>
[-Version] <String>
-HsmName <String>
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
HsmByVaultName
Get-AzKeyVaultKey
[[-Name] <String>]
-HsmName <String>
[-InRemovedState]
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
HsmByKeyVersions
Get-AzKeyVaultKey
[-Name] <String>
-HsmName <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>]
ByResourceIdVaultName
Get-AzKeyVaultKey
[[-Name] <String>]
-ResourceId <String>
[-InRemovedState]
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByResourceIdKeyName
Get-AzKeyVaultKey
[-Name] <String>
[-Version] <String>
-ResourceId <String>
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ByResourceIdKeyVersions
Get-AzKeyVaultKey
[-Name] <String>
-ResourceId <String>
[-IncludeVersions]
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
HsmByResourceIdVaultName
Get-AzKeyVaultKey
[[-Name] <String>]
-HsmResourceId <String>
[-InRemovedState]
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
HsmByResourceIdKeyName
Get-AzKeyVaultKey
[-Name] <String>
[-Version] <String>
-HsmResourceId <String>
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
HsmByResourceIdKeyVersions
Get-AzKeyVaultKey
[-Name] <String>
-HsmResourceId <String>
[-IncludeVersions]
[-OutFile <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Rutina Get-AzKeyVaultKey získá klíče 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
Parametry
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure
Vlastnosti parametru
Typ: IAzureContextContainer
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: AzContext, AzureRmContext, AzureCredential
Sady parametrů
(All)
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: 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í.
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
HsmByKeyName
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByVaultName
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
-HsmObject
Objekt HSM.
Vlastnosti parametru
Typ: PSManagedHsm
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
HsmByInputObjectVaultName
Position: 0
Povinné: True
Hodnota z kanálu: True
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByInputObjectKeyName
Position: 0
Povinné: True
Hodnota z kanálu: True
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByInputObjectKeyVersions
Position: 0
Povinné: True
Hodnota z kanálu: True
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
-HsmResourceId
ID prostředku HSM.
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
HsmByResourceIdVaultName
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
HsmByResourceIdKeyName
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
HsmByResourceIdKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: 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 .
Vlastnosti parametru
Typ: SwitchParameter
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
ByKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByInputObjectKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByInputObjectKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByResourceIdKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByResourceIdKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
KeyVault – objekt.
Typ: PSKeyVault
Default value: None
Podporuje zástupné znaky: False
DontShow: False
ByInputObjectVaultName
Position: 0
Povinné: True
Hodnota z kanálu: True
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByInputObjectKeyName
Position: 0
Povinné: True
Hodnota z kanálu: True
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByInputObjectKeyVersions
Position: 0
Povinné: True
Hodnota z kanálu: True
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
-InRemovedState
Určuje, jestli se mají ve výstupu zobrazit dříve odstraněné klíče.
Vlastnosti parametru
Typ: SwitchParameter
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
ByVaultName
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByVaultName
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByInputObjectVaultName
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByInputObjectVaultName
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByResourceIdVaultName
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByResourceIdVaultName
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
-Name
Určuje název sady klíčů, který se má získat.
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: True
DontShow: False
Aliasy: Název klíče
Sady parametrů
ByVaultName
Position: 1
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByVaultName
Position: 1
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByInputObjectVaultName
Position: 1
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByInputObjectVaultName
Position: 1
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByResourceIdVaultName
Position: 1
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByResourceIdVaultName
Position: 1
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
-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.
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
(All)
Position: Named
Povinné: False
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
-ResourceId
ID prostředku služby KeyVault
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
ByResourceIdVaultName
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
ByResourceIdKeyName
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: False
ByResourceIdKeyVersions
Position: Named
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: True
Hodnota ze zbývajících argumentů: 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í.
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Sady parametrů
ByVaultName
Position: 0
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByKeyName
Position: 0
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByKeyVersions
Position: 0
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: 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.
Vlastnosti parametru
Typ: String
Default value: None
Podporuje zástupné znaky: False
DontShow: False
Aliasy: KlíčováVerze
Sady parametrů
ByKeyName
Position: 2
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByKeyName
Position: 2
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByInputObjectKeyName
Position: 2
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByInputObjectKeyName
Position: 2
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
ByResourceIdKeyName
Position: 2
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
HsmByResourceIdKeyName
Position: 2
Povinné: True
Hodnota z kanálu: False
Hodnota z kanálu podle názvu vlastnosti: False
Hodnota ze zbývajících argumentů: False
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters .
Výstupy