Gateways - List Gateway Members

服务:

Core

API 版本:

v1

注意

此 API 以预览版提供。

按 ID 列出 OnPremisesGateway 的网关成员。

权限

• 调用方必须具有网关的权限。

所需的委派范围

Gateway.Read.All 或 Gateway.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体 和 托管标识	是的

接口

GET https://api.fabric.microsoft.com/v1/gateways/{gatewayId}/members

URI 参数

名称	在	必需	类型	说明
gatewayId	path	True	string uuid	网关的 ID。

响应

名称	类型	说明
200 OK	ListGatewayMembersResponse	还行。 作成功。
Other Status Codes	ErrorResponse	常见错误代码： EntityNotFound - 找不到请求的资源。

示例

Example

示例请求

HTTP

GET https://api.fabric.microsoft.com/v1/gateways/8e41c4dd-a382-4937-9bf3-695ab881f7c2/members

示例响应

状态代码:

200

{
  "value": [
    {
      "id": "8e41c4dd-a382-4937-9bf3-695ab881f7c2",
      "displayName": "ContosoPrimaryMemberGateway",
      "publicKey": {
        "exponent": "AQGB",
        "modulus": "od9b...90Jp1Q=="
      },
      "version": "3000.1.1",
      "enabled": true
    },
    {
      "id": "5d225cda-42d5-43d3-bc40-218f746e1d58",
      "displayName": "ContosoSecondaryMemberGateway",
      "publicKey": {
        "exponent": "AQCB",
        "modulus": "o57c...90Jh1P=="
      },
      "version": "3000.1.1",
      "enabled": false
    }
  ]
}

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
ListGatewayMembersResponse
OnPremisesGatewayMember	网关成员信息。
PublicKey	本地网关的公钥。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

ListGatewayMembersResponse

Object

名称	类型	说明
continuationToken	string	下一个结果集批处理的令牌。 如果没有更多记录，则会从响应中删除该记录。
continuationUri	string	下一个结果集批处理的 URI。 如果没有更多记录，则会从响应中删除该记录。
value	OnPremisesGatewayMember[]	返回的网关群集成员列表。

OnPremisesGatewayMember

Object

网关成员信息。

名称	类型	说明
displayName	string	网关成员的显示名称。
enabled	boolean	网关成员是否已启用。 True - Enabled、False - 未启用。
id	string uuid	网关成员的对象 ID。
publicKey	PublicKey	网关成员的公钥。 用于加密用于创建和更新连接的凭据。
version	string	已安装网关成员的版本。

PublicKey

Object

本地网关的公钥。

名称	类型	说明
exponent	string	公钥的指数。
modulus	string	公钥的模数。