Databases - List Principals

Returnerar en lista över databashuvudkonton för det angivna Kusto-klustret och databasen.

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

URI-parametrar

Name I Obligatorisk Typ Description
clusterName
path True

string

Namnet på Kusto-klustret.

Reguljärt uttrycksmönster: ^.*$

databaseName
path True

string

Namnet på databasen i Kusto-klustret.

Reguljärt uttrycksmönster: ^.*$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

DatabasePrincipalListResult

Listan över databashuvudkonton har hämtats.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Exempel

KustoDatabaseListPrincipals

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
DatabasePrincipal

En klass som representerar databasens huvudnamnsentitet.

DatabasePrincipalListResult

Åtgärdssvar för kusto-databasens huvudnamn i listan.

DatabasePrincipalRole

Databasens huvudroll.

DatabasePrincipalType

Databasens huvudnamnstyp.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Felsvar

DatabasePrincipal

En klass som representerar databasens huvudnamnsentitet.

Name Typ Description
appId

string

Program-ID – endast relevant för programhuvudnamnstyp.

email

string

Databasens huvudnamn e-post om det finns.

fqn

string

Fullständigt kvalificerat namn för databasens huvudnamn.

name

string

Databasens huvudnamn.

role

DatabasePrincipalRole

Databasens huvudroll.

tenantName

string

Klientorganisationens namn på huvudkontot

type

DatabasePrincipalType

Databasens huvudnamnstyp.

DatabasePrincipalListResult

Åtgärdssvar för kusto-databasens huvudnamn i listan.

Name Typ Description
value

DatabasePrincipal[]

Listan över Kusto-databashuvudkonton.

DatabasePrincipalRole

Databasens huvudroll.

Name Typ Description
Admin

string

Ingestor

string

Monitor

string

UnrestrictedViewer

string

User

string

Viewer

string

DatabasePrincipalType

Databasens huvudnamnstyp.

Name Typ Description
App

string

Group

string

User

string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Den ytterligare informationen.

type

string

Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.

code

string

Felkoden.

details

ErrorDetail[]

Felinformationen.

message

string

Felmeddelandet.

target

string

Felmålet.

ErrorResponse

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.