1. Packages
  2. Azure Native
  3. API Docs
  4. webpubsub
  5. getWebPubSubPrivateEndpointConnection
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.webpubsub.getWebPubSubPrivateEndpointConnection

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 the specified private endpoint connection

    Uses Azure REST API version 2024-03-01.

    Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native webpubsub [ApiVersion]. See the version guide for details.

    Using getWebPubSubPrivateEndpointConnection

    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 getWebPubSubPrivateEndpointConnection(args: GetWebPubSubPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetWebPubSubPrivateEndpointConnectionResult>
function getWebPubSubPrivateEndpointConnectionOutput(args: GetWebPubSubPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetWebPubSubPrivateEndpointConnectionResult>
    def get_web_pub_sub_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) -> GetWebPubSubPrivateEndpointConnectionResult
def get_web_pub_sub_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[GetWebPubSubPrivateEndpointConnectionResult]
    func LookupWebPubSubPrivateEndpointConnection(ctx *Context, args *LookupWebPubSubPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupWebPubSubPrivateEndpointConnectionResult, error)
func LookupWebPubSubPrivateEndpointConnectionOutput(ctx *Context, args *LookupWebPubSubPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupWebPubSubPrivateEndpointConnectionResultOutput

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

    public static class GetWebPubSubPrivateEndpointConnection 
{
    public static Task<GetWebPubSubPrivateEndpointConnectionResult> InvokeAsync(GetWebPubSubPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetWebPubSubPrivateEndpointConnectionResult> Invoke(GetWebPubSubPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWebPubSubPrivateEndpointConnectionResult> getWebPubSubPrivateEndpointConnection(GetWebPubSubPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetWebPubSubPrivateEndpointConnectionResult> getWebPubSubPrivateEndpointConnection(GetWebPubSubPrivateEndpointConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:webpubsub:getWebPubSubPrivateEndpointConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the resource.
    PrivateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ResourceName string
    The name of the resource.
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Azure resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the resource.
    privateEndpointConnectionName string
    The name of the private endpoint connection associated with the Azure resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    resourceName string
    The name of the resource.
    private_endpoint_connection_name str
    The name of the private endpoint connection associated with the Azure resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    resource_name str
    The name of the resource.
    privateEndpointConnectionName String
    The name of the private endpoint connection associated with the Azure resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    resourceName String
    The name of the resource.

    getWebPubSubPrivateEndpointConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    GroupIds List<string>
    Group IDs
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData Pulumi.AzureNative.WebPubSub.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint Pulumi.AzureNative.WebPubSub.Outputs.PrivateEndpointResponse
    Private endpoint
    PrivateLinkServiceConnectionState Pulumi.AzureNative.WebPubSub.Outputs.PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection
    AzureApiVersion string
    The Azure API version of the resource.
    GroupIds []string
    Group IDs
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    PrivateEndpoint PrivateEndpointResponse
    Private endpoint
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection
    azureApiVersion String
    The Azure API version of the resource.
    groupIds List<String>
    Group IDs
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    Private endpoint
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection
    azureApiVersion string
    The Azure API version of the resource.
    groupIds string[]
    Group IDs
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint PrivateEndpointResponse
    Private endpoint
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection
    azure_api_version str
    The Azure API version of the resource.
    group_ids Sequence[str]
    Group IDs
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    private_endpoint PrivateEndpointResponse
    Private endpoint
    private_link_service_connection_state PrivateLinkServiceConnectionStateResponse
    Connection state of the private endpoint connection
    azureApiVersion String
    The Azure API version of the resource.
    groupIds List<String>
    Group IDs
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    privateEndpoint Property Map
    Private endpoint
    privateLinkServiceConnectionState Property Map
    Connection state of the private endpoint connection

    Supporting Types

    PrivateEndpointResponse

    Id string
    Full qualified Id of the private endpoint
    Id string
    Full qualified Id of the private endpoint
    id String
    Full qualified Id of the private endpoint
    id string
    Full qualified Id of the private endpoint
    id str
    Full qualified Id of the private endpoint
    id String
    Full qualified Id of the private endpoint

    PrivateLinkServiceConnectionStateResponse

    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    ActionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    Description string
    The reason for approval/rejection of the connection.
    Status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired string
    A message indicating if changes on the service provider require any updates on the consumer.
    description string
    The reason for approval/rejection of the connection.
    status string
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actions_required str
    A message indicating if changes on the service provider require any updates on the consumer.
    description str
    The reason for approval/rejection of the connection.
    status str
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
    actionsRequired String
    A message indicating if changes on the service provider require any updates on the consumer.
    description String
    The reason for approval/rejection of the connection.
    status String
    Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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