Private Endpoint Connections - Update

Serviço:

AKS

Versão da API:

2025-04-01

Atualiza uma conexão de ponto de extremidade privado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
privateEndpointConnectionName	path	True	string	O nome da conexão de ponto de extremidade privado.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
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]$	O nome do recurso de cluster gerenciado.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
properties.privateLinkServiceConnectionState	True	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
properties.privateEndpoint		PrivateEndpoint	O recurso do ponto de extremidade privado.

Respostas

Nome	Tipo	Description
200 OK	PrivateEndpointConnection	A conexão de ponto de extremidade privado existente foi atualizada com êxito.
201 Created	PrivateEndpointConnection	A nova conexão de ponto de extremidade privado foi criada com êxito.
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Update Private Endpoint Connection

Solicitação de exemplo

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

Resposta de exemplo

Código de status:

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"
  }
}

Código de status:

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"
  }
}

Definições

Nome	Description
CloudError	Uma resposta de erro do serviço contêiner.
CloudErrorBody	Uma resposta de erro do serviço contêiner.
ConnectionStatus	O status da conexão do serviço de link privado.
PrivateEndpoint	Ponto de extremidade privado ao qual uma conexão pertence.
PrivateEndpointConnection	Uma conexão de ponto de extremidade privado
PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
PrivateLinkServiceConnectionState	O estado de uma conexão de serviço de link privado.

CloudError

Objeto

Uma resposta de erro do serviço contêiner.

Nome	Tipo	Description
error	CloudErrorBody	Detalhes sobre o erro.

CloudErrorBody

Objeto

Uma resposta de erro do serviço contêiner.

Nome	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O destino do erro específico. Por exemplo, o nome da propriedade em erro.

ConnectionStatus

Enumeração

O status da conexão do serviço de link privado.

Valor	Description
Approved
Disconnected
Pending
Rejected

PrivateEndpoint

Objeto

Ponto de extremidade privado ao qual uma conexão pertence.

Nome	Tipo	Description
id	string	A ID do recurso do ponto de extremidade privado

PrivateEndpointConnection

Objeto

Uma conexão de ponto de extremidade privado

Nome	Tipo	Description
id	string	A ID da conexão de ponto de extremidade privado.
name	string	O nome da conexão de ponto de extremidade privado.
properties.privateEndpoint	PrivateEndpoint	O recurso do ponto de extremidade privado.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	O estado de provisionamento atual.
type	string	O tipo de recurso.

PrivateEndpointConnectionProvisioningState

Enumeração

O estado de provisionamento atual.

Valor	Description
Canceled
Creating
Deleting
Failed
Succeeded

PrivateLinkServiceConnectionState

Objeto

O estado de uma conexão de serviço de link privado.

Nome	Tipo	Description
description	string	A descrição da conexão do serviço de link privado.
status	ConnectionStatus	O status da conexão do serviço de link privado.