Web Apps - Create Or Update Hybrid Connection

Description for Creates a new Hybrid Connection using a Service Bus relay.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}?api-version=2024-04-01

URI Parameters

Name In Required Type Description
name
path True

string

The name of the web app.

namespaceName
path True

string

The namespace for this hybrid connection.

relayName
path True

string

The relay name for this hybrid connection.

resourceGroupName
path True

string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

api-version
query True

string

API Version

Request Body

Name Type Description
kind

string

Kind of resource.

properties.hostname

string

The hostname of the endpoint.

properties.port

integer

The port of the endpoint.

properties.relayArmUri

string

The ARM URI to the Service Bus relay.

properties.relayName

string

The name of the Service Bus relay.

properties.sendKeyName

string

The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.

properties.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.

properties.serviceBusNamespace

string

The name of the Service Bus namespace.

properties.serviceBusSuffix

string

The suffix for the service bus endpoint. By default this is .servicebus.windows.net

Responses

Name Type Description
200 OK

HybridConnection

OK

Other Status Codes

DefaultErrorResponse

App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Definitions

Name Description
DefaultErrorResponse

App Service error response.

Details
Error

Error model.

HybridConnection

Hybrid Connection contract. This is used to configure a Hybrid Connection.

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error

Error model.

Details

Name Type Description
code

string

Standardized string to programmatically identify the error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

Error

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.

details

Details[]

Detailed errors.

innererror

string

More information to debug error.

message

string

Detailed error description and debugging information.

target

string

Detailed error description and debugging information.

HybridConnection

Hybrid Connection contract. This is used to configure a Hybrid Connection.

Name Type Description
id

string

Resource Id.

kind

string

Kind of resource.

name

string

Resource Name.

properties.hostname

string

The hostname of the endpoint.

properties.port

integer

The port of the endpoint.

properties.relayArmUri

string

The ARM URI to the Service Bus relay.

properties.relayName

string

The name of the Service Bus relay.

properties.sendKeyName

string

The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.

properties.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.

properties.serviceBusNamespace

string

The name of the Service Bus namespace.

properties.serviceBusSuffix

string

The suffix for the service bus endpoint. By default this is .servicebus.windows.net

type

string

Resource type.