azure-native.digitaltwins.PrivateEndpointConnection

Explore with Pulumi AI

The private endpoint connection of a Digital Twin. API Version: 2020-12-01.

Example Usage

Update the status of a private endpoint connection with the given name

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.DigitalTwins.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "myPrivateConnection",
        Properties = new AzureNative.DigitalTwins.Inputs.PrivateEndpointConnectionPropertiesArgs
        {
            PrivateLinkServiceConnectionState = new AzureNative.DigitalTwins.Inputs.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs
            {
                Description = "Approved by johndoe@company.com.",
                Status = "Approved",
            },
        },
        ResourceGroupName = "resRg",
        ResourceName = "myDigitalTwinsService",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitaltwins.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &digitaltwins.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("myPrivateConnection"),
			Properties: digitaltwins.PrivateEndpointConnectionResponseProperties{
				PrivateLinkServiceConnectionState: &digitaltwins.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs{
					Description: pulumi.String("Approved by johndoe@company.com."),
					Status:      pulumi.String("Approved"),
				},
			},
			ResourceGroupName: pulumi.String("resRg"),
			ResourceName:      pulumi.String("myDigitalTwinsService"),
		})
		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.digitaltwins.PrivateEndpointConnection;
import com.pulumi.azurenative.digitaltwins.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()        
            .privateEndpointConnectionName("myPrivateConnection")
            .properties(Map.of("privateLinkServiceConnectionState", Map.ofEntries(
                Map.entry("description", "Approved by johndoe@company.com."),
                Map.entry("status", "Approved")
            )))
            .resourceGroupName("resRg")
            .resourceName("myDigitalTwinsService")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.digitaltwins.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="myPrivateConnection",
    properties=azure_native.digitaltwins.PrivateEndpointConnectionResponsePropertiesArgs(
        private_link_service_connection_state=azure_native.digitaltwins.ConnectionPropertiesPrivateLinkServiceConnectionStateArgs(
            description="Approved by johndoe@company.com.",
            status="Approved",
        ),
    ),
    resource_group_name="resRg",
    resource_name_="myDigitalTwinsService")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpointConnection = new azure_native.digitaltwins.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "myPrivateConnection",
    properties: {
        privateLinkServiceConnectionState: {
            description: "Approved by johndoe@company.com.",
            status: "Approved",
        },
    },
    resourceGroupName: "resRg",
    resourceName: "myDigitalTwinsService",
});
resources:
  privateEndpointConnection:
    type: azure-native:digitaltwins:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: myPrivateConnection
      properties:
        privateLinkServiceConnectionState:
          description: Approved by johndoe@company.com.
          status: Approved
      resourceGroupName: resRg
      resourceName: myDigitalTwinsService

Create PrivateEndpointConnection Resource

new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              properties: Optional[PrivateEndpointConnectionPropertiesArgs] = None,
                              resource_group_name: Optional[str] = None,
                              resource_name_: Optional[str] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
                              args: PrivateEndpointConnectionInitArgs,
                              opts: Optional[ResourceOptions] = 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:digitaltwins:PrivateEndpointConnection
properties: # The arguments to resource properties.
options: # 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.
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.

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:

Properties Pulumi.AzureNative.DigitalTwins.Inputs.PrivateEndpointConnectionPropertiesArgs
ResourceGroupName string

The name of the resource group that contains the DigitalTwinsInstance.

ResourceName string

The name of the DigitalTwinsInstance.

PrivateEndpointConnectionName string

The name of the private endpoint connection.

Properties PrivateEndpointConnectionPropertiesArgs
ResourceGroupName string

The name of the resource group that contains the DigitalTwinsInstance.

ResourceName string

The name of the DigitalTwinsInstance.

PrivateEndpointConnectionName string

The name of the private endpoint connection.

properties PrivateEndpointConnectionPropertiesArgs
resourceGroupName String

The name of the resource group that contains the DigitalTwinsInstance.

resourceName String

The name of the DigitalTwinsInstance.

privateEndpointConnectionName String

The name of the private endpoint connection.

properties PrivateEndpointConnectionPropertiesArgs
resourceGroupName string

The name of the resource group that contains the DigitalTwinsInstance.

resourceName string

The name of the DigitalTwinsInstance.

privateEndpointConnectionName string

The name of the private endpoint connection.

properties PrivateEndpointConnectionPropertiesArgs
resource_group_name str

The name of the resource group that contains the DigitalTwinsInstance.

resource_name str

The name of the DigitalTwinsInstance.

