Condividi tramite


Databases - List Principals

Restituisce un elenco di entità di database del cluster e del database Kusto specificati.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
clusterName
path True

string

Nome del cluster Kusto.

Criterio di espressione regolare: ^.*$

databaseName
path True

string

Nome del database nel cluster Kusto.

Criterio di espressione regolare: ^.*$

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

DatabasePrincipalListResult

È stato recuperato l'elenco delle entità di database.

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Esempio

KustoDatabaseListPrincipals

Esempio di richiesta

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

Risposta di esempio

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

Definizioni

Nome Descrizione
DatabasePrincipal

Classe che rappresenta l'entità principale del database.

DatabasePrincipalListResult

Risposta dell'operazione delle entità di database Kusto nell'elenco.

DatabasePrincipalRole

Ruolo dell'entità di database.

DatabasePrincipalType

Tipo di entità di database.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

ErrorDetail

Dettagli dell'errore.

ErrorResponse

Risposta di errore

DatabasePrincipal

Classe che rappresenta l'entità principale del database.

Nome Tipo Descrizione
appId

string

ID applicazione: rilevante solo per il tipo di entità applicazione.

email

string

Indirizzo di posta elettronica dell'entità di database, se esistente.

fqn

string

Nome completo dell'entità di database.

name

string

Nome dell'entità di database.

role

DatabasePrincipalRole

Ruolo dell'entità di database.

tenantName

string

Nome del tenant dell'entità

type

DatabasePrincipalType

Tipo di entità di database.

DatabasePrincipalListResult

Risposta dell'operazione delle entità di database Kusto nell'elenco.

Nome Tipo Descrizione
value

DatabasePrincipal[]

Elenco delle entità di database Kusto.

DatabasePrincipalRole

Ruolo dell'entità di database.

Nome Tipo Descrizione
Admin

string

Ingestor

string

Monitor

string

UnrestrictedViewer

string

User

string

Viewer

string

DatabasePrincipalType

Tipo di entità di database.

Nome Tipo Descrizione
App

string

Group

string

User

string

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

ErrorDetail[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.