Tables - Create Or Update

참조

Service:: Log Analytics

API Version:: 2022-10-01

Log Analytics 작업 영역 테이블을 업데이트하거나 만듭니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
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	형식	Description
properties.plan	TablePlanEnum	이 테이블에 수집된 로그를 처리하고 충전하는 방법을 시스템에 지시합니다.
properties.restoredLogs	RestoredLogs	이 테이블을 시작한 복원 작업의 매개 변수입니다.
properties.retentionInDays	integer	4에서 730 사이의 테이블 보존 기간(일)입니다. 이 속성을 -1로 설정하면 기본적으로 작업 영역 보존이 적용됩니다.
properties.schema	Schema	테이블 스키마입니다.
properties.searchResults	SearchResults	이 테이블을 시작한 검색 작업의 매개 변수입니다.
properties.totalRetentionInDays	integer	4일에서 4383 사이의 총 보존 기간(일)입니다. 이 속성을 -1로 설정하면 기본적으로 테이블 보존이 적용됩니다.

응답

Name	형식	Description
200 OK	Table	OK 응답 정의입니다.
202 Accepted		허용되는 응답 정의(장기 실행 작업).
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

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

PUT 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

정의

Name	Description
Column	테이블 열입니다.
ColumnDataTypeHintEnum	열 데이터 형식 논리 힌트입니다.
ColumnTypeEnum	열의 데이터 형식입니다.
createdByType	리소스를 만든 ID 유형입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
ProvisioningStateEnum	테이블의 현재 프로비저닝 상태입니다. '업데이트'로 설정된 경우 는 진행 중인 작업으로 인해 리소스 잠금을 나타내며 진행 중인 작업이 끝날 때까지 테이블에 대한 업데이트를 금지합니다.
RestoredLogs	복원 매개 변수입니다.
ResultStatistics	작업 실행 통계를 검색합니다.
Schema	테이블의 스키마입니다.
SearchResults	이 테이블을 시작한 검색 작업의 매개 변수입니다.
SourceEnum	테이블의 작성자입니다.
systemData	리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.
Table	작업 영역 데이터 테이블 정의입니다.
TablePlanEnum	이 테이블에 수집된 로그를 처리하고 충전하는 방법을 시스템에 지시합니다.
TableSubTypeEnum	하위 형식은 테이블과 상호 작용하는 데 사용할 수 있는 API와 테이블에 대해 사용할 수 있는 기능을 설명합니다.
TableTypeEnum	테이블의 작성자입니다.

Column

테이블 열입니다.

Name	형식	Description
dataTypeHint	ColumnDataTypeHintEnum	열 데이터 형식 논리 힌트입니다.
description	string	열 설명입니다.
displayName	string	열 표시 이름입니다.
isDefaultDisplay	boolean	기본적으로 표시됩니다.
isHidden	boolean	열이 숨겨져 있습니다.
name	string	열 이름입니다.
type	ColumnTypeEnum	열의 데이터 형식입니다.

ColumnDataTypeHintEnum

열 데이터 형식 논리 힌트입니다.

Name	형식	Description
armPath	string	ARM(Azure 리소스 모델) 경로: /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	표준 셰이프인 xxxxxxxx-xxxx-xxxx-xxxx-xx를 따르는 표준 128비트 GUID
ip	string	표준 셰이프 x.x.x.x/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	형식	Description
boolean	string
dateTime	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string

createdByType

리소스를 만든 ID 유형입니다.

Name	형식	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	Error 개체.

ProvisioningStateEnum

테이블의 현재 프로비저닝 상태입니다. '업데이트'로 설정된 경우 는 진행 중인 작업으로 인해 리소스 잠금을 나타내며 진행 중인 작업이 끝날 때까지 테이블에 대한 업데이트를 금지합니다.

Name	형식	Description
Deleting	string	테이블 상태가 삭제되고 있습니다.
InProgress	string	테이블 스키마는 안정적이며 변경 없이 테이블 데이터가 업데이트되고 있습니다.
Succeeded	string	테이블 상태는 안정적이며 변경 없이 테이블이 잠금 해제되고 새 업데이트를 위해 열립니다.
Updating	string	테이블 스키마는 여전히 빌드되고 업데이트되고 있으며, 프로시저가 완료될 때까지 테이블은 현재 변경 내용에 대해 잠겨 있습니다.

RestoredLogs

복원 매개 변수입니다.

