Private Endpoint Connections - Get

服務:

Key Vault

API 版本:

2022-07-01

取得與金鑰保存庫相關聯的指定私人端點連線。

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

URI 參數

名稱	位於	必要	類型	Description
privateEndpointConnectionName	path	True	string	與金鑰保存庫相關聯的私人端點連線名稱。
resourceGroupName	path	True	string	包含金鑰保存庫的資源群組名稱。
subscriptionId	path	True	string	可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	金鑰保存庫的名稱。
api-version	query	True	string	用戶端 API 版本。

回應

名稱	類型	Description
200 OK	PrivateEndpointConnection	已成功傳回私人端點連線。
204 No Content		私人端點連線不存在。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

範例

KeyVaultGetPrivateEndpointConnection

範例要求

HTTP

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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python get_private_endpoint_connection.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.private_endpoint_connections.get(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        private_endpoint_connection_name="sample-pec",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/getPrivateEndpointConnection.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

範例回覆

狀態碼:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
  "etag": "",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

狀態碼:

204

定義

名稱	Description
ActionsRequired	訊息，指出服務提供者上的變更是否需要取用者的任何更新。
CloudError	來自 Key Vault 資源提供者的錯誤回應
CloudErrorBody	來自 Key Vault 資源提供者的錯誤回應
PrivateEndpoint	私人端點對象屬性。
PrivateEndpointConnection	私人端點聯機資源。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。
PrivateLinkServiceConnectionState	物件，表示私人連結連接的核准狀態。

ActionsRequired

列舉型別

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

值	Description
None

CloudError

Object

來自 Key Vault 資源提供者的錯誤回應

名稱	類型	Description
error	CloudErrorBody	來自 Key Vault 資源提供者的錯誤回應

CloudErrorBody

Object

來自 Key Vault 資源提供者的錯誤回應

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

PrivateEndpoint

Object

私人端點對象屬性。

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

PrivateEndpointConnection

Object

私人端點聯機資源。

名稱	類型	Description
etag	string	每當私人端點連線的狀態有所變更時，就會進行修改。
id	string	金鑰保存庫資源的完整識別碼。
location	string	金鑰保存庫資源的 Azure 位置。
name	string	金鑰保存庫資源的名稱。
properties.privateEndpoint	PrivateEndpoint	私人端點對象的屬性。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	私人連結連線的核准狀態。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	布建私人端點連線的狀態。
tags	object	指派給金鑰保存庫資源的標記。
type	string	金鑰保存庫資源的資源類型。

PrivateEndpointConnectionProvisioningState

列舉型別

目前的布建狀態。

值	Description
Creating
Deleting
Disconnected
Failed
Succeeded
Updating

PrivateEndpointServiceConnectionStatus

列舉型別

私人端點連線狀態。

值	Description
Approved
Disconnected
Pending
Rejected

PrivateLinkServiceConnectionState

Object

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

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