Databases - List Principals

Referencia

Servicio:: Azure Kusto

Versión de la API:: 2024-04-13

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=2024-04-13

Parámetros de identificador URI

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

Respuestas

Nombre	Tipo	Description
200 OK	DatabasePrincipalListResult	Se recuperó correctamente la lista de entidades de seguridad de base de datos.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

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=2024-04-13

Respuesta de muestra

status code:: 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"
    }
  ]
}

Definiciones

Nombre	Description
DatabasePrincipal	Clase que representa la entidad principal de base de datos.
DatabasePrincipalListResult	Respuesta de la operación de entidades de seguridad de base de datos de Kusto.
DatabasePrincipalRole	Rol de entidad de seguridad de base de datos.
DatabasePrincipalType	Tipo de entidad de seguridad 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

Clase que representa la entidad principal de base de datos.

Nombre	Tipo	Description
appId	string	Identificador de aplicación: solo es relevante para el tipo de entidad de seguridad de la aplicación.
email	string	Si existe, el correo electrónico de la entidad de seguridad de la base de datos.
fqn	string	Nombre completo de la entidad de seguridad de base de datos.
name	string	Nombre principal de la base de datos.
role	DatabasePrincipalRole	Rol de entidad de seguridad de base de datos.
tenantName	string	Nombre de inquilino de la entidad de seguridad
type	DatabasePrincipalType	Tipo de entidad de seguridad de base de datos.

DatabasePrincipalListResult

Respuesta de la operación de entidades de seguridad de base de datos de Kusto.

Nombre	Tipo	Description
value	DatabasePrincipal[]	Lista de entidades de seguridad de base de datos de Kusto.

DatabasePrincipalRole

Rol de entidad de seguridad de base de datos.

Nombre	Tipo	Description
Admin	string
Ingestor	string
Monitor	string
UnrestrictedViewer	string
User	string
Viewer	string

DatabasePrincipalType

Tipo de entidad de seguridad de base de datos.

Nombre	Tipo	Description
App	string
Group	string
User	string

ErrorAdditionalInfo

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

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	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Compartir a través de