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

Tables - Get

  • Ссылка
Служба:
Log Analytics
Версия API:
2023-09-01

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

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
 path True

string

Имя группы ресурсов. Регистр букв в имени не учитывается.
subscriptionId
 path True

string

Идентификатор целевой подписки.
tableName
 path True

string

Имя таблицы.

Шаблон регулярного выражения: ^[A-Za-z0-9-_]+$
workspaceName
 path True

string

имя рабочей области;

Шаблон регулярного выражения: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True

string

Версия API, используемая для данной операции.

Ответы

Имя Тип Описание
200 OK

Table

Определение ответа OK.
Other Status Codes

ErrorResponse

Ответ об ошибке, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Области

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

Примеры

TablesGet

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Column

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

Имя Тип Описание
dataTypeHint

ColumnDataTypeHintEnum

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

string

Описание столбца.
displayName

string

Отображаемое имя столбца.
isDefaultDisplay

boolean

Отображается по умолчанию.
isHidden

boolean

Является ли столбец скрытым.
name

string

Имя столбца.
type

ColumnTypeEnum

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

ColumnDataTypeHintEnum

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

Имя Тип Описание
armPath

string

Путь к модели ресурсов Azure (ARM): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid

string

Стандартный 128-разрядный GUID, следующий за стандартной фигурой xxxxxxx-xxxx-xxxx-xxxxx.
ip

string

Стандартный IP-адрес версии 4 или 6 после стандартной фигуры x.x.x/y:y:y:y:y:y:y:y:y:y:y
uri

string

Строка, соответствующая шаблону универсального кода ресурса (URI), например scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

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

Имя Тип Описание
boolean

string

dateTime

string

dynamic

string

guid

string

int

string

long

string

real

string

string

string

createdByType

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

Имя Тип Описание
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

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

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

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

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Сообщение об ошибке

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

ProvisioningStateEnum

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

Имя Тип Описание
Deleting

string

Состояние таблицы удаляется.
InProgress

string

Схема таблицы является стабильной и без изменений, данные таблицы обновляются.
Succeeded

string

Состояние таблицы стабильное и без изменений, таблица разблокирована и открыта для новых обновлений.
Updating

string

Схема таблицы по-прежнему строится и обновляется. В настоящее время таблица заблокирована для любых изменений, пока не будет выполнена процедура.

RestoredLogs

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

Имя Тип Описание
azureAsyncOperationId

string

Идентификатор асинхронной операции таблицы результатов поиска.
endRestoreTime

string

Метка времени для завершения восстановления по (UTC).
sourceTable

string

Таблица для восстановления данных.
startRestoreTime

string

Метка времени для начала восстановления (в формате UTC).

ResultStatistics

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

Имя Тип Описание
ingestedRecords

integer

Количество строк, возвращенных заданием поиска.
progress

number

Процент завершения задания поиска.
scannedGb

number

Задание поиска: объем отсканированных данных.

Schema

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

Имя Тип Описание
categories

string[]

Категория таблицы.
columns

Column[]

Список настраиваемых столбцов таблицы.
description

string

Описание таблицы.
displayName

string

Отображаемое имя таблицы.
labels

string[]

Метки таблиц.
name

string

Имя таблицы.
solutions

string[]

Список решений, с которыми связана таблица
source

SourceEnum

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

Column[]

Список стандартных столбцов таблицы.
tableSubType

TableSubTypeEnum

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

TableTypeEnum

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

SearchResults

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

Имя Тип Описание
azureAsyncOperationId

string

Идентификатор асинхронной операции таблицы результатов поиска.
description

string

Поиск описания задания.
endSearchTime

string

Метка времени для завершения поиска по (UTC)
limit

integer

Ограничьте задание поиска, чтобы возвращать до указанного количества строк.
query

string

Запрос задания поиска.
sourceTable

string

Таблица, используемая в задании поиска.
startSearchTime

string

Метка времени для начала поиска (UTC)

SourceEnum

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

Имя Тип Описание
customer

string

Таблицы, созданные владельцем рабочей области и доступные только в этой рабочей области.
microsoft

string

Таблицы, подготовленные системой, собранные с помощью параметров диагностики, агентов или любых других стандартных средств сбора данных.

systemData

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

Имя Тип Описание
createdAt

string

Метка времени создания ресурса (UTC).
createdBy

string

Удостоверение, создающее ресурс.
createdByType

createdByType

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

string

Метка времени последнего изменения ресурса (UTC)
lastModifiedBy

string

Удостоверение, которое в последний раз изменял ресурс.
lastModifiedByType

createdByType

Тип удостоверения, изменяющего ресурс в последний раз.

Table

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

Имя Тип Описание
id

string

Полный идентификатор ресурса. Пример : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса.
properties.archiveRetentionInDays

integer

Хранение архива табличных данных в днях. Вычисляется как (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate

string

Метка времени последнего изменения плана таблицы (UTC).
properties.plan

TablePlanEnum

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

ProvisioningStateEnum

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

RestoredLogs

Параметры операции восстановления, которая инициировала эту таблицу.
properties.resultStatistics

ResultStatistics

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

integer

Срок хранения таблицы в днях от 4 до 730. Если установить для этого свойства значение -1, по умолчанию будет храниться рабочая область.
properties.retentionInDaysAsDefault

boolean

True — значение происходит от хранения рабочей области в днях, False — для конкретного клиента.
properties.schema

Schema

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

SearchResults

Параметры задания поиска, которое инициировало эту таблицу.
properties.totalRetentionInDays

integer

Общий срок хранения таблицы в днях от 4 до 4383. Если задать для этого свойства значение -1, по умолчанию будет храниться таблица.
properties.totalRetentionInDaysAsDefault

boolean

True — значение происходит от хранения в днях, False — для конкретного клиента.
systemData

systemData

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

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

TablePlanEnum

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

Имя Тип Описание
Analytics

string

Журналы, которые позволяют выполнять мониторинг и аналитику.
Basic

string

Журналы, которые корректируются для поддержки больших объемов с низким значением подробных журналов.

TableSubTypeEnum

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

Имя Тип Описание
Any

string

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

string

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

string

Таблица, доступная для отправки данных с помощью любого из средств, поддерживаемых правилами сбора данных: API конечной точки сбора данных, преобразования времени приема или любой другой механизм, предоставляемый правилами сбора данных.

TableTypeEnum

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

Имя Тип Описание
CustomLog

string

Настраиваемая таблица журналов.
Microsoft

string

Стандартные данные, собираемые Azure Monitor.
RestoredLogs

string

Восстановленные данные.
SearchResults

string

Данные, собираемые заданием поиска.