Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

PrivateEndpointConnection

The private endpoint connection of an IotHub API Version: 2020-08-31.

Example Usage

PrivateEndpointConnection_Update

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.Devices.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        PrivateEndpointConnectionName = "myPrivateEndpointConnection",
        Properties = new AzureNative.Devices.Inputs.PrivateEndpointConnectionPropertiesArgs
        {
            PrivateLinkServiceConnectionState = new AzureNative.Devices.Inputs.PrivateLinkServiceConnectionStateArgs
            {
                Description = "Approved by johndoe@contoso.com",
                Status = "Approved",
            },
        },
        ResourceGroupName = "myResourceGroup",
        ResourceName = "testHub",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := devices.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &devices.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("myPrivateEndpointConnection"),
			Properties: &devices.PrivateEndpointConnectionPropertiesArgs{
				PrivateLinkServiceConnectionState: &devices.PrivateLinkServiceConnectionStateArgs{
					Description: pulumi.String("Approved by johndoe@contoso.com"),
					Status:      pulumi.String("Approved"),
				},
			},
			ResourceGroupName: pulumi.String("myResourceGroup"),
			ResourceName:      pulumi.String("testHub"),
		})
		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.devices.PrivateEndpointConnection;
import com.pulumi.azurenative.devices.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("myPrivateEndpointConnection")
            .properties(Map.of("privateLinkServiceConnectionState", Map.ofEntries(
                Map.entry("description", "Approved by johndoe@contoso.com"),
                Map.entry("status", "Approved")
            )))
            .resourceGroupName("myResourceGroup")
            .resourceName("testHub")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.devices.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="myPrivateEndpointConnection",
    properties=azure_native.devices.PrivateEndpointConnectionPropertiesArgs(
        private_link_service_connection_state=azure_native.devices.PrivateLinkServiceConnectionStateArgs(
            description="Approved by johndoe@contoso.com",
            status="Approved",
        ),
    ),
    resource_group_name="myResourceGroup",
    resource_name_="testHub")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpointConnection = new azure_native.devices.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "myPrivateEndpointConnection",
    properties: {
        privateLinkServiceConnectionState: {
            description: "Approved by johndoe@contoso.com",
            status: "Approved",
        },
    },
    resourceGroupName: "myResourceGroup",
    resourceName: "testHub",
});
resources:
  privateEndpointConnection:
    type: azure-native:devices:PrivateEndpointConnection
    properties:
      privateEndpointConnectionName: myPrivateEndpointConnection
      properties:
        privateLinkServiceConnectionState:
          description: Approved by johndoe@contoso.com
          status: Approved
      resourceGroupName: myResourceGroup
      resourceName: testHub

Create a 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:devices: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.Devices.Inputs.PrivateEndpointConnectionPropertiesArgs

The properties of a private endpoint connection

ResourceGroupName string

The name of the resource group that contains the IoT hub.

ResourceName string

The name of the IoT hub.

PrivateEndpointConnectionName string

The name of the private endpoint connection

Properties PrivateEndpointConnectionPropertiesArgs

The properties of a private endpoint connection

ResourceGroupName string

The name of the resource group that contains the IoT hub.

ResourceName string

The name of the IoT hub.

PrivateEndpointConnectionName string

The name of the private endpoint connection

properties PrivateEndpointConnectionPropertiesArgs

The properties of a private endpoint connection

resourceGroupName String

The name of the resource group that contains the IoT hub.

resourceName String

The name of the IoT hub.

privateEndpointConnectionName String

The name of the private endpoint connection

properties PrivateEndpointConnectionPropertiesArgs

The properties of a private endpoint connection

resourceGroupName string

The name of the resource group that contains the IoT hub.

resourceName string

The name of the IoT hub.

privateEndpointConnectionName string

The name of the private endpoint connection

properties PrivateEndpointConnectionPropertiesArgs

The properties of a private endpoint connection

resource_group_name str

The name of the resource group that contains the IoT hub.

resource_name str

The name of the IoT hub.

private_endpoint_connection_name str

The name of the private endpoint connection

properties Property Map

The properties of a private endpoint connection

resourceGroupName String

The name of the resource group that contains the IoT hub.

resourceName String

The name of the IoT hub.

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

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionState

The current state of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionState

The current state of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionState

The current state of a private endpoint connection

private_link_service_connection_state PrivateLinkServiceConnectionState

The current state of a private endpoint connection

privateLinkServiceConnectionState Property Map

The current state of a private endpoint connection

PrivateEndpointConnectionPropertiesResponse

PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

PrivateEndpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

privateEndpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

privateEndpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

private_link_service_connection_state PrivateLinkServiceConnectionStateResponse

The current state of a private endpoint connection

private_endpoint PrivateEndpointResponse

The private endpoint property of a private endpoint connection

privateLinkServiceConnectionState Property Map

The current state of a private endpoint connection

privateEndpoint Property Map

The private endpoint property of a private endpoint connection

PrivateEndpointResponse

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.

PrivateLinkServiceConnectionState

Description string

The description for the current state of a private endpoint connection

Status string | Pulumi.AzureNative.Devices.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

PrivateLinkServiceConnectionStateResponse

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

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:devices:PrivateEndpointConnection myPrivateEndpointConnection /subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0