Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. keyvault
  5. PrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.keyvault.PrivateEndpointConnection

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Private endpoint connection resource. Azure REST API version: 2023-02-01. Prior API version in Azure Native 1.x: 2019-09-01.

    Other available API versions: 2023-07-01, 2024-04-01-preview, 2024-11-01, 2024-12-01-preview.

    Example Usage

    KeyVaultPutPrivateEndpointConnection

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.KeyVault.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "sample-pec",
        PrivateLinkServiceConnectionState = new AzureNative.KeyVault.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Description = "My name is Joe and I'm approving this.",
            Status = AzureNative.KeyVault.PrivateEndpointServiceConnectionStatus.Approved,
        },
        ResourceGroupName = "sample-group",
        VaultName = "sample-vault",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := keyvault.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &keyvault.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("sample-pec"),
			PrivateLinkServiceConnectionState: &keyvault.PrivateLinkServiceConnectionStateArgs{
				Description: pulumi.String("My name is Joe and I'm approving this."),
				Status:      pulumi.String(keyvault.PrivateEndpointServiceConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("sample-group"),
			VaultName:         pulumi.String("sample-vault"),
		})
		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.keyvault.PrivateEndpointConnection;
import com.pulumi.azurenative.keyvault.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.keyvault.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("sample-pec")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .description("My name is Joe and I'm approving this.")
                .status("Approved")
                .build())
            .resourceGroupName("sample-group")
            .vaultName("sample-vault")
            .build());

    }
}

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

const privateEndpointConnection = new azure_native.keyvault.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "sample-pec",
    privateLinkServiceConnectionState: {
        description: "My name is Joe and I'm approving this.",
        status: azure_native.keyvault.PrivateEndpointServiceConnectionStatus.Approved,
    },
    resourceGroupName: "sample-group",
    vaultName: "sample-vault",
});

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.keyvault.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="sample-pec",
    private_link_service_connection_state={
        "description": "My name is Joe and I'm approving this.",
        "status": azure_native.keyvault.PrivateEndpointServiceConnectionStatus.APPROVED,
    },
    resource_group_name="sample-group",
    vault_name="sample-vault")

    resources:
  privateEndpointConnection:
    type: azure-native:keyvault:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: sample-pec
      privateLinkServiceConnectionState:
        description: My name is Joe and I'm approving this.
        status: Approved
      resourceGroupName: sample-group
      vaultName: sample-vault

    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,
                              resource_group_name: Optional[str] = None,
                              vault_name: Optional[str] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = 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:keyvault: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 exampleprivateEndpointConnectionResourceResourceFromKeyvault = new AzureNative.KeyVault.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKeyvault", new()
{
    ResourceGroupName = "string",
    VaultName = "string",
    PrivateEndpointConnectionName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.KeyVault.Inputs.PrivateLinkServiceConnectionStateArgs
    {
        ActionsRequired = "string",
        Description = "string",
        Status = "string",
    },
});

    example, err := keyvault.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromKeyvault", &keyvault.PrivateEndpointConnectionArgs{
	ResourceGroupName:             pulumi.String("string"),
	VaultName:                     pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &keyvault.PrivateLinkServiceConnectionStateArgs{
		ActionsRequired: pulumi.String("string"),
		Description:     pulumi.String("string"),
		Status:          pulumi.String("string"),
	},
})

    var exampleprivateEndpointConnectionResourceResourceFromKeyvault = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKeyvault", PrivateEndpointConnectionArgs.builder()
    .resourceGroupName("string")
    .vaultName("string")
    .privateEndpointConnectionName("string")
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
        .actionsRequired("string")
        .description("string")
        .status("string")
        .build())
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_keyvault = azure_native.keyvault.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKeyvault",
    resource_group_name="string",
    vault_name="string",
    private_endpoint_connection_name="string",
    private_link_service_connection_state={
        "actions_required": "string",
        "description": "string",
        "status": "string",
    })

    const exampleprivateEndpointConnectionResourceResourceFromKeyvault = new azure_native.keyvault.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromKeyvault", {
    resourceGroupName: "string",
    vaultName: "string",
    privateEndpointConnectionName: "string",
    privateLinkServiceConnectionState: {
        actionsRequired: "string",
        description: "string",
        status: "string",
    },
});

    type: azure-native:keyvault:PrivateEndpointConnection
