通过

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

Databases - List Principals

服务:
Azure Kusto
API 版本:
2024-04-13

返回给定 Kusto 群集和数据库的数据库主体的列表。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals?api-version=2024-04-13

URI 参数

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

string

pattern: ^.*$

Kusto 群集的名称。
databaseName
 path True

string

pattern: ^.*$

Kusto 群集中数据库的名称。
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

DatabasePrincipalListResult

已成功检索数据库主体列表。
Other Status Codes

ErrorResponse

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

示例

KustoDatabaseListPrincipals

示例请求

POST https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/kustoCluster/databases/KustoDatabase8/listPrincipals?api-version=2024-04-13

示例响应

状态代码:
200 
{
  "value": [
    {
      "name": "Some User",
      "role": "Admin",
      "type": "User",
      "fqn": "aaduser=some_guid",
      "email": "user@microsoft.com",
      "appId": ""
    },
    {
      "name": "Kusto",
      "role": "Viewer",
      "type": "Group",
      "fqn": "aadgroup=some_guid",
      "email": "kusto@microsoft.com",
      "appId": ""
    },
    {
      "name": "SomeApp",
      "role": "Admin",
      "type": "App",
      "fqn": "aadapp=some_guid_app_id",
      "email": "",
      "appId": "some_guid_app_id"
    }
  ]
}

定义

名称 说明
DatabasePrincipal

表示数据库主体实体的类。
DatabasePrincipalListResult

列出 Kusto 数据库主体操作响应。
DatabasePrincipalRole

数据库主体角色。
DatabasePrincipalType

数据库主体类型。
ErrorAdditionalInfo

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

错误详细信息。
ErrorResponse

错误响应

DatabasePrincipal

Object

表示数据库主体实体的类。

名称 类型 说明
appId

string

应用程序 ID - 仅适用于应用程序主体类型。
email

string

数据库主体电子邮件（如果存在）。
fqn

string

数据库主体完全限定名称。
name

string

数据库主体名称。
role

DatabasePrincipalRole

数据库主体角色。
tenantName

string

主体的租户名称
type

DatabasePrincipalType

数据库主体类型。

DatabasePrincipalListResult

Object

列出 Kusto 数据库主体操作响应。

名称 类型 说明
value

DatabasePrincipal[]

Kusto 数据库主体的列表。

DatabasePrincipalRole

枚举

数据库主体角色。

值 说明
Admin
Ingestor
Monitor
User
UnrestrictedViewer
Viewer

DatabasePrincipalType

枚举

数据库主体类型。

值 说明
App
Group
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorDetail

Object

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorDetail[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

ErrorResponse

Object

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。