Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. aadiam
  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.aadiam.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: 2020-03-01. Prior API version in Azure Native 1.x: 2020-03-01.

    Example Usage

    AadiamPutPrivateEndpointConnection

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.AadIam.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PolicyName = "example-policy-5849",
        PrivateEndpoint = new AzureNative.AadIam.Inputs.PrivateEndpointArgs
        {
            Id = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkConnections/{privateEndpointConnection name}",
        },
        PrivateEndpointConnectionName = "{privateEndpointConnection name}",
        PrivateLinkServiceConnectionState = new AzureNative.AadIam.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            ActionsRequired = "None",
            Description = "You may pass",
            Status = AzureNative.AadIam.PrivateEndpointServiceConnectionStatus.Approved,
        },
        ResourceGroupName = "resourcegroup",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aadiam.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &aadiam.PrivateEndpointConnectionArgs{
			PolicyName: pulumi.String("example-policy-5849"),
			PrivateEndpoint: &aadiam.PrivateEndpointArgs{
				Id: pulumi.String("subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkConnections/{privateEndpointConnection name}"),
			},
			PrivateEndpointConnectionName: pulumi.String("{privateEndpointConnection name}"),
			PrivateLinkServiceConnectionState: &aadiam.PrivateLinkServiceConnectionStateArgs{
				ActionsRequired: pulumi.String("None"),
				Description:     pulumi.String("You may pass"),
				Status:          pulumi.String(aadiam.PrivateEndpointServiceConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("resourcegroup"),
		})
		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.aadiam.PrivateEndpointConnection;
import com.pulumi.azurenative.aadiam.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.aadiam.inputs.PrivateEndpointArgs;
import com.pulumi.azurenative.aadiam.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()
            .policyName("example-policy-5849")
            .privateEndpoint(PrivateEndpointArgs.builder()
                .id("subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkConnections/{privateEndpointConnection name}")
                .build())
            .privateEndpointConnectionName("{privateEndpointConnection name}")
            .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                .actionsRequired("None")
                .description("You may pass")
                .status("Approved")
                .build())
            .resourceGroupName("resourcegroup")
            .build());

    }
}

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

