azure-native.web.getWebAppPrivateEndpointConnection
Explore with Pulumi AI
Description for Gets a private endpoint connection
Uses Azure REST API version 2024-04-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. 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: 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]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 dictionaryThe following arguments are supported:
- Name string
 - Name of the site.
 - Private
Endpoint stringConnection Name  - Name of the private endpoint connection.
 - Resource
Group stringName  - Name of the resource group to which the resource belongs.
 
- Name string
 - Name of the site.
 - Private
Endpoint stringConnection Name  - Name of the private endpoint connection.
 - Resource
Group stringName  - Name of the resource group to which the resource belongs.
 
- name String
 - Name of the site.
 - private
Endpoint StringConnection Name  - Name of the private endpoint connection.
 - resource
Group StringName  - Name of the resource group to which the resource belongs.
 
- name string
 - Name of the site.
 - private
Endpoint stringConnection Name  - Name of the private endpoint connection.
 - resource
Group stringName  - Name of the resource group to which the resource belongs.
 
- name str
 - Name of the site.
 - private_
endpoint_ strconnection_ name  - Name of the private endpoint connection.
 - resource_
group_ strname  - Name of the resource group to which the resource belongs.
 
- name String
 - Name of the site.
 - private
Endpoint StringConnection Name  - Name of the private endpoint connection.
 - resource
Group StringName  - Name of the resource group to which the resource belongs.
 
getWebAppPrivateEndpointConnection Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Id string
 - Resource Id.
 - Name string
 - Resource Name.
 - Provisioning
State string - Type string
 - Resource type.
 - Ip
Addresses List<string> - Private IPAddresses mapped to the remote private endpoint
 - Kind string
 - Kind of resource.
 - Private
Endpoint Pulumi.Azure Native. Web. Outputs. Arm Id Wrapper Response  - PrivateEndpoint of a remote private endpoint connection
 - Private
Link Pulumi.Service Connection State Azure Native. Web. Outputs. Private Link Connection State Response  - The state of a private link connection
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Id string
 - Resource Id.
 - Name string
 - Resource Name.
 - Provisioning
State string - Type string
 - Resource type.
 - Ip
Addresses []string - Private IPAddresses mapped to the remote private endpoint
 - Kind string
 - Kind of resource.
 - Private
Endpoint ArmId Wrapper Response  - PrivateEndpoint of a remote private endpoint connection
 - Private
Link PrivateService Connection State Link Connection State Response  - The state of a private link connection
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - id String
 - Resource Id.
 - name String
 - Resource Name.
 - provisioning
State String - type String
 - Resource type.
 - ip
Addresses List<String> - Private IPAddresses mapped to the remote private endpoint
 - kind String
 - Kind of resource.
 - private
Endpoint ArmId Wrapper Response  - PrivateEndpoint of a remote private endpoint connection
 - private
Link PrivateService Connection State Link Connection State Response  - The state of a private link connection
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - id string
 - Resource Id.
 - name string
 - Resource Name.
 - provisioning
State string - type string
 - Resource type.
 - ip
Addresses string[] - Private IPAddresses mapped to the remote private endpoint
 - kind string
 - Kind of resource.
 - private
Endpoint ArmId Wrapper Response  - PrivateEndpoint of a remote private endpoint connection
 - private
Link PrivateService Connection State Link Connection State Response  - The state of a private link connection
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - 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 ArmId Wrapper Response  - PrivateEndpoint of a remote private endpoint connection
 - private_
link_ Privateservice_ connection_ state Link Connection State Response  - The state of a private link connection
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - id String
 - Resource Id.
 - name String
 - Resource Name.
 - provisioning
State String - type String
 - Resource type.
 - ip
Addresses List<String> - Private IPAddresses mapped to the remote private endpoint
 - kind String
 - Kind of resource.
 - private
Endpoint Property Map - PrivateEndpoint of a remote private endpoint connection
 - private
Link Property MapService Connection State  - The state of a private link connection
 
Supporting Types
ArmIdWrapperResponse   
- Id string
 
- Id string
 
- id String
 
- id string
 
- id str
 
- id String
 
PrivateLinkConnectionStateResponse    
- 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
 
- 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
 
- 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
 
- 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
 
- 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
 
- 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
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0