private_endpoint_connection_name str

The name of the private endpoint connection.

properties Property Map
resourceGroupName String

The name of the resource group that contains the DigitalTwinsInstance.

resourceName String

The name of the DigitalTwinsInstance.

privateEndpointConnectionName String

The name 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.

Name string

The resource name.

Type string

The resource type.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The resource name.

Type string

The resource type.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name.

type String

The resource type.

id string

The provider-assigned unique ID for this managed resource.

name string

The resource name.

type string

The resource type.

id str

The provider-assigned unique ID for this managed resource.

name str

The resource name.

type str

The resource type.

id String

The provider-assigned unique ID for this managed resource.

name String

The resource name.

type String

The resource type.

Supporting Types

ConnectionPropertiesPrivateLinkServiceConnectionState

Description string

The description for the current state of a private endpoint connection.

Status string | Pulumi.AzureNative.DigitalTwins.PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

ActionsRequired string

Actions required for a private endpoint connection.

Description string

The description for the current state of a private endpoint connection.

Status string | PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

ActionsRequired string

Actions required for a private endpoint connection.

description String

The description for the current state of a private endpoint connection.

status String | PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

actionsRequired String

Actions required for a private endpoint connection.

description string

The description for the current state of a private endpoint connection.

status string | PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

actionsRequired string

Actions required for a private endpoint connection.

description str

The description for the current state of a private endpoint connection.

status str | PrivateLinkServiceConnectionStatus

The status of a private endpoint connection.

actions_required str

Actions required for a private endpoint connection.

description String

The description for the current state of a private endpoint connection.

status String | "Pending" | "Approved" | "Rejected" | "Disconnected"

The status of a private endpoint connection.

actionsRequired String

Actions required for a private endpoint connection.

ConnectionPropertiesResponsePrivateEndpoint

Id string

The resource identifier.

Id string

The resource identifier.

id String

The resource identifier.

id string

The resource identifier.

id str

The resource identifier.

id String

The resource identifier.

ConnectionPropertiesResponsePrivateLinkServiceConnectionState

Description string

The description for the current state of a private endpoint connection.

Status string

The status of a private endpoint connection.

ActionsRequired string

Actions required for a private endpoint connection.

Description string

The description for the current state of a private endpoint connection.

Status string

The status of a private endpoint connection.

ActionsRequired string

Actions required for a private endpoint connection.

description String

The description for the current state of a private endpoint connection.

status String

The status of a private endpoint connection.

actionsRequired String

Actions required for a private endpoint connection.

description string

The description for the current state of a private endpoint connection.

status string

The status of a private endpoint connection.

actionsRequired string

Actions required for a private endpoint connection.

description str

The description for the current state of a private endpoint connection.

status str

The status of a private endpoint connection.

actions_required str

Actions required for a private endpoint connection.

description String

The description for the current state of a private endpoint connection.

status String

The status of a private endpoint connection.

actionsRequired String

Actions required for a private endpoint connection.

PrivateEndpointConnectionProperties

GroupIds []string

The list of group ids for the private endpoint connection.

PrivateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionState
groupIds List<String>

The list of group ids for the private endpoint connection.

privateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionState
groupIds string[]

The list of group ids for the private endpoint connection.

privateLinkServiceConnectionState ConnectionPropertiesPrivateLinkServiceConnectionState
group_ids Sequence[str]

The list of group ids for the private endpoint connection.

private_link_service_connection_state ConnectionPropertiesPrivateLinkServiceConnectionState
groupIds List<String>

The list of group ids for the private endpoint connection.

privateLinkServiceConnectionState Property Map

PrivateEndpointConnectionResponseProperties

provisioningState String

The provisioning state.

groupIds List<String>

The list of group ids for the private endpoint connection.

privateEndpoint Property Map
privateLinkServiceConnectionState Property Map

PrivateLinkServiceConnectionStatus

Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
PrivateLinkServiceConnectionStatusPending
Pending
PrivateLinkServiceConnectionStatusApproved
Approved
PrivateLinkServiceConnectionStatusRejected
Rejected
PrivateLinkServiceConnectionStatusDisconnected
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

Import

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

$ pulumi import azure-native:digitaltwins:PrivateEndpointConnection myPrivateConnection /subscriptions/50016170-c839-41ba-a724-51e9df440b9e/resourcegroups/resRg/providers/Microsoft.DigitalTwins/digitalTwinsInstances/myDigitalTwinsService/privateEndpointConnections/myPrivateConnection 

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0