Compartilhar via


Tables - Get

Obtém uma tabela de workspace 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 de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

A ID da assinatura de destino.

tableName
path True

string

O nome da tabela.

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

workspaceName
path True

string

O nome do workspace.

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 ser usada para esta operação.

Respostas

Nome Tipo Description
200 OK

Table

Definição de resposta OK.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

TablesGet

Solicitação de exemplo

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 de exemplo

{
  "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

Nome Description
Column

Coluna de tabela.

ColumnDataTypeHintEnum

Dica lógica do tipo de dados de coluna.

ColumnTypeEnum

Tipo de dados da coluna.

createdByType

O tipo de identidade que criou o recurso.

ErrorAdditionalInfo

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

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

ProvisioningStateEnum

O estado de provisionamento atual da tabela. Se definido como "atualização", indica um bloqueio de recurso devido à operação em andamento, proibindo qualquer atualização na tabela até que a operação em andamento seja concluída.

RestoredLogs

Restaurar parâmetros.

ResultStatistics

Pesquisar estatísticas de execução do trabalho.

Schema

Esquema da tabela.

SearchResults

Parâmetros do trabalho 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 do workspace.

TablePlanEnum

Instrua o sistema como manipular e carregar os logs ingeridos nesta tabela.

TableSubTypeEnum

O subtipo descreve quais APIs podem ser usadas para interagir com a tabela e quais recursos estão disponíveis nela.

TableTypeEnum

Criador da tabela.

Column

Coluna de tabela.

Nome Tipo Description
dataTypeHint

ColumnDataTypeHintEnum

Dica lógica do tipo de dados de coluna.

description

string

Descrição da coluna.

displayName

string

Nome de exibição da coluna.

isDefaultDisplay

boolean

É exibido por padrão.

isHidden

boolean

A coluna está oculta.

name

string

Nome da coluna.

type

ColumnTypeEnum

Tipo de dados da coluna.

ColumnDataTypeHintEnum

Dica lógica do tipo de dados de coluna.

Nome Tipo Description
armPath

string

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

guid

string

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

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

uri

string

Uma cadeia de caracteres 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 da coluna.

Nome 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.

Nome Tipo Description
Application

string

Key

string

ManagedIdentity

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.

ProvisioningStateEnum

O estado de provisionamento atual da tabela. Se definido como "atualização", indica um bloqueio de recurso devido à operação em andamento, proibindo qualquer atualização na tabela até que a operação em andamento seja concluída.

Nome Tipo Description
Deleting

string

O estado da tabela está excluindo.

InProgress

string

O esquema de tabela é estável e, sem alterações, os dados da tabela estão sendo 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á sendo criado e atualizado, a tabela está bloqueada no momento para quaisquer alterações até que o procedimento seja feito.

RestoredLogs

Restaurar parâmetros.

Nome Tipo Description
azureAsyncOperationId

string

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

endRestoreTime

string

O carimbo de data/hora para encerrar a restauração por (UTC).

sourceTable

string

A tabela da qual restaurar dados.

startRestoreTime

string

O carimbo de data/hora do qual iniciar a restauração (UTC).

ResultStatistics

Pesquisar estatísticas de execução do trabalho.

Nome Tipo Description
ingestedRecords

integer

O número de linhas que foram retornadas pelo trabalho de pesquisa.

progress

number

Percentual de conclusão do trabalho de pesquisa.

scannedGb

number

Trabalho de pesquisa: quantidade de dados verificados.

Schema

Esquema da tabela.

Nome Tipo Description
categories

string[]

Categoria de tabela.

columns

Column[]

Uma lista de colunas personalizadas de tabela.

description

string

Descrição da tabela.

displayName

string

Nome de exibição da tabela.

labels

string[]

Rótulos de tabela.

name

string

Nome da tabela.

solutions

string[]

Lista de soluções à qual a tabela é afiliada

source

SourceEnum

Criador da tabela.

standardColumns

Column[]

Uma lista de colunas padrão da tabela.

tableSubType

TableSubTypeEnum

O subtipo descreve quais APIs podem ser usadas para interagir com a tabela e quais recursos estão disponíveis nela.

tableType

TableTypeEnum

Criador da tabela.

SearchResults

Parâmetros do trabalho de pesquisa que iniciou esta tabela.

Nome Tipo Description
azureAsyncOperationId

string

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

description

string

Descrição do trabalho de pesquisa.

endSearchTime

string

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

limit

integer

Limite o trabalho de pesquisa para retornar até o número especificado de linhas.

query

string

Consulta de trabalho de pesquisa.

sourceTable

string

A tabela usada no trabalho de pesquisa.

startSearchTime

string

O carimbo de data/hora do qual iniciar a pesquisa (UTC)

SourceEnum

Criador da tabela.

Nome Tipo Description
customer

string

Tabelas criadas pelo proprietário do Workspace e encontradas somente neste Workspace.

microsoft

string

Tabelas provisionadas pelo sistema, conforme coletado por meio das Configurações de Diagnóstico, dos Agentes ou de qualquer outro meio de coleta de dados padrão.

systemData

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

Nome 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 do workspace.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.archiveRetentionInDays

integer

A retenção de arquivos 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

Instrua o sistema como manipular e carregar os logs ingeridos nesta tabela.

properties.provisioningState

ProvisioningStateEnum

O estado de provisionamento atual da tabela. Se definido como "atualização", indica um bloqueio de recurso devido à operação em andamento, proibindo qualquer atualização na tabela até que a operação em andamento seja concluída.

properties.restoredLogs

RestoredLogs

Parâmetros da operação de restauração que iniciou esta tabela.

properties.resultStatistics

ResultStatistics

Pesquisar estatísticas de execução do trabalho.

properties.retentionInDays

integer

A retenção da tabela em dias, entre 4 e 730. Definir essa propriedade como -1 usará como padrão a retenção do workspace.

properties.retentionInDaysAsDefault

boolean

True – O valor se origina da retenção do workspace em dias, False – específico do cliente.

properties.schema

Schema

Esquema da tabela.

properties.searchResults

SearchResults

Parâmetros do trabalho de pesquisa que iniciou esta tabela.

properties.totalRetentionInDays

integer

A retenção total da tabela em dias, entre 4 e 4383. Definir essa propriedade como -1 usará como padrão a retenção de tabela.

properties.totalRetentionInDaysAsDefault

boolean

True – o valor se origina da retenção em dias, False – específico do cliente.

systemData

systemData

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

type

string

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

TablePlanEnum

Instrua o sistema como manipular e carregar os logs ingeridos nesta tabela.

Nome Tipo Description
Analytics

string

Logs que permitem monitoramento e análise.

Basic

string

Logs ajustados para dar suporte a logs detalhados de baixo valor de alto volume.

TableSubTypeEnum

O subtipo descreve quais APIs podem ser usadas para interagir com a tabela e quais recursos estão disponíveis nela.

Nome Tipo Description
Any

string

O subtipo padrão com o qual as tabelas internas são criadas.

Classic

string

Indica uma tabela criada por meio da API do Coletor de Dados ou com o recurso de logs personalizados do agente MMA ou qualquer tabela na qual campos personalizados foram criados.

DataCollectionRuleBased

string

Uma tabela qualificada para ter dados enviados para ele por meio de qualquer um dos meios compatíveis com regras de coleta de dados: a API de ponto de extremidade de coleta de dados, transformações de tempo de ingestão ou qualquer outro mecanismo fornecido pelas Regras de Coleta de Dados

TableTypeEnum

Criador da tabela.

Nome Tipo Description
CustomLog

string

Tabela de log personalizada.

Microsoft

string

Dados padrão coletados pelo Azure Monitor.

RestoredLogs

string

Dados restaurados.

SearchResults

string

Dados coletados por um trabalho de pesquisa.