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

azure-native.relay.PrivateEndpointConnection

Explore with Pulumi AI

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

    Properties of the PrivateEndpointConnection.

    Uses Azure REST API version 2021-11-01. In version 1.x of the Azure Native provider, it used API version 2018-01-01-preview.

    Other available API versions: 2018-01-01-preview, 2024-01-01.

    Example Usage

    NameSpacePrivateEndPointConnectionCreate

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.Relay.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        NamespaceName = "example-RelayNamespace-5849",
        PrivateEndpoint = new AzureNative.Relay.Inputs.PrivateEndpointArgs
        {
            Id = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1",
        },
        PrivateEndpointConnectionName = "{privateEndpointConnection name}",
        PrivateLinkServiceConnectionState = new AzureNative.Relay.Inputs.ConnectionStateArgs
        {
            Description = "You may pass",
            Status = AzureNative.Relay.PrivateLinkConnectionStatus.Approved,
        },
        ResourceGroupName = "resourcegroup",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := relay.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &relay.PrivateEndpointConnectionArgs{
			NamespaceName: pulumi.String("example-RelayNamespace-5849"),
			PrivateEndpoint: &relay.PrivateEndpointArgs{
				Id: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1"),
			},
			PrivateEndpointConnectionName: pulumi.String("{privateEndpointConnection name}"),
			PrivateLinkServiceConnectionState: &relay.ConnectionStateArgs{
				Description: pulumi.String("You may pass"),
				Status:      pulumi.String(relay.PrivateLinkConnectionStatusApproved),
			},
			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.relay.PrivateEndpointConnection;
import com.pulumi.azurenative.relay.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.relay.inputs.PrivateEndpointArgs;
import com.pulumi.azurenative.relay.inputs.ConnectionStateArgs;
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()
            .namespaceName("example-RelayNamespace-5849")
            .privateEndpoint(PrivateEndpointArgs.builder()
                .id("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1")
                .build())
            .privateEndpointConnectionName("{privateEndpointConnection name}")
            .privateLinkServiceConnectionState(ConnectionStateArgs.builder()
                .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.relay.PrivateEndpointConnection("privateEndpointConnection", {
    namespaceName: "example-RelayNamespace-5849",
    privateEndpoint: {
        id: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1",
    },
    privateEndpointConnectionName: "{privateEndpointConnection name}",
    privateLinkServiceConnectionState: {
        description: "You may pass",
        status: azure_native.relay.PrivateLinkConnectionStatus.Approved,
    },
    resourceGroupName: "resourcegroup",
});

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.relay.PrivateEndpointConnection("privateEndpointConnection",
    namespace_name="example-RelayNamespace-5849",
    private_endpoint={
        "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1",
    },
    private_endpoint_connection_name="{privateEndpointConnection name}",
    private_link_service_connection_state={
        "description": "You may pass",
        "status": azure_native.relay.PrivateLinkConnectionStatus.APPROVED,
    },
    resource_group_name="resourcegroup")

    resources:
  privateEndpointConnection:
    type: azure-native:relay:PrivateEndpointConnection
    properties:
      namespaceName: example-RelayNamespace-5849
      privateEndpoint:
        id: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1
      privateEndpointConnectionName: '{privateEndpointConnection name}'
      privateLinkServiceConnectionState:
        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: PrivateEndpointConnectionInitArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              namespace_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[ConnectionStateArgs] = None,
                              provisioning_state: Optional[Union[str, EndPointProvisioningState]] = 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:relay: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 PrivateEndpointConnectionInitArgs
    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 exampleprivateEndpointConnectionResourceResourceFromRelay = new AzureNative.Relay.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromRelay", new()
{
    NamespaceName = "string",
    ResourceGroupName = "string",
    PrivateEndpoint = new AzureNative.Relay.Inputs.PrivateEndpointArgs
    {
        Id = "string",
    },
    PrivateEndpointConnectionName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.Relay.Inputs.ConnectionStateArgs
    {
        Description = "string",
        Status = "string",
    },
    ProvisioningState = "string",
});

    example, err := relay.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromRelay", &relay.PrivateEndpointConnectionArgs{
	NamespaceName:     pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	PrivateEndpoint: &relay.PrivateEndpointArgs{
		Id: pulumi.String("string"),
	},
	PrivateEndpointConnectionName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &relay.ConnectionStateArgs{
		Description: pulumi.String("string"),
		Status:      pulumi.String("string"),
	},
	ProvisioningState: pulumi.String("string"),
})

    var exampleprivateEndpointConnectionResourceResourceFromRelay = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromRelay", PrivateEndpointConnectionArgs.builder()
    .namespaceName("string")
    .resourceGroupName("string")
    .privateEndpoint(PrivateEndpointArgs.builder()
        .id("string")
        .build())
    .privateEndpointConnectionName("string")
    .privateLinkServiceConnectionState(ConnectionStateArgs.builder()
        .description("string")
        .status("string")
        .build())
    .provisioningState("string")
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_relay = azure_native.relay.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromRelay",
    namespace_name="string",
    resource_group_name="string",
    private_endpoint={
        "id": "string",
    },
    private_endpoint_connection_name="string",
    private_link_service_connection_state={
        "description": "string",
        "status": "string",
    },
    provisioning_state="string")

    const exampleprivateEndpointConnectionResourceResourceFromRelay = new azure_native.relay.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromRelay", {
    namespaceName: "string",
    resourceGroupName: "string",
    privateEndpoint: {
        id: "string",
    },
    privateEndpointConnectionName: "string",
    privateLinkServiceConnectionState: {
        description: "string",
        status: "string",
    },
    provisioningState: "string",
});

    type: azure-native:relay:PrivateEndpointConnection
