Freigeben über

Databases - List Principals

Dienst:
Azure Kusto
API-Version:
2024-04-13

Gibt eine Liste der Datenbankprinzipale des angegebenen Kusto-Clusters und der Angegebenen Datenbank zurück.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
clusterName
 path True

string

pattern: ^.*$

Der Name des Kusto-Clusters.
databaseName
 path True

string

pattern: ^.*$

Der Name der Datenbank im Kusto-Cluster.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId
 path True

string

minLength: 1

Die ID des Zielabonnements.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

DatabasePrincipalListResult

Die Liste der Datenbankprinzipale wurde erfolgreich abgerufen.
Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

KustoDatabaseListPrincipals

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
DatabasePrincipal

Eine Klasse, die die Datenbankprinzipalentität darstellt.
DatabasePrincipalListResult

Die Antwort auf den Kusto-Datenbankprinzipalvorgang.
DatabasePrincipalRole

Datenbankprinzipalrolle.
DatabasePrincipalType

Datenbankprinzipaltyp.
ErrorAdditionalInfo

Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail

Das Fehlerdetails.
ErrorResponse

Fehlerantwort

DatabasePrincipal

Objekt

Eine Klasse, die die Datenbankprinzipalentität darstellt.

Name Typ Beschreibung
appId

string

Anwendungs-ID – nur für Anwendungsprinzipaltyp relevant.
email

string

Datenbankprinzipal-E-Mail, falls vorhanden.
fqn

string

Vollqualifizierter Datenbankprinzipalname.
name

string

Datenbankprinzipalname.
role

DatabasePrincipalRole

Datenbankprinzipalrolle.
tenantName

string

Der Mandantenname des Prinzipals
type

DatabasePrincipalType

Datenbankprinzipaltyp.

DatabasePrincipalListResult

Objekt

Die Antwort auf den Kusto-Datenbankprinzipalvorgang.

Name Typ Beschreibung
value

DatabasePrincipal[]

Die Liste der Kusto-Datenbankprinzipale.

DatabasePrincipalRole

Enumeration

Datenbankprinzipalrolle.

Wert Beschreibung
Admin
Ingestor
Monitor
User
UnrestrictedViewer
Viewer

DatabasePrincipalType

Enumeration

Datenbankprinzipaltyp.

Wert Beschreibung
App
Group
User

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name Typ Beschreibung
info

object

Die zusätzlichen Informationen.
type

string

Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die zusätzlichen Informationen des Fehlers.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name Typ Beschreibung
error

ErrorDetail

Das Fehlerobjekt.