Azure Native

Pulumi Official
Package maintained by Pulumi
v1.67.0 published on Tuesday, Jul 12, 2022 by Pulumi

PrivateEndpointConnection

API Version: 2020-06-01.

Example Usage

PrivateEndpointConnections_Update

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var privateEndpointConnection = new AzureNative.EventGrid.PrivateEndpointConnection("privateEndpointConnection", new AzureNative.EventGrid.PrivateEndpointConnectionArgs
        {
            ParentName = "exampletopic1",
            ParentType = "topics",
            PrivateEndpointConnectionName = "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B",
            PrivateLinkServiceConnectionState = new AzureNative.EventGrid.Inputs.ConnectionStateArgs
            {
                ActionsRequired = "None",
                Description = "approving connection",
                Status = "Approved",
            },
            ResourceGroupName = "examplerg",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := eventgrid.NewPrivateEndpointConnection(ctx, "privateEndpointConnection", &eventgrid.PrivateEndpointConnectionArgs{
			ParentName:                    pulumi.String("exampletopic1"),
			ParentType:                    pulumi.String("topics"),
			PrivateEndpointConnectionName: pulumi.String("BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B"),
			PrivateLinkServiceConnectionState: &eventgrid.ConnectionStateArgs{
				ActionsRequired: pulumi.String("None"),
				Description:     pulumi.String("approving connection"),
				Status:          pulumi.String("Approved"),
			},
			ResourceGroupName: pulumi.String("examplerg"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()        
            .parentName("exampletopic1")
            .parentType("topics")
            .privateEndpointConnectionName("BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B")
            .privateLinkServiceConnectionState(Map.ofEntries(
                Map.entry("actionsRequired", "None"),
                Map.entry("description", "approving connection"),
                Map.entry("status", "Approved")
            ))
            .resourceGroupName("examplerg")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

private_endpoint_connection = azure_native.eventgrid.PrivateEndpointConnection("privateEndpointConnection",
    parent_name="exampletopic1",
    parent_type="topics",
    private_endpoint_connection_name="BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B",
    private_link_service_connection_state=azure_native.eventgrid.ConnectionStateArgs(
        actions_required="None",
        description="approving connection",
        status="Approved",
    ),
    resource_group_name="examplerg")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const privateEndpointConnection = new azure_native.eventgrid.PrivateEndpointConnection("privateEndpointConnection", {
    parentName: "exampletopic1",
    parentType: "topics",
    privateEndpointConnectionName: "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B",
    privateLinkServiceConnectionState: {
        actionsRequired: "None",
        description: "approving connection",
        status: "Approved",
    },
    resourceGroupName: "examplerg",
});
resources:
  privateEndpointConnection:
    type: azure-native:eventgrid:PrivateEndpointConnection
    properties:
      parentName: exampletopic1
      parentType: topics
      privateEndpointConnectionName: BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B
      privateLinkServiceConnectionState:
        actionsRequired: None
        description: approving connection
        status: Approved
      resourceGroupName: examplerg

Create a PrivateEndpointConnection Resource

new PrivateEndpointConnection(name: string, args: PrivateEndpointConnectionArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointConnection(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              group_ids: Optional[Sequence[str]] = None,
                              parent_name: Optional[str] = None,
                              parent_type: Optional[str] = None,
                              private_endpoint: Optional[PrivateEndpointArgs] = None,
                              private_endpoint_connection_name: Optional[str] = None,
                              private_link_service_connection_state: Optional[ConnectionStateArgs] = None,
                              provisioning_state: Optional[Union[str, ResourceProvisioningState]] = None,
                              resource_group_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)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args)
public PrivateEndpointConnection(String name, PrivateEndpointConnectionArgs args, CustomResourceOptions options)
type: azure-native:eventgrid: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 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.

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:

ParentName string

The name of the parent resource (namely, either, the topic name or domain name).

ParentType string

The type of the parent resource. This can be either 'topics' or 'domains'.

ResourceGroupName string

The name of the resource group within the user's subscription.

GroupIds List<string>

GroupIds from the private link service resource.

PrivateEndpoint Pulumi.AzureNative.EventGrid.Inputs.PrivateEndpointArgs

The Private Endpoint resource for this Connection.

PrivateEndpointConnectionName string

The name of the private endpoint connection connection.

PrivateLinkServiceConnectionState Pulumi.AzureNative.EventGrid.Inputs.ConnectionStateArgs

Details about the state of the connection.

ProvisioningState string | Pulumi.AzureNative.EventGrid.ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

ParentName string

The name of the parent resource (namely, either, the topic name or domain name).

ParentType string

The type of the parent resource. This can be either 'topics' or 'domains'.

ResourceGroupName string

The name of the resource group within the user's subscription.

GroupIds []string

GroupIds from the private link service resource.

PrivateEndpoint PrivateEndpointArgs

The Private Endpoint resource for this Connection.

PrivateEndpointConnectionName string

The name of the private endpoint connection connection.

PrivateLinkServiceConnectionState ConnectionStateArgs

Details about the state of the connection.

ProvisioningState string | ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

parentName String

The name of the parent resource (namely, either, the topic name or domain name).

parentType String

The type of the parent resource. This can be either 'topics' or 'domains'.

resourceGroupName String

The name of the resource group within the user's subscription.

groupIds List<String>

GroupIds from the private link service resource.

privateEndpoint PrivateEndpointArgs

The Private Endpoint resource for this Connection.

privateEndpointConnectionName String

The name of the private endpoint connection connection.

privateLinkServiceConnectionState ConnectionStateArgs

Details about the state of the connection.

provisioningState String | ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

parentName string

The name of the parent resource (namely, either, the topic name or domain name).

parentType string

The type of the parent resource. This can be either 'topics' or 'domains'.

resourceGroupName string

The name of the resource group within the user's subscription.

groupIds string[]

GroupIds from the private link service resource.

privateEndpoint PrivateEndpointArgs

The Private Endpoint resource for this Connection.

privateEndpointConnectionName string

The name of the private endpoint connection connection.

privateLinkServiceConnectionState ConnectionStateArgs

Details about the state of the connection.

provisioningState string | ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

parent_name str

The name of the parent resource (namely, either, the topic name or domain name).

parent_type str

The type of the parent resource. This can be either 'topics' or 'domains'.

resource_group_name str

The name of the resource group within the user's subscription.

group_ids Sequence[str]

GroupIds from the private link service resource.

private_endpoint PrivateEndpointArgs

The Private Endpoint resource for this Connection.

private_endpoint_connection_name str

The name of the private endpoint connection connection.

private_link_service_connection_state ConnectionStateArgs

Details about the state of the connection.

provisioning_state str | ResourceProvisioningState

Provisioning state of the Private Endpoint Connection.

parentName String

The name of the parent resource (namely, either, the topic name or domain name).

parentType String

The type of the parent resource. This can be either 'topics' or 'domains'.

resourceGroupName String

The name of the resource group within the user's subscription.

groupIds List<String>

GroupIds from the private link service resource.

privateEndpoint Property Map

The Private Endpoint resource for this Connection.

privateEndpointConnectionName String

The name of the private endpoint connection connection.

privateLinkServiceConnectionState Property Map

Details about the state of the connection.

provisioningState String | "Creating" | "Updating" | "Deleting" | "Succeeded" | "Canceled" | "Failed"

Provisioning 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

Name of the resource.

Type string

Type of the resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Name of the resource.

Type string

Type of the resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Name of the resource.

type String

Type of the resource.

id string

The provider-assigned unique ID for this managed resource.

name string

Name of the resource.

type string

Type of the resource.

id str

The provider-assigned unique ID for this managed resource.

name str

Name of the resource.

type str

Type of the resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Name of the resource.

type String

Type of the resource.

Supporting Types

ConnectionState

ActionsRequired string

Actions required (if any).

Description string

Description of the connection state.

Status string | Pulumi.AzureNative.EventGrid.PersistedConnectionStatus

Status of the connection.

ActionsRequired string

Actions required (if any).

Description string

Description of the connection state.

Status string | PersistedConnectionStatus

Status of the connection.

actionsRequired String

Actions required (if any).

description String

Description of the connection state.

status String | PersistedConnectionStatus

Status of the connection.

actionsRequired string

Actions required (if any).

description string

Description of the connection state.

status string | PersistedConnectionStatus

Status of the connection.

actions_required str

Actions required (if any).

description str

Description of the connection state.

status str | PersistedConnectionStatus

Status of the connection.

actionsRequired String

Actions required (if any).

description String

Description of the connection state.

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

Status of the connection.

ConnectionStateResponse

ActionsRequired string

Actions required (if any).

Description string

Description of the connection state.

Status string

Status of the connection.

ActionsRequired string

Actions required (if any).

Description string

Description of the connection state.

Status string

Status of the connection.

actionsRequired String

Actions required (if any).

description String

Description of the connection state.

status String

Status of the connection.

actionsRequired string

Actions required (if any).

description string

Description of the connection state.

status string

Status of the connection.

actions_required str

Actions required (if any).

description str

Description of the connection state.

status str

Status of the connection.

actionsRequired String

Actions required (if any).

description String

Description of the connection state.

status String

Status of the connection.

PersistedConnectionStatus

Pending
Pending
Approved
Approved
Rejected
Rejected
Disconnected
Disconnected
PersistedConnectionStatusPending
Pending
PersistedConnectionStatusApproved
Approved
PersistedConnectionStatusRejected
Rejected
PersistedConnectionStatusDisconnected
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

PrivateEndpoint

Id string

The ARM identifier for Private Endpoint.

Id string

The ARM identifier for Private Endpoint.

id String

The ARM identifier for Private Endpoint.

id string

The ARM identifier for Private Endpoint.

id str

The ARM identifier for Private Endpoint.

id String

The ARM identifier for Private Endpoint.

PrivateEndpointResponse

Id string

The ARM identifier for Private Endpoint.

Id string

The ARM identifier for Private Endpoint.

id String

The ARM identifier for Private Endpoint.

id string

The ARM identifier for Private Endpoint.

id str

The ARM identifier for Private Endpoint.

id String

The ARM identifier for Private Endpoint.

ResourceProvisioningState

Creating
Creating
Updating
Updating
Deleting
Deleting
Succeeded
Succeeded
Canceled
Canceled
Failed
Failed
ResourceProvisioningStateCreating
Creating
ResourceProvisioningStateUpdating
Updating
ResourceProvisioningStateDeleting
Deleting
ResourceProvisioningStateSucceeded
Succeeded
ResourceProvisioningStateCanceled
Canceled
ResourceProvisioningStateFailed
Failed
Creating
Creating
Updating
Updating
Deleting
Deleting
Succeeded
Succeeded
Canceled
Canceled
Failed
Failed
Creating
Creating
Updating
Updating
Deleting
Deleting
Succeeded
Succeeded
Canceled
Canceled
Failed
Failed
CREATING
Creating
UPDATING
Updating
DELETING
Deleting
SUCCEEDED
Succeeded
CANCELED
Canceled
FAILED
Failed
"Creating"
Creating
"Updating"
Updating
"Deleting"
Deleting
"Succeeded"
Succeeded
"Canceled"
Canceled
"Failed"
Failed

Import

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

$ pulumi import azure-native:eventgrid:PrivateEndpointConnection BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B /subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B 

Package Details

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