Get-AzKeyVault

  • Reference
Modul:
Az.KeyVault

Získá trezory klíčů.

Syntaxe

Get-AzKeyVault
   [[-VaultName] <String>]
   [[-ResourceGroupName] <String>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]
Get-AzKeyVault
   [-VaultName] <String>
   [-Location] <String>
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]
Get-AzKeyVault
   [-InRemovedState]
   [-DefaultProfile <IAzureContextContainer>]
   [-SubscriptionId <String>]
   [<CommonParameters>]

Description

Rutina Get-AzKeyVault získá informace o trezorech klíčů v předplatném. Můžete zobrazit všechny instance trezorů klíčů v předplatném nebo filtrovat výsledky podle skupiny prostředků nebo konkrétního trezoru klíčů. Všimněte si, že i když při získání jednoho trezoru klíčů zadáte skupinu prostředků, je pro tuto rutinu volitelná, měli byste to udělat kvůli lepšímu výkonu.

Rutina může volat pod rozhraním Microsoft Graph API podle vstupních parametrů:

  • GET /directoryObjects/{id}
  • GET /users/{id}
  • GET /servicePrincipals/{id}
  • GET /groups/{id}

Příklady

Příklad 1: Získání všech trezorů klíčů v aktuálním předplatném

Get-AzKeyVault

Vault Name          : myvault1
Resource Group Name : myrg
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.Ke
                      yVault/vaults/myvault1
Tags                :


Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Tento příkaz získá všechny trezory klíčů ve vašem aktuálním předplatném.

Příklad 2: Získání konkrétního trezoru klíčů

Get-AzKeyVault -VaultName 'myvault'

Vault Name                       : myvault
Resource Group Name              : myrg
Location                         : westus
Resource ID                      : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers
                                   /Microsoft.KeyVault/vaults/myvault
Vault URI                        : https://myvault.vault.azure.net/
Tenant ID                        : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
SKU                              : Standard
Enabled For Deployment?          : True
Enabled For Template Deployment? : True
Enabled For Disk Encryption?     : False
Soft Delete Enabled?             : True
Access Policies                  :
                                   Tenant ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Object ID                                  : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx
                                   Application ID                             :
                                   Display Name                               : User Name (username@microsoft.com)
                                   Permissions to Keys                        : get, create, delete, list, update,
                                   import, backup, restore, recover
                                   Permissions to Secrets                     : get, list, set, delete, backup,
                                   restore, recover
                                   Permissions to Certificates                : get, delete, list, create, import,
                                   update, deleteissuers, getissuers, listissuers, managecontacts, manageissuers,
                                   setissuers, recover
                                   Permissions to (Key Vault Managed) Storage : delete, deletesas, get, getsas, list,
                                   listsas, regeneratekey, set, setsas, update

Tags                             :

Tento příkaz získá trezor klíčů myvault ve vašem aktuálním předplatném.

Příklad 3: Získání trezorů klíčů ve skupině prostředků

Get-AzKeyVault -ResourceGroupName 'myrg1'

Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Tento příkaz získá všechny trezory klíčů ve skupině prostředků ContosoPayRollResourceGroup.

Příklad 4: Získání všech odstraněných trezorů klíčů v aktuálním předplatném

Get-AzKeyVault -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

Tento příkaz získá všechny odstraněné trezory klíčů ve vašem aktuálním předplatném.

Příklad 5: Získání odstraněného trezoru klíčů

Get-AzKeyVault -VaultName 'myvault4'  -Location 'westus' -InRemovedState

Vault Name           : myvault4
Location             : westus
Id                   : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/providers/Microsoft.KeyVault/locations/westu
                       s/deletedVaults/myvault4
Resource ID          : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg/providers/Microsoft.K
                       eyVault/vaults/myvault4
Deletion Date        : 5/24/2018 9:33:24 PM
Scheduled Purge Date : 8/22/2018 9:33:24 PM
Tags                 :

Tento příkaz získá informace o odstraněném trezoru klíčů myvault4 ve vašem aktuálním předplatném a v oblasti westus.

Příklad 6: Získání trezorů klíčů pomocí filtrování

Get-AzKeyVault -VaultName 'myvault*'

Vault Name          : myvault2
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault2
Tags                :

Vault Name          : myvault3
Resource Group Name : myrg1
Location            : westus
Resource ID         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx/resourceGroups/myrg1/providers/Microsoft.Ke
                      yVault/vaults/myvault3
Tags                :

Tento příkaz získá všechny trezory klíčů v předplatném, které začínají na myvault.

Parametry

-DefaultProfile

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

Typ:IAzureContextContainer
Aliasy:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-InRemovedState

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

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Location

Umístění odstraněného trezoru.

Typ:String
Position:1
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-ResourceGroupName

Určuje název skupiny prostředků přidružené k trezoru klíčů nebo trezorům klíčů, které se dotazují.

Typ:String
Position:1
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:True

-SubscriptionId

ID předplatného. Ve výchozím nastavení se rutiny spouští v předplatném, které je nastavené v aktuálním kontextu. Pokud uživatel určí jiné předplatné, spustí se aktuální rutina v předplatném určeném uživatelem. Přepsání předplatných se projeví jenom během životního cyklu aktuální rutiny. Nezmění předplatné v kontextu a nemá vliv na následné rutiny.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Tag

Páry klíč-hodnota ve formě tabulky hash. Příklad: @{key0="value0"; key1=$null; key2="value2"}

Typ:Hashtable
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-VaultName

Určuje název trezoru klíčů.

Typ:String
Aliasy:Name
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:True

Vstupy

String

Hashtable

Výstupy

PSKeyVault

PSKeyVaultIdentityItem

PSDeletedKeyVault