PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/?api-version=2023-01-01
Description for Creates a new Hybrid Connection using a Service Bus relay.
Servers
- https://management.azure.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
The name of the web app. |
namespaceName |
String | Yes |
The namespace for this hybrid connection. |
relayName |
String | Yes |
The relay name for this hybrid connection. |
slot |
String | Yes |
The name of the slot for the web app. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName |
String | Yes |
Name of the resource group to which the resource belongs. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Resource Id. |
name |
String | No |
Resource Name. |
properties |
Object | No |
HybridConnection resource specific properties |
properties.port |
Integer | No |
The port of the endpoint. |
properties.relayName |
String | No |
The name of the Service Bus relay. |
properties.serviceBusSuffix |
String | No |
The suffix for the service bus endpoint. By default this is .servicebus.windows.net |
properties.serviceBusNamespace |
String | No |
The name of the Service Bus namespace. |
properties.hostname |
String | No |
The hostname of the endpoint. |
properties.sendKeyName |
String | No |
The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. |
properties.sendKeyValue |
String | No |
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. |
properties.relayArmUri |
String | No |
The ARM URI to the Service Bus relay. |
type |
String | No |
Resource type. |
kind |
String | No |
Kind of resource. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.