Vaults - Get

參考

Service:: Key Vault

API Version:: 2022-07-01

取得指定的 Azure 金鑰保存庫。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}?api-version=2022-07-01

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string	保存庫所屬的資源群組名稱。
subscriptionId	path	True	string	可唯一識別 Microsoft Azure 訂用帳戶的訂用帳戶認證。訂用帳戶識別碼會構成每個服務呼叫 URI 的一部分。
vaultName	path	True	string	保存庫的名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	Vault	擷取的保存庫
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

範例

Retrieve a vault

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python get_vault.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.vaults.get(
        resource_group_name="sample-resource-group",
        vault_name="sample-vault",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/getVault.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-resource-group/providers/Microsoft.KeyVault/vaults/sample-vault",
  "name": "sample-vault",
  "type": "Microsoft.KeyVault/vaults",
  "location": "westus",
  "tags": {},
  "systemData": {
    "createdBy": "keyVaultUser1",
    "createdByType": "User",
    "createdAt": "2020-01-01T12:00:00.0000000Z",
    "lastModifiedBy": "keyVaultUser2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-01T12:00:00.0000000Z"
  },
  "properties": {
    "sku": {
      "family": "A",
      "name": "standard"
    },
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt",
            "decrypt",
            "wrapKey",
            "unwrapKey",
            "sign",
            "verify",
            "get",
            "list",
            "create",
            "update",
            "import",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "secrets": [
            "get",
            "list",
            "set",
            "delete",
            "backup",
            "restore",
            "recover",
            "purge"
          ],
          "certificates": [
            "get",
            "list",
            "delete",
            "create",
            "import",
            "update",
            "managecontacts",
            "getissuers",
            "listissuers",
            "setissuers",
            "deleteissuers",
            "manageissuers",
            "recover",
            "purge"
          ]
        }
      }
    ],
    "enabledForDeployment": true,
    "enabledForDiskEncryption": true,
    "enabledForTemplateDeployment": true,
    "hsmPoolResourceId": "00000000-0000-0000-0000-000000000000",
    "vaultUri": "https://sample-vault.vault.azure.net",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "Enabled"
  }
}

定義

名稱	Description
AccessPolicyEntry	可存取金鑰保存庫的身分識別。陣列中的所有身分識別都必須使用與密鑰保存庫租使用者識別元相同的租用戶標識碼。
ActionsRequired	訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。
CertificatePermissions	憑證的許可權
CloudError	金鑰保存庫資源提供者的錯誤回應
CloudErrorBody	金鑰保存庫資源提供者的錯誤回應
CreateMode	保存庫的建立模式，指出保存庫是否需要復原。
identityType	建立金鑰保存庫資源的身分識別類型。
IPRule	從特定IP位址或IP範圍控管保存庫的輔助功能規則。
KeyPermissions	金鑰的許可權
NetworkRuleAction	沒有來自ipRules和 virtualNetworkRules 的規則相符時的預設動作。這只有在評估略過屬性之後才會使用。
NetworkRuleBypassOptions	告知哪些流量可以略過網路規則。這可以是 'AzureServices' 或 'None'。如果未指定，則預設值為『AzureServices』。
NetworkRuleSet	一組規則，控管保存庫的網路存取範圍。
Permissions	身分識別具有金鑰、秘密、憑證和記憶體的許可權。
PrivateEndpoint	私人端點對象屬性。
PrivateEndpointConnectionItem	私人端點連線專案。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	物件，表示私人連結連線的核准狀態。
SecretPermissions	秘密的許可權
Sku	SKU 詳細資料
SkuFamily	SKU 系列名稱
SkuName	指定金鑰保存庫是標準保存庫還是進階保存庫的 SKU 名稱。
StoragePermissions	記憶體帳戶的許可權
SystemData	關於建立和上次修改金鑰保存庫資源的元數據。
Vault	具有擴充詳細數據的資源資訊。
VaultProperties	保存庫的屬性
VaultProvisioningState	保存庫的布建狀態。
VirtualNetworkRule	規則，控管來自特定虛擬網路之保存庫的存取範圍。

AccessPolicyEntry

可存取金鑰保存庫的身分識別。陣列中的所有身分識別都必須使用與密鑰保存庫租使用者識別元相同的租用戶標識碼。

名稱	類型	Description
applicationId	string	代表主體提出要求之用戶端的應用程式標識碼
objectId	string	保存庫 Azure Active Directory 租用戶中用戶、服務主體或安全組的物件標識碼。存取原則清單的物件識別碼必須是唯一的。
permissions	Permissions	身分識別具有金鑰、秘密和憑證的許可權。
tenantId	string	應該用來驗證金鑰保存庫要求的 Azure Active Directory 租使用者識別碼。

ActionsRequired

訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。

名稱	類型	Description
None	string

