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

Roles - Get

按 ID 获取角色。

GET https://{subdomain}.{baseDomain}/api/roles/{roleId}?api-version=2022-07-31

URI 参数

Name In Required Type Description
baseDomain
path True
  • string

所有 Azure IoT Central 服务请求的基本域。

roleId
path True
  • string

角色的唯一 ID。

subdomain
path True
  • string

应用程序子域。

api-version
query True
  • string

要调用的 API 的版本。

响应

Name Type Description
200 OK

成功

Other Status Codes

从 IoT Central 服务收到的错误响应。

Headers

  • x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

Get role by ID

Sample Request

GET https://appsubdomain.azureiotcentral.com/api/roles/ca310b8d-2f4a-44e0-a36e-957c202cd8d4?api-version=2022-07-31

Sample Response

{
  "id": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4",
  "displayName": "Administrator"
}

定义

Error

响应错误定义。

ErrorDetails

错误的详细信息。

Role

角色定义。

Error

响应错误定义。

Name Type Description
error

当前请求的错误详细信息。

ErrorDetails

错误的详细信息。

Name Type Description
code
  • string

错误代码。

message
  • string

错误消息详细信息。

requestId
  • string

当前请求的相关 ID。

time
  • string

错误请求失败的时间。

Role

角色定义。

Name Type Description
displayName
  • string

角色的显示名称。

id
  • string

角色的唯一 ID。