Share via

Web Apps - Create Or Update Relay Service Connection

Service:
App Service
API Version:
2025-05-01

Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}?api-version=2025-05-01

URI Parameters

Name In Required Type Description
entityName
 path True

string

Name of the hybrid connection.
name
 path True

string

Name of the app.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string (uuid)

The ID of the target subscription. The value must be an UUID.
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
kind

string

Kind of resource.
properties.biztalkUri

string

properties.entityConnectionString

string

properties.entityName

string

properties.hostname

string

properties.port

integer (int32)

properties.resourceConnectionString

string

properties.resourceType

string

Responses

Name Type Description
200 OK

RelayServiceConnectionEntity

Resource 'RelayServiceConnectionEntity' update operation succeeded
Other Status Codes

DefaultErrorResponse

An unexpected 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
createdByType

The type of identity that created the resource.
DefaultErrorResponse

App Service error response.
DefaultErrorResponseError

Error model.
DefaultErrorResponseErrorDetailsItem

Detailed errors.
RelayServiceConnectionEntity

Hybrid Connection for an App Service app.
systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Object

App Service error response.

Name Type Description
error

DefaultErrorResponseError

Error model.

DefaultErrorResponseError

Object

Error model.

Name Type Description
code

string

Standardized string to programmatically identify the error.
details

DefaultErrorResponseErrorDetailsItem[]

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.

DefaultErrorResponseErrorDetailsItem

Object

Detailed errors.

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.

RelayServiceConnectionEntity

Object

Hybrid Connection for an App Service app.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind

string

Kind of resource.
name

string

The name of the resource
properties.biztalkUri

string

properties.entityConnectionString

string

properties.entityName

string

properties.hostname

string

properties.port

integer (int32)

properties.resourceConnectionString

string

properties.resourceType

string

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.