Databases - List Principals

Service:: Azure Kusto

Version d'API:: 2025-02-14

Retourne une liste de principaux de base de données du cluster et de la base de données Kusto donnés.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
clusterName	path	True	string pattern: ^.*$	Nom du cluster Kusto.
databaseName	path	True	string pattern: ^.*$	Nom de la base de données dans le cluster Kusto.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string minLength: 1	ID de l’abonnement cible.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	DatabasePrincipalListResult	Opération Azure terminée avec succès.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

KustoDatabaseListPrincipals

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
    }
  ]
}

Définitions

Nom	Description
DatabasePrincipal	Une classe représentant l’entité principale de la base de données.
DatabasePrincipalListResult	La liste des principaux de base de données Kusto : réponse opérationnelle.
DatabasePrincipalRole	Rôle principal de base de données.
DatabasePrincipalType	Type de principal de base de données.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur

DatabasePrincipal

Objet

Une classe représentant l’entité principale de la base de données.

Nom	Type	Description
appId	string	ID d’application - pertinent uniquement pour le type principal d’application.
email	string	Adresse principale de la base de données si elle existe.
fqn	string	Nom entièrement qualifié du principal de la base de données.
name	string	Nom principal de la base de données.
role	DatabasePrincipalRole	Rôle principal de base de données.
tenantName	string	Le nom du principal du locataire
type	DatabasePrincipalType	Type de principal de base de données.

DatabasePrincipalListResult

Objet

La liste des principaux de base de données Kusto : réponse opérationnelle.

Nom	Type	Description
nextLink	string	Lien vers la page suivante des résultats.
value	DatabasePrincipal[]	Liste des principaux de base de données Kusto.

DatabasePrincipalRole

Énumération

Rôle principal de base de données.

Valeur	Description
Admin	Administrateur
Ingestor	Ingestion
Monitor	Monitor
User	Utilisateur
UnrestrictedViewer	UnrestrictedViewer
Viewer	Spectateur

DatabasePrincipalType

Énumération

Type de principal de base de données.

Valeur	Description
App	Application
Group	Groupe
User	Utilisateur

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.