Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. web
  6. getWebAppPrivateEndpointConnection
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 v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.web.getWebAppPrivateEndpointConnection

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.
Viewing docs for Azure Native v3.23.0
published on Saturday, Jul 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Description for Gets a private endpoint connection

    Uses Azure REST API version 2025-05-01.

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

    Using getWebAppPrivateEndpointConnection

    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 getWebAppPrivateEndpointConnection(args: GetWebAppPrivateEndpointConnectionArgs, opts?: InvokeOptions): Promise<GetWebAppPrivateEndpointConnectionResult>
function getWebAppPrivateEndpointConnectionOutput(args: GetWebAppPrivateEndpointConnectionOutputArgs, opts?: InvokeOptions): Output<GetWebAppPrivateEndpointConnectionResult>
    def get_web_app_private_endpoint_connection(name: Optional[str] = None,
                                            private_endpoint_connection_name: Optional[str] = None,
                                            resource_group_name: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetWebAppPrivateEndpointConnectionResult
def get_web_app_private_endpoint_connection_output(name: pulumi.Input[Optional[str]] = None,
                                            private_endpoint_connection_name: pulumi.Input[Optional[str]] = None,
                                            resource_group_name: pulumi.Input[Optional[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetWebAppPrivateEndpointConnectionResult]
    func LookupWebAppPrivateEndpointConnection(ctx *Context, args *LookupWebAppPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupWebAppPrivateEndpointConnectionResult, error)
func LookupWebAppPrivateEndpointConnectionOutput(ctx *Context, args *LookupWebAppPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupWebAppPrivateEndpointConnectionResultOutput

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

    public static class GetWebAppPrivateEndpointConnection 
{
    public static Task<GetWebAppPrivateEndpointConnectionResult> InvokeAsync(GetWebAppPrivateEndpointConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetWebAppPrivateEndpointConnectionResult> Invoke(GetWebAppPrivateEndpointConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWebAppPrivateEndpointConnectionResult> getWebAppPrivateEndpointConnection(GetWebAppPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetWebAppPrivateEndpointConnectionResult> getWebAppPrivateEndpointConnection(GetWebAppPrivateEndpointConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:web:getWebAppPrivateEndpointConnection
  arguments:
    # arguments dictionary
    data "azure-native_web_get_web_app_private_endpoint_connection" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    Name of the site.
    PrivateEndpointConnectionName string
    Name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    Name string
    Name of the site.
    PrivateEndpointConnectionName string
    Name of the private endpoint connection.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    name string
    Name of the site.
    private_endpoint_connection_name string
    Name of the private endpoint connection.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    name String
    Name of the site.
    privateEndpointConnectionName String
    Name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    name string
    Name of the site.
    privateEndpointConnectionName string
    Name of the private endpoint connection.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    name str
    Name of the site.
    private_endpoint_connection_name str
    Name of the private endpoint connection.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    name String
    Name of the site.
    privateEndpointConnectionName String
    Name of the private endpoint connection.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getWebAppPrivateEndpointConnection Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    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
    SystemData Pulumi.AzureNative.Web.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"
    IpAddresses List<string>
    Private IPAddresses mapped to the remote private endpoint
    Kind string
    Kind of resource.
    PrivateEndpoint Pulumi.AzureNative.Web.Outputs.ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    PrivateLinkServiceConnectionState Pulumi.AzureNative.Web.Outputs.PrivateLinkConnectionStateResponse
    The state of a private link connection
    AzureApiVersion string
    The Azure API version of the resource.
    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
    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"
    IpAddresses []string
    Private IPAddresses mapped to the remote private endpoint
    Kind string
    Kind of resource.
    PrivateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    PrivateLinkServiceConnectionState PrivateLinkConnectionStateResponse
    The state of a private link connection
    azure_api_version string
    The Azure API version of the resource.
    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
    provisioning_state string
    system_data object
    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"
    ip_addresses list(string)
    Private IPAddresses mapped to the remote private endpoint
    kind string
    Kind of resource.
    private_endpoint object
    PrivateEndpoint of a remote private endpoint connection
    private_link_service_connection_state object
    The state of a private link connection
    azureApiVersion String
    The Azure API version of the resource.
    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
    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"
    ipAddresses List<String>
    Private IPAddresses mapped to the remote private endpoint
    kind String
    Kind of resource.
    privateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
    The state of a private link connection
    azureApiVersion string
    The Azure API version of the resource.
    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
    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"
    ipAddresses string[]
    Private IPAddresses mapped to the remote private endpoint
    kind string
    Kind of resource.
    privateEndpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    privateLinkServiceConnectionState PrivateLinkConnectionStateResponse
    The state of a private link connection
    azure_api_version str
    The Azure API version of the resource.
    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
    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"
    ip_addresses Sequence[str]
    Private IPAddresses mapped to the remote private endpoint
    kind str
    Kind of resource.
    private_endpoint ArmIdWrapperResponse
    PrivateEndpoint of a remote private endpoint connection
    private_link_service_connection_state PrivateLinkConnectionStateResponse
    The state of a private link connection
    azureApiVersion String
    The Azure API version of the resource.
    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
    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"
    ipAddresses List<String>
    Private IPAddresses mapped to the remote private endpoint
    kind String
    Kind of resource.
    privateEndpoint Property Map
    PrivateEndpoint of a remote private endpoint connection
    privateLinkServiceConnectionState Property Map
    The state of a private link connection

    Supporting Types

    ArmIdWrapperResponse

    Id string
    Id string
    id string
    id String
    id string
    id str
    id String

    PrivateLinkConnectionStateResponse

    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    ActionsRequired string
    ActionsRequired for a private link connection
    Description string
    Description of a private link connection
    Status string
    Status of a private link connection
    actions_required string
    ActionsRequired for a private link connection
    description string
    Description of a private link connection
    status string
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection
    actionsRequired string
    ActionsRequired for a private link connection
    description string
    Description of a private link connection
    status string
    Status of a private link connection
    actions_required str
    ActionsRequired for a private link connection
    description str
    Description of a private link connection
    status str
    Status of a private link connection
    actionsRequired String
    ActionsRequired for a private link connection
    description String
    Description of a private link connection
    status String
    Status of a private link connection

    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.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type 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.
    Viewing docs for Azure Native v3.23.0
    published on Saturday, Jul 18, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial