Tables - Get

Ссылка

Служба:: Log Analytics

Версия API:: 2025-02-01

Возвращает таблицу рабочей области Log Analytics.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
tableName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9-_]+$	Имя таблицы.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Имя рабочей области.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	Table	ОК определение ответа.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

TablesGet

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
}

Определения

Имя	Описание
Column	Столбец таблицы.
ColumnDataTypeHintEnum	Логическое указание типа данных столбца.
ColumnTypeEnum	Тип данных столбца.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
ProvisioningStateEnum	Текущее состояние подготовки таблицы. Если задано значение "обновление", указывает блокировку ресурса из-за текущей операции, запретив любое обновление таблицы до завершения текущей операции.
RestoredLogs	Параметры восстановления.
ResultStatistics	Статистика выполнения задания поиска.
Schema	Схема таблицы.
SearchResults	Параметры задания поиска, инициирующего эту таблицу.
SourceEnum	Создатель таблицы.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Table	Определение таблицы данных рабочей области.
TablePlanEnum	Укажите системе, как обрабатывать и взимать плату за журналы, входящие в эту таблицу.
TableSubTypeEnum	Подтип описывает, какие API можно использовать для взаимодействия с таблицей и какие функции доступны для него.
TableTypeEnum	Создатель таблицы.

Column

Object

Столбец таблицы.

Имя	Тип	Описание
dataTypeHint	ColumnDataTypeHintEnum	Логическое указание типа данных столбца.
description	string	Описание столбца.
displayName	string	Отображаемое имя столбца.
isDefaultDisplay	boolean	Отображается по умолчанию.
isHidden	boolean	Скрыт ли столбец.
name	string	Имя столбца.
type	ColumnTypeEnum	Тип данных столбца.

ColumnDataTypeHintEnum

Перечисление

Логическое указание типа данных столбца.

Значение	Описание
armPath	Путь к модели ресурсов Azure (ARM): /subscriptions/{...}/resourceGroups/{...}/providers/Microsoft. {...}/{...}/{...}/{...}...
guid	Стандартный 128-разрядный GUID после стандартной фигуры xxxx-xxxx-xxxx-
ip	Стандартный IP-адрес версии 4/V6 после стандартной фигуры x.x.x/y:y:y:y:y:y
uri	Строка, соответствующая шаблону универсального кода ресурса (URI), например scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Перечисление

Тип данных столбца.

Значение	Описание
boolean
dateTime
dynamic
guid
int
long
real
string

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

ProvisioningStateEnum

Перечисление

Текущее состояние подготовки таблицы. Если задано значение "обновление", указывает блокировку ресурса из-за текущей операции, запретив любое обновление таблицы до завершения текущей операции.

Значение	Описание
Deleting	Состояние таблицы удаляется.
InProgress	Схема таблицы стабильна и без изменений обновляется табличные данные.
Succeeded	Состояние таблицы стабильно и без изменений разблокируется и открывается для новых обновлений.
Updating	Схема таблиц по-прежнему строится и обновляется, таблица в настоящее время блокируется для любых изменений до завершения процедуры.

RestoredLogs

Object

Параметры восстановления.

Имя	Тип	Описание
azureAsyncOperationId	string	Идентификатор асинхронной операции таблицы результатов поиска.
endRestoreTime	string (date-time)	Метка времени для завершения восстановления (UTC).
sourceTable	string	Таблица для восстановления данных из.
startRestoreTime	string (date-time)	Метка времени для запуска восстановления из (UTC).

ResultStatistics

Object

Статистика выполнения задания поиска.

Имя	Тип	Описание
ingestedRecords	integer (int32)	Количество строк, возвращаемых заданием поиска.
progress	number multipleOf: 0.01	Процент завершения задания поиска.
scannedGb	number multipleOf: 0.01	Задание поиска: объем сканированных данных.

Schema

Object

Схема таблицы.

Имя	Тип	Описание
categories	string[]	Категория таблицы.
columns	Column[]	Список настраиваемых столбцов таблицы.
description	string	Описание таблицы.
displayName	string	Отображаемое имя таблицы.
labels	string[]	Метки таблиц.
name	string	Имя таблицы.
solutions	string[]	Список решений, с которым связана таблица
source	SourceEnum	Создатель таблицы.
standardColumns	Column[]	Список стандартных столбцов таблицы.
tableSubType	TableSubTypeEnum	Подтип описывает, какие API можно использовать для взаимодействия с таблицей и какие функции доступны для него.
tableType	TableTypeEnum	Создатель таблицы.

