Private Endpoint Connections - Update

Ссылка

Service:: AKS

API Version:: 2024-02-01

Обновления подключение к частной конечной точке.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
privateEndpointConnectionName	path	True	string	Имя подключения к частной конечной точке.
resourceGroupName	path	True	string	Имя группы ресурсов. Регистр букв в имени не учитывается.
resourceName	path	True	string	Имя ресурса управляемого кластера. Regex pattern: `^[a-zA-Z0-9]$\|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$`
subscriptionId	path	True	string uuid	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string	Версия API, используемая для данной операции.

Текст запроса

Имя	Обязательно	Тип	Описание
properties.privateLinkServiceConnectionState	True	PrivateLinkServiceConnectionState	Коллекция сведений о состоянии соединения между потребителем службы и поставщиком.
properties.privateEndpoint		PrivateEndpoint	Ресурс частной конечной точки.

Ответы

Имя	Тип	Описание
200 OK	PrivateEndpointConnection	Существующее подключение к частной конечной точке успешно обновлено.
201 Created	PrivateEndpointConnection	Новое подключение к частной конечной точке успешно создано.
Other Status Codes	CloudError	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update Private Endpoint Connection

Sample Request

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

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


import com.azure.resourcemanager.containerservice.fluent.models.PrivateEndpointConnectionInner;
import com.azure.resourcemanager.containerservice.models.ConnectionStatus;
import com.azure.resourcemanager.containerservice.models.PrivateLinkServiceConnectionState;

/**
 * Samples for PrivateEndpointConnections Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/containerservice/resource-manager/Microsoft.ContainerService/aks/stable/2024-02-01/examples/
     * PrivateEndpointConnectionsUpdate.json
     */
    /**
     * Sample code: Update Private Endpoint Connection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updatePrivateEndpointConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.kubernetesClusters().manager().serviceClient().getPrivateEndpointConnections().updateWithResponse("rg1",
            "clustername1", "privateendpointconnection1",
            new PrivateEndpointConnectionInner().withPrivateLinkServiceConnectionState(
                new PrivateLinkServiceConnectionState().withStatus(ConnectionStatus.APPROVED)),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

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/2024-02-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

Sample Response

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

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

Определения

Имя	Описание
CloudError	Ответ об ошибке от службы контейнеров.
CloudErrorBody	Ответ об ошибке от службы контейнеров.
ConnectionStatus	Состояние подключения службы приватного канала.
PrivateEndpoint	Частная конечная точка, к которой принадлежит подключение.
PrivateEndpointConnection	Подключение к частной конечной точке
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала.

CloudError

Ответ об ошибке от службы контейнеров.

Имя	Тип	Описание
error	CloudErrorBody	Сведения об ошибке.

CloudErrorBody

Ответ об ошибке от службы контейнеров.

Имя	Тип	Описание
code	string	Идентификатор ошибки. Коды инвариантны и предназначены для программного использования.
details	CloudErrorBody[]	Список дополнительных сведений об ошибке.
message	string	Сообщение с описанием ошибки, предназначенное для отображения в пользовательском интерфейсе.
target	string	Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

ConnectionStatus

Состояние подключения службы приватного канала.

Имя	Тип	Описание
Approved	string
Disconnected	string
Pending	string
Rejected	string