properties:
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionsRequired: string
        description: string
        status: string
    resourceGroupName: string
    vaultName: 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:

    ResourceGroupName string
    Name of the resource group that contains the key vault.
    VaultName string
    The name of the key vault.
    PrivateEndpointConnectionName string
    Name of the private endpoint connection associated with the key vault.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.KeyVault.Inputs.PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    ResourceGroupName string
    Name of the resource group that contains the key vault.
    VaultName string
    The name of the key vault.
    PrivateEndpointConnectionName string
    Name of the private endpoint connection associated with the key vault.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateArgs
    Approval state of the private link connection.
    resourceGroupName String
    Name of the resource group that contains the key vault.
    vaultName String
    The name of the key vault.
    privateEndpointConnectionName String
    Name of the private endpoint connection associated with the key vault.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    resourceGroupName string
    Name of the resource group that contains the key vault.
    vaultName string
    The name of the key vault.
    privateEndpointConnectionName string
    Name of the private endpoint connection associated with the key vault.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    resource_group_name str
    Name of the resource group that contains the key vault.
    vault_name str
    The name of the key vault.
    private_endpoint_connection_name str
    Name of the private endpoint connection associated with the key vault.
    private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
    Approval state of the private link connection.
    resourceGroupName String
    Name of the resource group that contains the key vault.
    vaultName String
    The name of the key vault.
    privateEndpointConnectionName String
    Name of the private endpoint connection associated with the key vault.
    privateLinkServiceConnectionState Property Map
    Approval state of the private link 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.
    Location string
    Azure location of the key vault resource.
    Name string
    Name of the key vault resource.
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    Tags Dictionary<string, string>
    Tags assigned to the key vault resource.
    Type string
    Resource type of the key vault resource.
    Etag string
    Modified whenever there is a change in the state of private endpoint connection.
    PrivateEndpoint Pulumi.AzureNative.KeyVault.Outputs.PrivateEndpointResponse
    Properties of the private endpoint object.
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Azure location of the key vault resource.
    Name string
    Name of the key vault resource.
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    Tags map[string]string
    Tags assigned to the key vault resource.
    Type string
    Resource type of the key vault resource.
    Etag string
    Modified whenever there is a change in the state of private endpoint connection.
    PrivateEndpoint PrivateEndpointResponse
    Properties of the private endpoint object.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    Azure location of the key vault resource.
    name String
    Name of the key vault resource.
    provisioningState String
    Provisioning state of the private endpoint connection.
    tags Map<String,String>
    Tags assigned to the key vault resource.
    type String
    Resource type of the key vault resource.
    etag String
    Modified whenever there is a change in the state of private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    Properties of the private endpoint object.
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    Azure location of the key vault resource.
    name string
    Name of the key vault resource.
    provisioningState string
    Provisioning state of the private endpoint connection.
    tags {[key: string]: string}
    Tags assigned to the key vault resource.
    type string
    Resource type of the key vault resource.
    etag string
    Modified whenever there is a change in the state of private endpoint connection.
    privateEndpoint PrivateEndpointResponse
    Properties of the private endpoint object.
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    Azure location of the key vault resource.
    name str
    Name of the key vault resource.
    provisioning_state str
    Provisioning state of the private endpoint connection.
    tags Mapping[str, str]
    Tags assigned to the key vault resource.
    type str
    Resource type of the key vault resource.
    etag str
    Modified whenever there is a change in the state of private endpoint connection.
    private_endpoint PrivateEndpointResponse
    Properties of the private endpoint object.
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    Azure location of the key vault resource.
    name String
    Name of the key vault resource.
    provisioningState String
    Provisioning state of the private endpoint connection.
    tags Map<String>
    Tags assigned to the key vault resource.
    type String
    Resource type of the key vault resource.
    etag String
    Modified whenever there is a change in the state of private endpoint connection.
    privateEndpoint Property Map
    Properties of the private endpoint object.

    Supporting Types

    ActionsRequired, ActionsRequiredArgs

    None
    None
    ActionsRequiredNone
    None
    None
    None
    None
    None
    NONE
    None
    "None"
    None

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    Full identifier of the private endpoint resource.
    Id string
    Full identifier of the private endpoint resource.
    id String
    Full identifier of the private endpoint resource.
    id string
    Full identifier of the private endpoint resource.
    id str
    Full identifier of the private endpoint resource.
    id String
    Full identifier of the private endpoint resource.

    PrivateEndpointServiceConnectionStatus, PrivateEndpointServiceConnectionStatusArgs

    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PrivateEndpointServiceConnectionStatusPending
    Pending
    PrivateEndpointServiceConnectionStatusApproved
    Approved
    PrivateEndpointServiceConnectionStatusRejected
    Rejected
    PrivateEndpointServiceConnectionStatusDisconnected
    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

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    ActionsRequired string | Pulumi.AzureNative.KeyVault.ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval or rejection.
    Status string | Pulumi.AzureNative.KeyVault.PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    ActionsRequired string | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval or rejection.
    Status string | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired String | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval or rejection.
    status String | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired string | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval or rejection.
    status string | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actions_required str | ActionsRequired
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval or rejection.
    status str | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired String | "None"
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval or rejection.
    status String | "Pending" | "Approved" | "Rejected" | "Disconnected"
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval or rejection.
    Status string
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval or rejection.
    Status string
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval or rejection.
    status String
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval or rejection.
    status string
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval or rejection.
    status str
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval or rejection.
    status String
    Indicates whether the connection has been approved, rejected or removed by the key vault owner.

    Import

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

    $ pulumi import azure-native:keyvault:PrivateEndpointConnection sample-pec /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native