Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devices
  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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.devices.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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    The private endpoint connection of an IotHub Azure REST API version: 2022-04-30-preview. Prior API version in Azure Native 1.x: 2020-08-31.

    Other available API versions: 2022-11-15-preview, 2023-06-30, 2023-06-30-preview.

    Example Usage

    PrivateEndpointConnection_Update

    using System.Collections.Generic;
using System.Linq;
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 = AzureNative.Devices.PrivateLinkServiceConnectionStatus.Approved,
            },
        },
        ResourceGroupName = "myResourceGroup",
        ResourceName = "testHub",
    });

});

    package main

import (
	devices "github.com/pulumi/pulumi-azure-native-sdk/devices/v2"
	"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(devices.PrivateLinkServiceConnectionStatusApproved),
				},
			},
			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 com.pulumi.azurenative.devices.inputs.PrivateEndpointConnectionPropertiesArgs;
import com.pulumi.azurenative.devices.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()
            .privateEndpointConnectionName("myPrivateEndpointConnection")
            .properties(PrivateEndpointConnectionPropertiesArgs.builder()
                .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
                    .description("Approved by johndoe@contoso.com")
                    .status("Approved")
                    .build())
                .build())
            .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={
        "private_link_service_connection_state": {
            "description": "Approved by johndoe@contoso.com",
            "status": azure_native.devices.PrivateLinkServiceConnectionStatus.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: azure_native.devices.PrivateLinkServiceConnectionStatus.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 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,
                              properties: Optional[PrivateEndpointConnectionPropertiesArgs] = None,
                              resource_group_name: Optional[str] = None,
                              resource_name_: Optional[str] = None,
                              private_endpoint_connection_name: Optional[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:devices: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 exampleprivateEndpointConnectionResourceResourceFromDevices = new AzureNative.Devices.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDevices", new()
{
    Properties = new AzureNative.Devices.Inputs.PrivateEndpointConnectionPropertiesArgs
    {
        PrivateLinkServiceConnectionState = new AzureNative.Devices.Inputs.PrivateLinkServiceConnectionStateArgs
        {
            Description = "string",
            Status = "string",
            ActionsRequired = "string",
        },
    },
    ResourceGroupName = "string",
    ResourceName = "string",
    PrivateEndpointConnectionName = "string",
});

    example, err := devices.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromDevices", &devices.PrivateEndpointConnectionArgs{
	Properties: &devices.PrivateEndpointConnectionPropertiesArgs{
		PrivateLinkServiceConnectionState: &devices.PrivateLinkServiceConnectionStateArgs{
			Description:     pulumi.String("string"),
			Status:          pulumi.String("string"),
			ActionsRequired: pulumi.String("string"),
		},
	},
	ResourceGroupName:             pulumi.String("string"),
	ResourceName:                  pulumi.String("string"),
	PrivateEndpointConnectionName: pulumi.String("string"),
})

    var exampleprivateEndpointConnectionResourceResourceFromDevices = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDevices", PrivateEndpointConnectionArgs.builder()
    .properties(PrivateEndpointConnectionPropertiesArgs.builder()
        .privateLinkServiceConnectionState(PrivateLinkServiceConnectionStateArgs.builder()
            .description("string")
            .status("string")
            .actionsRequired("string")
            .build())
        .build())
    .resourceGroupName("string")
    .resourceName("string")
    .privateEndpointConnectionName("string")
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_devices = azure_native.devices.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDevices",
    properties={
        "private_link_service_connection_state": {
            "description": "string",
            "status": "string",
            "actions_required": "string",
        },
    },
    resource_group_name="string",
    resource_name_="string",
    private_endpoint_connection_name="string")

    const exampleprivateEndpointConnectionResourceResourceFromDevices = new azure_native.devices.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromDevices", {
    properties: {
        privateLinkServiceConnectionState: {
            description: "string",
            status: "string",
            actionsRequired: "string",
        },
    },
    resourceGroupName: "string",
    resourceName: "string",
    privateEndpointConnectionName: "string",
});

    type: azure-native:devices:PrivateEndpointConnection
properties:
    privateEndpointConnectionName: string
    properties:
        privateLinkServiceConnectionState:
            actionsRequired: string
            description: string
            status: string
    resourceGroupName: string
    resourceName: 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:

    Properties Pulumi.AzureNative.Devices.Inputs.PrivateEndpointConnectionProperties
    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 PrivateEndpointConnectionProperties
    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 PrivateEndpointConnectionProperties
    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, PrivateEndpointConnectionPropertiesArgs

    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, PrivateEndpointConnectionPropertiesResponseArgs

    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, PrivateEndpointResponseArgs

    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, PrivateLinkServiceConnectionStateArgs

    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, PrivateLinkServiceConnectionStateResponseArgs

    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, PrivateLinkServiceConnectionStatusArgs

    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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native