Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. purview
  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.purview.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

    A private endpoint connection class. Azure REST API version: 2021-12-01. Prior API version in Azure Native 1.x: 2020-12-01-preview.

    Other available API versions: 2021-07-01, 2023-05-01-preview, 2024-04-01-preview.

    Example Usage

    PrivateEndpointConnections_CreateOrUpdate

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.Purview.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        AccountName = "account1",
        PrivateEndpointConnectionName = "privateEndpointConnection1",
        PrivateLinkServiceConnectionState = new AzureNative.Purview.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Description = "Approved by johndoe@company.com",
            Status = AzureNative.Purview.Status.Approved,
        },
        ResourceGroupName = "SampleResourceGroup",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := purview.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &purview.PrivateEndpointConnectionArgs{
			AccountName:                   pulumi.String("account1"),
			PrivateEndpointConnectionName: pulumi.String("privateEndpointConnection1"),
			PrivateLinkServiceConnectionState: &purview.PrivateLinkServiceConnectionStateArgs{
				Description: pulumi.String("Approved by johndoe@company.com"),
				Status:      pulumi.String(purview.StatusApproved),
			},
			ResourceGroupName: pulumi.String("SampleResourceGroup"),
		})
		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.purview.PrivateEndpointConnection;
import com.pulumi.azurenative.purview.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.purview.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()
            .accountName("account1")
            .privateEndpointConnectionName("privateEndpointConnection1")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .description("Approved by johndoe@company.com")
                .status("Approved")
                .build())
            .resourceGroupName("SampleResourceGroup")
            .build());

    }
}

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

const privateEndpointConnection = new azure_native.purview.PrivateEndpointConnection("privateEndpointConnection", {
    accountName: "account1",
    privateEndpointConnectionName: "privateEndpointConnection1",
    privateLinkServiceConnectionState: {
        description: "Approved by johndoe@company.com",
        status: azure_native.purview.Status.Approved,
    },
    resourceGroupName: "SampleResourceGroup",
});

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.purview.PrivateEndpointConnection("privateEndpointConnection",
    account_name="account1",
    private_endpoint_connection_name="privateEndpointConnection1",
    private_link_service_connection_state={
        "description": "Approved by johndoe@company.com",
        "status": azure_native.purview.Status.APPROVED,
    },
    resource_group_name="SampleResourceGroup")

    resources:
  privateEndpointConnection:
    type: azure-native:purview:PrivateEndpointConnection
    properties:
      accountName: account1
      privateEndpointConnectionName: privateEndpointConnection1
      privateLinkServiceConnectionState:
        description: Approved by johndoe@company.com
        status: Approved
      resourceGroupName: SampleResourceGroup

    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,
                              private_endpoint: Optional[PrivateEndpointArgs] = 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:purview: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 exampleprivateEndpointConnectionResourceResourceFromPurview = new AzureNative.Purview.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromPurview", new()
{
    AccountName = "string",
    ResourceGroupName = "string",
    PrivateEndpoint = new AzureNative.Purview.Inputs.PrivateEndpointArgs
    {
        Id = "string",
    },
    PrivateEndpointConnectionName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.Purview.Inputs.PrivateLinkServiceConnectionStateArgs
    {
        ActionsRequired = "string",
        Description = "string",
        Status = "string",
    },
});

    example, err := purview.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromPurview", &purview.PrivateEndpointConnectionArgs{
	AccountName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	PrivateEndpoint: &purview.PrivateEndpointArgs{
		Id: pulumi.String("string"),
	},
	PrivateEndpointConnectionName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &purview.PrivateLinkServiceConnectionStateArgs{
		ActionsRequired: pulumi.String("string"),
		Description:     pulumi.String("string"),
		Status:          pulumi.String("string"),
	},
})

    var exampleprivateEndpointConnectionResourceResourceFromPurview = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromPurview", PrivateEndpointConnectionArgs.builder()
    .accountName("string")
    .resourceGroupName("string")
    .privateEndpoint(PrivateEndpointArgs.builder()
        .id("string")
        .build())
    .privateEndpointConnectionName("string")
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
        .actionsRequired("string")
        .description("string")
        .status("string")
        .build())
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_purview = azure_native.purview.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromPurview",
    account_name="string",
    resource_group_name="string",
    private_endpoint={
        "id": "string",
    },
    private_endpoint_connection_name="string",
    private_link_service_connection_state={
        "actions_required": "string",
        "description": "string",
        "status": "string",
    })

    const exampleprivateEndpointConnectionResourceResourceFromPurview = new azure_native.purview.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromPurview", {
    accountName: "string",
    resourceGroupName: "string",
    privateEndpoint: {
        id: "string",
    },
    privateEndpointConnectionName: "string",
    privateLinkServiceConnectionState: {
        actionsRequired: "string",
        description: "string",
        status: "string",
    },
});

    type: azure-native:purview:PrivateEndpointConnection
