azure-native.hdinsight.PrivateEndpointConnection
Explore with Pulumi AI
The private endpoint connection. Azure REST API version: 2021-06-01. Prior API version in Azure Native 1.x: 2021-06-01.
Other available API versions: 2023-04-15-preview, 2023-08-15-preview, 2024-08-01-preview.
Example Usage
Approve a private endpoint connection manually.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.HDInsight.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        ClusterName = "cluster1",
        PrivateEndpointConnectionName = "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
        PrivateLinkServiceConnectionState = new AzureNative.HDInsight.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            ActionsRequired = "None",
            Description = "update it from pending to approved.",
            Status = AzureNative.HDInsight.PrivateLinkServiceConnectionStatus.Approved,
        },
        ResourceGroupName = "rg1",
    });
});
package main
import (
	hdinsight "github.com/pulumi/pulumi-azure-native-sdk/hdinsight/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := hdinsight.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &hdinsight.PrivateEndpointConnectionArgs{
			ClusterName:                   pulumi.String("cluster1"),
			PrivateEndpointConnectionName: pulumi.String("testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2"),
			PrivateLinkServiceConnectionState: &hdinsight.PrivateLinkServiceConnectionStateArgs{
				ActionsRequired: pulumi.String("None"),
				Description:     pulumi.String("update it from pending to approved."),
				Status:          pulumi.String(hdinsight.PrivateLinkServiceConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("rg1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.hdinsight.PrivateEndpointConnection;
import com.pulumi.azurenative.hdinsight.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.hdinsight.inputs.PrivateLinkServiceConnectionStateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var privateEndpointConnection = new PrivateEndpointConnection("privateEndpointConnection", PrivateEndpointConnectionArgs.builder()
            .clusterName("cluster1")
            .privateEndpointConnectionName("testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .actionsRequired("None")
                .description("update it from pending to approved.")
                .status("Approved")
                .build())
            .resourceGroupName("rg1")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const privateEndpointConnection = new azure_native.hdinsight.PrivateEndpointConnection("privateEndpointConnection", {
    clusterName: "cluster1",
    privateEndpointConnectionName: "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
    privateLinkServiceConnectionState: {
        actionsRequired: "None",
        description: "update it from pending to approved.",
        status: azure_native.hdinsight.PrivateLinkServiceConnectionStatus.Approved,
    },
    resourceGroupName: "rg1",
});
import pulumi
import pulumi_azure_native as azure_native
private_endpoint_connection = azure_native.hdinsight.PrivateEndpointConnection("privateEndpointConnection",
    cluster_name="cluster1",
    private_endpoint_connection_name="testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2",
    private_link_service_connection_state={
        "actions_required": "None",
        "description": "update it from pending to approved.",
        "status": azure_native.hdinsight.PrivateLinkServiceConnectionStatus.APPROVED,
    },
    resource_group_name="rg1")
resources:
  privateEndpointConnection:
    type: azure-native:hdinsight:PrivateEndpointConnection
    properties:
      clusterName: cluster1
      privateEndpointConnectionName: testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2
      privateLinkServiceConnectionState:
        actionsRequired: None
        description: update it from pending to approved.
        status: Approved
      resourceGroupName: rg1
Create PrivateEndpointConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);@overload
def PrivateEndpointConnection(resource_name: str,
                              args: PrivateEndpointConnectionArgs,
                              opts: Optional[ResourceOptions] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              cluster_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
                              resource_group_name: Optional[str] = None,
                              private_endpoint_connection_name: Optional[str] = None)func NewPrivateEndpointConnection(ctx *Context, name string, args PrivateEndpointConnectionArgs, opts ...ResourceOption) (*PrivateEndpointConnection, error)public PrivateEndpointConnection(string name, PrivateEndpointConnectionArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)
type: azure-native:hdinsight:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PrivateEndpointConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampleprivateEndpointConnectionResourceResourceFromHdinsight = new AzureNative.HDInsight.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight", new()
{
    ClusterName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.HDInsight.Inputs.PrivateLinkServiceConnectionStateArgs
    {
        Status = "string",
        ActionsRequired = "string",
        Description = "string",
    },
    ResourceGroupName = "string",
    PrivateEndpointConnectionName = "string",
});
example, err := hdinsight.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromHdinsight", &hdinsight.PrivateEndpointConnectionArgs{
	ClusterName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &hdinsight.PrivateLinkServiceConnectionStateArgs{
		Status:          pulumi.String("string"),
		ActionsRequired: pulumi.String("string"),
		Description:     pulumi.String("string"),
	},
	ResourceGroupName:             pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
})
var exampleprivateEndpointConnectionResourceResourceFromHdinsight = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight", PrivateEndpointConnectionArgs.builder()
    .clusterName("string")
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
        .status("string")
        .actionsRequired("string")
        .description("string")
        .build())
    .resourceGroupName("string")
    .privateEndpointConnectionName("string")
    .build());
exampleprivate_endpoint_connection_resource_resource_from_hdinsight = azure_native.hdinsight.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight",
    cluster_name="string",
    private_link_service_connection_state={
        "status": "string",
        "actions_required": "string",
        "description": "string",
    },
    resource_group_name="string",
    private_endpoint_connection_name="string")
const exampleprivateEndpointConnectionResourceResourceFromHdinsight = new azure_native.hdinsight.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromHdinsight", {
    clusterName: "string",
    privateLinkServiceConnectionState: {
        status: "string",
        actionsRequired: "string",
        description: "string",
    },
    resourceGroupName: "string",
    privateEndpointConnectionName: "string",
});
type: azure-native:hdinsight:PrivateEndpointConnection
properties:
    clusterName: string
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionsRequired: string
        description: string
        status: string
    resourceGroupName: string
PrivateEndpointConnection Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PrivateEndpointConnection resource accepts the following input properties:
- ClusterName string
- The name of the cluster.
- PrivateLink Pulumi.Service Connection State Azure Native. HDInsight. Inputs. Private Link Service Connection State 
- The private link service connection state.
- ResourceGroup stringName 
- The name of the resource group.
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- ClusterName string
- The name of the cluster.
- PrivateLink PrivateService Connection State Link Service Connection State Args 
- The private link service connection state.
- ResourceGroup stringName 
- The name of the resource group.
- PrivateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- clusterName String
- The name of the cluster.
- privateLink PrivateService Connection State Link Service Connection State 
- The private link service connection state.
- resourceGroup StringName 
- The name of the resource group.
- privateEndpoint StringConnection Name 
- The name of the private endpoint connection.
- clusterName string
- The name of the cluster.
- privateLink PrivateService Connection State Link Service Connection State 
- The private link service connection state.
- resourceGroup stringName 
- The name of the resource group.
- privateEndpoint stringConnection Name 
- The name of the private endpoint connection.
- cluster_name str
- The name of the cluster.
- private_link_ Privateservice_ connection_ state Link Service Connection State Args 
- The private link service connection state.
- resource_group_ strname 
- The name of the resource group.
- private_endpoint_ strconnection_ name 
- The name of the private endpoint connection.
- clusterName String
- The name of the cluster.
- privateLink Property MapService Connection State 
- The private link service connection state.
- resourceGroup StringName 
- The name of the resource group.
- privateEndpoint StringConnection Name 
- The name of the private endpoint connection.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateEndpointConnection resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- LinkIdentifier string
- The link identifier.
- Name string
- The name of the resource
- PrivateEndpoint Pulumi.Azure Native. HDInsight. Outputs. Private Endpoint Response 
- The private endpoint of the private endpoint connection
- ProvisioningState string
- The provisioning state, which only appears in the response.
- SystemData Pulumi.Azure Native. HDInsight. Outputs. System Data Response 
- 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"
- Id string
- The provider-assigned unique ID for this managed resource.
- LinkIdentifier string
- The link identifier.
- Name string
- The name of the resource
- PrivateEndpoint PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- ProvisioningState string
- The provisioning state, which only appears in the response.
- SystemData SystemData Response 
- 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"
- id String
- The provider-assigned unique ID for this managed resource.
- linkIdentifier String
- The link identifier.
- name String
- The name of the resource
- privateEndpoint PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- provisioningState String
- The provisioning state, which only appears in the response.
- systemData SystemData Response 
- 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"
- id string
- The provider-assigned unique ID for this managed resource.
- linkIdentifier string
- The link identifier.
- name string
- The name of the resource
- privateEndpoint PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- provisioningState string
- The provisioning state, which only appears in the response.
- systemData SystemData Response 
- 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"
- id str
- The provider-assigned unique ID for this managed resource.
- link_identifier str
- The link identifier.
- name str
- The name of the resource
- private_endpoint PrivateEndpoint Response 
- The private endpoint of the private endpoint connection
- provisioning_state str
- The provisioning state, which only appears in the response.
- system_data SystemData Response 
- Metadata pertaining to creation and last modification of the resource.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- linkIdentifier String
- The link identifier.
- name String
- The name of the resource
- privateEndpoint Property Map
- The private endpoint of the private endpoint connection
- provisioningState String
- The provisioning state, which only appears in the response.
- systemData Property Map
- 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"
Supporting Types
PrivateEndpointResponse, PrivateEndpointResponseArgs      
- Id string
- The private endpoint id.
- Id string
- The private endpoint id.
- id String
- The private endpoint id.
- id string
- The private endpoint id.
- id str
- The private endpoint id.
- id String
- The private endpoint id.
PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs          
- Status
string | Pulumi.Azure Native. HDInsight. Private Link Service Connection Status 
- The concrete private link service connection.
- ActionsRequired string
- Whether there is further actions.
- Description string
- The optional description of the status.
- Status
string | PrivateLink Service Connection Status 
- The concrete private link service connection.
- ActionsRequired string
- Whether there is further actions.
- Description string
- The optional description of the status.
- status
String | PrivateLink Service Connection Status 
- The concrete private link service connection.
- actionsRequired String
- Whether there is further actions.
- description String
- The optional description of the status.
- status
string | PrivateLink Service Connection Status 
- The concrete private link service connection.
- actionsRequired string
- Whether there is further actions.
- description string
- The optional description of the status.
- status
str | PrivateLink Service Connection Status 
- The concrete private link service connection.
- actions_required str
- Whether there is further actions.
- description str
- The optional description of the status.
- status String | "Approved" | "Rejected" | "Pending" | "Removed"
- The concrete private link service connection.
- actionsRequired String
- Whether there is further actions.
- description String
- The optional description of the status.
PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs            
- Status string
- The concrete private link service connection.
- ActionsRequired string
- Whether there is further actions.
- Description string
- The optional description of the status.
- Status string
- The concrete private link service connection.
- ActionsRequired string
- Whether there is further actions.
- Description string
- The optional description of the status.
- status String
- The concrete private link service connection.
- actionsRequired String
- Whether there is further actions.
- description String
- The optional description of the status.
- status string
- The concrete private link service connection.
- actionsRequired string
- Whether there is further actions.
- description string
- The optional description of the status.
- status str
- The concrete private link service connection.
- actions_required str
- Whether there is further actions.
- description str
- The optional description of the status.
- status String
- The concrete private link service connection.
- actionsRequired String
- Whether there is further actions.
- description String
- The optional description of the status.
PrivateLinkServiceConnectionStatus, PrivateLinkServiceConnectionStatusArgs          
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Removed
- Removed
- PrivateLink Service Connection Status Approved 
- Approved
- PrivateLink Service Connection Status Rejected 
- Rejected
- PrivateLink Service Connection Status Pending 
- Pending
- PrivateLink Service Connection Status Removed 
- Removed
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Removed
- Removed
- Approved
- Approved
- Rejected
- Rejected
- Pending
- Pending
- Removed
- Removed
- APPROVED
- Approved
- REJECTED
- Rejected
- PENDING
- Pending
- REMOVED
- Removed
- "Approved"
- Approved
- "Rejected"
- Rejected
- "Pending"
- Pending
- "Removed"
- Removed
SystemDataResponse, SystemDataResponseArgs      
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- CreatedAt string
- The timestamp of resource creation (UTC).
- CreatedBy string
- The identity that created the resource.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
- createdAt string
- The timestamp of resource creation (UTC).
- createdBy string
- The identity that created the resource.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- The type of identity that last modified the resource.
- created_at str
- The timestamp of resource creation (UTC).
- created_by str
- The identity that created the resource.
- created_by_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- The type of identity that last modified the resource.
- createdAt String
- The timestamp of resource creation (UTC).
- createdBy String
- The identity that created the resource.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:hdinsight:PrivateEndpointConnection testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0