Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. documentdb
  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.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.documentdb.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.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

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

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

    Example Usage

    Approve or reject a private endpoint connection with a given name.

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.DocumentDB.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        AccountName = "ddb1",
        PrivateEndpointConnectionName = "privateEndpointConnectionName",
        PrivateLinkServiceConnectionState = new AzureNative.DocumentDB.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
        {
            Description = "Approved by johndoe@contoso.com",
            Status = "Approved",
        },
        ResourceGroupName = "rg1",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentdb.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &documentdb.PrivateEndpointConnectionArgs{
			AccountName:                   pulumi.String("ddb1"),
			PrivateEndpointConnectionName: pulumi.String("privateEndpointConnectionName"),
			PrivateLinkServiceConnectionState: &documentdb.PrivateLinkServiceConnectionStatePropertyArgs{
				Description: pulumi.String("Approved by johndoe@contoso.com"),
				Status:      pulumi.String("Approved"),
			},
			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.documentdb.PrivateEndpointConnection;
import com.pulumi.azurenative.documentdb.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.documentdb.inputs.PrivateLinkServiceConnectionStatePropertyArgs;
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()
            .accountName("ddb1")
            .privateEndpointConnectionName("privateEndpointConnectionName")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStatePropertyArgs.builder()
                .description("Approved by johndoe@contoso.com")
                .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.documentdb.PrivateEndpointConnection("privateEndpointConnection", {
    accountName: "ddb1",
    privateEndpointConnectionName: "privateEndpointConnectionName",
    privateLinkServiceConnectionState: {
        description: "Approved by johndoe@contoso.com",
        status: "Approved",
    },
    resourceGroupName: "rg1",
});

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.documentdb.PrivateEndpointConnection("privateEndpointConnection",
    account_name="ddb1",
    private_endpoint_connection_name="privateEndpointConnectionName",
    private_link_service_connection_state={
        "description": "Approved by johndoe@contoso.com",
        "status": "Approved",
    },
    resource_group_name="rg1")

    resources:
  privateEndpointConnection:
    type: azure-native:documentdb:PrivateEndpointConnection
    properties:
      accountName: ddb1
      privateEndpointConnectionName: privateEndpointConnectionName
      privateLinkServiceConnectionState:
        description: Approved by johndoe@contoso.com
        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,
                              account_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              group_id: Optional[str] = None,
                              private_endpoint: Optional[PrivateEndpointPropertyArgs] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStatePropertyArgs] = None,
                              provisioning_state: 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:documentdb: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 exampleprivateEndpointConnectionResourceResourceFromDocumentdb = new AzureNative.DocumentDB.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDocumentdb", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    GroupId = "string",
    PrivateEndpoint = new AzureNative.DocumentDB.Inputs.PrivateEndpointPropertyArgs
    {
        Id = "string",
    },
    PrivateEndpointConnectionName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.DocumentDB.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
    {
        Description = "string",
        Status = "string",
    },
    ProvisioningState = "string",
});

    example, err := documentdb.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDocumentdb", &documentdb.PrivateEndpointConnectionArgs{
	AccountName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	GroupId:           pulumi.String("string"),
	PrivateEndpoint: &documentdb.PrivateEndpointPropertyArgs{
		Id: pulumi.String("string"),
	},
	PrivateEndpointConnectionName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &documentdb.PrivateLinkServiceConnectionStatePropertyArgs{
		Description: pulumi.String("string"),
		Status:      pulumi.String("string"),
	},
	ProvisioningState: pulumi.String("string"),
})

    var exampleprivateEndpointConnectionResourceResourceFromDocumentdb = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDocumentdb", PrivateEndpointConnectionArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .groupId("string")
    .privateEndpoint(PrivateEndpointPropertyArgs.builder()
        .id("string")
        .build())
    .privateEndpointConnectionName("string")
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStatePropertyArgs.builder()
        .description("string")
        .status("string")
        .build())
    .provisioningState("string")
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_documentdb = azure_native.documentdb.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDocumentdb",
    account_name="string",
    resource_group_name="string",
    group_id="string",
    private_endpoint={
        "id": "string",
    },
    private_endpoint_connection_name="string",
    private_link_service_connection_state={
        "description": "string",
        "status": "string",
    },
    provisioning_state="string")

    const exampleprivateEndpointConnectionResourceResourceFromDocumentdb = new azure_native.documentdb.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDocumentdb", {
    accountName: "string",
    resourceGroupName: "string",
    groupId: "string",
    privateEndpoint: {
        id: "string",
    },
    privateEndpointConnectionName: "string",
    privateLinkServiceConnectionState: {
        description: "string",
        status: "string",
    },
    provisioningState: "string",
});

    type: azure-native:documentdb:PrivateEndpointConnection