properties:
    accountName: string
    privateEndpoint:
        id: 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:

    AccountName string
    The name of the account.
    ResourceGroupName string
    The resource group name.
    PrivateEndpoint Pulumi.AzureNative.Purview.Inputs.PrivateEndpoint
    The private endpoint information.
    PrivateEndpointConnectionName string
    Name of the private endpoint connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Purview.Inputs.PrivateLinkServiceConnectionState
    The private link service connection state.
    AccountName string
    The name of the account.
    ResourceGroupName string
    The resource group name.
    PrivateEndpoint PrivateEndpointArgs
    The private endpoint information.
    PrivateEndpointConnectionName string
    Name of the private endpoint connection.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateArgs
    The private link service connection state.
    accountName String
    The name of the account.
    resourceGroupName String
    The resource group name.
    privateEndpoint PrivateEndpoint
    The private endpoint information.
    privateEndpointConnectionName String
    Name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    The private link service connection state.
    accountName string
    The name of the account.
    resourceGroupName string
    The resource group name.
    privateEndpoint PrivateEndpoint
    The private endpoint information.
    privateEndpointConnectionName string
    Name of the private endpoint connection.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    The private link service connection state.
    account_name str
    The name of the account.
    resource_group_name str
    The resource group name.
    private_endpoint PrivateEndpointArgs
    The private endpoint information.
    private_endpoint_connection_name str
    Name of the private endpoint connection.
    private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
    The private link service connection state.
    accountName String
    The name of the account.
    resourceGroupName String
    The resource group name.
    privateEndpoint Property Map
    The private endpoint information.
    privateEndpointConnectionName String
    Name of the private endpoint connection.
    privateLinkServiceConnectionState Property Map
    The private link service connection state.

    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
    Gets or sets the name.
    ProvisioningState string
    The provisioning state.
    SystemData Pulumi.AzureNative.Purview.Outputs.ProxyResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Gets or sets the type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Gets or sets the name.
    ProvisioningState string
    The provisioning state.
    SystemData ProxyResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    Type string
    Gets or sets the type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Gets or sets the name.
    provisioningState String
    The provisioning state.
    systemData ProxyResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    type String
    Gets or sets the type.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Gets or sets the name.
    provisioningState string
    The provisioning state.
    systemData ProxyResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    type string
    Gets or sets the type.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Gets or sets the name.
    provisioning_state str
    The provisioning state.
    system_data ProxyResourceResponseSystemData
    Metadata pertaining to creation and last modification of the resource.
    type str
    Gets or sets the type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Gets or sets the name.
    provisioningState String
    The provisioning state.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    Gets or sets the type.

    Supporting Types

    PrivateEndpoint, PrivateEndpointArgs

    Id string
    The private endpoint identifier.
    Id string
    The private endpoint identifier.
    id String
    The private endpoint identifier.
    id string
    The private endpoint identifier.
    id str
    The private endpoint identifier.
    id String
    The private endpoint identifier.

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    The private endpoint identifier.
    Id string
    The private endpoint identifier.
    id String
    The private endpoint identifier.
    id string
    The private endpoint identifier.
    id str
    The private endpoint identifier.
    id String
    The private endpoint identifier.

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    ActionsRequired string
    The required actions.
    Description string
    The description.
    Status string | Pulumi.AzureNative.Purview.Status
    The status.
    ActionsRequired string
    The required actions.
    Description string
    The description.
    Status string | Status
    The status.
    actionsRequired String
    The required actions.
    description String
    The description.
    status String | Status
    The status.
    actionsRequired string
    The required actions.
    description string
    The description.
    status string | Status
    The status.
    actions_required str
    The required actions.
    description str
    The description.
    status str | Status
    The status.
    actionsRequired String
    The required actions.
    description String
    The description.
    status String | "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected"
    The status.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionsRequired string
    The required actions.
    Description string
    The description.
    Status string
    The status.
    ActionsRequired string
    The required actions.
    Description string
    The description.
    Status string
    The status.
    actionsRequired String
    The required actions.
    description String
    The description.
    status String
    The status.
    actionsRequired string
    The required actions.
    description string
    The description.
    status string
    The status.
    actions_required str
    The required actions.
    description str
    The description.
    status str
    The status.
    actionsRequired String
    The required actions.
    description String
    The description.
    status String
    The status.

    ProxyResourceResponseSystemData, ProxyResourceResponseSystemDataArgs

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of the last modification the resource (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of the last modification the resource (UTC).
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of the last modification the resource (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of the last modification the resource (UTC).
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of the last modification the resource (UTC).
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    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.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of the last modification the resource (UTC).
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Status, StatusArgs

    Unknown
    Unknown
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    StatusUnknown
    Unknown
    StatusPending
    Pending
    StatusApproved
    Approved
    StatusRejected
    Rejected
    StatusDisconnected
    Disconnected
    Unknown
    Unknown
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    Unknown
    Unknown
    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    UNKNOWN
    Unknown
    PENDING
    Pending
    APPROVED
    Approved
    REJECTED
    Rejected
    DISCONNECTED
    Disconnected
    "Unknown"
    Unknown
    "Pending"
    Pending
    "Approved"
    Approved
    "Rejected"
    Rejected
    "Disconnected"
    Disconnected

    Import

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

    $ pulumi import azure-native:purview:PrivateEndpointConnection privateEndpointConnection1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Purview/accounts/{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.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native