1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. getWebAppPrivateEndpointConnection
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.web.getWebAppPrivateEndpointConnection

Explore with Pulumi AI

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Description for Gets a private endpoint connection

Uses Azure REST API version 2022-09-01.

Other available API versions: 2020-10-01, 2023-01-01, 2023-12-01, 2024-04-01.

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>
Copy
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: Optional[pulumi.Input[str]] = None,
                                            private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
                                            resource_group_name: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetWebAppPrivateEndpointConnectionResult]
Copy
func LookupWebAppPrivateEndpointConnection(ctx *Context, args *LookupWebAppPrivateEndpointConnectionArgs, opts ...InvokeOption) (*LookupWebAppPrivateEndpointConnectionResult, error)
func LookupWebAppPrivateEndpointConnectionOutput(ctx *Context, args *LookupWebAppPrivateEndpointConnectionOutputArgs, opts ...InvokeOption) LookupWebAppPrivateEndpointConnectionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetWebAppPrivateEndpointConnectionResult> getWebAppPrivateEndpointConnection(GetWebAppPrivateEndpointConnectionArgs args, InvokeOptions options)
public static Output<GetWebAppPrivateEndpointConnectionResult> getWebAppPrivateEndpointConnection(GetWebAppPrivateEndpointConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:getWebAppPrivateEndpointConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the site.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the site.
PrivateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private endpoint connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the site.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the site.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the site.
private_endpoint_connection_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the private endpoint connection.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group to which the resource belongs.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the site.
privateEndpointConnectionName
This property is required.
Changes to this property will trigger replacement.
String
Name of the private endpoint connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.

getWebAppPrivateEndpointConnection Result

The following output properties are available:

Id string
Resource Id.
Name string
Resource Name.
ProvisioningState string
Type string
Resource type.
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
Id string
Resource Id.
Name string
Resource Name.
ProvisioningState string
Type string
Resource type.
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
id String
Resource Id.
name String
Resource Name.
provisioningState String
type String
Resource type.
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
id string
Resource Id.
name string
Resource Name.
provisioningState string
type string
Resource type.
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
id str
Resource Id.
name str
Resource Name.
provisioning_state str
type str
Resource type.
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
id String
Resource Id.
name String
Resource Name.
provisioningState String
type String
Resource type.
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 This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. 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
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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi