Private Endpoint Connections - Create Or Update

Ссылка

Service:: HDInsight

API Version:: 2021-06-01

Утверждение или отклонение подключения к частной конечной точке вручную.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2021-06-01

Параметры URI

Name	In	Required	Type	Description
clusterName	path	True	string	Имя кластера.
privateEndpointConnectionName	path	True	string	Имя подключения к частной конечной точке.
resourceGroupName	path	True	string	Имя группы ресурсов.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют Microsoft Azure подписке. Идентификатор подписки формирует часть URI для каждого вызова службы.
api-version	query	True	string	Версия API клиента HDInsight.

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

Name	Required	Type	Description
properties.privateLinkServiceConnectionState	True	PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала.

Ответы

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

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

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	олицетворения учетной записи пользователя

Примеры

Approve a private endpoint connection manually.

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateEndpointConnections/testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2?api-version=2021-06-01

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "update it from pending to approved.",
      "actionsRequired": "None"
    }
  }
}

import com.azure.resourcemanager.hdinsight.models.PrivateLinkServiceConnectionState;
import com.azure.resourcemanager.hdinsight.models.PrivateLinkServiceConnectionStatus;

/** Samples for PrivateEndpointConnections CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/ApprovePrivateEndpointConnection.json
     */
    /**
     * Sample code: Approve a private endpoint connection manually.
     *
     * @param manager Entry point to HDInsightManager.
     */
    public static void approveAPrivateEndpointConnectionManually(
        com.azure.resourcemanager.hdinsight.HDInsightManager manager) {
        manager
            .privateEndpointConnections()
            .define("testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2")
            .withExistingCluster("rg1", "cluster1")
            .withPrivateLinkServiceConnectionState(
                new PrivateLinkServiceConnectionState()
                    .withStatus(PrivateLinkServiceConnectionStatus.APPROVED)
                    .withDescription("update it from pending to approved.")
                    .withActionsRequired("None"))
            .create();
    }
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

package armhdinsight_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/hdinsight/armhdinsight"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2021-06-01/examples/ApprovePrivateEndpointConnection.json
func ExamplePrivateEndpointConnectionsClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armhdinsight.NewPrivateEndpointConnectionsClient("subid", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := client.BeginCreateOrUpdate(ctx,
		"rg1",
		"cluster1",
		"testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
		armhdinsight.PrivateEndpointConnection{
			Properties: &armhdinsight.PrivateEndpointConnectionProperties{
				PrivateLinkServiceConnectionState: &armhdinsight.PrivateLinkServiceConnectionState{
					Description:     to.Ptr("update it from pending to approved."),
					ActionsRequired: to.Ptr("None"),
					Status:          to.Ptr(armhdinsight.PrivateLinkServiceConnectionStatusApproved),
				},
			},
		},
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// TODO: use response item
	_ = res
}

Read this SDK documentation on how to add the SDK to your project and authenticate.

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateEndpointConnections/testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
  "name": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
  "type": "Microsoft.HDInsight/clusters/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testprivateep"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "update it from pending to approved.",
      "actionsRequired": "None"
    },
    "linkIdentifier": "620815036",
    "provisioningState": "Succeeded"
  }
}

Status code:: 201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateEndpointConnections/testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
  "name": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
  "type": "Microsoft.HDInsight/clusters/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testprivateep"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "update it from pending to approved.",
      "actionsRequired": "None"
    },
    "linkIdentifier": "620815036",
    "provisioningState": "Succeeded"
  }
}

Определения

createdByType	Тип удостоверения, создавшего ресурс.
ErrorResponse	Описывает формат ответа на ошибку.
PrivateEndpoint	Частная конечная точка.
PrivateEndpointConnection	Подключение к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Состояние подготовки, которое отображается только в ответе.
PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала.
PrivateLinkServiceConnectionStatus	Конкретное подключение службы приватного канала.
systemData	Метаданные, относящиеся к созданию и последнему модификации ресурса.

createdByType

Тип удостоверения, создавшего ресурс.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorResponse

Описывает формат ответа на ошибку.

Name	Type	Description
code	string	Код ошибки
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

PrivateEndpoint

Частная конечная точка.

Name	Type	Description
id	string	Идентификатор частной конечной точки.

PrivateEndpointConnection

Подключение к частной конечной точке.

Name	Type	Description
id	string	Полный идентификатор ресурса. Например, /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса.
properties.linkIdentifier	string	Идентификатор ссылки.
properties.privateEndpoint	PrivateEndpoint	Частная конечная точка подключения к частной конечной точке
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Состояние подключения службы приватного канала.
properties.provisioningState	PrivateEndpointConnectionProvisioningState	Состояние подготовки, которое отображается только в ответе.
systemData	systemData	Метаданные, относящиеся к созданию и последнему модификации ресурса.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft. служба хранилища/storageAccounts"

PrivateEndpointConnectionProvisioningState

Состояние подготовки, которое отображается только в ответе.

Name	Type	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string
Updating	string

PrivateLinkServiceConnectionState

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

Name	Type	Description
actionsRequired	string	Существуют ли дальнейшие действия.
description	string	Необязательное описание состояния.
status	PrivateLinkServiceConnectionStatus	Конкретное подключение службы приватного канала.

PrivateLinkServiceConnectionStatus

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

Name	Type	Description
Approved	string
Pending	string
Rejected	string
Removed	string

systemData

Метаданные, относящиеся к созданию и последнему модификации ресурса.

Name	Type	Description
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последнее изменение ресурса.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.