Private Endpoint Connections - Create Or Update

Approve or reject a private endpoint connection manually.

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

URI Parameters

Name In Required Type Description
clusterName
path True

string

The name of the cluster.

privateEndpointConnectionName
path True

string

The name of the private endpoint connection.

resourceGroupName
path True

string

The name of the resource group.

subscriptionId
path True

string

The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

api-version
query True

string

The HDInsight client API Version.

Request Body

Name Required Type Description
properties.privateLinkServiceConnectionState True

PrivateLinkServiceConnectionState

The private link service connection state.

Responses

Name Type Description
200 OK

PrivateEndpointConnection

OK response definition.

201 Created

PrivateEndpointConnection

Created response definition

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

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 impersonate your user account

Examples

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

Sample response

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

Definitions

Name Description
createdByType

The type of identity that created the resource.

ErrorResponse

Describes the format of Error response.

PrivateEndpoint

The private endpoint.

PrivateEndpointConnection

The private endpoint connection.

PrivateEndpointConnectionProvisioningState

The provisioning state, which only appears in the response.

PrivateLinkServiceConnectionState

The private link service connection state.

PrivateLinkServiceConnectionStatus

The concrete private link service connection.

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name Type Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorResponse

Describes the format of Error response.

Name Type Description
code

string

Error code

message

string

Error message indicating why the operation failed.

PrivateEndpoint

The private endpoint.

Name Type Description
id

string

The private endpoint id.

PrivateEndpointConnection

The private endpoint connection.

Name Type Description
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.linkIdentifier

string

The link identifier.

properties.privateEndpoint

PrivateEndpoint

The private endpoint of the private endpoint connection

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

The private link service connection state.

properties.provisioningState

PrivateEndpointConnectionProvisioningState

The provisioning state, which only appears in the response.

systemData

systemData

Metadata pertaining to creation and last modification of the resource.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProvisioningState

The provisioning state, which only appears in the response.

Name Type Description
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

Updating

string

PrivateLinkServiceConnectionState

The private link service connection state.

Name Type Description
actionsRequired

string

Whether there is further actions.

description

string

The optional description of the status.

status

PrivateLinkServiceConnectionStatus

The concrete private link service connection.

PrivateLinkServiceConnectionStatus

The concrete private link service connection.

Name Type Description
Approved

string

Pending

string

Rejected

string

Removed

string

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.