Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Azure Native

v1.42.0 published on Monday, Oct 25, 2021 by Pulumi

PrivateEndpointConnection

A private endpoint connection API Version: 2019-10-17-preview.

Example Usage

Approve or reject a private endpoint connection with a given name.

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var privateEndpointConnection = new AzureNative.Insights.PrivateEndpointConnection("privateEndpointConnection", new AzureNative.Insights.PrivateEndpointConnectionArgs
        {
            PrivateEndpointConnectionName = "private-endpoint-connection-name",
            PrivateLinkServiceConnectionState = new AzureNative.Insights.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
            {
                Description = "Approved by johndoe@contoso.com",
                Status = "Approved",
            },
            ResourceGroupName = "MyResourceGroup",
            ScopeName = "MyPrivateLinkScope",
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &insights.PrivateEndpointConnectionArgs{
			PrivateEndpointConnectionName: pulumi.String("private-endpoint-connection-name"),
			PrivateLinkServiceConnectionState: &insights.PrivateLinkServiceConnectionStatePropertyArgs{
				Description: pulumi.String("Approved by johndoe@contoso.com"),
				Status:      pulumi.String("Approved"),
			},
			ResourceGroupName: pulumi.String("MyResourceGroup"),
			ScopeName:         pulumi.String("MyPrivateLinkScope"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.insights.PrivateEndpointConnection("privateEndpointConnection",
    private_endpoint_connection_name="private-endpoint-connection-name",
    private_link_service_connection_state=azure_native.insights.PrivateLinkServiceConnectionStatePropertyArgs(
        description="Approved by johndoe@contoso.com",
        status="Approved",
    ),
    resource_group_name="MyResourceGroup",
    scope_name="MyPrivateLinkScope")

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

const privateEndpointConnection = new azure_native.insights.PrivateEndpointConnection("privateEndpointConnection", {
    privateEndpointConnectionName: "private-endpoint-connection-name",
    privateLinkServiceConnectionState: {
        description: "Approved by johndoe@contoso.com",
        status: "Approved",
    },
    resourceGroupName: "MyResourceGroup",
    scopeName: "MyPrivateLinkScope",
});

Create a PrivateEndpointConnection Resource

new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              private_endpoint: Optional[PrivateEndpointPropertyArgs] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[PrivateLinkServiceConnectionStatePropertyArgs] = None,
                              resource_group_name: Optional[str] = None,
                              scope_name: Optional[str] = None)
@overload
def PrivateEndpointConnection(resource_name: str,
                              args: PrivateEndpointConnectionArgs,
                              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)
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.

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:

ResourceGroupName string
The name of the resource group.
ScopeName string
The name of the Azure Monitor PrivateLinkScope resource.
PrivateEndpoint Pulumi.AzureNative.Insights.Inputs.PrivateEndpointPropertyArgs
Private endpoint which the connection belongs to.
PrivateEndpointConnectionName string
The name of the private endpoint connection.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Insights.Inputs.PrivateLinkServiceConnectionStatePropertyArgs
Connection state of the private endpoint connection.
ResourceGroupName string
The name of the resource group.
ScopeName string
The name of the Azure Monitor PrivateLinkScope resource.
PrivateEndpoint PrivateEndpointPropertyArgs
Private endpoint which the connection belongs to.
PrivateEndpointConnectionName string
The name of the private endpoint connection.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyArgs
Connection state of the private endpoint connection.
resourceGroupName string
The name of the resource group.
scopeName string
The name of the Azure Monitor PrivateLinkScope resource.
privateEndpoint PrivateEndpointPropertyArgs
Private endpoint which the connection belongs to.
privateEndpointConnectionName string
The name of the private endpoint connection.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyArgs
Connection state of the private endpoint connection.
resource_group_name str
The name of the resource group.
scope_name str
The name of the Azure Monitor PrivateLinkScope resource.
private_endpoint PrivateEndpointPropertyArgs
Private endpoint which the connection belongs to.
private_endpoint_connection_name str
The name of the private endpoint connection.
private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyArgs
Connection 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.
Name string
Azure resource name
ProvisioningState string
State of the private endpoint connection.
Type string
Azure resource type
Id string
The provider-assigned unique ID for this managed resource.
Name string
Azure resource name
ProvisioningState string
State of the private endpoint connection.
Type string
Azure resource type
id string
The provider-assigned unique ID for this managed resource.
name string
Azure resource name
provisioningState string
State of the private endpoint connection.
type string
Azure resource type
id str
The provider-assigned unique ID for this managed resource.
name str
Azure resource name
provisioning_state str
State of the private endpoint connection.
type str
Azure resource type

Supporting Types

PrivateEndpointProperty

Id string
Resource id of the private endpoint.
Id string
Resource id of the private endpoint.
id string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.

PrivateEndpointPropertyResponse

Id string
Resource id of the private endpoint.
Id string
Resource id of the private endpoint.
id string
Resource id of the private endpoint.
id str
Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Description string
The private link service connection description.
Status string
The private link service connection status.
Description string
The private link service connection description.
Status string
The private link service connection status.
description string
The private link service connection description.
status string
The private link service connection status.
description str
The private link service connection description.
status str
The private link service connection status.

PrivateLinkServiceConnectionStatePropertyResponse

ActionsRequired string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
ActionsRequired string
The actions required for private link service connection.
Description string
The private link service connection description.
Status string
The private link service connection status.
actionsRequired string
The actions required for private link service connection.
description string
The private link service connection description.
status string
The private link service connection status.
actions_required str
The actions required for private link service connection.
description str
The private link service connection description.
status str
The private link service connection status.

Import

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

$ pulumi import azure-native:insights:PrivateEndpointConnection private-endpoint-connection-name /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/privateLinkScopes/MyPrivateLinkScope/privateEndpointConnections/private-endpoint-connection-name 

Package Details

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