Private Endpoint Connection
A private endpoint connection Uses Azure REST API version 2024-11-15. Other available API versions: 2019-08-01-preview, 2021-01-15, 2021-03-01-preview, 2021-03-15, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview, 2025-04-15, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cosmosdb [ApiVersion]
. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.
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.CosmosDB.PrivateEndpointConnection("privateEndpointConnection", new()
{
AccountName = "ddb1",
PrivateEndpointConnectionName = "privateEndpointConnectionName",
PrivateLinkServiceConnectionState = new AzureNative.CosmosDB.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
{
Description = "Approved by johndoe@contoso.com",
Status = "Approved",
},
ResourceGroupName = "rg1",
});
});
package main
import (
cosmosdb "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cosmosdb.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &cosmosdb.PrivateEndpointConnectionArgs{
AccountName: pulumi.String("ddb1"),
PrivateEndpointConnectionName: pulumi.String("privateEndpointConnectionName"),
PrivateLinkServiceConnectionState: &cosmosdb.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.cosmosdb.PrivateEndpointConnection;
import com.pulumi.azurenative.cosmosdb.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.cosmosdb.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
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:cosmosdb:PrivateEndpointConnection privateEndpointConnectionName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}
Properties
The Azure API version of the resource.
Private endpoint which the connection belongs to.
Connection State of the Private Endpoint Connection.
Provisioning state of the private endpoint.