你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Apps - Create Or Update Hybrid Connection

Service:

App Service

API Version:

2023-12-01

有关使用服务总线中继创建新的混合连接的说明。

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

URI 参数

名称	在	必需	类型	说明
name	path	True	string	Web 应用的名称。
namespaceName	path	True	string	此混合连接的命名空间。
relayName	path	True	string	此混合连接的中继名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

请求正文

名称	类型	说明
kind	string	资源类型。
properties.hostname	string	终结点的主机名。
properties.port	integer	终结点的端口。
properties.relayArmUri	string	服务总线中继的 ARM URI。
properties.relayName	string	服务总线中继的名称。
properties.sendKeyName	string	具有“发送”权限的服务总线密钥的名称。 这用于向服务总线进行身份验证。
properties.sendKeyValue	string	服务总线密钥的值。 这用于向服务总线进行身份验证。 在 ARM 中，此密钥不会正常返回，请改用 POST /listKeys API。
properties.serviceBusNamespace	string	服务总线命名空间的名称。
properties.serviceBusSuffix	string	服务总线终结点的后缀。 默认情况下，这是 .servicebus.windows.net

响应

名称	类型	说明
200 OK	HybridConnection	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

定义

名称	说明
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
HybridConnection	混合连接协定。 这用于配置混合连接。

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	用于以编程方式识别错误的标准化字符串。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	用于以编程方式识别错误的标准化字符串。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

HybridConnection

混合连接协定。 这用于配置混合连接。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.hostname	string	终结点的主机名。
properties.port	integer	终结点的端口。
properties.relayArmUri	string	服务总线中继的 ARM URI。
properties.relayName	string	服务总线中继的名称。
properties.sendKeyName	string	具有“发送”权限的服务总线密钥的名称。 这用于向服务总线进行身份验证。
properties.sendKeyValue	string	服务总线密钥的值。 这用于向服务总线进行身份验证。 在 ARM 中，此密钥不会正常返回，请改用 POST /listKeys API。
properties.serviceBusNamespace	string	服务总线命名空间的名称。
properties.serviceBusSuffix	string	服务总线终结点的后缀。 默认情况下，这是 .servicebus.windows.net
type	string	资源类型。