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

WCF Relays - Create Or Update

创建或更新 WCF 中继。 此操作是幂等的。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays/{relayName}?api-version=2021-11-01

URI 参数

名称 必需 类型 说明
namespaceName
path True

string

命名空间名称

relayName
path True

string

中继名称。

resourceGroupName
path True

string

Azure 订阅中的资源组的名称。

subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

客户端 API 版本。

请求正文

名称 类型 说明
properties.relayType

Relaytype

WCF 中继类型。

properties.requiresClientAuthorization

boolean

如果此中继需要客户端授权,则返回 true;否则为 false。

properties.requiresTransportSecurity

boolean

如果此中继需要传输安全性,则返回 true;否则为 false。

properties.userMetadata

string

usermetadata 是一个占位符,用于存储 WCF 中继终结点的用户定义字符串数据。 例如,它可用于存储描述性数据,例如团队列表及其联系信息。 此外,还可以存储用户定义的配置设置。

响应

名称 类型 说明
200 OK

WcfRelay

创建 WCF 中继的请求已成功。

Other Status Codes

ErrorResponse

描述操作失败原因的中继错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

RelayCreate

示例请求

PUT https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9953/wcfRelays/example-Relay-Wcf-1194?api-version=2021-11-01

{
  "properties": {
    "relayType": "NetTcp",
    "requiresClientAuthorization": true,
    "requiresTransportSecurity": true
  }
}

示例响应

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-9953/WcfRelays/example-Relay-Wcf-1194",
  "name": "example-Relay-Wcf-1194",
  "type": "Microsoft.Relay/WcfRelays",
  "properties": {
    "createdAt": "2017-03-16T00:26:17.5014661Z",
    "updatedAt": "2017-03-16T00:26:17.5014661Z",
    "relayType": "NetTcp",
    "requiresClientAuthorization": true,
    "requiresTransportSecurity": true,
    "isDynamic": false
  }
}

定义

名称 说明
createdByType

创建资源的标识类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Relaytype

WCF 中继类型。

systemData

与资源的创建和上次修改相关的元数据。

WcfRelay

WCF 中继资源的说明。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

Relaytype

WCF 中继类型。

名称 类型 说明
Http

string

NetTcp

string

systemData

与资源的创建和上次修改相关的元数据。

名称 类型 说明
createdAt

string

资源的创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

资源上次修改的时间戳 (UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识类型。

WcfRelay

WCF 中继资源的说明。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

资源所在的地理位置

name

string

资源的名称

properties.createdAt

string

创建 WCF 中继的时间。

properties.isDynamic

boolean

如果中继是动态的,则返回 true;否则为 false。

properties.listenerCount

integer

此中继的侦听器数。 请注意,支持 min :1 和 max:25。

properties.relayType

Relaytype

WCF 中继类型。

properties.requiresClientAuthorization

boolean

如果此中继需要客户端授权,则返回 true;否则为 false。

properties.requiresTransportSecurity

boolean

如果此中继需要传输安全性,则返回 true;否则为 false。

properties.updatedAt

string

命名空间的更新时间。

properties.userMetadata

string

usermetadata 是一个占位符,用于存储 WCF 中继终结点的用户定义字符串数据。 例如,它可用于存储描述性数据,例如团队列表及其联系信息。 此外,还可以存储用户定义的配置设置。

systemData

systemData

与此资源相关的系统元数据。

type

string

资源类型。 例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs”