Databases - List Principals

Référence

Service:: Azure Kusto

Version d'API:: 2024-04-13

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

Paramètres URI

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

Réponses

Nom	Type	Description
200 OK	DatabasePrincipalListResult	Récupération réussie de la liste des principaux de base de données.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

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

Exemple de réponse

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

Définitions

Nom	Description
DatabasePrincipal	Classe représentant l’entité du principal de base de données.
DatabasePrincipalListResult	Réponse de l’opération des principaux de base de données Kusto de liste.
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

Classe représentant l’entité du principal de base de données.

Nom	Type	Description
appId	string	ID d’application : pertinent uniquement pour le type de principal de l’application.
email	string	E-mail du principal de base de données s’il existe.
fqn	string	Nom complet du principal de base de données.
name	string	Nom du principal de la base de données.
role	DatabasePrincipalRole	Rôle principal de base de données.
tenantName	string	Nom du locataire du principal
type	DatabasePrincipalType	Type de principal de base de données.

DatabasePrincipalListResult

Réponse de l’opération des principaux de base de données Kusto de liste.

Nom	Type	Description
value	DatabasePrincipal[]	Liste des principaux de base de données Kusto.

DatabasePrincipalRole

Rôle principal de base de données.

Nom	Type	Description
Admin	string
Ingestor	string
Monitor	string
UnrestrictedViewer	string
User	string
Viewer	string

DatabasePrincipalType

Type de principal de base de données.

Nom	Type	Description
App	string
Group	string
User	string

ErrorAdditionalInfo

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

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

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

Partager via