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 パラメーター

名前 / 必須 説明
clusterName
path True

string

Kusto クラスターの名前。

Regex pattern: ^.*$

databaseName
path True

string

Kusto クラスター内のデータベースの名前。

Regex pattern: ^.*$

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
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"
    }
  ]
}

定義

名前 説明
DatabasePrincipal

データベース プリンシパル エンティティを表すクラス。

DatabasePrincipalListResult

Kusto データベース プリンシパル操作応答の一覧。

DatabasePrincipalRole

データベース プリンシパル ロール。

DatabasePrincipalType

データベース プリンシパルの種類。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

DatabasePrincipal

データベース プリンシパル エンティティを表すクラス。

名前 説明
appId

string

アプリケーション ID - アプリケーション プリンシパルの種類にのみ関連します。

email

string

データベース プリンシパルの電子メール (存在する場合)。

fqn

string

データベース プリンシパルの完全修飾名。

name

string

データベース プリンシパル名。

role

DatabasePrincipalRole

データベース プリンシパル ロール。

tenantName

string

プリンシパルのテナント名

type

DatabasePrincipalType

データベース プリンシパルの種類。

DatabasePrincipalListResult

Kusto データベース プリンシパル操作応答の一覧。

名前 説明
value

DatabasePrincipal[]

Kusto データベース プリンシパルの一覧。

DatabasePrincipalRole

データベース プリンシパル ロール。

名前 説明
Admin

string

Ingestor

string

Monitor

string

UnrestrictedViewer

string

User

string

Viewer

string

DatabasePrincipalType

データベース プリンシパルの種類。

名前 説明
App

string

Group

string

User

string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。