azure-native.web.WebAppHybridConnection
Explore with Pulumi AI
Hybrid Connection contract. This is used to configure a Hybrid Connection. API Version: 2020-12-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}
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 string
- The unique name of the resource.
- args WebAppHybridConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args WebAppHybridConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WebAppHybridConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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",
})
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());
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)
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",
});
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
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 string
- The name of the web app.
- Namespace
Name string - The namespace for this hybrid connection.
- Resource
Group stringName - 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.
- Relay
Arm stringUri - The ARM URI to the Service Bus relay.
- Relay
Name string - The name of the Service Bus relay.
- Send
Key stringName - The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
- Send
Key stringValue - 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 stringNamespace - The name of the Service Bus namespace.
- Service
Bus stringSuffix - The suffix for the service bus endpoint. By default this is .servicebus.windows.net
- Name string
- The name of the web app.
- Namespace
Name string - The namespace for this hybrid connection.
- Resource
Group stringName - 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.
- Relay
Arm stringUri - The ARM URI to the Service Bus relay.
- Relay
Name string - The name of the Service Bus relay.
- Send
Key stringName - The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
- Send
Key stringValue - 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 stringNamespace - The name of the Service Bus namespace.
- Service
Bus stringSuffix - The suffix for the service bus endpoint. By default this is .servicebus.windows.net
- name String
- The name of the web app.
- namespace
Name String - The namespace for this hybrid connection.
- resource
Group StringName - 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.
- relay
Arm StringUri - The ARM URI to the Service Bus relay.
- relay
Name String - The name of the Service Bus relay.
- send
Key StringName - The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
- send
Key StringValue - 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 StringNamespace - The name of the Service Bus namespace.
- service
Bus StringSuffix - The suffix for the service bus endpoint. By default this is .servicebus.windows.net
- name string
- The name of the web app.
- namespace
Name string - The namespace for this hybrid connection.
- resource
Group stringName - 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.
- relay
Arm stringUri - The ARM URI to the Service Bus relay.
- relay
Name string - The name of the Service Bus relay.
- send
Key stringName - The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
- send
Key stringValue - 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 stringNamespace - The name of the Service Bus namespace.
- service
Bus stringSuffix - The suffix for the service bus endpoint. By default this is .servicebus.windows.net
- name str
- The name of the web app.
- namespace_
name str - The namespace for this hybrid connection.
- resource_
group_ strname - 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_ struri - The ARM URI to the Service Bus relay.
- relay_
name str - The name of the Service Bus relay.
- send_
key_ strname - The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
- send_
key_ strvalue - 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_ strnamespace - The name of the Service Bus namespace.
- service_
bus_ strsuffix - The suffix for the service bus endpoint. By default this is .servicebus.windows.net
- name String
- The name of the web app.
- namespace
Name String - The namespace for this hybrid connection.
- resource
Group StringName - 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.
- relay
Arm StringUri - The ARM URI to the Service Bus relay.
- relay
Name String - The name of the Service Bus relay.
- send
Key StringName - The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.
- send
Key StringValue - 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 StringNamespace - The name of the Service Bus namespace.
- service
Bus StringSuffix - 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:
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0