const privateEndpointConnection = new azure_native.aadiam.PrivateEndpointConnection("privateEndpointConnection", {
    policyName: "example-policy-5849",
    privateEndpoint: {
        id: "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkConnections/{privateEndpointConnection name}",
    },
    privateEndpointConnectionName: "{privateEndpointConnection name}",
    privateLinkServiceConnectionState: {
        actionsRequired: "None",
        description: "You may pass",
        status: azure_native.aadiam.PrivateEndpointServiceConnectionStatus.Approved,
    },
    resourceGroupName: "resourcegroup",
});

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.aadiam.PrivateEndpointConnection("privateEndpointConnection",
    policy_name="example-policy-5849",
    private_endpoint={
        "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkConnections/{privateEndpointConnection name}",
    },
    private_endpoint_connection_name="{privateEndpointConnection name}",
    private_link_service_connection_state={
        "actions_required": "None",
        "description": "You may pass",
        "status": azure_native.aadiam.PrivateEndpointServiceConnectionStatus.APPROVED,
    },
    resource_group_name="resourcegroup")

    resources:
  privateEndpointConnection:
    type: azure-native:aadiam:PrivateEndpointConnection
    properties:
      policyName: example-policy-5849
      privateEndpoint:
        id: subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/microsoft.aadiam/privateLinkForAzureAD/ddb1/privateLinkConnections/{privateEndpointConnection name}
      privateEndpointConnectionName: '{privateEndpointConnection name}'
      privateLinkServiceConnectionState:
        actionsRequired: None
        description: You may pass
        status: Approved
      resourceGroupName: resourcegroup

    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,
                              policy_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              private_endpoint: Optional[PrivateEndpointArgs] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_connection_tags: Optional[TagsResourceArgs] = 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:aadiam: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 privateEndpointConnectionResource = new AzureNative.AadIam.PrivateEndpointConnection("privateEndpointConnectionResource", new()
{
    PolicyName = "string",
    ResourceGroupName = "string",
    PrivateEndpoint = new AzureNative.AadIam.Inputs.PrivateEndpointArgs
    {
        Id = "string",
    },
    PrivateEndpointConnectionName = "string",
    PrivateLinkConnectionTags = new AzureNative.AadIam.Inputs.TagsResourceArgs
    {
        Tags = 
        {
            { "string", "string" },
        },
    },
    PrivateLinkServiceConnectionState = new AzureNative.AadIam.Inputs.PrivateLinkServiceConnectionStateArgs
    {
        ActionsRequired = "string",
        Description = "string",
        Status = "string",
    },
});

    example, err := aadiam.NewPrivateEndpointConnection(ctx, "privateEndpointConnectionResource", &aadiam.PrivateEndpointConnectionArgs{
	PolicyName:        pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	PrivateEndpoint: &aadiam.PrivateEndpointArgs{
		Id: pulumi.String("string"),
	},
	PrivateEndpointConnectionName: pulumi.String("string"),
	PrivateLinkConnectionTags: &aadiam.TagsResourceArgs{
		Tags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	PrivateLinkServiceConnectionState: &aadiam.PrivateLinkServiceConnectionStateArgs{
		ActionsRequired: pulumi.String("string"),
		Description:     pulumi.String("string"),
		Status:          pulumi.String("string"),
	},
})

    var privateEndpointConnectionResource = new PrivateEndpointConnection("privateEndpointConnectionResource", PrivateEndpointConnectionArgs.builder()
    .policyName("string")
    .resourceGroupName("string")
    .privateEndpoint(PrivateEndpointArgs.builder()
        .id("string")
        .build())
    .privateEndpointConnectionName("string")
    .privateLinkConnectionTags(TagsResourceArgs.builder()
        .tags(Map.of("string", "string"))
        .build())
    .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
        .actionsRequired("string")
        .description("string")
        .status("string")
        .build())
    .build());

    private_endpoint_connection_resource = azure_native.aadiam.PrivateEndpointConnection("privateEndpointConnectionResource",
    policy_name="string",
    resource_group_name="string",
    private_endpoint={
        "id": "string",
    },
    private_endpoint_connection_name="string",
    private_link_connection_tags={
        "tags": {
            "string": "string",
        },
    },
    private_link_service_connection_state={
        "actions_required": "string",
        "description": "string",
        "status": "string",
    })

    const privateEndpointConnectionResource = new azure_native.aadiam.PrivateEndpointConnection("privateEndpointConnectionResource", {
    policyName: "string",
    resourceGroupName: "string",
    privateEndpoint: {
        id: "string",
    },
    privateEndpointConnectionName: "string",
    privateLinkConnectionTags: {
        tags: {
            string: "string",
        },
    },
    privateLinkServiceConnectionState: {
        actionsRequired: "string",
        description: "string",
        status: "string",
    },
});

    type: azure-native:aadiam:PrivateEndpointConnection
