Dela via

Databases - List Principals

Tjänst:
Azure Kusto
API-version:
2024-04-13

Returnerar en lista över databashuvudnamn 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=2024-04-13

URI-parametrar

Name I Obligatorisk Typ Description
clusterName
 path True

string

pattern: ^.*$

Namnet på Kusto-klustret.
databaseName
 path True

string

pattern: ^.*$

Namnet på databasen i Kusto-klustret.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId
 path True

string

minLength: 1

ID för målprenumerationen.
api-version
 query True

string

minLength: 1

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

Svar

Name Typ Description
200 OK

DatabasePrincipalListResult

Listan över databasobjekt 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=2024-04-13

Exempelsvar

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

Definitioner

Name Description
DatabasePrincipal

En klass som representerar databasens huvudnamnsentitet.
DatabasePrincipalListResult

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

Databasens huvudroll.
DatabasePrincipalType

Databashuvudnamnstyp.
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Felsvar

DatabasePrincipal

Objekt

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

Databashuvudnamnstyp.

DatabasePrincipalListResult

Objekt

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

Name Typ Description
value

DatabasePrincipal[]

Listan över Kusto-databashuvudnamn.

DatabasePrincipalRole

Uppräkning

Databasens huvudroll.

Värde Description
Admin
Ingestor
Monitor
User
UnrestrictedViewer
Viewer

DatabasePrincipalType

Uppräkning

Databashuvudnamnstyp.

Värde Description
App
Group
User

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

object

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Felsvar

Name Typ Description
error

ErrorDetail

Felobjektet.