Поделиться через

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

Идентификатор целевой подписки.
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": "[email protected]",
      "appId": ""
    },
    {
      "name": "Kusto",
      "role": "Viewer",
      "type": "Group",
      "fqn": "aadgroup=some_guid",
      "email": "[email protected]",
      "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

Идентификатор приложения — относится только к типу субъекта приложения.
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

Объект ошибки.