1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. getWebAppRelayServiceConnection
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.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.web.getWebAppRelayServiceConnection

Explore with Pulumi AI

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.2.0 published on Monday, Apr 14, 2025 by Pulumi

Description for Gets a hybrid connection configuration by its name.

Uses Azure REST API version 2024-04-01.

Other available API versions: 2016-08-01, 2018-02-01, 2018-11-01, 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 getWebAppRelayServiceConnection

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 getWebAppRelayServiceConnection(args: GetWebAppRelayServiceConnectionArgs, opts?: InvokeOptions): Promise<GetWebAppRelayServiceConnectionResult>
function getWebAppRelayServiceConnectionOutput(args: GetWebAppRelayServiceConnectionOutputArgs, opts?: InvokeOptions): Output<GetWebAppRelayServiceConnectionResult>
Copy
def get_web_app_relay_service_connection(entity_name: Optional[str] = None,
                                         name: Optional[str] = None,
                                         resource_group_name: Optional[str] = None,
                                         opts: Optional[InvokeOptions] = None) -> GetWebAppRelayServiceConnectionResult
def get_web_app_relay_service_connection_output(entity_name: Optional[pulumi.Input[str]] = None,
                                         name: Optional[pulumi.Input[str]] = None,
                                         resource_group_name: Optional[pulumi.Input[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetWebAppRelayServiceConnectionResult]
Copy
func LookupWebAppRelayServiceConnection(ctx *Context, args *LookupWebAppRelayServiceConnectionArgs, opts ...InvokeOption) (*LookupWebAppRelayServiceConnectionResult, error)
func LookupWebAppRelayServiceConnectionOutput(ctx *Context, args *LookupWebAppRelayServiceConnectionOutputArgs, opts ...InvokeOption) LookupWebAppRelayServiceConnectionResultOutput
Copy

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

public static class GetWebAppRelayServiceConnection 
{
    public static Task<GetWebAppRelayServiceConnectionResult> InvokeAsync(GetWebAppRelayServiceConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetWebAppRelayServiceConnectionResult> Invoke(GetWebAppRelayServiceConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWebAppRelayServiceConnectionResult> getWebAppRelayServiceConnection(GetWebAppRelayServiceConnectionArgs args, InvokeOptions options)
public static Output<GetWebAppRelayServiceConnectionResult> getWebAppRelayServiceConnection(GetWebAppRelayServiceConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:web:getWebAppRelayServiceConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EntityName
This property is required.
Changes to this property will trigger replacement.
string
Name of the hybrid connection.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
EntityName
This property is required.
Changes to this property will trigger replacement.
string
Name of the hybrid connection.
Name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
entityName
This property is required.
Changes to this property will trigger replacement.
String
Name of the hybrid connection.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
entityName
This property is required.
Changes to this property will trigger replacement.
string
Name of the hybrid connection.
name
This property is required.
Changes to this property will trigger replacement.
string
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
entity_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the hybrid connection.
name
This property is required.
Changes to this property will trigger replacement.
str
Name of the app.
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.
entityName
This property is required.
Changes to this property will trigger replacement.
String
Name of the hybrid connection.
name
This property is required.
Changes to this property will trigger replacement.
String
Name of the app.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.

getWebAppRelayServiceConnection Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id.
Name string
Resource Name.
Type string
Resource type.
BiztalkUri string
EntityConnectionString string
EntityName string
Hostname string
Kind string
Kind of resource.
Port int
ResourceConnectionString string
ResourceType string
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id.
Name string
Resource Name.
Type string
Resource type.
BiztalkUri string
EntityConnectionString string
EntityName string
Hostname string
Kind string
Kind of resource.
Port int
ResourceConnectionString string
ResourceType string
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id.
name String
Resource Name.
type String
Resource type.
biztalkUri String
entityConnectionString String
entityName String
hostname String
kind String
Kind of resource.
port Integer
resourceConnectionString String
resourceType String
azureApiVersion string
The Azure API version of the resource.
id string
Resource Id.
name string
Resource Name.
type string
Resource type.
biztalkUri string
entityConnectionString string
entityName string
hostname string
kind string
Kind of resource.
port number
resourceConnectionString string
resourceType string
azure_api_version str
The Azure API version of the resource.
id str
Resource Id.
name str
Resource Name.
type str
Resource type.
biztalk_uri str
entity_connection_string str
entity_name str
hostname str
kind str
Kind of resource.
port int
resource_connection_string str
resource_type str
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id.
name String
Resource Name.
type String
Resource type.
biztalkUri String
entityConnectionString String
entityName String
hostname String
kind String
Kind of resource.
port Number
resourceConnectionString String
resourceType String

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 v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi