Tables - Update

Ссылка

Service:: Log Analytics

API Version:: 2022-10-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
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, используемая для данной операции.

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

Имя	Тип	Описание
properties.plan	TablePlanEnum	Укажите системе, как обрабатывать и заряжать журналы, поехаемые в эту таблицу.
properties.restoredLogs	RestoredLogs	Параметры операции восстановления, которая инициировала эту таблицу.
properties.retentionInDays	integer	Срок хранения таблицы в днях от 4 до 730. Если установить для этого свойства значение -1, по умолчанию будет храниться рабочая область.
properties.schema	Schema	Схема таблицы.
properties.searchResults	SearchResults	Параметры задания поиска, которое инициировало эту таблицу.
properties.totalRetentionInDays	integer	Общий срок хранения таблицы в днях от 4 до 4383. Если задать для этого свойства значение -1, по умолчанию будет храниться таблица.

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
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=2022-10-01

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

import com.azure.resourcemanager.loganalytics.models.Column;
import com.azure.resourcemanager.loganalytics.models.ColumnTypeEnum;
import com.azure.resourcemanager.loganalytics.models.Schema;
import java.util.Arrays;

/** Samples for Tables CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesUpsert.json
     */
    /**
     * Sample code: TablesUpsert.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void tablesUpsert(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager
            .tables()
            .define("AzureNetworkFlow")
            .withExistingWorkspace("oiautorest6685", "oiautorest6685")
            .withRetentionInDays(45)
            .withTotalRetentionInDays(70)
            .withSchema(
                new Schema()
                    .withName("AzureNetworkFlow")
                    .withColumns(Arrays.asList(new Column().withName("MyNewColumn").withType(ColumnTypeEnum.GUID))))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python tables_upsert.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = LogAnalyticsManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-00000000000",
    )

    response = client.tables.begin_create_or_update(
        resource_group_name="oiautorest6685",
        workspace_name="oiautorest6685",
        table_name="AzureNetworkFlow",
        parameters={
            "properties": {
                "retentionInDays": 45,
                "schema": {"columns": [{"name": "MyNewColumn", "type": "guid"}], "name": "AzureNetworkFlow"},
                "totalRetentionInDays": 70,
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesUpsert.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { OperationalInsightsManagementClient } = require("@azure/arm-operationalinsights");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Update a Log Analytics workspace table.
 *
 * @summary Update a Log Analytics workspace table.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesUpsert.json
 */
async function tablesUpsert() {
  const subscriptionId =
    process.env["OPERATIONALINSIGHTS_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-00000000000";
  const resourceGroupName = process.env["OPERATIONALINSIGHTS_RESOURCE_GROUP"] || "oiautorest6685";
  const workspaceName = "oiautorest6685";
  const tableName = "AzureNetworkFlow";
  const parameters = {
    schema: {
      name: "AzureNetworkFlow",
      columns: [{ name: "MyNewColumn", type: "guid" }],
    },
    retentionInDays: 45,
    totalRetentionInDays: 70,
  };
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.tables.beginUpdateAndWait(
    resourceGroupName,
    workspaceName,
    tableName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.OperationalInsights;
using Azure.ResourceManager.OperationalInsights.Models;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesUpsert.json
// this example is just showing the usage of "Tables_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this OperationalInsightsTableResource created on azure
// for more information of creating OperationalInsightsTableResource, please refer to the document of OperationalInsightsTableResource
string subscriptionId = "00000000-0000-0000-0000-00000000000";
string resourceGroupName = "oiautorest6685";
string workspaceName = "oiautorest6685";
string tableName = "AzureNetworkFlow";
ResourceIdentifier operationalInsightsTableResourceId = OperationalInsightsTableResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, tableName);
OperationalInsightsTableResource operationalInsightsTable = client.GetOperationalInsightsTableResource(operationalInsightsTableResourceId);

// invoke the operation
OperationalInsightsTableData data = new OperationalInsightsTableData()
{
    RetentionInDays = 45,
    TotalRetentionInDays = 70,
    Schema = new OperationalInsightsSchema()
    {
        Name = "AzureNetworkFlow",
        Columns =
        {
        new OperationalInsightsColumn()
        {
        Name = "MyNewColumn",
        ColumnType = OperationalInsightsColumnType.Guid,
        }
        },
    },
};
ArmOperation<OperationalInsightsTableResource> lro = await operationalInsightsTable.UpdateAsync(WaitUntil.Completed, data);
OperationalInsightsTableResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
OperationalInsightsTableData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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,
    "retentionInDaysAsDefault": false,
    "totalRetentionInDaysAsDefault": false,
    "plan": "Analytics"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourcegroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/AzureNetworkFlow",
  "name": "AzureNetworkFlow"
}

Status code:: 202

azure-asyncoperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/providers/Microsoft.OperaitonalInsights/locations/eastus/operationstatuses/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-10-01

Определения

Имя	Описание
Column	Столбец таблицы.
ColumnDataTypeHintEnum	Логическое указание типа данных столбца.
ColumnTypeEnum	Тип данных столбца.
createdByType	Тип удостоверения, создавшего ресурс.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
ProvisioningStateEnum	Текущее состояние подготовки таблицы. Если задано значение "обновление", указывает на блокировку ресурса из-за текущей операции, запрещающую любое обновление таблицы до завершения текущей операции.
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	Объект error.

ProvisioningStateEnum

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

Имя	Тип	Описание
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	Текущее состояние подготовки таблицы. Если задано значение "обновление", указывает на блокировку ресурса из-за текущей операции, запрещающую любое обновление таблицы до завершения текущей операции.
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	Данные, собранные заданием поиска.

Tables - Update

Параметры URI

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

Ответы

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

azure_auth

Scopes

Примеры

TablesUpsert

Sample Request

Sample Response

Определения

Column

ColumnDataTypeHintEnum

ColumnTypeEnum

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningStateEnum

RestoredLogs

ResultStatistics

Schema

SearchResults

SourceEnum

systemData

Table

TablePlanEnum

TableSubTypeEnum

TableTypeEnum

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