通过

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

WCF Relays - List By Namespace

服务:
Relay
API 版本:
2024-01-01

列出命名空间中的 WCF 中继。

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

URI 参数

名称 在 必需 类型 说明
namespaceName
 path True

string

minLength: 6
maxLength: 50

命名空间名称
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

资源组的名称。 此名称不区分大小写。
subscriptionId
 path True

string

minLength: 1

目标订阅的 ID。
api-version
 query True

string

minLength: 1

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

WcfRelaysListResult

请求已成功。
Other Status Codes

ErrorResponse

意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

RelayListAll

示例请求

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/resourcegroup/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/wcfRelays?api-version=2024-01-01

示例响应

状态代码:
200 
{
  "value": [
    {
      "name": "example-Relay-Wcf-01",
      "type": "Microsoft.Relay/Namespaces/WcfRelays",
      "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/RG1-eg/providers/Microsoft.Relay/namespaces/example-RelayNamespace-01/WcfRelays/example-Relay-Wcf-01",
      "properties": {
        "createdAt": "2017-01-24T00:46:27.0049983Z",
        "isDynamic": false,
        "relayType": "NetTcp",
        "requiresClientAuthorization": true,
        "requiresTransportSecurity": true,
        "updatedAt": "2017-01-24T00:46:27.0049983Z",
        "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"
      }
    }
  ]
}

定义

名称 说明
createdByType

创建资源的标识的类型。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorDetail

错误详细信息。
ErrorResponse

错误响应
Relaytype

WCF 中继类型。
systemData

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

WCF 中继资源的说明。
WcfRelaysListResult

列表 WCF 中继作的响应。

createdByType

枚举

创建资源的标识的类型。

值 说明
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

Relaytype

枚举

WCF 中继类型。

值 说明
NetTcp
Http

systemData

Object

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

名称 类型 说明
createdAt

string (date-time)

资源创建时间戳（UTC）。
createdBy

string

创建资源的标识。
createdByType

createdByType

创建资源的标识的类型。
lastModifiedAt

string (date-time)

上次修改的资源时间戳（UTC）
lastModifiedBy

string

上次修改资源的标识。
lastModifiedByType

createdByType

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

WcfRelay

Object

WCF 中继资源的说明。

名称 类型 说明
id

string

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

string

资源所在的地理位置
name

string

资源的名称
properties.createdAt

string (date-time)

创建 WCF 中继的时间。
properties.isDynamic

boolean

如果中继是动态的，则返回 true;否则为 false。
properties.listenerCount

integer (int32)

maximum: 25

此中继的侦听器数。 请注意，支持 min ：1 和 max：25。
properties.relayType

Relaytype

WCF 中继类型。
properties.requiresClientAuthorization

boolean

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

boolean

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

string (date-time)

命名空间的更新时间。
properties.userMetadata

string

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

systemData

包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type

string

资源的类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

WcfRelaysListResult

Object

列表 WCF 中继作的响应。

名称 类型 说明
nextLink

string (uri)

指向下一页项目的链接
value

WcfRelay[]

此页面上的 WcfRelay 项目