Partager via

Databases - List Principals

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

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

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

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

Object

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

Object

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

Énumération

Rôle principal de base de données.

Valeur Description
Admin
Ingestor
Monitor
User
UnrestrictedViewer
Viewer

DatabasePrincipalType

Énumération

Type de principal de base de données.

Valeur Description
App
Group
User

ErrorAdditionalInfo

Object

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

Object

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

Object

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.