Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. appservice
  5. HybridConnection

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.appservice.HybridConnection

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an App Service Hybrid Connection for an existing App Service, Relay and Service Bus.

!> NOTE: This resource has been deprecated in version 5.0 of the provider and will be removed in version 6.0. Please use azure.appservice.FunctionAppHybridConnection and azure.appservice.WebAppHybridConnection resources instead.

Example Usage

This example provisions an App Service, a Relay Hybrid Connection, and a Service Bus using their outputs to create the App Service Hybrid Connection.

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "exampleResourceGroup1",
    location: "West Europe",
});
const examplePlan = new azure.appservice.Plan("example", {
    name: "exampleAppServicePlan1",
    location: example.location,
    resourceGroupName: example.name,
    sku: {
        tier: "Standard",
        size: "S1",
    },
});
const exampleAppService = new azure.appservice.AppService("example", {
    name: "exampleAppService1",
    location: example.location,
    resourceGroupName: example.name,
    appServicePlanId: examplePlan.id,
});
const exampleNamespace = new azure.relay.Namespace("example", {
    name: "exampleRN1",
    location: example.location,
    resourceGroupName: example.name,
    skuName: "Standard",
});
const exampleHybridConnection = new azure.relay.HybridConnection("example", {
    name: "exampleRHC1",
    resourceGroupName: example.name,
    relayNamespaceName: exampleNamespace.name,
    userMetadata: "examplemetadata",
});
const exampleHybridConnection2 = new azure.appservice.HybridConnection("example", {
    appServiceName: exampleAppService.name,
    resourceGroupName: example.name,
    relayId: exampleHybridConnection.id,
    hostname: "testhostname.example",
    port: 8080,
    sendKeyName: "exampleSharedAccessKey",
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="exampleResourceGroup1",
    location="West Europe")
example_plan = azure.appservice.Plan("example",
    name="exampleAppServicePlan1",
    location=example.location,
    resource_group_name=example.name,
    sku={
        "tier": "Standard",
        "size": "S1",
    })
example_app_service = azure.appservice.AppService("example",
    name="exampleAppService1",
    location=example.location,
    resource_group_name=example.name,
    app_service_plan_id=example_plan.id)
example_namespace = azure.relay.Namespace("example",
    name="exampleRN1",
    location=example.location,
    resource_group_name=example.name,
    sku_name="Standard")
example_hybrid_connection = azure.relay.HybridConnection("example",
    name="exampleRHC1",
    resource_group_name=example.name,
    relay_namespace_name=example_namespace.name,
    user_metadata="examplemetadata")
example_hybrid_connection2 = azure.appservice.HybridConnection("example",
    app_service_name=example_app_service.name,
    resource_group_name=example.name,
    relay_id=example_hybrid_connection.id,
    hostname="testhostname.example",
    port=8080,
    send_key_name="exampleSharedAccessKey")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appservice"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/relay"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("exampleResourceGroup1"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		examplePlan, err := appservice.NewPlan(ctx, "example", &appservice.PlanArgs{
			Name:              pulumi.String("exampleAppServicePlan1"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			Sku: &appservice.PlanSkuArgs{
				Tier: pulumi.String("Standard"),
				Size: pulumi.String("S1"),
			},
		})
		if err != nil {
			return err
		}
		exampleAppService, err := appservice.NewAppService(ctx, "example", &appservice.AppServiceArgs{
			Name:              pulumi.String("exampleAppService1"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			AppServicePlanId:  examplePlan.ID(),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := relay.NewNamespace(ctx, "example", &relay.NamespaceArgs{
			Name:              pulumi.String("exampleRN1"),
			Location:          example.Location,
			ResourceGroupName: example.Name,
			SkuName:           pulumi.String("Standard"),
		})
		if err != nil {
			return err
		}
		exampleHybridConnection, err := relay.NewHybridConnection(ctx, "example", &relay.HybridConnectionArgs{
			Name:               pulumi.String("exampleRHC1"),
			ResourceGroupName:  example.Name,
			RelayNamespaceName: exampleNamespace.Name,
			UserMetadata:       pulumi.String("examplemetadata"),
		})
		if err != nil {
			return err
		}
		_, err = appservice.NewHybridConnection(ctx, "example", &appservice.HybridConnectionArgs{
			AppServiceName:    exampleAppService.Name,
			ResourceGroupName: example.Name,
			RelayId:           exampleHybridConnection.ID(),
			Hostname:          pulumi.String("testhostname.example"),
			Port:              pulumi.Int(8080),
			SendKeyName:       pulumi.String("exampleSharedAccessKey"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "exampleResourceGroup1",
        Location = "West Europe",
    });

    var examplePlan = new Azure.AppService.Plan("example", new()
    {
        Name = "exampleAppServicePlan1",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Sku = new Azure.AppService.Inputs.PlanSkuArgs
        {
            Tier = "Standard",
            Size = "S1",
        },
    });

    var exampleAppService = new Azure.AppService.AppService("example", new()
    {
        Name = "exampleAppService1",
        Location = example.Location,
        ResourceGroupName = example.Name,
        AppServicePlanId = examplePlan.Id,
    });

    var exampleNamespace = new Azure.Relay.Namespace("example", new()
    {
        Name = "exampleRN1",
        Location = example.Location,
        ResourceGroupName = example.Name,
        SkuName = "Standard",
    });

    var exampleHybridConnection = new Azure.Relay.HybridConnection("example", new()
    {
        Name = "exampleRHC1",
        ResourceGroupName = example.Name,
        RelayNamespaceName = exampleNamespace.Name,
        UserMetadata = "examplemetadata",
    });

    var exampleHybridConnection2 = new Azure.AppService.HybridConnection("example", new()
    {
        AppServiceName = exampleAppService.Name,
        ResourceGroupName = example.Name,
        RelayId = exampleHybridConnection.Id,
        Hostname = "testhostname.example",
        Port = 8080,
        SendKeyName = "exampleSharedAccessKey",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appservice.Plan;
import com.pulumi.azure.appservice.PlanArgs;
import com.pulumi.azure.appservice.inputs.PlanSkuArgs;
import com.pulumi.azure.appservice.AppService;
import com.pulumi.azure.appservice.AppServiceArgs;
import com.pulumi.azure.relay.Namespace;
import com.pulumi.azure.relay.NamespaceArgs;
import com.pulumi.azure.relay.HybridConnection;
import com.pulumi.azure.relay.HybridConnectionArgs;
import com.pulumi.azure.appservice.HybridConnection;
import com.pulumi.azure.appservice.HybridConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("exampleResourceGroup1")
            .location("West Europe")
            .build());

        var examplePlan = new Plan("examplePlan", PlanArgs.builder()
            .name("exampleAppServicePlan1")
            .location(example.location())
            .resourceGroupName(example.name())
            .sku(PlanSkuArgs.builder()
                .tier("Standard")
                .size("S1")
                .build())
            .build());

        var exampleAppService = new AppService("exampleAppService", AppServiceArgs.builder()
            .name("exampleAppService1")
            .location(example.location())
            .resourceGroupName(example.name())
            .appServicePlanId(examplePlan.id())
            .build());

        var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()
            .name("exampleRN1")
            .location(example.location())
            .resourceGroupName(example.name())
            .skuName("Standard")
            .build());

        var exampleHybridConnection = new HybridConnection("exampleHybridConnection", HybridConnectionArgs.builder()
            .name("exampleRHC1")
            .resourceGroupName(example.name())
            .relayNamespaceName(exampleNamespace.name())
            .userMetadata("examplemetadata")
            .build());

        var exampleHybridConnection2 = new HybridConnection("exampleHybridConnection2", HybridConnectionArgs.builder()
            .appServiceName(exampleAppService.name())
            .resourceGroupName(example.name())
            .relayId(exampleHybridConnection.id())
            .hostname("testhostname.example")
            .port(8080)
            .sendKeyName("exampleSharedAccessKey")
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: exampleResourceGroup1
      location: West Europe
  examplePlan:
    type: azure:appservice:Plan
    name: example
    properties:
      name: exampleAppServicePlan1
      location: ${example.location}
      resourceGroupName: ${example.name}
      sku:
        tier: Standard
        size: S1
  exampleAppService:
    type: azure:appservice:AppService
    name: example
    properties:
      name: exampleAppService1
      location: ${example.location}
      resourceGroupName: ${example.name}
      appServicePlanId: ${examplePlan.id}
  exampleNamespace:
    type: azure:relay:Namespace
    name: example
    properties:
      name: exampleRN1
      location: ${example.location}
      resourceGroupName: ${example.name}
      skuName: Standard
  exampleHybridConnection:
    type: azure:relay:HybridConnection
    name: example
    properties:
      name: exampleRHC1
      resourceGroupName: ${example.name}
      relayNamespaceName: ${exampleNamespace.name}
      userMetadata: examplemetadata
  exampleHybridConnection2:
    type: azure:appservice:HybridConnection
    name: example
    properties:
      appServiceName: ${exampleAppService.name}
      resourceGroupName: ${example.name}
      relayId: ${exampleHybridConnection.id}
      hostname: testhostname.example
      port: 8080
      sendKeyName: exampleSharedAccessKey
Copy

Create HybridConnection Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HybridConnection(name: string, args: HybridConnectionArgs, opts?: CustomResourceOptions);
@overload
def HybridConnection(resource_name: str,
                     args: HybridConnectionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def HybridConnection(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     app_service_name: Optional[str] = None,
                     hostname: Optional[str] = None,
                     port: Optional[int] = None,
                     relay_id: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     send_key_name: Optional[str] = None)
func NewHybridConnection(ctx *Context, name string, args HybridConnectionArgs, opts ...ResourceOption) (*HybridConnection, error)
public HybridConnection(string name, HybridConnectionArgs args, CustomResourceOptions? opts = null)
public HybridConnection(String name, HybridConnectionArgs args)
public HybridConnection(String name, HybridConnectionArgs args, CustomResourceOptions options)

type: azure:appservice:HybridConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HybridConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var hybridConnectionResource = new Azure.AppService.HybridConnection("hybridConnectionResource", new()
{
    AppServiceName = "string",
    Hostname = "string",
    Port = 0,
    RelayId = "string",
    ResourceGroupName = "string",
    SendKeyName = "string",
});
Copy
example, err := appservice.NewHybridConnection(ctx, "hybridConnectionResource", &appservice.HybridConnectionArgs{
	AppServiceName:    pulumi.String("string"),
	Hostname:          pulumi.String("string"),
	Port:              pulumi.Int(0),
	RelayId:           pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	SendKeyName:       pulumi.String("string"),
})
Copy
var hybridConnectionResource = new HybridConnection("hybridConnectionResource", HybridConnectionArgs.builder()
    .appServiceName("string")
    .hostname("string")
    .port(0)
    .relayId("string")
    .resourceGroupName("string")
    .sendKeyName("string")
    .build());
Copy
hybrid_connection_resource = azure.appservice.HybridConnection("hybridConnectionResource",
    app_service_name="string",
    hostname="string",
    port=0,
    relay_id="string",
    resource_group_name="string",
    send_key_name="string")
Copy
const hybridConnectionResource = new azure.appservice.HybridConnection("hybridConnectionResource", {
    appServiceName: "string",
    hostname: "string",
    port: 0,
    relayId: "string",
    resourceGroupName: "string",
    sendKeyName: "string",
});
Copy
type: azure:appservice:HybridConnection
properties:
    appServiceName: string
    hostname: string
    port: 0
    relayId: string
    resourceGroupName: string
    sendKeyName: string
Copy

HybridConnection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HybridConnection resource accepts the following input properties:

AppServiceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the App Service. Changing this forces a new resource to be created.
Hostname This property is required. string
The hostname of the endpoint.
Port This property is required. int
The port of the endpoint.
RelayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
SendKeyName string
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
AppServiceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the App Service. Changing this forces a new resource to be created.
Hostname This property is required. string
The hostname of the endpoint.
Port This property is required. int
The port of the endpoint.
RelayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
SendKeyName string
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
appServiceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname This property is required. String
The hostname of the endpoint.
port This property is required. Integer
The port of the endpoint.
relayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
sendKeyName String
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
appServiceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname This property is required. string
The hostname of the endpoint.
port This property is required. number
The port of the endpoint.
relayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
sendKeyName string
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
app_service_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname This property is required. str
The hostname of the endpoint.
port This property is required. int
The port of the endpoint.
relay_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
send_key_name str
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
appServiceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname This property is required. String
The hostname of the endpoint.
port This property is required. Number
The port of the endpoint.
relayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
sendKeyName String
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.

Outputs

All input properties are implicitly available as output properties. Additionally, the HybridConnection resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
NamespaceName string
The name of the Relay Namespace.
RelayName string
SendKeyValue string
The value of the Service Bus Primary Access key.
ServiceBusNamespace string
The name of the Service Bus namespace.
ServiceBusSuffix string
The suffix for the service bus endpoint.
Id string
The provider-assigned unique ID for this managed resource.
NamespaceName string
The name of the Relay Namespace.
RelayName string
SendKeyValue string
The value of the Service Bus Primary Access key.
ServiceBusNamespace string
The name of the Service Bus namespace.
ServiceBusSuffix string
The suffix for the service bus endpoint.
id String
The provider-assigned unique ID for this managed resource.
namespaceName String
The name of the Relay Namespace.
relayName String
sendKeyValue String
The value of the Service Bus Primary Access key.
serviceBusNamespace String
The name of the Service Bus namespace.
serviceBusSuffix String
The suffix for the service bus endpoint.
id string
The provider-assigned unique ID for this managed resource.
namespaceName string
The name of the Relay Namespace.
relayName string
sendKeyValue string
The value of the Service Bus Primary Access key.
serviceBusNamespace string
The name of the Service Bus namespace.
serviceBusSuffix string
The suffix for the service bus endpoint.
id str
The provider-assigned unique ID for this managed resource.
namespace_name str
The name of the Relay Namespace.
relay_name str
send_key_value str
The value of the Service Bus Primary Access key.
service_bus_namespace str
The name of the Service Bus namespace.
service_bus_suffix str
The suffix for the service bus endpoint.
id String
The provider-assigned unique ID for this managed resource.
namespaceName String
The name of the Relay Namespace.
relayName String
sendKeyValue String
The value of the Service Bus Primary Access key.
serviceBusNamespace String
The name of the Service Bus namespace.
serviceBusSuffix String
The suffix for the service bus endpoint.

Look up Existing HybridConnection Resource

Get an existing HybridConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HybridConnectionState, opts?: CustomResourceOptions): HybridConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_service_name: Optional[str] = None,
        hostname: Optional[str] = None,
        namespace_name: Optional[str] = None,
        port: Optional[int] = None,
        relay_id: Optional[str] = None,
        relay_name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        send_key_name: Optional[str] = None,
        send_key_value: Optional[str] = None,
        service_bus_namespace: Optional[str] = None,
        service_bus_suffix: Optional[str] = None) -> HybridConnection
func GetHybridConnection(ctx *Context, name string, id IDInput, state *HybridConnectionState, opts ...ResourceOption) (*HybridConnection, error)
public static HybridConnection Get(string name, Input<string> id, HybridConnectionState? state, CustomResourceOptions? opts = null)
public static HybridConnection get(String name, Output<String> id, HybridConnectionState state, CustomResourceOptions options)
resources:  _:    type: azure:appservice:HybridConnection    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AppServiceName Changes to this property will trigger replacement. string
Specifies the name of the App Service. Changing this forces a new resource to be created.
Hostname string
The hostname of the endpoint.
NamespaceName string
The name of the Relay Namespace.
Port int
The port of the endpoint.
RelayId Changes to this property will trigger replacement. string
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
RelayName string
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
SendKeyName string
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
SendKeyValue string
The value of the Service Bus Primary Access key.
ServiceBusNamespace string
The name of the Service Bus namespace.
ServiceBusSuffix string
The suffix for the service bus endpoint.
AppServiceName Changes to this property will trigger replacement. string
Specifies the name of the App Service. Changing this forces a new resource to be created.
Hostname string
The hostname of the endpoint.
NamespaceName string
The name of the Relay Namespace.
Port int
The port of the endpoint.
RelayId Changes to this property will trigger replacement. string
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
RelayName string
ResourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
SendKeyName string
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
SendKeyValue string
The value of the Service Bus Primary Access key.
ServiceBusNamespace string
The name of the Service Bus namespace.
ServiceBusSuffix string
The suffix for the service bus endpoint.
appServiceName Changes to this property will trigger replacement. String
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname String
The hostname of the endpoint.
namespaceName String
The name of the Relay Namespace.
port Integer
The port of the endpoint.
relayId Changes to this property will trigger replacement. String
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
relayName String
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
sendKeyName String
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
sendKeyValue String
The value of the Service Bus Primary Access key.
serviceBusNamespace String
The name of the Service Bus namespace.
serviceBusSuffix String
The suffix for the service bus endpoint.
appServiceName Changes to this property will trigger replacement. string
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname string
The hostname of the endpoint.
namespaceName string
The name of the Relay Namespace.
port number
The port of the endpoint.
relayId Changes to this property will trigger replacement. string
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
relayName string
resourceGroupName Changes to this property will trigger replacement. string
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
sendKeyName string
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
sendKeyValue string
The value of the Service Bus Primary Access key.
serviceBusNamespace string
The name of the Service Bus namespace.
serviceBusSuffix string
The suffix for the service bus endpoint.
app_service_name Changes to this property will trigger replacement. str
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname str
The hostname of the endpoint.
namespace_name str
The name of the Relay Namespace.
port int
The port of the endpoint.
relay_id Changes to this property will trigger replacement. str
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
relay_name str
resource_group_name Changes to this property will trigger replacement. str
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
send_key_name str
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
send_key_value str
The value of the Service Bus Primary Access key.
service_bus_namespace str
The name of the Service Bus namespace.
service_bus_suffix str
The suffix for the service bus endpoint.
appServiceName Changes to this property will trigger replacement. String
Specifies the name of the App Service. Changing this forces a new resource to be created.
hostname String
The hostname of the endpoint.
namespaceName String
The name of the Relay Namespace.
port Number
The port of the endpoint.
relayId Changes to this property will trigger replacement. String
The ID of the Service Bus Relay. Changing this forces a new resource to be created.
relayName String
resourceGroupName Changes to this property will trigger replacement. String
The name of the resource group in which to create the App Service. Changing this forces a new resource to be created.
sendKeyName String
The name of the Service Bus key which has Send permissions. Defaults to RootManageSharedAccessKey.
sendKeyValue String
The value of the Service Bus Primary Access key.
serviceBusNamespace String
The name of the Service Bus namespace.
serviceBusSuffix String
The suffix for the service bus endpoint.

Import

App Service Hybrid Connections can be imported using the resource id, e.g.

$ pulumi import azure:appservice/hybridConnection:HybridConnection example /subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/exampleResourceGroup1/providers/Microsoft.Web/sites/exampleAppService1/hybridConnectionNamespaces/exampleRN1/relays/exampleRHC1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure