Get-AzKeyVault

參考

模組:: Az.KeyVault

取得金鑰保存庫。

語法

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

Get-AzKeyVault Cmdlet 會取得訂用帳戶中密鑰保存庫的相關信息。您可以檢視訂用帳戶中的所有金鑰保存庫實例，或依資源群組或特定金鑰保存庫篩選結果。請注意，雖然當您取得單一密鑰保存庫時，指定此 Cmdlet 的資源群組是選擇性的，但您應該這樣做以獲得更好的效能。

Cmdlet 可能會根據輸入參數呼叫下列Microsoft圖形 API：

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

範例

範例 1：取得您目前訂用帳戶中的所有金鑰保存庫

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                :

此命令會取得您目前訂用帳戶中的所有金鑰保存庫。

範例 2：取得特定金鑰保存庫

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                             :

此命令會取得目前訂用帳戶中名為 myvault 的密鑰保存庫。

範例 3：取得資源群組中的金鑰保存庫

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                :

此命令會取得資源群組中名為 ContosoPayRollResourceGroup 的所有密鑰保存庫。

範例 4：取得目前訂用帳戶中所有已刪除的金鑰保存庫

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                 :

此命令會取得您目前訂用帳戶中所有已刪除的金鑰保存庫。

範例 5：取得已刪除的金鑰保存庫

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                 :

此命令會取得目前訂用帳戶和westus區域中名為 myvault4 的已刪除金鑰保存庫資訊。

範例 6：使用篩選取得金鑰保存庫

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                :

此命令會取得以「myvault」開頭的訂用帳戶中的所有密鑰保存庫。

參數

-DefaultProfile

用於與 azure 通訊的認證、帳戶、租用戶和訂用帳戶

類型:	IAzureContextContainer
別名:	AzContext, AzureRmContext, AzureCredential
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InRemovedState

指定是否要在輸出中顯示先前刪除的保存庫。

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	False
接受萬用字元:	False

-Location

已刪除保存庫的位置。

類型:	String
Position:	1
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-ResourceGroupName

指定與要查詢之金鑰保存庫或金鑰保存庫相關聯的資源組名。

類型:	String
Position:	1
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	True

-SubscriptionId

訂用帳戶的標識碼。根據預設，Cmdlet 會在目前內容中設定的訂用帳戶中執行。如果使用者指定另一個訂用帳戶，則會在使用者指定的訂用帳戶中執行目前的 Cmdlet。覆寫訂閱只會在目前 Cmdlet 的生命週期內生效。它不會變更內容中的訂用帳戶，而且不會影響後續的 Cmdlet。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Tag

哈希表形式的索引鍵/值組。例如：@{key0=“value0”;key1=$null;key2=“value2”}

類型:	Hashtable
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-VaultName

指定金鑰保存庫的名稱。

類型:	String
別名:	Name
Position:	0
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	True

輸入

String

Hashtable

輸出

PSKeyVault

PSKeyVaultIdentityItem

PSDeletedKeyVault

共用方式為

Get-AzKeyVault

語法

Description

範例

範例 1：取得您目前訂用帳戶中的所有金鑰保存庫

範例 2：取得特定金鑰保存庫

範例 3：取得資源群組中的金鑰保存庫

範例 4：取得目前訂用帳戶中所有已刪除的金鑰保存庫

範例 5：取得已刪除的金鑰保存庫

範例 6：使用篩選取得金鑰保存庫

參數

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-SubscriptionId

-Tag

-VaultName

輸入

輸出

其他資源

共用方式為

Get-AzKeyVault

語法

Description

範例

範例 1：取得您目前訂用帳戶中的所有金鑰保存庫

範例 2：取得特定金鑰保存庫

範例 3：取得資源群組中的金鑰保存庫

範例 4：取得目前訂用帳戶中所有已刪除的金鑰保存庫

範例 5：取得已刪除的金鑰保存庫

範例 6：使用篩選取得金鑰保存庫

參數

-DefaultProfile

-InRemovedState

-Location

-ResourceGroupName

-SubscriptionId

-Tag

-VaultName

輸入

輸出

相關連結

其他資源