Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Azure Native
  4. API Docs
  5. web
  6. getWebAppRelayServiceConnection
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.getWebAppRelayServiceConnection

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 hybrid connection configuration by its name.

    Uses Azure REST API version 2025-05-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, 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 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>
    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: pulumi.Input[Optional[str]] = None,
                                         name: pulumi.Input[Optional[str]] = None,
                                         resource_group_name: pulumi.Input[Optional[str]] = None,
                                         opts: Optional[InvokeOptions] = None) -> Output[GetWebAppRelayServiceConnectionResult]
    func LookupWebAppRelayServiceConnection(ctx *Context, args *LookupWebAppRelayServiceConnectionArgs, opts ...InvokeOption) (*LookupWebAppRelayServiceConnectionResult, error)
func LookupWebAppRelayServiceConnectionOutput(ctx *Context, args *LookupWebAppRelayServiceConnectionOutputArgs, opts ...InvokeOption) LookupWebAppRelayServiceConnectionResultOutput

    > 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)
}
    public static CompletableFuture<GetWebAppRelayServiceConnectionResult> getWebAppRelayServiceConnection(GetWebAppRelayServiceConnectionArgs args, InvokeOptions options)
public static Output<GetWebAppRelayServiceConnectionResult> getWebAppRelayServiceConnection(GetWebAppRelayServiceConnectionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    EntityName string
    Name of the hybrid connection.
    Name string
    Name of the app.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    EntityName string
    Name of the hybrid connection.
    Name string
    Name of the app.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    entity_name string
    Name of the hybrid connection.
    name string
    Name of the app.
    resource_group_name string
    The name of the resource group. The name is case insensitive.
    entityName String
    Name of the hybrid connection.
    name String
    Name of the app.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    entityName string
    Name of the hybrid connection.
    name string
    Name of the app.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    entity_name str
    Name of the hybrid connection.
    name str
    Name of the app.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    entityName String
    Name of the hybrid connection.
    name String
    Name of the app.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getWebAppRelayServiceConnection 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
    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"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name 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"
    BiztalkUri string
    EntityConnectionString string
    EntityName string
    Hostname string
    Kind string
    Kind of resource.
    Port int
    ResourceConnectionString string
    ResourceType string
    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
    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"
    biztalk_uri string
    entity_connection_string string
    entity_name string
    hostname string
    kind string
    Kind of resource.
    port number
    resource_connection_string string
    resource_type string
    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
    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"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name 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"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name 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"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name 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"
    biztalkUri String
    entityConnectionString String
    entityName String
    hostname String
    kind String
    Kind of resource.
    port Number
    resourceConnectionString String
    resourceType String

    Supporting Types

    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