Partilhar via

Items - Get KQL Database Definition

Serviço:
KQLDatabase
Versão da API:
v1

Retorna a definição pública do banco de dados KQL especificada.
Esta API suporta operações de longa duração (LRO).

Permissões

O chamador deve ter permissões de leitura e gravação para o banco de dados KQL.

Escopos delegados necessários

KQLDatabase.ReadWrite.All ou Item.ReadWrite.All

Identidades suportadas pelo Entra da Microsoft

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade Apoio
Utilizador Sim
Entidade de serviço e identidades geridas Sim

Interfaz

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/getDefinition
Com parâmetros opcionais: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/kqlDatabases/{kqlDatabaseId}/getDefinition?format={format}

Parâmetros do URI

Name Em Necessário Tipo Description
kqlDatabaseId
 path True

string (uuid)

O ID do banco de dados KQL.
workspaceId
 path True

string (uuid)

O ID do espaço de trabalho.
format
 query

string

O formato da definição pública do banco de dados KQL.

Respostas

Name Tipo Description
200 OK

KQLDatabaseDefinitionResponse

Pedido concluído com sucesso.
202 Accepted

Pedido aceite. Está em curso a recuperação da definição.

Cabeçalhos

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Códigos de erro comuns:

  • OperationNotSupportedForItem - Operação não suportada para o item solicitado.

Exemplos

Get a ReadWrite KQL database definition example

Pedido de amostra

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/kqlDatabases/5b218778-e7a5-4d73-8187-f10824047715/getDefinition

Resposta da amostra

Código de estado:
200 
{
  "definition": {
    "parts": [
      {
        "path": "DatabaseProperties.json",
        "payload": "ewogICJkYXRhYmFzZVR5cGUiOiAiUmVhZFdyaXRlIiwKICAicGFyZW50RXZlbnRob3VzZUl0ZW1JZCI6ICI1YjIxODc3OC1lN2E1LTRkNzMtODE4Ny1mMTA4MjQwNDc4MzYiLAogICJvbmVMYWtlQ2FjaGluZ1BlcmlvZCI6ICJQMzY1MDBEIiwKICAib25lTGFrZVN0YW5kYXJkU3RvcmFnZVBlcmlvZCI6ICJQMzY1MDBEIgp9",
        "payloadType": "InlineBase64"
      },
      {
        "path": "DatabaseSchema.kql",
        "payload": "Ly8gS1FMIHNjcmlwdAovLyBVc2UgbWFuYWdlbWVudCBjb21tYW5kcyBpbiB0aGlzIHNjcmlwdCB0byBjb25maWd1cmUgeW91ciBkYXRhYmFzZSBpdGVtcywgc3VjaCBhcyB0YWJsZXMsIGZ1bmN0aW9ucywgbWF0ZXJpYWxpemVkIHZpZXdzLCBhbmQgbW9yZS4KCi5jcmVhdGUtbWVyZ2UgdGFibGUgTXlMb2dzIChMZXZlbDpzdHJpbmcsIFRpbWVzdGFtcDpkYXRldGltZSwgVXNlcklkOnN0cmluZywgVHJhY2VJZDpzdHJpbmcsIE1lc3NhZ2U6c3RyaW5nLCBQcm9jZXNzSWQ6aW50KQ",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
Código de estado:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Definições

Name Description
ErrorRelatedResource

O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse

A resposta de erro.
ErrorResponseDetails

Os detalhes da resposta de erro.
KQLDatabaseDefinition

Objeto de definição pública do banco de dados KQL.
KQLDatabaseDefinitionPart

Objeto de parte de definição de banco de dados KQL.
KQLDatabaseDefinitionResponse

Resposta de definição pública do banco de dados KQL.
PayloadType

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name Tipo Description
resourceId

string

A ID do recurso envolvida no erro.
resourceType

string

O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
moreDetails

ErrorResponseDetails[]

Lista de detalhes de erro adicionais.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.
requestId

string

ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name Tipo Description
errorCode

string

Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message

string

Uma representação legível por humanos do erro.
relatedResource

ErrorRelatedResource

Os detalhes do recurso relacionados ao erro.

KQLDatabaseDefinition

Object

Objeto de definição pública do banco de dados KQL.

Name Tipo Description
format

string

O formato da definição do item.
parts

KQLDatabaseDefinitionPart[]

Uma lista de partes de definição.

KQLDatabaseDefinitionPart

Object

Objeto de parte de definição de banco de dados KQL.

Name Tipo Description
path

string

O caminho da parte do banco de dados KQL.
payload

string

A carga útil parcial do banco de dados KQL.
payloadType

PayloadType

O tipo de carga útil.

KQLDatabaseDefinitionResponse

Object

Resposta de definição pública do banco de dados KQL.

Name Tipo Description
definition

KQLDatabaseDefinition

Objeto de definição pública do banco de dados KQL.

PayloadType

Enumeração

O tipo de carga útil da peça de definição. Ao longo do tempo, podem ser adicionados tipos de carga útil adicionais.

Valor Description
InlineBase64

Base em linha 64.