CertificatePermissions

憑證的許可權

名稱	類型	Description
all	string
backup	string
create	string
delete	string
deleteissuers	string
get	string
getissuers	string
import	string
list	string
listissuers	string
managecontacts	string
manageissuers	string
purge	string
recover	string
restore	string
setissuers	string
update	string

CloudError

金鑰保存庫資源提供者的錯誤回應

名稱	類型	Description
error	CloudErrorBody	金鑰保存庫資源提供者的錯誤回應

CloudErrorBody

金鑰保存庫資源提供者的錯誤回應

名稱	類型	Description
code	string	錯誤碼。這是可透過程序設計方式取用的助記鍵。
message	string	使用者易記的錯誤訊息。訊息通常是本地化的，而且可能會隨著服務版本而有所不同。

CreateMode

保存庫的建立模式，指出保存庫是否需要復原。

名稱	類型	Description
default	string
recover	string

identityType

建立金鑰保存庫資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

IPRule

從特定IP位址或IP範圍控管保存庫的輔助功能規則。

名稱	類型	Description
value	string	CIDR 表示法中的 IPv4 位址範圍，例如 '124.56.78.91' (簡單 IP 位址) 或 '124.56.78.0/24' (開頭為 124.56.78 的所有地址) 。

KeyPermissions

金鑰的許可權

名稱	類型	Description
all	string
backup	string
create	string
decrypt	string
delete	string
encrypt	string
get	string
getrotationpolicy	string
import	string
list	string
purge	string
recover	string
release	string
restore	string
rotate	string
setrotationpolicy	string
sign	string
unwrapKey	string
update	string
verify	string
wrapKey	string

NetworkRuleAction

沒有來自ipRules和 virtualNetworkRules 的規則相符時的預設動作。這只有在評估略過屬性之後才會使用。

名稱	類型	Description
Allow	string
Deny	string

NetworkRuleBypassOptions

告知哪些流量可以略過網路規則。這可以是 'AzureServices' 或 'None'。如果未指定，則預設值為『AzureServices』。

名稱	類型	Description
AzureServices	string
None	string

NetworkRuleSet

一組規則，控管保存庫的網路存取範圍。

名稱	類型	Description
bypass	NetworkRuleBypassOptions	告知哪些流量可以略過網路規則。這可以是 'AzureServices' 或 'None'。如果未指定，則預設值為『AzureServices』。
defaultAction	NetworkRuleAction	沒有來自ipRules和 virtualNetworkRules 的規則相符時的預設動作。這只有在評估略過屬性之後才會使用。
ipRules	IPRule[]	IP 位址規則的清單。
virtualNetworkRules	VirtualNetworkRule[]	虛擬網路規則的清單。

Permissions

身分識別具有金鑰、秘密、憑證和記憶體的許可權。

名稱	類型	Description
certificates	CertificatePermissions[]	憑證的許可權
keys	KeyPermissions[]	金鑰的許可權
secrets	SecretPermissions[]	秘密的許可權
storage	StoragePermissions[]	記憶體帳戶的許可權

PrivateEndpoint

私人端點對象屬性。

名稱	類型	Description
id	string	私人端點資源的完整標識碼。

PrivateEndpointConnectionItem

私人端點連線專案。

名稱	類型	Description
etag	string	每當私人端點連線的狀態有所變更時，就會進行修改。
id	string	私人端點聯機的標識碼。
properties.privateEndpoint	PrivateEndpoint	私人端點對象的屬性。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	私人連結連線的核准狀態。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	私人端點聯機的布建狀態。

PrivateEndpointConnectionProvisioningState

目前的布建狀態。

名稱	類型	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。

名稱	類型	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

物件，表示私人連結連線的核准狀態。

名稱	類型	Description
actionsRequired	ActionsRequired	訊息，指出服務提供者上的變更是否需要在取用者上進行任何更新。
description	string	核准或拒絕的原因。
status	PrivateEndpointServiceConnectionStatus	指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。

SecretPermissions

秘密的許可權

名稱	類型	Description
all	string
backup	string
delete	string
get	string
list	string
purge	string
recover	string
restore	string
set	string

Sku

SKU 詳細資料

名稱	類型	Description
family	SkuFamily	SKU 系列名稱
name	SkuName	指定金鑰保存庫是標準保存庫還是進階保存庫的 SKU 名稱。

SkuFamily

SKU 系列名稱

名稱	類型	Description
A	string

SkuName

指定金鑰保存庫是標準保存庫還是進階保存庫的 SKU 名稱。

名稱	類型	Description
premium	string
standard	string

StoragePermissions

記憶體帳戶的許可權

名稱	類型	Description
all	string
backup	string
delete	string
deletesas	string
get	string
getsas	string
list	string
listsas	string
purge	string
recover	string
regeneratekey	string
restore	string
set	string
setsas	string
update	string