properties:
    policyName: string
    privateEndpoint:
        id: string
    privateEndpointConnectionName: string
    privateLinkConnectionTags:
        tags:
            string: 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:

    PolicyName string
    The name of the private link policy in Azure AD.
    ResourceGroupName string
    Name of an Azure resource group.
    PrivateEndpoint Pulumi.AzureNative.AadIam.Inputs.PrivateEndpoint
    Properties of the private endpoint object.
    PrivateEndpointConnectionName string
    The PrivateEndpointConnection name.
    PrivateLinkConnectionTags Pulumi.AzureNative.AadIam.Inputs.TagsResource
    Updated tag information to set into the PrivateLinkConnection instance.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.AadIam.Inputs.PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    PolicyName string
    The name of the private link policy in Azure AD.
    ResourceGroupName string
    Name of an Azure resource group.
    PrivateEndpoint PrivateEndpointArgs
    Properties of the private endpoint object.
    PrivateEndpointConnectionName string
    The PrivateEndpointConnection name.
    PrivateLinkConnectionTags TagsResourceArgs
    Updated tag information to set into the PrivateLinkConnection instance.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateArgs
    Approval state of the private link connection.
    policyName String
    The name of the private link policy in Azure AD.
    resourceGroupName String
    Name of an Azure resource group.
    privateEndpoint PrivateEndpoint
    Properties of the private endpoint object.
    privateEndpointConnectionName String
    The PrivateEndpointConnection name.
    privateLinkConnectionTags TagsResource
    Updated tag information to set into the PrivateLinkConnection instance.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    policyName string
    The name of the private link policy in Azure AD.
    resourceGroupName string
    Name of an Azure resource group.
    privateEndpoint PrivateEndpoint
    Properties of the private endpoint object.
    privateEndpointConnectionName string
    The PrivateEndpointConnection name.
    privateLinkConnectionTags TagsResource
    Updated tag information to set into the PrivateLinkConnection instance.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    policy_name str
    The name of the private link policy in Azure AD.
    resource_group_name str
    Name of an Azure resource group.
    private_endpoint PrivateEndpointArgs
    Properties of the private endpoint object.
    private_endpoint_connection_name str
    The PrivateEndpointConnection name.
    private_link_connection_tags TagsResourceArgs
    Updated tag information to set into the PrivateLinkConnection instance.
    private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
    Approval state of the private link connection.
    policyName String
    The name of the private link policy in Azure AD.
    resourceGroupName String
    Name of an Azure resource group.
    privateEndpoint Property Map
    Properties of the private endpoint object.
    privateEndpointConnectionName String
    The PrivateEndpointConnection name.
    privateLinkConnectionTags Property Map
    Updated tag information to set into the PrivateLinkConnection instance.
    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.
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    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
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    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
    provisioningState String
    Provisioning state of the private endpoint connection.
    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
    provisioningState string
    Provisioning state of the private endpoint connection.
    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
    provisioning_state str
    Provisioning state of the private endpoint connection.
    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
    provisioningState String
    Provisioning state of the private endpoint connection.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

    Supporting Types

    PrivateEndpoint, PrivateEndpointArgs

    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.

    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

    Approved
    Approved
    Pending
    Pending
    Rejected
    Rejected
    Disconnected
    Disconnected
    PrivateEndpointServiceConnectionStatusApproved
    Approved
    PrivateEndpointServiceConnectionStatusPending
    Pending
    PrivateEndpointServiceConnectionStatusRejected
    Rejected
    PrivateEndpointServiceConnectionStatusDisconnected
    Disconnected
    Approved
    Approved
    Pending
    Pending
    Rejected
    Rejected
    Disconnected
    Disconnected
    Approved
    Approved
    Pending
    Pending
    Rejected
    Rejected
    Disconnected
    Disconnected
    APPROVED
    Approved
    PENDING
    Pending
    REJECTED
    Rejected
    DISCONNECTED
    Disconnected
    "Approved"
    Approved
    "Pending"
    Pending
    "Rejected"
    Rejected
    "Disconnected"
    Disconnected

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    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 | Pulumi.AzureNative.AadIam.PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the given policy 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 | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the given policy 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 | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the given policy 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 | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the given policy 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 | PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the given policy 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 | "Approved" | "Pending" | "Rejected" | "Disconnected"
    Indicates whether the connection has been approved, rejected or removed by the given policy 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 given policy 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 given policy 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 given policy 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 given policy 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 given policy 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 given policy owner.

    TagsResource, TagsResourceArgs

    Tags Dictionary<string, string>
    Resource tags
    Tags map[string]string
    Resource tags
    tags Map<String,String>
    Resource tags
    tags {[key: string]: string}
    Resource tags
    tags Mapping[str, str]
    Resource tags
    tags Map<String>
    Resource tags

    Import

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

    $ pulumi import azure-native:aadiam:PrivateEndpointConnection {privateEndpointConnection name} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/privateLinkForAzureAd/{policyName}/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