你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
WCF Relays - List By Namespace
Lists命名空间中的 WCF 中继。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Relay/namespaces/{namespaceName}/wcfRelays?api-version=2021-11-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
namespace
|
path | True |
string |
命名空间名称 |
resource
|
path | True |
string |
Azure 订阅中资源组的名称。 |
subscription
|
path | True |
string |
唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。 |
api-version
|
query | True |
string |
客户端 API 版本。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
WCF 中继已成功返回。 |
|
Other Status Codes |
描述操作失败原因的中继错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
RelayListAll
Sample Request
Sample Response
{
"value": [
{
"id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01",
"name": "example-Relay-Wcf-01",
"type": "Microsoft.Relay/Namespaces/WcfRelays",
"properties": {
"createdAt": "2017-01-24T00:46:27.0049983Z",
"updatedAt": "2017-01-24T00:46:27.0049983Z",
"relayType": "NetTcp",
"requiresClientAuthorization": true,
"requiresTransportSecurity": true,
"isDynamic": false,
"userMetadata": "usermetadata is a placeholder to store user-defined string data for the HybridConnection endpoint.e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored"
}
}
]
}
定义
名称 | 说明 |
---|---|
created |
创建资源的标识类型。 |
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Relaytype |
WCF 中继类型。 |
system |
与资源的创建和上次修改相关的元数据。 |
Wcf |
WCF 中继资源的说明。 |
Wcf |
列表 WCF 中继操作的响应。 |
createdByType
创建资源的标识类型。
名称 | 类型 | 说明 |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
Relaytype
WCF 中继类型。
名称 | 类型 | 说明 |
---|---|---|
Http |
string |
|
NetTcp |
string |
systemData
与资源的创建和上次修改相关的元数据。
名称 | 类型 | 说明 |
---|---|---|
createdAt |
string |
资源创建时间戳 (UTC) 。 |
createdBy |
string |
创建资源的标识。 |
createdByType |
创建资源的标识类型。 |
|
lastModifiedAt |
string |
资源上次修改的时间戳 (UTC) |
lastModifiedBy |
string |
上次修改资源的标识。 |
lastModifiedByType |
上次修改资源的标识类型。 |
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 |
此中继的侦听器数。 请注意,支持最小值 :1 和 max:25。 |
properties.relayType |
WCF 中继类型。 |
|
properties.requiresClientAuthorization |
boolean |
如果此中继需要客户端授权,则返回 true;否则为 false。 |
properties.requiresTransportSecurity |
boolean |
如果此中继需要传输安全性,则返回 true;否则为 false。 |
properties.updatedAt |
string |
更新命名空间的时间。 |
properties.userMetadata |
string |
usermetadata 是一个占位符,用于存储 WCF 中继终结点的用户定义字符串数据。 例如,它可用于存储描述性数据,例如团队列表及其联系信息。 此外,还可以存储用户定义的配置设置。 |
systemData |
与此资源相关的系统元数据。 |
|
type |
string |
资源类型。 例如“Microsoft.EventHub/Namespaces”或“Microsoft.EventHub/Namespaces/EventHubs” |
WcfRelaysListResult
列表 WCF 中继操作的响应。
名称 | 类型 | 说明 |
---|---|---|
nextLink |
string |
链接到下一组结果。 如果值包含 WCF 中继的不完整列表,则不为空。 |
value |
Wcf |
列出 WCF 中继操作的结果。 |