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 banco de dados Kusto fornecidos.

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

Parâmetros do URI

Name	Em	Necessá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

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

Exemplos

KustoDatabaseListPrincipals

Pedido de amostra

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 da amostra

Código de estado:: 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

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

DatabasePrincipal

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

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

DatabasePrincipalListResult

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

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

DatabasePrincipalRole

Função principal do banco de dados.

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

DatabasePrincipalType

Tipo principal de banco de dados.

Name	Tipo	Description
App	string
Group	string
User	string

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Partilhar via