Private Endpoint Connections - Get

Reference

Service:: Key Vault

API Version:: 2022-07-01

Získá zadané připojení privátního koncového bodu přidružené k trezoru klíčů.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
privateEndpointConnectionName	path	True	string	Název připojení privátního koncového bodu přidruženého k trezoru klíčů
resourceGroupName	path	True	string	Název skupiny prostředků, která obsahuje trezor klíčů.
subscriptionId	path	True	string	Přihlašovací údaje předplatného, které jednoznačně identifikují předplatné Microsoft Azure. ID předplatného je součástí identifikátoru URI pro každé volání služby.
vaultName	path	True	string	Název trezoru klíčů. Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	Verze rozhraní API klienta.

Odpovědi

Name	Typ	Description
200 OK	PrivateEndpointConnection	Připojení privátního koncového bodu se úspěšně vrátilo.
204 No Content		Připojení privátního koncového bodu neexistuje.
Other Status Codes	CloudError	Chybová odpověď popisující, proč operace selhala.

Příklady

KeyVaultGetPrivateEndpointConnection

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

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

Sample Response

Status code:: 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"
    }
  }
}

Status code:: 204

Definice

Name	Description
ActionsRequired	Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.
CloudError	Chybová odpověď od poskytovatele prostředků Key Vault
CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault
PrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
PrivateEndpointConnection	Prostředek připojení privátního koncového bodu.
PrivateEndpointConnectionProvisioningState	Aktuální stav zřizování.
PrivateEndpointServiceConnectionStatus	Stav připojení privátního koncového bodu.
PrivateLinkServiceConnectionState	Objekt, který představuje stav schválení připojení privátního propojení.

ActionsRequired

Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.

Name	Typ	Description
None	string

CloudError

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
error	CloudErrorBody	Chybová odpověď od poskytovatele prostředků Key Vault

CloudErrorBody

Chybová odpověď od poskytovatele prostředků Key Vault

Name	Typ	Description
code	string	Kód chyby Jedná se o mnemotechnický objekt, který je možné využívat programově.
message	string	Uživatelsky přívětivá chybová zpráva. Zpráva je obvykle lokalizovaná a může se lišit podle verze služby.

PrivateEndpoint

Vlastnosti objektu privátního koncového bodu.

Name	Typ	Description
id	string	Úplný identifikátor prostředku privátního koncového bodu.

PrivateEndpointConnection

Prostředek připojení privátního koncového bodu.

Name	Typ	Description
etag	string	Změněno vždy, když dojde ke změně stavu připojení privátního koncového bodu.
id	string	Plně kvalifikovaný identifikátor prostředku trezoru klíčů
location	string	Umístění prostředku trezoru klíčů v Azure
name	string	Název prostředku trezoru klíčů
properties.privateEndpoint	PrivateEndpoint	Vlastnosti objektu privátního koncového bodu.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Stav schválení připojení privátního propojení
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Stav zřizování připojení privátního koncového bodu.
tags	object	Značky přiřazené k prostředku trezoru klíčů
type	string	Typ prostředku trezoru klíčů.

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

Name	Typ	Description
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

Name	Typ	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

Objekt, který představuje stav schválení připojení privátního propojení.

Name	Typ	Description
actionsRequired	ActionsRequired	Zpráva s informací, že změny poskytovatele služeb vyžadují aktualizace příjemce.
description	string	Důvod schválení nebo zamítnutí.
status	PrivateEndpointServiceConnectionStatus	Označuje, jestli vlastník trezoru klíčů připojení schválil, odmítl nebo odebral.