Private Endpoint Connections - List By Resource

Referencia

Service:: Key Vault

API Version:: 2022-07-01

A List művelet információkat kap a tárolóhoz társított privát végponti kapcsolatokról.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	A kulcstartót tartalmazó erőforráscsoport neve.
subscriptionId	path	True	string	Az előfizetés hitelesítő adatai, amelyek egyedileg azonosítják a Microsoft Azure-előfizetést. Az előfizetés-azonosító az URI részét képezi minden szolgáltatáshíváshoz.
vaultName	path	True	string	A kulcstartó neve. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Client API-verzió.

Válaszok

Name	Típus	Description
200 OK	PrivateEndpointConnectionListResult	A megadott erőforráscsoportban található összes privát végponti kapcsolat adatainak lekérése.
Other Status Codes	CloudError	Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg.

Példák

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
}

Definíciók

Name	Description
ActionsRequired	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
CloudError	Hibaválasz Key Vault erőforrás-szolgáltatótól
CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól
PrivateEndpoint	Privát végpont objektumtulajdonságai.
PrivateEndpointConnection	Privát végpont kapcsolati erőforrása.
PrivateEndpointConnectionListResult	A privát végponti kapcsolatok listája.
PrivateEndpointConnectionProvisioningState	Az aktuális kiépítési állapot.
PrivateEndpointServiceConnectionStatus	A privát végpont kapcsolati állapota.
PrivateLinkServiceConnectionState	Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli.

ActionsRequired

Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.

Name	Típus	Description
None	string

CloudError

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
error	CloudErrorBody	Hibaválasz Key Vault erőforrás-szolgáltatótól

CloudErrorBody

Hibaválasz Key Vault erőforrás-szolgáltatótól

Name	Típus	Description
code	string	Hibakód. Ez egy mnemonikus, amely programozott módon fogyasztható.
message	string	Felhasználóbarát hibaüzenet. Az üzenet általában honosított, és a szolgáltatás verziójától függően változhat.

PrivateEndpoint

Privát végpont objektumtulajdonságai.

Name	Típus	Description
id	string	A privát végponti erőforrás teljes azonosítója.

PrivateEndpointConnection

Privát végpont kapcsolati erőforrása.

Name	Típus	Description
etag	string	A privát végponti kapcsolat állapotának változásakor módosul.
id	string	A Key Vault-erőforrás teljes azonosítója.
location	string	A Key Vault-erőforrás Azure-beli helye.
name	string	A Key Vault-erőforrás neve.
properties.privateEndpoint	PrivateEndpoint	A privát végpont objektumának tulajdonságai.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	A privát kapcsolat jóváhagyási állapota.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	A privát végponti kapcsolat kiépítési állapota.
tags	object	A Key Vault-erőforráshoz rendelt címkék.
type	string	A Key Vault-erőforrás erőforrástípusa.

PrivateEndpointConnectionListResult

A privát végponti kapcsolatok listája.

Name	Típus	Description
nextLink	string	A privát végponti kapcsolatok következő készletének lekéréséhez szükséges URL-cím.
value	PrivateEndpointConnection[]	A privát végponti kapcsolatok listája.

PrivateEndpointConnectionProvisioningState

Az aktuális kiépítési állapot.

Name	Típus	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

A privát végpont kapcsolati állapota.

Name	Típus	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Egy objektum, amely a privát kapcsolati kapcsolat jóváhagyási állapotát jelöli.

Name	Típus	Description
actionsRequired	ActionsRequired	Üzenet, amely jelzi, hogy a szolgáltató módosításaihoz szükség van-e a fogyasztó frissítésére.
description	string	A jóváhagyás vagy elutasítás oka.
status	PrivateEndpointServiceConnectionStatus	Azt jelzi, hogy a kulcstartó tulajdonosa jóváhagyta, elutasította vagy eltávolította-e a kapcsolatot.