properties:
    namespaceName: 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:

    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    PrivateEndpoint Pulumi.AzureNative.Relay.Inputs.PrivateEndpoint
    The Private Endpoint resource for this Connection.
    PrivateEndpointConnectionName string
    The PrivateEndpointConnection name
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Relay.Inputs.ConnectionState
    Details about the state of the connection.
    ProvisioningState string | Pulumi.AzureNative.Relay.EndPointProvisioningState
    Provisioning state of the Private Endpoint Connection.
    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    PrivateEndpoint PrivateEndpointArgs
    The Private Endpoint resource for this Connection.
    PrivateEndpointConnectionName string
    The PrivateEndpointConnection name
    PrivateLinkServiceConnectionState ConnectionStateArgs
    Details about the state of the connection.
    ProvisioningState string | EndPointProvisioningState
    Provisioning state of the Private Endpoint Connection.
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    privateEndpoint PrivateEndpoint
    The Private Endpoint resource for this Connection.
    privateEndpointConnectionName String
    The PrivateEndpointConnection name
    privateLinkServiceConnectionState ConnectionState
    Details about the state of the connection.
    provisioningState String | EndPointProvisioningState
    Provisioning state of the Private Endpoint Connection.
    namespaceName string
    The namespace name
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    privateEndpoint PrivateEndpoint
    The Private Endpoint resource for this Connection.
    privateEndpointConnectionName string
    The PrivateEndpointConnection name
    privateLinkServiceConnectionState ConnectionState
    Details about the state of the connection.
    provisioningState string | EndPointProvisioningState
    Provisioning state of the Private Endpoint Connection.
    namespace_name str
    The namespace name
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    private_endpoint PrivateEndpointArgs
    The Private Endpoint resource for this Connection.
    private_endpoint_connection_name str
    The PrivateEndpointConnection name
    private_link_service_connection_state ConnectionStateArgs
    Details about the state of the connection.
    provisioning_state str | EndPointProvisioningState
    Provisioning state of the Private Endpoint Connection.
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    privateEndpoint Property Map
    The Private Endpoint resource for this Connection.
    privateEndpointConnectionName String
    The PrivateEndpointConnection name
    privateLinkServiceConnectionState Property Map
    Details about the state of the connection.
    provisioningState String | "Creating" | "Updating" | "Deleting" | "Succeeded" | "Canceled" | "Failed"
    Provisioning state of the Private Endpoint 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
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Relay.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    systemData Property Map
    The system meta data relating to this resource.
    type String
    The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"

    Supporting Types

    ConnectionState, ConnectionStateArgs

    Description string
    Description of the connection state.
    Status string | Pulumi.AzureNative.Relay.PrivateLinkConnectionStatus
    Status of the connection.
    Description string
    Description of the connection state.
    Status string | PrivateLinkConnectionStatus
    Status of the connection.
    description String
    Description of the connection state.
    status String | PrivateLinkConnectionStatus
    Status of the connection.
    description string
    Description of the connection state.
    status string | PrivateLinkConnectionStatus
    Status of the connection.
    description str
    Description of the connection state.
    status str | PrivateLinkConnectionStatus
    Status of the connection.
    description String
    Description of the connection state.
    status String | "Pending" | "Approved" | "Rejected" | "Disconnected"
    Status of the connection.

    ConnectionStateResponse, ConnectionStateResponseArgs

    Description string
    Description of the connection state.
    Status string
    Status of the connection.
    Description string
    Description of the connection state.
    Status string
    Status of the connection.
    description String
    Description of the connection state.
    status String
    Status of the connection.
    description string
    Description of the connection state.
    status string
    Status of the connection.
    description str
    Description of the connection state.
    status str
    Status of the connection.
    description String
    Description of the connection state.
    status String
    Status of the connection.

    EndPointProvisioningState, EndPointProvisioningStateArgs

    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    EndPointProvisioningStateCreating
    Creating
    EndPointProvisioningStateUpdating
    Updating
    EndPointProvisioningStateDeleting
    Deleting
    EndPointProvisioningStateSucceeded
    Succeeded
    EndPointProvisioningStateCanceled
    Canceled
    EndPointProvisioningStateFailed
    Failed
    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    Creating
    Creating
    Updating
    Updating
    Deleting
    Deleting
    Succeeded
    Succeeded
    Canceled
    Canceled
    Failed
    Failed
    CREATING
    Creating
    UPDATING
    Updating
    DELETING
    Deleting
    SUCCEEDED
    Succeeded
    CANCELED
    Canceled
    FAILED
    Failed
    "Creating"
    Creating
    "Updating"
    Updating
    "Deleting"
    Deleting
    "Succeeded"
    Succeeded
    "Canceled"
    Canceled
    "Failed"
    Failed

    PrivateEndpoint, PrivateEndpointArgs

    Id string
    The ARM identifier for Private Endpoint.
    Id string
    The ARM identifier for Private Endpoint.
    id String
    The ARM identifier for Private Endpoint.
    id string
    The ARM identifier for Private Endpoint.
    id str
    The ARM identifier for Private Endpoint.
    id String
    The ARM identifier for Private Endpoint.

    PrivateEndpointResponse, PrivateEndpointResponseArgs

    Id string
    The ARM identifier for Private Endpoint.
    Id string
    The ARM identifier for Private Endpoint.
    id String
    The ARM identifier for Private Endpoint.
    id string
    The ARM identifier for Private Endpoint.
    id str
    The ARM identifier for Private Endpoint.
    id String
    The ARM identifier for Private Endpoint.

    PrivateLinkConnectionStatus, PrivateLinkConnectionStatusArgs

    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PrivateLinkConnectionStatusPending
    Pending
    PrivateLinkConnectionStatusApproved
    Approved
    PrivateLinkConnectionStatusRejected
    Rejected
    PrivateLinkConnectionStatusDisconnected
    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

    SystemDataResponse, SystemDataResponseArgs

    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 resource last modification (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 resource last modification (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 resource last modification (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 resource last modification (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 resource last modification (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 resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Import

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

    $ pulumi import azure-native:relay:PrivateEndpointConnection {privateEndpointConnection name} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/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 v2 docs if using the v2 version of this package.
    Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
    pulumi/pulumi-azure-native