1. Packages
  2. Azure Native
  3. API Docs
  4. iothub
  5. getPrivateEndpointConnection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.iothub.getPrivateEndpointConnection

Get Started
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get private endpoint connection properties

    Uses Azure REST API version 2023-06-30.

    Other available API versions: 2020-03-01, 2020-04-01, 2020-06-15, 2020-07-10-preview, 2020-08-01, 2020-08-31, 2020-08-31-preview, 2021-02-01-preview, 2021-03-03-preview, 2021-03-31, 2021-07-01, 2021-07-01-preview, 2021-07-02, 2021-07-02-preview, 2022-04-30-preview, 2022-11-15-preview, 2023-06-30-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native iothub [ApiVersion]. See the version guide for details.

    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?: InvokeOptions): 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: Optional[pulumi.Input[str]] = None,
                                    resource_group_name: Optional[pulumi.Input[str]] = None,
                                    resource_name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = 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 CompletableFuture<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointConnectionResult> getPrivateEndpointConnection(GetPrivateEndpointConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:iothub:getPrivateEndpointConnection
  arguments:
    # arguments dictionary

    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 IoT hub.
    ResourceName string
    The name of the IoT hub.
    PrivateEndpointConnectionName string
    The name of the 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
    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
    resourceGroupName string
    The name of the resource group that contains the IoT hub.
    resourceName string
    The name of the IoT hub.
    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 IoT hub.
    resource_name str
    The name of the IoT hub.
    privateEndpointConnectionName String
    The name of the private endpoint connection
    resourceGroupName String
    The name of the resource group that contains the IoT hub.
    resourceName String
    The name of the IoT hub.

    getPrivateEndpointConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The resource identifier.
    Name string
    The resource name.
    Properties Pulumi.AzureNative.IoTHub.Outputs.PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    Type string
    The resource type.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The resource identifier.
    Name string
    The resource name.
    Properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    Type string
    The resource type.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The resource identifier.
    name String
    The resource name.
    properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    type String
    The resource type.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The resource identifier.
    name string
    The resource name.
    properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    type string
    The resource type.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The resource identifier.
    name str
    The resource name.
    properties PrivateEndpointConnectionPropertiesResponse
    The properties of a private endpoint connection
    type str
    The resource type.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The resource identifier.
    name String
    The resource name.
    properties Property Map
    The properties of a private endpoint connection
    type String
    The resource type.

    Supporting Types

    PrivateEndpointConnectionPropertiesResponse

    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

    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.

    PrivateLinkServiceConnectionStateResponse

    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

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.8.0 published on Wednesday, Sep 3, 2025 by Pulumi
    pulumi/pulumi-azure-native
      Meet Neo: Your AI Platform Teammate