SearchResults

Object

Параметры задания поиска, инициирующего эту таблицу.

Имя	Тип	Описание
azureAsyncOperationId	string	Идентификатор асинхронной операции таблицы результатов поиска.
description	string	Описание задания поиска.
endSearchTime	string (date-time)	Метка времени для завершения поиска по (UTC)
limit	integer (int32)	Ограничьте задание поиска, чтобы вернуться до указанного количества строк.
query	string	Запрос задания поиска.
sourceTable	string	Таблица, используемая в задании поиска.
startSearchTime	string (date-time)	Метка времени для запуска поиска из (UTC)

SourceEnum

Перечисление

Создатель таблицы.

Значение	Описание
customer	Таблицы, созданные владельцем рабочей области, и найдены только в этой рабочей области.
microsoft	Таблицы, подготовленные системой, собранные с помощью параметров диагностики, агентов или других стандартных средств сбора данных.

systemData

Object

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Table

Object

Определение таблицы данных рабочей области.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.archiveRetentionInDays	integer (int32)	Хранение архива данных таблицы в днях. Вычисляется как (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	Метка времени последнего изменения плана таблицы (UTC).
properties.plan	TablePlanEnum	Укажите системе, как обрабатывать и взимать плату за журналы, входящие в эту таблицу.
properties.provisioningState	ProvisioningStateEnum	Текущее состояние подготовки таблицы. Если задано значение "обновление", указывает блокировку ресурса из-за текущей операции, запретив любое обновление таблицы до завершения текущей операции.
properties.restoredLogs	RestoredLogs	Параметры операции восстановления, инициируемой этой таблицей.
properties.resultStatistics	ResultStatistics	Статистика выполнения задания поиска.
properties.retentionInDays	integer (int32) minimum: 4 maximum: 730	Срок хранения таблицы в днях от 4 до 730. Если для этого свойства задано значение -1 по умолчанию будет сохраняться рабочая область.
properties.retentionInDaysAsDefault	boolean	True— значение происходит из хранения рабочей области в днях, false — конкретное клиент.
properties.schema	Schema	Схема таблицы.
properties.searchResults	SearchResults	Параметры задания поиска, инициирующего эту таблицу.
properties.totalRetentionInDays	integer (int32) minimum: 4 maximum: 4383	Общее хранение таблицы в днях от 4 до 4383. Если для этого свойства задано значение -1 по умолчанию будет сохраняться таблица.
properties.totalRetentionInDaysAsDefault	boolean	True — значение исходит от хранения в днях, false — конкретный клиент.
systemData	systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

TablePlanEnum

Перечисление

Укажите системе, как обрабатывать и взимать плату за журналы, входящие в эту таблицу.

Значение	Описание
Analytics	Журналы, разрешающие мониторинг и аналитику.
Basic	Журналы, которые корректируются для поддержки больших объемов журналов с низким уровнем детализации значений.

TableSubTypeEnum

Перечисление

Подтип описывает, какие API можно использовать для взаимодействия с таблицей и какие функции доступны для него.

Значение	Описание
Any	Подтип по умолчанию, с помощью которого создаются встроенные таблицы.
Classic	Указывает таблицу, созданную с помощью API сборщика данных или с помощью функции пользовательских журналов агента MMA или любой таблицы, для которой были созданы настраиваемые поля.
DataCollectionRuleBased	Таблица, доступная для отправки данных с помощью любого из средств, поддерживаемых правилами сбора данных: API конечной точки сбора данных, преобразования времени приема или любого другого механизма, предоставленного правилами сбора данных

TableTypeEnum

Перечисление

Создатель таблицы.

Значение	Описание
CustomLog	Настраиваемая таблица журналов.
Microsoft	Стандартные данные, собранные Azure Monitor.
RestoredLogs	Восстановленные данные.
SearchResults	Данные, собранные заданием поиска.

Поделиться через

Tables - Get

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

TablesGet

Образец запроса

Пример ответа

Определения

Column

ColumnDataTypeHintEnum

ColumnTypeEnum

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningStateEnum

RestoredLogs

ResultStatistics

Schema

SearchResults

SourceEnum

systemData

Table

TablePlanEnum

TableSubTypeEnum

TableTypeEnum

Дополнительные ресурсы