Databases - List Principals

Referência

Serviço:: Azure Kusto

Versão da API:: 2024-04-13

Retorna uma lista de entidades de banco de dados do cluster e do banco de dados Kusto especificados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
clusterName	path	True	string	O nome do cluster Kusto. Padrão Regex: `^.*$`
databaseName	path	True	string	O nome do banco de dados no cluster Kusto. Padrão Regex: `^.*$`
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	DatabasePrincipalListResult	Recuperou com êxito a lista de entidades de banco de dados.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Exemplos

KustoDatabaseListPrincipals

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
    }
  ]
}

Definições

Nome	Description
DatabasePrincipal	Uma classe que representa a entidade de entidade de banco de dados.
DatabasePrincipalListResult	A lista de resposta da operação de entidades de banco de dados do Kusto.
DatabasePrincipalRole	Função de entidade de banco de dados.
DatabasePrincipalType	Tipo de entidade de banco de dados.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro

DatabasePrincipal

Uma classe que representa a entidade de entidade de banco de dados.

Nome	Tipo	Description
appId	string	ID do aplicativo – relevante apenas para o tipo de entidade de aplicativo.
email	string	Email da entidade de banco de dados, se existir.
fqn	string	Nome totalmente qualificado da entidade de banco de dados.
name	string	Nome da entidade de banco de dados.
role	DatabasePrincipalRole	Função de entidade de banco de dados.
tenantName	string	O nome do locatário da entidade de segurança
type	DatabasePrincipalType	Tipo de entidade de banco de dados.

DatabasePrincipalListResult

A lista de resposta da operação de entidades de banco de dados do Kusto.

Nome	Tipo	Description
value	DatabasePrincipal[]	A lista de entidades de banco de dados do Kusto.

DatabasePrincipalRole

Função de entidade de banco de dados.

Nome	Tipo	Description
Admin	string
Ingestor	string
Monitor	string
UnrestrictedViewer	string
User	string
Viewer	string

DatabasePrincipalType

Tipo de entidade de banco de dados.

Nome	Tipo	Description
App	string
Group	string
User	string

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

Compartilhar via