Private Endpoint Connections - Update

Dienst:

AKS

API-Version:

2025-04-01

Aktualisiert eine private Endpunktverbindung.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2025-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
privateEndpointConnectionName	path	True	string	Der Name der privaten Endpunktverbindung.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
resourceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$	Der Name der verwalteten Clusterressource.
subscriptionId	path	True	string (uuid)	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.privateLinkServiceConnectionState	True	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
properties.privateEndpoint		PrivateEndpoint	Die Ressource des privaten Endpunkts.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	Die vorhandene private Endpunktverbindung wurde erfolgreich aktualisiert.
201 Created	PrivateEndpointConnection	Die neue private Endpunktverbindung wurde erfolgreich erstellt.
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Update Private Endpoint Connection

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/privateEndpointConnections/privateendpointconnection1?api-version=2025-04-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved"
    }
  }
}

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.containerservice import ContainerServiceClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-containerservice
# USAGE
    python private_endpoint_connections_update.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 = ContainerServiceClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.private_endpoint_connections.update(
        resource_group_name="rg1",
        resource_name="clustername1",
        private_endpoint_connection_name="privateendpointconnection1",
        parameters={"properties": {"privateLinkServiceConnectionState": {"status": "Approved"}}},
    )
    print(response)


# x-ms-original-file: specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2025-04-01/examples/PrivateEndpointConnectionsUpdate.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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1",
  "name": "privateendpointconnection1",
  "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved"
    },
    "provisioningState": "Succeeded"
  }
}

Statuscode:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ContainerService/managedCluster/clustername1/privateEndpointConnections/privateendpointconnection1",
  "name": "privateendpointconnection1",
  "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved"
    },
    "provisioningState": "Succeeded"
  }
}

Definitionen

Name	Beschreibung
CloudError	Eine Fehlerantwort des Containerdiensts.
CloudErrorBody	Eine Fehlerantwort des Containerdiensts.
ConnectionStatus	Der Verbindungsstatus des privaten Verknüpfungsdiensts.
PrivateEndpoint	Privater Endpunkt, zu dem eine Verbindung gehört.
PrivateEndpointConnection	Eine private Endpunktverbindung
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateLinkServiceConnectionState	Der Status einer Verbindung mit einem privaten Linkdienst.

CloudError

Objekt

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
error	CloudErrorBody	Details zum Fehler.

CloudErrorBody

Objekt

Eine Fehlerantwort des Containerdiensts.

Name	Typ	Beschreibung
code	string	Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details	CloudErrorBody[]	Eine Liste mit zusätzlichen Details zum Fehler.
message	string	Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target	string	Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

ConnectionStatus

Enumeration

Der Verbindungsstatus des privaten Verknüpfungsdiensts.

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Objekt

Privater Endpunkt, zu dem eine Verbindung gehört.

Name	Typ	Beschreibung
id	string	Die Ressourcen-ID des privaten Endpunkts

PrivateEndpointConnection

Objekt

Eine private Endpunktverbindung

Name	Typ	Beschreibung
id	string	Die ID der privaten Endpunktverbindung.
name	string	Der Name der privaten Endpunktverbindung.
properties.privateEndpoint	PrivateEndpoint	Die Ressource des privaten Endpunkts.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
type	string	Der Ressourcentyp.

PrivateEndpointConnectionProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Canceled
Creating
Deleting
Failed
Succeeded

PrivateLinkServiceConnectionState

Objekt

Der Status einer Verbindung mit einem privaten Linkdienst.

Name	Typ	Beschreibung
description	string	Die Verbindungsbeschreibung des privaten Linksdiensts.
status	ConnectionStatus	Der Verbindungsstatus des privaten Verknüpfungsdiensts.