Name	형식	Description
azureAsyncOperationId	string	검색 결과 테이블 비동기 작업 ID입니다.
endRestoreTime	string	(UTC)에 의해 복원을 종료하는 타임스탬프입니다.
sourceTable	string	데이터를 복원할 테이블입니다.
startRestoreTime	string	(UTC)에서 복원을 시작할 타임스탬프입니다.

ResultStatistics

작업 실행 통계를 검색합니다.

Name	형식	Description
ingestedRecords	integer	검색 작업에서 반환된 행 수입니다.
progress	number	검색 작업 완료율입니다.
scannedGb	number	검색 작업: 스캔한 데이터의 양입니다.

Schema

테이블의 스키마입니다.

Name	형식	Description
categories	string[]	테이블 범주입니다.
columns	Column[]	테이블 사용자 지정 열 목록입니다.
description	string	테이블 설명입니다.
displayName	string	테이블 표시 이름입니다.
labels	string[]	테이블 레이블.
name	string	테이블 이름입니다.
solutions	string[]	테이블이 관련되어 있는 솔루션 목록
source	SourceEnum	테이블의 작성자입니다.
standardColumns	Column[]	테이블 표준 열 목록입니다.
tableSubType	TableSubTypeEnum	하위 형식은 테이블과 상호 작용하는 데 사용할 수 있는 API와 테이블에 대해 사용할 수 있는 기능을 설명합니다.
tableType	TableTypeEnum	테이블의 작성자입니다.

SearchResults

이 테이블을 시작한 검색 작업의 매개 변수입니다.

Name	형식	Description
azureAsyncOperationId	string	검색 결과 테이블 비동기 작업 ID입니다.
description	string	검색 작업 설명.
endSearchTime	string	검색을 종료할 타임스탬프(UTC)
limit	integer	지정된 행 수까지 반환하도록 검색 작업을 제한합니다.
query	string	작업 쿼리를 검색합니다.
sourceTable	string	검색 작업에 사용되는 테이블입니다.
startSearchTime	string	검색을 시작할 타임스탬프(UTC)

SourceEnum

테이블의 작성자입니다.

Name	형식	Description
customer	string	작업 영역 소유자가 만든 테이블이며 이 작업 영역에서만 찾을 수 있습니다.
microsoft	string	진단 설정, 에이전트 또는 기타 표준 데이터 수집 수단을 통해 수집되는 시스템에서 프로비전된 테이블입니다.

systemData

리소스 만들기 및 마지막 수정과 관련된 메타데이터입니다.

Name	형식	Description
createdAt	string	UTC(리소스 만들기)의 타임스탬프입니다.
createdBy	string	리소스를 만든 ID입니다.
createdByType	createdByType	리소스를 만든 ID 유형입니다.
lastModifiedAt	string	리소스 마지막 수정의 타임스탬프(UTC)
lastModifiedBy	string	리소스를 마지막으로 수정한 ID입니다.
lastModifiedByType	createdByType	리소스를 마지막으로 수정한 ID 유형입니다.

Table

작업 영역 데이터 테이블 정의입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /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

이 테이블에 수집된 로그를 처리하고 충전하는 방법을 시스템에 지시합니다.

Name	형식	Description
Analytics	string	모니터링 및 분석을 허용하는 로그입니다.
Basic	string	대용량 낮은 값의 자세한 정보 표시 로그를 지원하도록 조정된 로그입니다.

TableSubTypeEnum

하위 형식은 테이블과 상호 작용하는 데 사용할 수 있는 API와 테이블에 대해 사용할 수 있는 기능을 설명합니다.

Name	형식	Description
Any	string	기본 제공 테이블을 만드는 기본 하위 형식입니다.
Classic	string	데이터 수집기 API 또는 MMA 에이전트의 사용자 지정 로그 기능 또는 사용자 지정 필드를 만든 테이블을 통해 만든 테이블을 나타냅니다.
DataCollectionRuleBased	string	데이터 수집 규칙에서 지원하는 수단을 통해 데이터를 보낼 수 있는 테이블: 데이터 수집 엔드포인트 API, 수집 시간 변환 또는 데이터 수집 규칙에서 제공하는 기타 메커니즘

TableTypeEnum

테이블의 작성자입니다.

Name	형식	Description
CustomLog	string	사용자 지정 로그 테이블입니다.
Microsoft	string	Azure Monitor에서 수집한 표준 데이터입니다.
RestoredLogs	string	복원된 데이터입니다.
SearchResults	string	검색 작업에서 수집한 데이터입니다.

Tables - Create Or 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

추가 리소스