Private Endpoint Connections - List By Resource

參考

Service:: Key Vault

API Version:: 2022-07-01

清單作業會取得與保存庫相關聯之私人端點連線的相關信息。

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

URI 參數

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

回應

名稱	類型	Description
200 OK	PrivateEndpointConnectionListResult	取得指定資源群組中所有私人端點連線的相關信息。
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

範例

KeyVaultListPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections?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 list_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.list_by_resource(
        resource_group_name="sample-group",
        vault_name="sample-vault",
    )
    for item in response:
        print(item)


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

{
  "value": [
    {
      "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"
        }
      }
    },
    {
      "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"
        }
      }
    }
  ],
  "nextLink": null
}

定義

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

ActionsRequired

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

名稱	類型	Description
None	string

CloudError

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

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

CloudErrorBody

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

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

PrivateEndpoint

私人端點對象屬性。

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

PrivateEndpointConnection

私人端點聯機資源。

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

PrivateEndpointConnectionListResult

私人端點連線的清單。

名稱	類型	Description
nextLink	string	要取得下一組私人端點連線的URL。
value	PrivateEndpointConnection[]	私人端點連線的清單。

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	指出金鑰保存庫擁有者是否已核准、拒絕或移除連線。