Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. eventgrid
  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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.eventgrid.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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    Azure REST API version: 2022-06-15. Prior API version in Azure Native 1.x: 2020-06-01.

    Other available API versions: 2023-06-01-preview, 2023-12-15-preview, 2024-06-01-preview, 2024-12-15-preview, 2025-02-15.

    Example Usage

    PrivateEndpointConnections_Update

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

return await Deployment.RunAsync(() => 
{
    var privateEndpointConnection = new AzureNative.EventGrid.PrivateEndpointConnection("privateEndpointConnection", new()
    {
        ParentName = "exampletopic1",
        ParentType = "topics",
        PrivateEndpointConnectionName = "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B",
        PrivateLinkServiceConnectionState = new AzureNative.EventGrid.Inputs.ConnectionStateArgs
        {
            ActionsRequired = "None",
            Description = "approving connection",
            Status = AzureNative.EventGrid.PersistedConnectionStatus.Approved,
        },
        ResourceGroupName = "examplerg",
    });

});

    package main

import (
	eventgrid "github.com/pulumi/pulumi-azure-native-sdk/eventgrid/v2"
	"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(eventgrid.PersistedConnectionStatusApproved),
			},
			ResourceGroupName: pulumi.String("examplerg"),
		})
		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.eventgrid.PrivateEndpointConnection;
import com.pulumi.azurenative.eventgrid.PrivateEndpointConnectionArgs;
import com.pulumi.azurenative.eventgrid.inputs.ConnectionStateArgs;
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()
            .parentName("exampletopic1")
            .parentType("topics")
            .privateEndpointConnectionName("BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B")
            .privateLinkServiceConnectionState(ConnectionStateArgs.builder()
                .actionsRequired("None")
                .description("approving connection")
                .status("Approved")
                .build())
            .resourceGroupName("examplerg")
            .build());

    }
}

    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: azure_native.eventgrid.PersistedConnectionStatus.Approved,
    },
    resourceGroupName: "examplerg",
});

    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={
        "actions_required": "None",
        "description": "approving connection",
        "status": azure_native.eventgrid.PersistedConnectionStatus.APPROVED,
    },
    resource_group_name="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 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,
                              parent_name: Optional[str] = None,
                              parent_type: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              group_ids: Optional[Sequence[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)
    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.

    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 exampleprivateEndpointConnectionResourceResourceFromEventgrid = new AzureNative.EventGrid.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromEventgrid", new()
{
    ParentName = "string",
    ParentType = "string",
    ResourceGroupName = "string",
    GroupIds = new[]
    {
        "string",
    },
    PrivateEndpoint = new AzureNative.EventGrid.Inputs.PrivateEndpointArgs
    {
        Id = "string",
    },
    PrivateEndpointConnectionName = "string",
    PrivateLinkServiceConnectionState = new AzureNative.EventGrid.Inputs.ConnectionStateArgs
    {
        ActionsRequired = "string",
        Description = "string",
        Status = "string",
    },
    ProvisioningState = "string",
});

    example, err := eventgrid.NewPrivateEndpointConnection(ctx, "exampleprivateEndpointConnectionResourceResourceFromEventgrid", &eventgrid.PrivateEndpointConnectionArgs{
	ParentName:        pulumi.String("string"),
	ParentType:        pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PrivateEndpoint: &eventgrid.PrivateEndpointArgs{
		Id: pulumi.String("string"),
	},
	PrivateEndpointConnectionName: pulumi.String("string"),
	PrivateLinkServiceConnectionState: &eventgrid.ConnectionStateArgs{
		ActionsRequired: pulumi.String("string"),
		Description:     pulumi.String("string"),
		Status:          pulumi.String("string"),
	},
	ProvisioningState: pulumi.String("string"),
})

    var exampleprivateEndpointConnectionResourceResourceFromEventgrid = new PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromEventgrid", PrivateEndpointConnectionArgs.builder()
    .parentName("string")
    .parentType("string")
    .resourceGroupName("string")
    .groupIds("string")
    .privateEndpoint(PrivateEndpointArgs.builder()
        .id("string")
        .build())
    .privateEndpointConnectionName("string")
    .privateLinkServiceConnectionState(ConnectionStateArgs.builder()
        .actionsRequired("string")
        .description("string")
        .status("string")
        .build())
    .provisioningState("string")
    .build());

    exampleprivate_endpoint_connection_resource_resource_from_eventgrid = azure_native.eventgrid.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromEventgrid",
    parent_name="string",
    parent_type="string",
    resource_group_name="string",
    group_ids=["string"],
    private_endpoint={
        "id": "string",
    },
    private_endpoint_connection_name="string",
    private_link_service_connection_state={
        "actions_required": "string",
        "description": "string",
        "status": "string",
    },
    provisioning_state="string")

    const exampleprivateEndpointConnectionResourceResourceFromEventgrid = new azure_native.eventgrid.PrivateEndpointConnection("exampleprivateEndpointConnectionResourceResourceFromEventgrid", {
    parentName: "string",
    parentType: "string",
    resourceGroupName: "string",
    groupIds: ["string"],
    privateEndpoint: {
        id: "string",
    },
    privateEndpointConnectionName: "string",
    privateLinkServiceConnectionState: {
        actionsRequired: "string",
        description: "string",
        status: "string",
    },
    provisioningState: "string",
});

    type: azure-native:eventgrid:PrivateEndpointConnection
properties:
    groupIds:
        - string
    parentName: string
    parentType: string
    privateEndpoint:
        id: string
    privateEndpointConnectionName: string
    privateLinkServiceConnectionState:
        actionsRequired: string
        description: string
        status: string
    provisioningState: string
    resourceGroupName: 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:

    ParentName string
    The name of the parent resource (namely, either, the topic name, domain name, or partner namespace name).
    ParentType string
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    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.PrivateEndpoint
    The Private Endpoint resource for this Connection.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection connection.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.EventGrid.Inputs.ConnectionState
    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, domain name, or partner namespace name).
    ParentType string
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    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, domain name, or partner namespace name).
    parentType String
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    resourceGroupName String
    The name of the resource group within the user's subscription.
    groupIds List<String>
    GroupIds from the private link service resource.
    privateEndpoint PrivateEndpoint
    The Private Endpoint resource for this Connection.
    privateEndpointConnectionName String
    The name of the private endpoint connection connection.
    privateLinkServiceConnectionState ConnectionState
    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, domain name, or partner namespace name).
    parentType string
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    resourceGroupName string
    The name of the resource group within the user's subscription.
    groupIds string[]
    GroupIds from the private link service resource.
    privateEndpoint PrivateEndpoint
    The Private Endpoint resource for this Connection.
    privateEndpointConnectionName string
    The name of the private endpoint connection connection.
    privateLinkServiceConnectionState ConnectionState
    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, domain name, or partner namespace name).
    parent_type str
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    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, domain name, or partner namespace name).
    parentType String
    The type of the parent resource. This can be either 'topics', 'domains', or 'partnerNamespaces'.
    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, ConnectionStateArgs

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

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

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

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

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

    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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native