Docs Packages
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. relay
  5. PrivateEndpointConnection
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.relay.PrivateEndpointConnection

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Private endpoint connection resource. API Version: 2018-01-01-preview.

    Example Usage

    RelayPutPrivateEndpointConnection

    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()
    {
        Location = "South Central US",
        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.PrivateLinkServiceConnectionStateArgs
        {
            Description = "You may pass",
            Status = "Approved",
        },
        ResourceGroupName = "resourcegroup",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := relay.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &relay.PrivateEndpointConnectionArgs{
			Location:      pulumi.String("South Central US"),
			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.PrivateLinkServiceConnectionStateArgs{
				Description: pulumi.String("You may pass"),
				Status:      pulumi.String("Approved"),
			},
			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 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()        
            .location("South Central US")
            .namespaceName("example-RelayNamespace-5849")
            .privateEndpoint(Map.of("id", "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Network/privateEndpoints/ali-relay-pve-1"))
            .privateEndpointConnectionName("{privateEndpointConnection name}")
            .privateLinkServiceConnectionState(Map.ofEntries(
                Map.entry("description", "You may pass"),
                Map.entry("status", "Approved")
            ))
            .resourceGroupName("resourcegroup")
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.relay.PrivateEndpointConnection("privateEndpointConnection",
    location="South Central US",
    namespace_name="example-RelayNamespace-5849",
    private_endpoint=azure_native.relay.PrivateEndpointArgs(
        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=azure_native.relay.PrivateLinkServiceConnectionStateArgs(
        description="You may pass",
        status="Approved",
    ),
    resource_group_name="resourcegroup")

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

const privateEndpointConnection = new azure_native.relay.PrivateEndpointConnection("privateEndpointConnection", {
    location: "South Central US",
    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",
});

    resources:
  privateEndpointConnection:
    type: azure-native:relay:PrivateEndpointConnection
    properties:
      location: South Central US
      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: PrivateEndpointConnectionArgs,
                              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,
                              location: Optional[str] = None,
                              private_endpoint: Optional[PrivateEndpointArgs] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStateArgs] = None,
                              tags: Optional[Mapping[str, 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: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 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 exampleprivateEndpointConnectionResourceResourceFromRelay = new AzureNative.Relay.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromRelay", new()
{
    NamespaceName = "string",
    ResourceGroupName = "string",
    Location = "string",
    PrivateEndpoint = 
    {
        { "id", "string" },
    },
    PrivateEndpointConnectionName = "string",
    PrivateLinkServiceConnectionState = 
    {
        { "actionRequired", "string" },
        { "description", "string" },
        { "status", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := relay.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromRelay", &relay.PrivateEndpointConnectionArgs{
	NamespaceName:     "string",
	ResourceGroupName: "string",
	Location:          "string",
	PrivateEndpoint: map[string]interface{}{
		"id": "string",
	},
	PrivateEndpointConnectionName: "string",
	PrivateLinkServiceConnectionState: map[string]interface{}{
		"actionRequired": "string",
		"description":    "string",
		"status":         "string",
	},
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var exampleprivateEndpointConnectionResourceResourceFromRelay = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromRelay", PrivateEndpointConnectionArgs.builder()
    .namespaceName("string")
    .resourceGroupName("string")
    .location("string")
    .privateEndpoint(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .privateEndpointConnectionName("string")
    .privateLinkServiceConnectionState(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

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

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

    type: azure-native:relay:PrivateEndpointConnection
properties:
    location: string
    namespaceName: string
    privateEndpoint:
        id: string
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionRequired: string
        description: string
        status: string
    resourceGroupName: string
    tags:
        string: 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

    The PrivateEndpointConnection resource accepts the following input properties:

    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    Location string
    Resource location.
    PrivateEndpoint Pulumi.AzureNative.Relay.Inputs.PrivateEndpoint
    Properties of the private endpoint object.
    PrivateEndpointConnectionName string
    The PrivateEndpointConnection name.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Relay.Inputs.PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    Tags Dictionary<string, string>
    Resource tags.
    NamespaceName string
    The namespace name
    ResourceGroupName string
    Name of the Resource group within the Azure subscription.
    Location string
    Resource location.
    PrivateEndpoint PrivateEndpointArgs
    Properties of the private endpoint object.
    PrivateEndpointConnectionName string
    The PrivateEndpointConnection name.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateArgs
    Approval state of the private link connection.
    Tags map[string]string
    Resource tags.
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    location String
    Resource location.
    privateEndpoint PrivateEndpoint
    Properties of the private endpoint object.
    privateEndpointConnectionName String
    The PrivateEndpointConnection name.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    tags Map<String,String>
    Resource tags.
    namespaceName string
    The namespace name
    resourceGroupName string
    Name of the Resource group within the Azure subscription.
    location string
    Resource location.
    privateEndpoint PrivateEndpoint
    Properties of the private endpoint object.
    privateEndpointConnectionName string
    The PrivateEndpointConnection name.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionState
    Approval state of the private link connection.
    tags {[key: string]: string}
    Resource tags.
    namespace_name str
    The namespace name
    resource_group_name str
    Name of the Resource group within the Azure subscription.
    location str
    Resource location.
    private_endpoint PrivateEndpointArgs
    Properties of the private endpoint object.
    private_endpoint_connection_name str
    The PrivateEndpointConnection name.
    private_link_service_connection_state PrivateLinkServiceConnectionStateArgs
    Approval state of the private link connection.
    tags Mapping[str, str]
    Resource tags.
    namespaceName String
    The namespace name
    resourceGroupName String
    Name of the Resource group within the Azure subscription.
    location String
    Resource location.
    privateEndpoint Property Map
    Properties of the private endpoint object.
    privateEndpointConnectionName String
    The PrivateEndpointConnection name.
    privateLinkServiceConnectionState Property Map
    Approval state of the private link connection.
    tags Map<String>
    Resource tags.

    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
    Resource name.
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    ProvisioningState string
    Provisioning state of the private endpoint connection.
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    Provisioning state of the private endpoint connection.
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    provisioningState string
    Provisioning state of the private endpoint connection.
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    provisioning_state str
    Provisioning state of the private endpoint connection.
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    provisioningState String
    Provisioning state of the private endpoint connection.
    type String
    Resource type.

    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

    Pending
    Pending
    Approved
    Approved
    Rejected
    Rejected
    Disconnected
    Disconnected
    PrivateEndpointServiceConnectionStatusPending
    Pending
    PrivateEndpointServiceConnectionStatusApproved
    Approved
    PrivateEndpointServiceConnectionStatusRejected
    Rejected
    PrivateEndpointServiceConnectionStatusDisconnected
    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

    PrivateLinkServiceConnectionState, PrivateLinkServiceConnectionStateArgs

    ActionRequired 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.Relay.PrivateEndpointServiceConnectionStatus
    Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.
    ActionRequired 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 Relay Namespace owner.
    actionRequired 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 Relay Namespace owner.
    actionRequired 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 Relay Namespace owner.
    action_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 Relay Namespace owner.
    actionRequired 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 | "Pending" | "Approved" | "Rejected" | "Disconnected"
    Indicates whether the connection has been approved, rejected or removed by the Relay Namespace owner.

    PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs

    ActionRequired 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 Relay Namespace owner.
    ActionRequired 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 Relay Namespace owner.
    actionRequired 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 Relay Namespace owner.
    actionRequired 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 Relay Namespace owner.
    action_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 Relay Namespace owner.
    actionRequired 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 Relay Namespace owner.

    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/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/alitest/providers/Microsoft.Relay/namespaces/relay-private-endpoint-test/privateEndpointConnections/{privateEndpointConnection name}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native