Tables - Update

Referensi

Service:: Log Analytics

API Version:: 2022-10-01

Memperbarui tabel ruang kerja Analitik Log.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
tableName	path	True	string	Nama tabel.
workspaceName	path	True	string	Nama ruang kerja. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.plan	TablePlanEnum	Instruksikan sistem cara menangani dan mengisi daya log yang diserap ke tabel ini.
properties.restoredLogs	RestoredLogs	Parameter operasi pemulihan yang memulai tabel ini.
properties.retentionInDays	integer	Retensi tabel dalam hari, antara 4 dan 730. Mengatur properti ini ke -1 akan default ke retensi ruang kerja.
properties.schema	Schema	Skema tabel.
properties.searchResults	SearchResults	Parameter pekerjaan pencarian yang memulai tabel ini.
properties.totalRetentionInDays	integer	Total retensi tabel dalam hari, antara 4 dan 4383. Mengatur properti ini ke -1 akan default ke retensi tabel.

Respons

Nama	Jenis	Deskripsi
200 OK	Table	Definisi respons OK.
202 Accepted		Definisi respons yang diterima (Operasi jangka panjang).
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
Column	Kolom tabel.
ColumnDataTypeHintEnum	Petunjuk logis jenis data kolom.
ColumnTypeEnum	Jenis data kolom.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
ProvisioningStateEnum	Status penyediaan tabel saat ini. Jika diatur ke 'memperbarui', menunjukkan kunci sumber daya karena operasi yang sedang berlangsung, melarang pembaruan apa pun ke tabel hingga operasi yang sedang berlangsung disimpulkan.
RestoredLogs	Pulihkan parameter.
ResultStatistics	Cari statistik eksekusi pekerjaan.
Schema	Skema tabel.
SearchResults	Parameter pekerjaan pencarian yang memulai tabel ini.
SourceEnum	Pembuat tabel.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
Table	Definisi tabel data ruang kerja.
TablePlanEnum	Instruksikan sistem cara menangani dan mengisi daya log yang diserap ke tabel ini.
TableSubTypeEnum	Subjenis menjelaskan API apa yang dapat digunakan untuk berinteraksi dengan tabel, dan fitur apa yang tersedia terhadapnya.
TableTypeEnum	Pembuat tabel.

Column

Kolom tabel.

Nama	Jenis	Deskripsi
dataTypeHint	ColumnDataTypeHintEnum	Petunjuk logis jenis data kolom.
description	string	Deskripsi kolom.
displayName	string	Nama tampilan kolom.
isDefaultDisplay	boolean	Ditampilkan secara default.
isHidden	boolean	Apakah kolom disembunyikan.
name	string	Nama kolom.
type	ColumnTypeEnum	Jenis data kolom.

ColumnDataTypeHintEnum

Petunjuk logis jenis data kolom.

Nama	Jenis	Deskripsi
armPath	string	Jalur Azure Resource Model (ARM): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	GUID 128-bit standar setelah bentuk standar, xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxx
ip	string	Alamat ip V4/V6 standar mengikuti bentuk standar, x.x.x.x/y:y:y:y:y:y:y:y:y
uri	string	String yang cocok dengan pola URI, misalnya, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Jenis data kolom.

Nama	Jenis	Deskripsi
boolean	string
dateTime	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string

createdByType

Jenis identitas yang membuat sumber daya.

Nama	Jenis	Deskripsi
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

ProvisioningStateEnum

Status penyediaan tabel saat ini. Jika diatur ke 'memperbarui', menunjukkan kunci sumber daya karena operasi yang sedang berlangsung, melarang pembaruan apa pun ke tabel hingga operasi yang sedang berlangsung disimpulkan.

Nama	Jenis	Deskripsi
Deleting	string	Status tabel sedang dihapus.
InProgress	string	Skema tabel stabil dan tanpa perubahan, data tabel sedang diperbarui.
Succeeded	string	Status tabel stabil dan tanpa perubahan, tabel tidak terkunci dan terbuka untuk pembaruan baru.
Updating	string	Skema tabel masih dibangun dan diperbarui, tabel saat ini dikunci untuk setiap perubahan sampai prosedur selesai.

RestoredLogs

Pulihkan parameter.

Nama	Jenis	Deskripsi
azureAsyncOperationId	string	Id operasi asinkron tabel hasil pencarian.
endRestoreTime	string	Tanda waktu untuk mengakhiri pemulihan oleh (UTC).
sourceTable	string	Tabel untuk memulihkan data.
startRestoreTime	string	Tanda waktu untuk memulai pemulihan dari (UTC).

ResultStatistics

Cari statistik eksekusi pekerjaan.

Nama	Jenis	Deskripsi
ingestedRecords	integer	Jumlah baris yang dikembalikan oleh pekerjaan pencarian.
progress	number	Persentase penyelesaian pekerjaan pencarian.
scannedGb	number	Pekerjaan pencarian: Jumlah data yang dipindai.

Schema

Skema tabel.

Nama	Jenis	Deskripsi
categories	string[]	Kategori tabel.
columns	Column[]	Daftar kolom kustom tabel.
description	string	Deskripsi tabel.
displayName	string	Nama tampilan tabel.
labels	string[]	Label tabel.
name	string	Nama tabel.
solutions	string[]	Daftar solusi yang berafiliasi dengan tabel
source	SourceEnum	Pembuat tabel.
standardColumns	Column[]	Daftar kolom standar tabel.
tableSubType	TableSubTypeEnum	Subjenis menjelaskan API apa yang dapat digunakan untuk berinteraksi dengan tabel, dan fitur apa yang tersedia terhadapnya.
tableType	TableTypeEnum	Pembuat tabel.

SearchResults

Parameter pekerjaan pencarian yang memulai tabel ini.

Nama	Jenis	Deskripsi
azureAsyncOperationId	string	Id operasi asinkron tabel hasil pencarian.
description	string	Deskripsi pekerjaan pencarian.
endSearchTime	string	Tanda waktu untuk mengakhiri pencarian menurut (UTC)
limit	integer	Batasi pekerjaan pencarian untuk mengembalikan hingga jumlah baris yang ditentukan.
query	string	Kueri pekerjaan pencarian.
sourceTable	string	Tabel yang digunakan dalam pekerjaan pencarian.
startSearchTime	string	Tanda waktu untuk memulai pencarian dari (UTC)

SourceEnum

Pembuat tabel.

Nama	Jenis	Deskripsi
customer	string	Tabel yang dibuat oleh pemilik Ruang Kerja, dan hanya ditemukan di Ruang Kerja ini.
microsoft	string	Tabel yang disediakan oleh sistem, seperti yang dikumpulkan melalui Pengaturan Diagnostik, Agen, atau sarana pengumpulan data standar lainnya.

systemData

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir mengubah sumber daya.

Table

Definisi tabel data ruang kerja.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.archiveRetentionInDays	integer	Retensi arsip data tabel dalam beberapa hari. Dihitung sebagai (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	Tanda waktu paket tabel terakhir diubah (UTC).
properties.plan	TablePlanEnum	Instruksikan sistem cara menangani dan mengisi daya log yang diserap ke tabel ini.
properties.provisioningState	ProvisioningStateEnum	Status penyediaan tabel saat ini. Jika diatur ke 'memperbarui', menunjukkan kunci sumber daya karena operasi yang sedang berlangsung, melarang pembaruan apa pun ke tabel hingga operasi yang sedang berlangsung disimpulkan.
properties.restoredLogs	RestoredLogs	Parameter operasi pemulihan yang memulai tabel ini.
properties.resultStatistics	ResultStatistics	Cari statistik eksekusi pekerjaan.
properties.retentionInDays	integer	Retensi tabel dalam hari, antara 4 dan 730. Mengatur properti ini ke -1 akan default ke retensi ruang kerja.
properties.retentionInDaysAsDefault	boolean	True - Nilai berasal dari retensi ruang kerja dalam hari, False - Spesifik pelanggan.
properties.schema	Schema	Skema tabel.
properties.searchResults	SearchResults	Parameter pekerjaan pencarian yang memulai tabel ini.
properties.totalRetentionInDays	integer	Total retensi tabel dalam hari, antara 4 dan 4383. Mengatur properti ini ke -1 akan default ke retensi tabel.
properties.totalRetentionInDaysAsDefault	boolean	True - Nilai berasal dari retensi dalam hari, False - Spesifik pelanggan.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

TablePlanEnum

Instruksikan sistem cara menangani dan mengisi daya log yang diserap ke tabel ini.

Nama	Jenis	Deskripsi
Analytics	string	Log yang memungkinkan pemantauan dan analitik.
Basic	string	Log yang disesuaikan untuk mendukung log verbose bernilai rendah volume tinggi.

TableSubTypeEnum

Subjenis menjelaskan API apa yang dapat digunakan untuk berinteraksi dengan tabel, dan fitur apa yang tersedia terhadapnya.

Nama	Jenis	Deskripsi
Any	string	Subjenis default yang tabel bawaannya dibuat.
Classic	string	Menunjukkan tabel yang dibuat melalui DATA Collector API atau dengan fitur log kustom agen MMA, atau tabel apa pun yang membuat Bidang Kustom.
DataCollectionRuleBased	string	Tabel yang memenuhi syarat untuk memiliki data yang dikirim ke dalamnya melalui salah satu cara yang didukung oleh Aturan Pengumpulan Data: API Titik Akhir Pengumpulan Data, transformasi waktu penyerapan, atau mekanisme lain yang disediakan oleh Aturan Pengumpulan Data

TableTypeEnum

Pembuat tabel.

Nama	Jenis	Deskripsi
CustomLog	string	Tabel log kustom.
Microsoft	string	Data standar yang dikumpulkan oleh Azure Monitor.
RestoredLogs	string	Data yang dipulihkan.
SearchResults	string	Data yang dikumpulkan oleh pekerjaan pencarian.

Tables - Update

Parameter URI

Isi Permintaan

Respons

Keamanan

azure_auth

Scopes

Contoh

TablesUpsert

Sample Request

Sample Response

Definisi

Column

ColumnDataTypeHintEnum

ColumnTypeEnum

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningStateEnum

RestoredLogs

ResultStatistics

Schema

SearchResults

SourceEnum

systemData

Table

TablePlanEnum

TableSubTypeEnum

TableTypeEnum

Sumber Daya Tambahan: