Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. web
  5. WebAppHybridConnection
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.web.WebAppHybridConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Hybrid Connection contract. This is used to configure a Hybrid Connection. Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2020-12-01.

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

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:web:WebAppHybridConnection myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}
Copy

Create WebAppHybridConnection Resource

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

Constructor syntax

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

@overload
def WebAppHybridConnection(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           name: Optional[str] = None,
                           namespace_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           hostname: Optional[str] = None,
                           kind: Optional[str] = None,
                           port: Optional[int] = None,
                           relay_arm_uri: Optional[str] = None,
                           relay_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)
func NewWebAppHybridConnection(ctx *Context, name string, args WebAppHybridConnectionArgs, opts ...ResourceOption) (*WebAppHybridConnection, error)
public WebAppHybridConnection(string name, WebAppHybridConnectionArgs args, CustomResourceOptions? opts = null)
public WebAppHybridConnection(String name, WebAppHybridConnectionArgs args)
public WebAppHybridConnection(String name, WebAppHybridConnectionArgs args, CustomResourceOptions options)

type: azure-native:web:WebAppHybridConnection
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. WebAppHybridConnectionArgs
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. WebAppHybridConnectionArgs
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. WebAppHybridConnectionArgs
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. WebAppHybridConnectionArgs
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. WebAppHybridConnectionArgs
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 webAppHybridConnectionResource = new AzureNative.Web.WebAppHybridConnection("webAppHybridConnectionResource", new()
{
    Name = "string",
    NamespaceName = "string",
    ResourceGroupName = "string",
    Hostname = "string",
    Kind = "string",
    Port = 0,
    RelayArmUri = "string",
    RelayName = "string",
    SendKeyName = "string",
    SendKeyValue = "string",
    ServiceBusNamespace = "string",
    ServiceBusSuffix = "string",
});
Copy
example, err := web.NewWebAppHybridConnection(ctx, "webAppHybridConnectionResource", &web.WebAppHybridConnectionArgs{
	Name:                "string",
	NamespaceName:       "string",
	ResourceGroupName:   "string",
	Hostname:            "string",
	Kind:                "string",
	Port:                0,
	RelayArmUri:         "string",
	RelayName:           "string",
	SendKeyName:         "string",
	SendKeyValue:        "string",
	ServiceBusNamespace: "string",
	ServiceBusSuffix:    "string",
})
Copy
var webAppHybridConnectionResource = new WebAppHybridConnection("webAppHybridConnectionResource", WebAppHybridConnectionArgs.builder()
    .name("string")
    .namespaceName("string")
    .resourceGroupName("string")
    .hostname("string")
    .kind("string")
    .port(0)
    .relayArmUri("string")
    .relayName("string")
    .sendKeyName("string")
    .sendKeyValue("string")
    .serviceBusNamespace("string")
    .serviceBusSuffix("string")
    .build());
Copy
web_app_hybrid_connection_resource = azure_native.web.WebAppHybridConnection("webAppHybridConnectionResource",
    name=string,
    namespace_name=string,
    resource_group_name=string,
    hostname=string,
    kind=string,
    port=0,
    relay_arm_uri=string,
    relay_name=string,
    send_key_name=string,
    send_key_value=string,
    service_bus_namespace=string,
    service_bus_suffix=string)
Copy
const webAppHybridConnectionResource = new azure_native.web.WebAppHybridConnection("webAppHybridConnectionResource", {
    name: "string",
    namespaceName: "string",
    resourceGroupName: "string",
    hostname: "string",
    kind: "string",
    port: 0,
    relayArmUri: "string",
    relayName: "string",
    sendKeyName: "string",
    sendKeyValue: "string",
    serviceBusNamespace: "string",
    serviceBusSuffix: "string",
});
Copy
type: azure-native:web:WebAppHybridConnection
properties:
    hostname: string
    kind: string
    name: string
    namespaceName: string
    port: 0
    relayArmUri: string
    relayName: string
    resourceGroupName: string
    sendKeyName: string
    sendKeyValue: string
    serviceBusNamespace: string
    serviceBusSuffix: string
Copy