SystemData

關於建立和上次修改金鑰保存庫資源的元數據。

名稱	類型	Description
createdAt	string	金鑰保存庫資源建立的時間戳 (UTC) 。
createdBy	string	建立金鑰保存庫資源的身分識別。
createdByType	identityType	建立金鑰保存庫資源的身分識別類型。
lastModifiedAt	string	金鑰保存庫資源上次修改的時間戳 (UTC) 。
lastModifiedBy	string	上次修改金鑰保存庫資源的身分識別。
lastModifiedByType	identityType	上次修改金鑰保存庫資源的身分識別類型。

Vault

具有擴充詳細數據的資源資訊。

名稱	類型	Description
id	string	金鑰保存庫資源的完整識別碼。
location	string	金鑰保存庫資源的 Azure 位置。
name	string	金鑰保存庫資源的名稱。
properties	VaultProperties	保存庫的屬性
systemData	SystemData	金鑰保存庫的系統元數據。
tags	object	指派給金鑰保存庫資源的標記。
type	string	金鑰保存庫資源的資源類型。

VaultProperties

保存庫的屬性

名稱	類型	預設值	Description
accessPolicies	AccessPolicyEntry[]		具有金鑰保存庫存取權的 0 到 1024 身分識別陣列。陣列中的所有身分識別都必須使用與密鑰保存庫租使用者識別元相同的租用戶標識碼。當設定為 `recover`時`createMode`，不需要存取原則。否則，需要存取原則。
createMode	CreateMode		保存庫的建立模式，指出保存庫是否需要復原。
enablePurgeProtection	boolean		屬性，指定是否為此保存庫啟用清除保護。將此屬性設定為 true 會啟用保護，以防止清除此保存庫及其內容，只有金鑰保存庫服務可能會起始硬式且無法復原的刪除。只有在同時啟用虛刪除時，此設定才有效。啟用這項功能是無法復原的，也就是說，屬性不接受 false 做為其值。
enableRbacAuthorization	boolean	False	控制數據動作授權方式的屬性。如果為 true，金鑰保存庫將會使用角色型存取控制 (RBAC) 來授權數據動作，而且將會忽略保存庫屬性中指定的存取原則。若為 false，金鑰保存庫將會使用保存庫屬性中指定的存取原則，而且會忽略儲存在 Azure Resource Manager 上的任何原則。如果為 null 或未指定，則會使用預設值 false 建立保存庫。請注意，管理動作一律會獲得 RBAC 的授權。
enableSoftDelete	boolean	True	屬性，指定此金鑰保存庫是否啟用「虛刪除」功能。如果未在建立新的密鑰保存庫時設定為任何值， (true 或 false) ，則預設會將其設定為 true。設定為 true 之後，就無法將它還原為 false。
enabledForDeployment	boolean		屬性，指定是否允許 Azure 虛擬機器從金鑰保存庫擷取儲存為秘密的憑證。
enabledForDiskEncryption	boolean		屬性，指定是否允許 Azure 磁碟加密從保存庫擷取秘密和解除包裝密鑰。
enabledForTemplateDeployment	boolean		屬性，指定是否允許 Azure Resource Manager 從金鑰保存庫擷取秘密。
hsmPoolResourceId	string		HSM 集區的資源標識碼。
networkAcls	NetworkRuleSet		規則，控管來自特定網路位置之密鑰保存庫的存取範圍。
privateEndpointConnections	PrivateEndpointConnectionItem[]		與金鑰保存庫相關聯的私人端點連線清單。
provisioningState	VaultProvisioningState		保存庫的布建狀態。
publicNetworkAccess	string	enabled	屬性，指定保存庫是否接受來自公用因特網的流量。如果設定為「已停用」所有流量，但私人端點流量除外，且來自受信任服務的流量將會遭到封鎖。這會覆寫設定的防火牆規則，這表示即使防火牆規則存在，我們也不會接受規則。
sku	Sku		SKU 詳細資料
softDeleteRetentionInDays	integer	90	softDelete 數據保留天數。它接受 >=7 和 <=90。
tenantId	string		應該用來驗證金鑰保存庫要求的 Azure Active Directory 租使用者識別碼。
vaultUri	string		保存庫的 URI，用於對金鑰和秘密執行作業。

VaultProvisioningState

保存庫的布建狀態。

名稱	類型	Description
RegisteringDns	string
Succeeded	string

VirtualNetworkRule

規則，控管來自特定虛擬網路之保存庫的存取範圍。

名稱	類型	Description
id	string	vnet 子網的完整資源標識符，例如 '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'。
ignoreMissingVnetServiceEndpoint	boolean	屬性，指定 NRP 是否會忽略是否已設定 serviceEndpoints 父子網的檢查。