Partilhar via

Tables - Get

  • Referência
Serviço:
Log Analytics
Versão da API:
2023-09-01

Obtém uma tabela de área de trabalho do Log Analytics.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}?api-version=2023-09-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId
 path True

string

O ID da subscrição de destino.
tableName
 path True

string

O nome da tabela.

Padrão Regex: ^[A-Za-z0-9-_]+$
workspaceName
 path True

string

O nome da área de trabalho.

Padrão Regex: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

A versão da API a utilizar para esta operação.

Respostas

Name Tipo Description
200 OK

Table

Definição de resposta OK.
Other Status Codes

ErrorResponse

Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

TablesGet

Pedido de amostra

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/table1_SRCH?api-version=2023-09-01

Resposta da amostra

Código de estado:
200 
{
  "systemData": {
    "createdBy": "00000000-0000-0000-0000-00000000000",
    "createdAt": "2020-02-03T04:05:06Z"
  },
  "properties": {
    "resultStatistics": {
      "progress": 75,
      "ingestedRecords": 5,
      "scannedGb": 23.5
    },
    "searchResults": {
      "query": "Heartbeat | where SourceSystem != '' | project SourceSystem",
      "description": "This table was created using a Search Job with the following query: 'Heartbeat | where SourceSystem != '' | project SourceSystem'.",
      "limit": 1000,
      "startSearchTime": "2020-02-03T04:05:06Z",
      "endSearchTime": "2020-02-02T04:05:06Z",
      "sourceTable": "Heartbeat"
    },
    "schema": {
      "name": "table1_SRCH",
      "tableSubType": "DataCollectionRuleBased",
      "tableType": "SearchResults",
      "displayName": null,
      "description": null,
      "columns": [],
      "standardColumns": [
        {
          "isHidden": false,
          "name": "TenantId",
          "type": "guid",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourceSystem",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "MG",
          "type": "guid",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "ManagementGroupName",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "TimeGenerated",
          "type": "dateTime",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Computer",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "RawData",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        }
      ],
      "categories": null,
      "labels": null,
      "source": null,
      "solutions": [
        "LogManagement"
      ]
    },
    "provisioningState": "InProgress",
    "retentionInDays": 50,
    "totalRetentionInDays": 50,
    "archiveRetentionInDays": 0,
    "retentionInDaysAsDefault": false,
    "totalRetentionInDaysAsDefault": true,
    "plan": "Analytics"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/table1_SRCH",
  "name": "table1_SRCH"
}

Definições

Name Description
Column

Coluna da tabela.
ColumnDataTypeHintEnum

Sugestão lógica do tipo de dados de coluna.
ColumnTypeEnum

Tipo de dados de coluna.
createdByType

O tipo de identidade que criou o recurso.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta a erros
ProvisioningStateEnum

O estado de aprovisionamento atual da tabela. Se estiver definido como "a atualizar", indica um bloqueio de recurso devido a uma operação em curso, proibindo qualquer atualização à tabela até que a operação em curso esteja concluída.
RestoredLogs

Restaurar parâmetros.
ResultStatistics

Estatísticas de execução de tarefas de pesquisa.
Schema

Esquema da tabela.
SearchResults

Parâmetros da tarefa de pesquisa que iniciou esta tabela.
SourceEnum

Criador da tabela.
systemData

Metadados relativos à criação e última modificação do recurso.
Table

Definição da tabela de dados da área de trabalho.
TablePlanEnum

Indique ao sistema como processar e carregar os registos ingeridos nesta tabela.
TableSubTypeEnum

O subtipo descreve que APIs podem ser utilizadas para interagir com a tabela e que funcionalidades estão disponíveis para a mesma.
TableTypeEnum

Criador da tabela.

Column

Coluna da tabela.

Name Tipo Description
dataTypeHint

ColumnDataTypeHintEnum

Sugestão lógica do tipo de dados de coluna.
description

string

Descrição da coluna.
displayName

string

Nome a apresentar da coluna.
isDefaultDisplay

boolean

É apresentado por predefinição.
isHidden

boolean

A coluna está oculta.
name

string

Nome da coluna.
type

ColumnTypeEnum

Tipo de dados de coluna.

ColumnDataTypeHintEnum

Sugestão lógica do tipo de dados de coluna.

Name Tipo Description
armPath

string

Um caminho do Modelo de Recurso do Azure (ARM): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid

string

Um GUID padrão de 128 bits seguindo a forma padrão, xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
ip

string

Um endereço IP V4/V6 padrão seguindo a forma padrão, x.x.x.x/y:y:y:y:y:y:y:y:y
uri

string

Uma cadeia que corresponde ao padrão de um URI, por exemplo, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Tipo de dados de coluna.

Name Tipo Description
boolean

string

dateTime

string

dynamic

string

guid

string

int

string

long

string

real

string

string

string

createdByType

O tipo de identidade que criou o recurso.

Name Tipo Description
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informações adicionais.

ErrorDetail

O detalhe do erro.

Name 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 a erros

Name Tipo Description
error

ErrorDetail

O objeto de erro.

ProvisioningStateEnum

O estado de aprovisionamento atual da tabela. Se estiver definido como "a atualizar", indica um bloqueio de recurso devido a uma operação em curso, proibindo qualquer atualização à tabela até que a operação em curso esteja concluída.

Name Tipo Description
Deleting

string

O estado da tabela está a ser eliminado.
InProgress

string

O esquema da tabela é estável e, sem alterações, os dados da tabela estão a ser atualizados.
Succeeded

string

O estado da tabela é estável e, sem alterações, a tabela é desbloqueada e aberta para novas atualizações.
Updating

string

O esquema de tabela ainda está a ser criado e atualizado. A tabela está atualmente bloqueada para quaisquer alterações até que o procedimento esteja concluído.

RestoredLogs

Restaurar parâmetros.

Name Tipo Description
azureAsyncOperationId

string

ID da operação assíncrona da tabela de resultados da pesquisa.
endRestoreTime

string

O carimbo de data/hora para terminar o restauro por (UTC).
sourceTable

string

A tabela a partir da qual restaurar dados.
startRestoreTime

string

O carimbo de data/hora para iniciar o restauro a partir de (UTC).

ResultStatistics

Estatísticas de execução de tarefas de pesquisa.

Name Tipo Description
ingestedRecords

integer

O número de linhas devolvidas pela tarefa de pesquisa.
progress

number

Percentagem de conclusão da tarefa de pesquisa.
scannedGb

number

Tarefa de pesquisa: quantidade de dados analisados.

Schema

Esquema da tabela.

Name Tipo Description
categories

string[]

Categoria da tabela.
columns

Column[]

Uma lista de colunas personalizadas de tabela.
description

string

Descrição da tabela.
displayName

string

Nome a apresentar da tabela.
labels

string[]

Etiquetas de tabela.
name

string

Nome da tabela.
solutions

string[]

Lista de soluções a que a tabela está afiliada
source

SourceEnum

Criador da tabela.
standardColumns

Column[]

Uma lista de colunas padrão de tabela.
tableSubType

TableSubTypeEnum

O subtipo descreve que APIs podem ser utilizadas para interagir com a tabela e que funcionalidades estão disponíveis para a mesma.
tableType

TableTypeEnum

Criador da tabela.

SearchResults

Parâmetros da tarefa de pesquisa que iniciou esta tabela.

Name Tipo Description
azureAsyncOperationId

string

ID da operação assíncrona da tabela de resultados da pesquisa.
description

string

Descrição da tarefa de pesquisa.
endSearchTime

string

O carimbo de data/hora para terminar a pesquisa por (UTC)
limit

integer

Limite a tarefa de pesquisa para devolver até ao número especificado de linhas.
query

string

Consulta da tarefa de pesquisa.
sourceTable

string

A tabela utilizada na tarefa de pesquisa.
startSearchTime

string

O carimbo de data/hora para iniciar a pesquisa a partir de (UTC)

SourceEnum

Criador da tabela.

Name Tipo Description
customer

string

Tabelas criadas pelo proprietário da Área de Trabalho e só encontradas nesta Área de Trabalho.
microsoft

string

Tabelas aprovisionadas pelo sistema, conforme recolhido através das Definições de Diagnóstico, dos Agentes ou de qualquer outro meio de recolha de dados padrão.

systemData

Metadados relativos à criação e última modificação do recurso.

Name Tipo Description
createdAt

string

O carimbo de data/hora da criação de recursos (UTC).
createdBy

string

A identidade que criou o recurso.
createdByType

createdByType

O tipo de identidade que criou o recurso.
lastModifiedAt

string

O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy

string

A identidade que modificou o recurso pela última vez.
lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

Table

Definição da tabela de dados da área de trabalho.

Name Tipo Description
id

string

ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.archiveRetentionInDays

integer

A retenção do arquivo de dados da tabela em dias. Calculado como (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate

string

O carimbo de data/hora em que o plano de tabela foi modificado pela última vez (UTC).
properties.plan

TablePlanEnum

Indique ao sistema como processar e carregar os registos ingeridos nesta tabela.
properties.provisioningState

ProvisioningStateEnum

O estado de aprovisionamento atual da tabela. Se estiver definido como "a atualizar", indica um bloqueio de recurso devido a uma operação em curso, proibindo qualquer atualização à tabela até que a operação em curso esteja concluída.
properties.restoredLogs

RestoredLogs

Parâmetros da operação de restauro que iniciou esta tabela.
properties.resultStatistics

ResultStatistics

Estatísticas de execução de tarefas de pesquisa.
properties.retentionInDays

integer

A retenção da tabela em dias, entre 4 e 730. Definir esta propriedade como -1 irá predefinir a retenção da área de trabalho.
properties.retentionInDaysAsDefault

boolean

True – o valor tem origem na retenção da área de trabalho em dias, Falso – Específico do cliente.
properties.schema

Schema

Esquema de tabela.
properties.searchResults

SearchResults

Parâmetros da tarefa de pesquisa que iniciou esta tabela.
properties.totalRetentionInDays

integer

A retenção total da tabela em dias, entre 4 e 4383. Definir esta propriedade como -1 irá predefinir a retenção da tabela.
properties.totalRetentionInDaysAsDefault

boolean

True – o valor tem origem na retenção em dias, Falso – Específico do cliente.
systemData

systemData

Metadados relativos à criação e última modificação do recurso.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

TablePlanEnum

Indique ao sistema como processar e carregar os registos ingeridos nesta tabela.

Name Tipo Description
Analytics

string

Registos que permitem monitorização e análise.
Basic

string

Registos que são ajustados para suportar registos verbosos de valor baixo de volume elevado.

TableSubTypeEnum

O subtipo descreve que APIs podem ser utilizadas para interagir com a tabela e que funcionalidades estão disponíveis para a mesma.

Name Tipo Description
Any

string

O subtipo predefinido com o qual as tabelas incorporadas são criadas.
Classic

string

Indica uma tabela criada através da API do Recoletor de Dados ou com a funcionalidade de registos personalizados do agente MMA ou qualquer tabela na qual foram criados Campos Personalizados.
DataCollectionRuleBased

string

Uma tabela elegível para enviar dados para a mesma através de qualquer um dos meios suportados pelas Regras de Recolha de Dados: a API de Ponto Final de Recolha de Dados, transformações de tempo de ingestão ou qualquer outro mecanismo fornecido pelas Regras de Recolha de Dados

TableTypeEnum

Criador da tabela.

Name Tipo Description
CustomLog

string

Tabela de registo personalizada.
Microsoft

string

Dados padrão recolhidos pelo Azure Monitor.
RestoredLogs

string

Dados restaurados.
SearchResults

string

Dados recolhidos por uma tarefa de pesquisa.