Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. containerservice
  5. PrivateEndpointConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.containerservice.PrivateEndpointConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

A private endpoint connection Azure REST API version: 2023-04-01. Prior API version in Azure Native 1.x: 2021-03-01.

Other available API versions: 2023-05-02-preview, 2023-06-01, 2023-06-02-preview, 2023-07-01, 2023-07-02-preview, 2023-08-01, 2023-08-02-preview, 2023-09-01, 2023-09-02-preview, 2023-10-01, 2023-10-02-preview, 2023-11-01, 2023-11-02-preview, 2024-01-01, 2024-01-02-preview, 2024-02-01, 2024-02-02-preview, 2024-03-02-preview, 2024-04-02-preview, 2024-05-01, 2024-05-02-preview, 2024-06-02-preview, 2024-07-01, 2024-07-02-preview, 2024-08-01, 2024-09-01, 2024-09-02-preview.

Example Usage

Update Private Endpoint Connection

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.ContainerService.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "privateendpointconnection1",
        PrivateLinkServiceConnectionState = new AzureNative.ContainerService.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Status = AzureNative.ContainerService.ConnectionStatus.Approved,
        },
        ResourceGroupName = "rg1",
        ResourceName = "clustername1",
    });

});
Copy
package main

import (
	containerservice "github.com/pulumi/pulumi-azure-native-sdk/containerservice/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := containerservice.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &containerservice.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("privateendpointconnection1"),
			PrivateLinkServiceConnectionState: &containerservice.PrivateLinkServiceConnectionStateArgs{
				Status: pulumi.String(containerservice.ConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("rg1"),
			ResourceName:      pulumi.String("clustername1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.containerservice.PrivateEndpointConnection;
import com.pulumi.azurenative.containerservice.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.containerservice.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()
            .privateEndpointConnectionName("privateendpointconnection1")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .status("Approved")
                .build())
            .resourceGroupName("rg1")
            .resourceName("clustername1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpointConnection = new azure_native.containerservice.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "privateendpointconnection1",
    privateLinkServiceConnectionState: {
        status: azure_native.containerservice.ConnectionStatus.Approved,
    },
    resourceGroupName: "rg1",
    resourceName: "clustername1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.containerservice.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="privateendpointconnection1",
    private_link_service_connection_state={
        "status": azure_native.containerservice.ConnectionStatus.APPROVED,
    },
    resource_group_name="rg1",
    resource_name_="clustername1")
Copy
resources:
  privateEndpointConnection:
    type: azure-native:containerservice:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: privateendpointconnection1
      privateLinkServiceConnectionState:
        status: Approved
      resourceGroupName: rg1
      resourceName: clustername1
Copy

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,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
                              resource_group_name: Optional[str] = None,
                              resource_name_: Optional[str] = None,
                              private_endpoint: Optional[PrivateEndpointArgs] = 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:containerservice:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PrivateEndpointConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. PrivateEndpointConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateEndpointConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 exampleprivateEndpointConnectionResourceResourceFromContainerservice = new AzureNative.Containerservice.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerservice", new()
{
    PrivateLinkServiceConnectionState = 
    {
        { "description", "string" },
        { "status", "string" },
    },
    ResourceGroupName = "string",
    ResourceName = "string",
    PrivateEndpoint = 
    {
        { "id", "string" },
    },
    PrivateEndpointConnectionName = "string",
});
Copy
example, err := containerservice.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromContainerservice", &containerservice.PrivateEndpointConnectionArgs{
	PrivateLinkServiceConnectionState: map[string]interface{}{
		"description": "string",
		"status":      "string",
	},
	ResourceGroupName: "string",
	ResourceName:      "string",
	PrivateEndpoint: map[string]interface{}{
		"id": "string",
	},
	PrivateEndpointConnectionName: "string",
})
Copy
var exampleprivateEndpointConnectionResourceResourceFromContainerservice = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerservice", PrivateEndpointConnectionArgs.builder()
    .privateLinkServiceConnectionState(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .resourceName("string")
    .privateEndpoint(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .privateEndpointConnectionName("string")
    .build());
Copy
exampleprivate_endpoint_connection_resource_resource_from_containerservice = azure_native.containerservice.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerservice",
    private_link_service_connection_state={
        description: string,
        status: string,
    },
    resource_group_name=string,
    resource_name_=string,
    private_endpoint={
        id: string,
    },
    private_endpoint_connection_name=string)
