1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. digitaltwins
  6. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v1.103.0 (Older version)
published on Tuesday, Oct 27, 2026 by Pulumi
azure-native logo Azure Native
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v1.103.0 (Older version)
published on Tuesday, Oct 27, 2026 by Pulumi

    Get private endpoint connection properties for the given private endpoint. API Version: 2020-12-01.

    Using getPrivateEndpointConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrivateEndpointConnection(args: GetPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointConnectionResult>
    function getPrivateEndpointConnectionOutput(args: GetPrivateEndpointConnectionOutputArgs, opts?: InvokeOutputOptions): Output<GetPrivateEndpointConnectionResult>
    def get_private_endpoint_connection(private_endpoint_connection_name: Optional[str] = None,
                                        resource_group_name: Optional[str] = None,
                                        resource_name: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointConnectionResult
    def get_private_endpoint_connection_output(private_endpoint_connection_name: pulumi.Input[Optional[str]] = None,
                                        resource_group_name: pulumi.Input[Optional[str]] = None,
                                        resource_name: pulumi.Input[Optional[str]] = None,
                                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetPrivateEndpointConnectionResult]
    func LookupPrivateEndpointConnection(ctx *Context, args *LookupPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupPrivateEndpointConnectionResult, error)
    func LookupPrivateEndpointConnectionOutput(ctx *Context, args *LookupPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupPrivateEndpointConnectionResultOutput

    > Note: This function is named LookupPrivateEndpointConnection in the Go SDK.

    public static class GetPrivateEndpointConnection 
    {
        public static Task<GetPrivateEndpointConnectionResult> InvokeAsync(GetPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivateEndpointConnectionResult> Invoke(GetPrivateEndpointConnectionInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
    public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
    public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: azure-native:digitaltwins:getPrivateEndpointConnection
      arguments:
        # arguments dictionary
    data "azure-native_digitaltwins_get_private_endpoint_connection" "name" {
        # arguments
    }

    The following arguments are supported:

    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    ResourceName string
    The name of the DigitalTwinsInstance.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    ResourceName string
    The name of the DigitalTwinsInstance.
    private_endpoint_connection_name string
    The name of the private endpoint connection.
    resource_group_name string
    The name of the resource group that contains the DigitalTwinsInstance.
    resource_name string
    The name of the DigitalTwinsInstance.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName String
    The name of the DigitalTwinsInstance.
    privateEndpointConnectionName string
    The name of the private endpoint connection.
    resourceGroupName string
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName string
    The name of the DigitalTwinsInstance.
    private_endpoint_connection_name str
    The name of the private endpoint connection.
    resource_group_name str
    The name of the resource group that contains the DigitalTwinsInstance.
    resource_name str
    The name of the DigitalTwinsInstance.
    privateEndpointConnectionName String
    The name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group that contains the DigitalTwinsInstance.
    resourceName String
    The name of the DigitalTwinsInstance.

    getPrivateEndpointConnection Result

    The following output properties are available:

    Id string
    The resource identifier.
    Name string
    The resource name.
    Properties Pulumi.AzureNative.DigitalTwins.Outputs.PrivateEndpointConnectionResponseProperties
    Type string
    The resource type.
    Id string
    The resource identifier.
    Name string
    The resource name.
    Properties PrivateEndpointConnectionResponseProperties
    Type string
    The resource type.
    id string
    The resource identifier.
    name string
    The resource name.
    properties object
    type string
    The resource type.
    id String
    The resource identifier.
    name String
    The resource name.
    properties PrivateEndpointConnectionResponseProperties
    type String
    The resource type.
    id string
    The resource identifier.
    name string
    The resource name.
    properties PrivateEndpointConnectionResponseProperties
    type string
    The resource type.
    id str
    The resource identifier.
    name str
    The resource name.
    properties PrivateEndpointConnectionResponseProperties
    type str
    The resource type.
    id String
    The resource identifier.
    name String
    The resource name.
    properties Property Map
    type String
    The resource type.

    Supporting Types

    ConnectionPropertiesResponsePrivateEndpoint

    Id string
    The resource identifier.
    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.

    ConnectionPropertiesResponsePrivateLinkServiceConnectionState

    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.
    actions_required 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.

    PrivateEndpointConnectionResponseProperties

    provisioning_state string
    The provisioning state.
    group_ids list(string)
    The list of group ids for the private endpoint connection.
    private_endpoint object
    private_link_service_connection_state object
    provisioningState String
    The provisioning state.
    groupIds List<String>
    The list of group ids for the private endpoint connection.
    privateEndpoint Property Map
    privateLinkServiceConnectionState Property Map

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo Azure Native
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v1.103.0 (Older version)
    published on Tuesday, Oct 27, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial