Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. WebAppRelayServiceConnection
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.WebAppRelayServiceConnection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Hybrid Connection for an App Service app.

Uses Azure REST API version 2022-09-01. In version 1.x of the Azure Native provider, it used API version 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:WebAppRelayServiceConnection myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}
Copy

Create WebAppRelayServiceConnection Resource

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

Constructor syntax

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

@overload
def WebAppRelayServiceConnection(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 name: Optional[str] = None,
                                 resource_group_name: Optional[str] = None,
                                 biztalk_uri: Optional[str] = None,
                                 entity_connection_string: Optional[str] = None,
                                 entity_name: Optional[str] = None,
                                 hostname: Optional[str] = None,
                                 kind: Optional[str] = None,
                                 port: Optional[int] = None,
                                 resource_connection_string: Optional[str] = None,
                                 resource_type: Optional[str] = None)
func NewWebAppRelayServiceConnection(ctx *Context, name string, args WebAppRelayServiceConnectionArgs, opts ...ResourceOption) (*WebAppRelayServiceConnection, error)
public WebAppRelayServiceConnection(string name, WebAppRelayServiceConnectionArgs args, CustomResourceOptions? opts = null)
public WebAppRelayServiceConnection(String name, WebAppRelayServiceConnectionArgs args)
public WebAppRelayServiceConnection(String name, WebAppRelayServiceConnectionArgs args, CustomResourceOptions options)

type: azure-native:web:WebAppRelayServiceConnection
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. WebAppRelayServiceConnectionArgs
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. WebAppRelayServiceConnectionArgs
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. WebAppRelayServiceConnectionArgs
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. WebAppRelayServiceConnectionArgs
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. WebAppRelayServiceConnectionArgs
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 webAppRelayServiceConnectionResource = new AzureNative.Web.WebAppRelayServiceConnection("webAppRelayServiceConnectionResource", new()
{
    Name = "string",
    ResourceGroupName = "string",
    BiztalkUri = "string",
    EntityConnectionString = "string",
    EntityName = "string",
    Hostname = "string",
    Kind = "string",
    Port = 0,
    ResourceConnectionString = "string",
    ResourceType = "string",
});
Copy
example, err := web.NewWebAppRelayServiceConnection(ctx, "webAppRelayServiceConnectionResource", &web.WebAppRelayServiceConnectionArgs{
	Name:                     pulumi.String("string"),
	ResourceGroupName:        pulumi.String("string"),
	BiztalkUri:               pulumi.String("string"),
	EntityConnectionString:   pulumi.String("string"),
	EntityName:               pulumi.String("string"),
	Hostname:                 pulumi.String("string"),
	Kind:                     pulumi.String("string"),
	Port:                     pulumi.Int(0),
	ResourceConnectionString: pulumi.String("string"),
	ResourceType:             pulumi.String("string"),
})
Copy
var webAppRelayServiceConnectionResource = new WebAppRelayServiceConnection("webAppRelayServiceConnectionResource", WebAppRelayServiceConnectionArgs.builder()
    .name("string")
    .resourceGroupName("string")
    .biztalkUri("string")
    .entityConnectionString("string")
    .entityName("string")
    .hostname("string")
    .kind("string")
    .port(0)
    .resourceConnectionString("string")
    .resourceType("string")
    .build());
Copy
web_app_relay_service_connection_resource = azure_native.web.WebAppRelayServiceConnection("webAppRelayServiceConnectionResource",
    name="string",
    resource_group_name="string",
    biztalk_uri="string",
    entity_connection_string="string",
    entity_name="string",
    hostname="string",
    kind="string",
    port=0,
    resource_connection_string="string",
    resource_type="string")
Copy
const webAppRelayServiceConnectionResource = new azure_native.web.WebAppRelayServiceConnection("webAppRelayServiceConnectionResource", {
    name: "string",
    resourceGroupName: "string",
    biztalkUri: "string",
    entityConnectionString: "string",
    entityName: "string",
    hostname: "string",
    kind: "string",
    port: 0,
    resourceConnectionString: "string",
    resourceType: "string",
});
Copy
type: azure-native:web:WebAppRelayServiceConnection
properties:
    biztalkUri: string
    entityConnectionString: string
    entityName: string
    hostname: string
    kind: string
    name: string
    port: 0
    resourceConnectionString: string
    resourceGroupName: string
    resourceType: string
Copy

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

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.
BiztalkUri string
EntityConnectionString string
EntityName string
Hostname string
Kind string
Kind of resource.
Port int
ResourceConnectionString string
ResourceType string
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.
BiztalkUri string
EntityConnectionString string
EntityName string
Hostname string
Kind string
Kind of resource.
Port int
ResourceConnectionString string
ResourceType string
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.
biztalkUri String
entityConnectionString String
entityName String
hostname String
kind String
Kind of resource.
port Integer
resourceConnectionString String
resourceType String
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.
biztalkUri string
entityConnectionString string
entityName string
hostname string
kind string
Kind of resource.
port number
resourceConnectionString string
resourceType string
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.
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
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.
biztalkUri String
entityConnectionString String
entityName String
hostname String
kind String
Kind of resource.
port Number
resourceConnectionString String
resourceType String

Outputs

All input properties are implicitly available as output properties. Additionally, the WebAppRelayServiceConnection 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 pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native