Databases - List Principals

傳回指定 Kusto 叢集和資料庫的資料庫主體清單。

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

URI 參數

名稱 位於 必要 類型 Description
clusterName
path True

string

Kusto 叢集的名稱。

Regex pattern: ^.*$

databaseName
path True

string

Kusto 叢集中的資料庫名稱。

Regex pattern: ^.*$

resourceGroupName
path True

string

資源群組的名稱。 名稱不區分大小寫。

subscriptionId
path True

string

目標訂用帳戶的標識碼。

api-version
query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

DatabasePrincipalListResult

已成功擷取資料庫主體的清單。

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

範例

KustoDatabaseListPrincipals

Sample Request

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

Sample Response

{
  "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"
    }
  ]
}

定義

名稱 Description
DatabasePrincipal

代表資料庫主體實體的類別。

DatabasePrincipalListResult

列出 Kusto 資料庫主體作業回應。

DatabasePrincipalRole

資料庫主體角色。

DatabasePrincipalType

資料庫主體類型。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

DatabasePrincipal

代表資料庫主體實體的類別。

名稱 類型 Description
appId

string

應用程式識別碼 - 僅適用於應用程式主體類型。

email

string

如果存在,則為資料庫主體電子郵件。

fqn

string

資料庫主體完整名稱。

name

string

資料庫主體名稱。

role

DatabasePrincipalRole

資料庫主體角色。

tenantName

string

主體的租用戶名稱

type

DatabasePrincipalType

資料庫主體類型。

DatabasePrincipalListResult

列出 Kusto 資料庫主體作業回應。

名稱 類型 Description
value

DatabasePrincipal[]

Kusto 資料庫主體的清單。

DatabasePrincipalRole

資料庫主體角色。

名稱 類型 Description
Admin

string

Ingestor

string

Monitor

string

UnrestrictedViewer

string

User

string

Viewer

string

DatabasePrincipalType

資料庫主體類型。

名稱 類型 Description
App

string

Group

string

User

string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細資料。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

錯誤物件。