properties:
    accountName: string
    groupId: string
    privateEndpoint:
        id: string
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        description: string
        status: string
    provisioningState: 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:

    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    GroupId string
    Group id of the private endpoint.
    PrivateEndpoint Pulumi.AzureNative.DocumentDB.Inputs.PrivateEndpointProperty
    Private endpoint which the connection belongs to.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.DocumentDB.Inputs.PrivateLinkServiceConnectionStateProperty
    Connection State of the Private Endpoint Connection.
    ProvisioningState string
    Provisioning state of the private endpoint.
    AccountName string
    Cosmos DB database account name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    GroupId string
    Group id of the private endpoint.
    PrivateEndpoint PrivateEndpointPropertyArgs
    Private endpoint which the connection belongs to.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyArgs
    Connection State of the Private Endpoint Connection.
    ProvisioningState string
    Provisioning state of the private endpoint.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    groupId String
    Group id of the private endpoint.
    privateEndpoint PrivateEndpointProperty
    Private endpoint which the connection belongs to.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateProperty
    Connection State of the Private Endpoint Connection.
    provisioningState String
    Provisioning state of the private endpoint.
    accountName string
    Cosmos DB database account name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    groupId string
    Group id of the private endpoint.
    privateEndpoint PrivateEndpointProperty
    Private endpoint which the connection belongs to.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateProperty
    Connection State of the Private Endpoint Connection.
    provisioningState string
    Provisioning state of the private endpoint.
    account_name str
    Cosmos DB database account name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    group_id str
    Group id of the private endpoint.
    private_endpoint PrivateEndpointPropertyArgs
    Private endpoint which the connection belongs to.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyArgs
    Connection State of the Private Endpoint Connection.
    provisioning_state str
    Provisioning state of the private endpoint.
    accountName String
    Cosmos DB database account name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    groupId String
    Group id of the private endpoint.
    privateEndpoint Property Map
    Private endpoint which the connection belongs to.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    privateLinkServiceConnectionState Property Map
    Connection State of the Private Endpoint Connection.
    provisioningState String
    Provisioning state of the private endpoint.

    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 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.
    Name string
    The name 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.
    name String
    The name 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.
    name string
    The name 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.
    name str
    The name 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.
    name String
    The name of the resource
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    PrivateEndpointProperty, PrivateEndpointPropertyArgs

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateEndpointPropertyResponse, PrivateEndpointPropertyResponseArgs

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateLinkServiceConnectionStateProperty, PrivateLinkServiceConnectionStatePropertyArgs

    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.

    PrivateLinkServiceConnectionStatePropertyResponse, PrivateLinkServiceConnectionStatePropertyResponseArgs

    ActionsRequired string
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    ActionsRequired string
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    actionsRequired String
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    actionsRequired string
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    actions_required str
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    actionsRequired String
    Any action that is required beyond basic workflow (approve/ reject/ disconnect)
    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:documentdb:PrivateEndpointConnection privateEndpointConnectionName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/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.3 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-azure-native