Databases - List Principals

Servicio:: Azure Kusto

Versión de la API:: 2025-02-14

Devuelve una lista de entidades de seguridad de base de datos del clúster y la base de datos de Kusto especificados.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
clusterName	path	True	string pattern: ^.*$	Nombre del clúster de Kusto.
databaseName	path	True	string pattern: ^.*$	Nombre de la base de datos en el clúster de Kusto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	DatabasePrincipalListResult	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

KustoDatabaseListPrincipals

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
DatabasePrincipal	Una clase que representa la entidad principal de la base de datos.
DatabasePrincipalListResult	La lista de la respuesta operativa de los principales de la base de datos Kusto.
DatabasePrincipalRole	Rol de entidad de seguridad de base de datos.
DatabasePrincipalType	Tipo principal de base de datos.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

DatabasePrincipal

Objeto

Una clase que representa la entidad principal de la base de datos.

Nombre	Tipo	Description
appId	string	ID de aplicación - relevante solo para el tipo principal de aplicación.
email	string	Correo electrónico principal de base de datos si existe.
fqn	string	Nombre totalmente cualificado del director de la base de datos.
name	string	Nombre del director de la base de datos.
role	DatabasePrincipalRole	Rol de entidad de seguridad de base de datos.
tenantName	string	El nombre del arrendatario del principal
type	DatabasePrincipalType	Tipo principal de base de datos.

DatabasePrincipalListResult

Objeto

La lista de la respuesta operativa de los principales de la base de datos Kusto.

Nombre	Tipo	Description
nextLink	string	Enlace a la siguiente página de resultados.
value	DatabasePrincipal[]	Lista de entidades de seguridad de base de datos de Kusto.

DatabasePrincipalRole

Enumeración

Rol de entidad de seguridad de base de datos.

Valor	Description
Admin	Administrador
Ingestor	Agente de ingesta
Monitor	Monitor
User	Usuario
UnrestrictedViewer	UnrestrictedViewer
Viewer	Visor

DatabasePrincipalType

Enumeración

Tipo principal de base de datos.

Valor	Description
App	Aplicación
Group	Grupo
User	Usuario

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.