WebAppHybridConnection 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 WebAppHybridConnection resource accepts the following input properties:

Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the web app.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace for this hybrid connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
Hostname string
The hostname of the endpoint.
Kind string
Kind of resource.
Port int
The port of the endpoint.
RelayArmUri string
The ARM URI to the Service Bus relay.
RelayName Changes to this property will trigger replacement. string
The name of the Service Bus relay.
SendKeyName string
The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
SendKeyValue string
The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
ServiceBusNamespace Changes to this property will trigger replacement. string
The name of the Service Bus namespace.
ServiceBusSuffix string
The suffix for the service bus endpoint. By default this is .servicebus.windows.net
Name
This property is required.
Changes to this property will trigger replacement.
string
The name of the web app.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace for this hybrid connection.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
Hostname string
The hostname of the endpoint.
Kind string
Kind of resource.
Port int
The port of the endpoint.
RelayArmUri string
The ARM URI to the Service Bus relay.
RelayName Changes to this property will trigger replacement. string
The name of the Service Bus relay.
SendKeyName string
The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
SendKeyValue string
The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
ServiceBusNamespace Changes to this property will trigger replacement. string
The name of the Service Bus namespace.
ServiceBusSuffix string
The suffix for the service bus endpoint. By default this is .servicebus.windows.net
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the web app.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace for this hybrid connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
hostname String
The hostname of the endpoint.
kind String
Kind of resource.
port Integer
The port of the endpoint.
relayArmUri String
The ARM URI to the Service Bus relay.
relayName Changes to this property will trigger replacement. String
The name of the Service Bus relay.
sendKeyName String
The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
sendKeyValue String
The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
serviceBusNamespace Changes to this property will trigger replacement. String
The name of the Service Bus namespace.
serviceBusSuffix String
The suffix for the service bus endpoint. By default this is .servicebus.windows.net
name
This property is required.
Changes to this property will trigger replacement.
string
The name of the web app.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace for this hybrid connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group to which the resource belongs.
hostname string
The hostname of the endpoint.
kind string
Kind of resource.
port number
The port of the endpoint.
relayArmUri string
The ARM URI to the Service Bus relay.
relayName Changes to this property will trigger replacement. string
The name of the Service Bus relay.
sendKeyName string
The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
sendKeyValue string
The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
serviceBusNamespace Changes to this property will trigger replacement. string
The name of the Service Bus namespace.
serviceBusSuffix string
The suffix for the service bus endpoint. By default this is .servicebus.windows.net
name
This property is required.
Changes to this property will trigger replacement.
str
The name of the web app.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The namespace for this hybrid 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.
hostname str
The hostname of the endpoint.
kind str
Kind of resource.
port int
The port of the endpoint.
relay_arm_uri str
The ARM URI to the Service Bus relay.
relay_name Changes to this property will trigger replacement. str
The name of the Service Bus relay.
send_key_name str
The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
send_key_value str
The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
service_bus_namespace Changes to this property will trigger replacement. str
The name of the Service Bus namespace.
service_bus_suffix str
The suffix for the service bus endpoint. By default this is .servicebus.windows.net
name
This property is required.
Changes to this property will trigger replacement.
String
The name of the web app.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace for this hybrid connection.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group to which the resource belongs.
hostname String
The hostname of the endpoint.
kind String
Kind of resource.
port Number
The port of the endpoint.
relayArmUri String
The ARM URI to the Service Bus relay.
relayName Changes to this property will trigger replacement. String
The name of the Service Bus relay.
sendKeyName String
The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
sendKeyValue String
The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.
serviceBusNamespace Changes to this property will trigger replacement. String
The name of the Service Bus namespace.
serviceBusSuffix String
The suffix for the service bus endpoint. By default this is .servicebus.windows.net

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
Id string
The provider-assigned unique ID for this managed resource.
Type string
Resource type.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.
id string
The provider-assigned unique ID for this managed resource.
type string
Resource type.
id str
The provider-assigned unique ID for this managed resource.
type str
Resource type.
id String
The provider-assigned unique ID for this managed resource.
type String
Resource type.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native