Copy
const exampleprivateEndpointConnectionResourceResourceFromContainerservice = new azure_native.containerservice.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromContainerservice", {
    privateLinkServiceConnectionState: {
        description: "string",
        status: "string",
    },
    resourceGroupName: "string",
    resourceName: "string",
    privateEndpoint: {
        id: "string",
    },
    privateEndpointConnectionName: "string",
});
Copy
type: azure-native:containerservice:PrivateEndpointConnection
properties:
    privateEndpoint:
        id: string
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        description: string
        status: string
    resourceGroupName: string
    resourceName: string
Copy

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:

PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.ContainerService.Inputs.PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed cluster resource.
PrivateEndpoint Pulumi.AzureNative.ContainerService.Inputs.PrivateEndpoint
The resource of private endpoint.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection.
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateArgs
A collection of information about the state of the connection between service consumer and provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed cluster resource.
PrivateEndpoint PrivateEndpointArgs
The resource of private endpoint.
PrivateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed cluster resource.
privateEndpoint PrivateEndpoint
The resource of private endpoint.
privateEndpointConnectionName Changes to this property will trigger replacement. String
The name of the private endpoint connection.
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionState
A collection of information about the state of the connection between service consumer and provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the managed cluster resource.
privateEndpoint PrivateEndpoint
The resource of private endpoint.
privateEndpointConnectionName Changes to this property will trigger replacement. string
The name of the private endpoint connection.
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateArgs
A collection of information about the state of the connection between service consumer and provider.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the managed cluster resource.
private_endpoint PrivateEndpointArgs
The resource of private endpoint.
private_endpoint_connection_name Changes to this property will trigger replacement. str
The name of the private endpoint connection.
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the managed cluster resource.
privateEndpoint Property Map
The resource of private endpoint.
privateEndpointConnectionName Changes to this property will trigger replacement. String
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.
Name string
The name of the private endpoint connection.
ProvisioningState string
The current provisioning state.
Type string
The resource type.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the private endpoint connection.
ProvisioningState string
The current provisioning state.
Type string
The resource type.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the private endpoint connection.
provisioningState String
The current provisioning state.
type String
The resource type.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the private endpoint connection.
provisioningState string
The current provisioning state.
type string
The resource type.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the private endpoint connection.
provisioning_state str
The current provisioning state.
type str
The resource type.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the private endpoint connection.
provisioningState String
The current provisioning state.
type String
The resource type.

Supporting Types

ConnectionStatus
, ConnectionStatusArgs

Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
ConnectionStatusPending
Pending
ConnectionStatusApproved
Approved
ConnectionStatusRejected
Rejected
ConnectionStatusDisconnected
Disconnected
Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
PENDING
Pending
APPROVED
Approved
REJECTED
Rejected
DISCONNECTED
Disconnected
"Pending"
Pending
"Approved"
Approved
"Rejected"
Rejected
"Disconnected"
Disconnected

PrivateEndpoint
, PrivateEndpointArgs

Id string
The resource ID of the private endpoint
Id string
The resource ID of the private endpoint
id String
The resource ID of the private endpoint
id string
The resource ID of the private endpoint
id str
The resource ID of the private endpoint
id String
The resource ID of the private endpoint

PrivateEndpointResponse
, PrivateEndpointResponseArgs

Id string
The resource ID of the private endpoint
Id string
The resource ID of the private endpoint
id String
The resource ID of the private endpoint
id string
The resource ID of the private endpoint
id str
The resource ID of the private endpoint
id String
The resource ID of the private endpoint

PrivateLinkServiceConnectionState
, PrivateLinkServiceConnectionStateArgs

Description string
The private link service connection description.
Status string | Pulumi.AzureNative.ContainerService.ConnectionStatus
The private link service connection status.
Description string
The private link service connection description.
Status string | ConnectionStatus
The private link service connection status.
description String
The private link service connection description.
status String | ConnectionStatus
The private link service connection status.
description string
The private link service connection description.
status string | ConnectionStatus
The private link service connection status.
description str
The private link service connection description.
status str | ConnectionStatus
The private link service connection status.
description String
The private link service connection description.
status String | "Pending" | "Approved" | "Rejected" | "Disconnected"
The private link service connection status.

PrivateLinkServiceConnectionStateResponse
, PrivateLinkServiceConnectionStateResponseArgs

Description string
The private link service connection description.
Status string
The private link service connection status.
Description string
The private link service connection description.
Status string
The private link service connection status.
description String
The private link service connection description.
status String
The private link service connection status.
description string
The private link service connection description.
status string
The private link service connection status.
description str
The private link service connection description.
status str
The private link service connection status.
description String
The private link service connection description.
status String
The private link service connection status.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:containerservice:PrivateEndpointConnection privateendpointconnection1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native