Share via

Microsoft.HDInsight clusters/privateEndpointConnections

  • Article

Bicep resource definition

The clusters/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HDInsight/clusters/privateEndpointConnections resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HDInsight/clusters/privateEndpointConnections@2024-08-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    privateLinkServiceConnectionState: {
      actionsRequired: 'string'
      description: 'string'
      status: 'string'
    }
  }
}

Property values

Microsoft.HDInsight/clusters/privateEndpointConnections

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: clusters
properties The private endpoint connection properties. PrivateEndpointConnectionProperties (required)

PrivateEndpointConnectionProperties

Name Description Value
privateLinkServiceConnectionState The private link service connection state. PrivateLinkServiceConnectionState (required)

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired Whether there is further actions. string
description The optional description of the status. string
status The concrete private link service connection. 'Approved'
'Pending'
'Rejected'
'Removed' (required)

ARM template resource definition

The clusters/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HDInsight/clusters/privateEndpointConnections resource, add the following JSON to your template.

{
  "type": "Microsoft.HDInsight/clusters/privateEndpointConnections",
  "apiVersion": "2024-08-01-preview",
  "name": "string",
  "properties": {
    "privateLinkServiceConnectionState": {
      "actionsRequired": "string",
      "description": "string",
      "status": "string"
    }
  }
}

Property values

Microsoft.HDInsight/clusters/privateEndpointConnections

Name Description Value
apiVersion The api version '2024-08-01-preview'
name The resource name string (required)
properties The private endpoint connection properties. PrivateEndpointConnectionProperties (required)
type The resource type 'Microsoft.HDInsight/clusters/privateEndpointConnections'

PrivateEndpointConnectionProperties

Name Description Value
privateLinkServiceConnectionState The private link service connection state. PrivateLinkServiceConnectionState (required)

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired Whether there is further actions. string
description The optional description of the status. string
status The concrete private link service connection. 'Approved'
'Pending'
'Rejected'
'Removed' (required)

Terraform (AzAPI provider) resource definition

The clusters/privateEndpointConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HDInsight/clusters/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HDInsight/clusters/privateEndpointConnections@2024-08-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      privateLinkServiceConnectionState = {
        actionsRequired = "string"
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

Microsoft.HDInsight/clusters/privateEndpointConnections

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters
properties The private endpoint connection properties. PrivateEndpointConnectionProperties (required)
type The resource type "Microsoft.HDInsight/clusters/privateEndpointConnections@2024-08-01-preview"

PrivateEndpointConnectionProperties

Name Description Value
privateLinkServiceConnectionState The private link service connection state. PrivateLinkServiceConnectionState (required)

PrivateLinkServiceConnectionState

Name Description Value
actionsRequired Whether there is further actions. string
description The optional description of the status. string
status The concrete private link service connection. 'Approved'
'Pending'
'Rejected'
'Removed' (required)