Tables - Create Or Update

  • Ссылка
Service:
Log Analytics
API Version:
2021-12-01-preview

Обновление или создание таблицы рабочей области Log Analytics.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/tables/{tableName}?api-version=2021-12-01-preview

Параметры URI

Name In Required Type Description
resourceGroupName
 path True
  • string

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

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

Имя таблицы.
workspaceName
 path True
  • string

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

Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version
 query True
  • string

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

Текст запроса

Name Type Description
properties.plan

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

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

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

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

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

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

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

Ответы

Name Type Description
200 OK

Определение ответа OK.
202 Accepted

Принятое определение ответа (длительная операция).
Other Status Codes

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

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

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

TablesUpsert

Sample Request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/AzureNetworkFlow?api-version=2021-12-01-preview

{
  "properties": {
    "schema": {
      "name": "AzureNetworkFlow",
      "columns": [
        {
          "name": "MyNewColumn",
          "type": "guid"
        }
      ]
    },
    "retentionInDays": 45,
    "totalRetentionInDays": 70
  }
}

Sample Response

Status code:
200 
{
  "properties": {
    "schema": {
      "name": "AzureNetworkFlow",
      "tableSubType": "DataCollectionRuleBased",
      "tableType": "Microsoft",
      "columns": [
        {
          "isHidden": false,
          "name": "MyNewColumn",
          "type": "guid",
          "isDefaultDisplay": false
        }
      ],
      "standardColumns": [
        {
          "isHidden": true,
          "name": "TenantId",
          "type": "guid",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourceSystem",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "TimeGenerated",
          "type": "dateTime",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "AgentID",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourceIP",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Protocol",
          "type": "string",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourcePort",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "DestinationPort",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "TcpFlags",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Packets",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Bytes",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "BytesOut",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "DurationInMs",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "RstCount",
          "type": "int",
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "MaxSampleRtt",
          "type": "int",
          "isDefaultDisplay": false
        }
      ],
      "solutions": [
        "LogManagement"
      ]
    },
    "provisioningState": "Succeeded",
    "retentionInDays": 45,
    "totalRetentionInDays": 70,
    "archiveRetentionInDays": 25,
    "plan": "Analytics"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/AzureNetworkFlow",
  "name": "AzureNetworkFlow"
}
Status code:
202

Определения

Column

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Column

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

Name Type Description
dataTypeHint

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

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

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

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

Столбец скрыт.
name
  • string

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

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

ColumnDataTypeHintEnum

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

Name Type Description
armPath
  • string

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

Стандартный 128-разрядный GUID после стандартной фигуры xxxx-xxxx-xxxx-xxxx-xxxx
ip
  • string

Стандартный IP-адрес версии 4/V6 после стандартной фигуры x.x.x.x/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

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

Name Type Description
boolean
  • string
dateTime
  • string
dynamic
  • string
guid
  • string
int
  • string
long
  • string
real
  • string
string
  • string

createdByType

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

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

ErrorAdditionalInfo

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

Name Type Description
info
  • object

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

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

ErrorDetail

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

Name Type Description
additionalInfo

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

Код ошибки.
details

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

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

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

ErrorResponse

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

Name Type Description
error

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

ProvisioningStateEnum

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

Name Type Description
InProgress
  • string

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

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

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

RestoredLogs

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

Name Type Description
endRestoreTime
  • string

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

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

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

ResultStatistics

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

Name Type Description
ingestedRecords
  • integer

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

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

Schema

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

Name Type Description
categories
  • string[]

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

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

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

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

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

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

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

Параметры задания поиска, инициированного этой таблицей.
solutions
  • string[]

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

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

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

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

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

SearchResults

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

Name Type Description
description
  • string

Описание задания поиска.
endSearchTime
  • string

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

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

Поисковый запрос задания.
sourceTable
  • string

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

Метка времени для запуска поиска в формате UTC

SourceEnum

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

Name Type Description
customer
  • string

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

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

systemData

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

Name Type Description
createdAt
  • string

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

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

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

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

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

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

Table

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

Name Type Description
id
  • string

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

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

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

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

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

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

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

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

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

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

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

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

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

Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft. служба хранилища/storageAccounts"

TablePlanEnum

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

Name Type Description
Analytics
  • string

Журналы, обеспечивающие мониторинг и аналитику.
Basic
  • string

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

TableSubTypeEnum

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

Name Type Description
Any
  • string

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

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

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

TableTypeEnum

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

Name Type Description
CustomLog
  • string

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

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

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

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