Tables - Update

Service:

Log Analytics

API Version:

2022-10-01

Aktualizace tabulky pracovního prostoru služby Log Analytics

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
subscriptionId	path	True	string	ID cílového předplatného.
tableName	path	True	string	Název tabulky.
workspaceName	path	True	string	Název pracovního prostoru. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.plan	TablePlanEnum	Instruujte systém, jak zpracovat a účtovat protokoly ingestované do této tabulky.
properties.restoredLogs	RestoredLogs	Parametry operace obnovení, která iniciovala tuto tabulku.
properties.retentionInDays	integer	Uchovávání tabulek ve dnech mezi 4 a 730. Nastavením této vlastnosti na hodnotu -1 se ve výchozím nastavení použije uchovávání pracovního prostoru.
properties.schema	Schema	Schéma tabulky.
properties.searchResults	SearchResults	Parametry úlohy vyhledávání, která iniciovala tuto tabulku.
properties.totalRetentionInDays	integer	Celková doba uchování v tabulce ve dnech mezi 4 a 4383. Nastavením této vlastnosti na hodnotu -1 se ve výchozím nastavení použije uchovávání tabulek.

Odpovědi

Name	Typ	Description
200 OK	Table	Definice odpovědi OK.
202 Accepted		Přijatá definice odpovědi (dlouhotrvající operace)
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

TablesUpsert

Sample Request

HTTP

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
  }
}

Java

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

Python

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

JavaScript

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

dotnet

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

Definice

Name	Description
Column	Sloupec tabulky.
ColumnDataTypeHintEnum	Logická nápověda pro datový typ sloupce.
ColumnTypeEnum	Datový typ sloupce.
createdByType	Typ identity, která vytvořila prostředek.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu
ProvisioningStateEnum	Aktuální stav zřizování tabulky Pokud je nastavená hodnota aktualizace, označuje zámek prostředku kvůli probíhající operaci, která zakazuje jakoukoli aktualizaci tabulky, dokud se probíhající operace nedokončí.
RestoredLogs	Parametry obnovení.
ResultStatistics	Statistiky provádění úloh vyhledávání.
Schema	Schéma tabulky.
SearchResults	Parametry úlohy hledání, která iniciovala tuto tabulku.
SourceEnum	Tvůrce tabulky.
systemData	Metadata týkající se vytvoření a poslední změny prostředku
Table	Definice tabulky dat pracovního prostoru
TablePlanEnum	Instruujte systém, jak zpracovávat a účtovat protokoly ingestované do této tabulky.
TableSubTypeEnum	Podtyp popisuje, jaká rozhraní API je možné použít k interakci s tabulkou a jaké funkce jsou pro ni k dispozici.
TableTypeEnum	Tvůrce tabulky.

Column

Sloupec tabulky.

Name	Typ	Description
dataTypeHint	ColumnDataTypeHintEnum	Logická nápověda pro datový typ sloupce.
description	string	Popis sloupce.
displayName	string	Zobrazovaný název sloupce.
isDefaultDisplay	boolean	Ve výchozím nastavení se zobrazuje.
isHidden	boolean	Je sloupec skrytý.
name	string	Název sloupce.
type	ColumnTypeEnum	Datový typ sloupce.

ColumnDataTypeHintEnum

Logická nápověda pro datový typ sloupce.

Name	Typ	Description
armPath	string	Cesta modelu prostředků Azure (ARM): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	Standardní 128bitový identifikátor GUID následující za standardním obrazcem xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
ip	string	Standardní IP adresa V4/V6 za standardním tvarem x.x.x/y:y:y:y:y:y:y:y:y:y:y
uri	string	Řetězec, který odpovídá vzoru identifikátoru URI, například scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Datový typ sloupce.

Name	Typ	Description
boolean	string
dateTime	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string

createdByType

Typ identity, která vytvořila prostředek.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Typ další informace.

ErrorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě
code	string	Kód chyby
details	ErrorDetail[]	Podrobnosti o chybě
message	string	Chybová zpráva
target	string	Cíl chyby.

ErrorResponse

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

ProvisioningStateEnum

Aktuální stav zřizování tabulky Pokud je nastavená hodnota aktualizace, označuje zámek prostředku kvůli probíhající operaci, která zakazuje jakoukoli aktualizaci tabulky, dokud se probíhající operace nedokončí.

Name	Typ	Description
Deleting	string	Stav tabulky se odstraňuje.
InProgress	string	Schéma tabulky je stabilní a beze změn se data tabulky aktualizují.
Succeeded	string	Stav tabulky je stabilní a beze změn, tabulka je odemknutá a otevřená pro nové aktualizace.
Updating	string	Schéma tabulky se stále vytváří a aktualizuje, tabulka je v současné době uzamčena pro všechny změny, dokud není postup dokončen.

RestoredLogs

Parametry obnovení.

Name	Typ	Description
azureAsyncOperationId	string	ID asynchronní operace tabulky výsledků hledání
endRestoreTime	string	Časové razítko pro ukončení obnovení do (UTC).
sourceTable	string	Tabulka, ze které chcete obnovit data.
startRestoreTime	string	Časové razítko pro spuštění obnovení od (UTC).

ResultStatistics

Statistiky provádění úloh vyhledávání.

Name	Typ	Description
ingestedRecords	integer	Počet řádků vrácených úlohou vyhledávání.
progress	number	Procento dokončení úlohy hledání
scannedGb	number	Úloha hledání: Množství naskenovaných dat.

Schema

Schéma tabulky.

Name	Typ	Description
categories	string[]	Kategorie tabulky.
columns	Column[]	Seznam vlastních sloupců tabulky.
description	string	Popis tabulky.
displayName	string	Zobrazovaný název tabulky.
labels	string[]	Popisky tabulek.
name	string	Název tabulky.
solutions	string[]	Seznam řešení, ke kterým je tabulka přidružená
source	SourceEnum	Tvůrce tabulky.
standardColumns	Column[]	Seznam standardních sloupců tabulky.
tableSubType	TableSubTypeEnum	Podtyp popisuje, jaká rozhraní API je možné použít k interakci s tabulkou a jaké funkce jsou pro ni k dispozici.
tableType	TableTypeEnum	Tvůrce tabulky.

SearchResults

Parametry úlohy hledání, která iniciovala tuto tabulku.

Name	Typ	Description
azureAsyncOperationId	string	ID asynchronní operace tabulky výsledků hledání
description	string	Popis úlohy hledání.
endSearchTime	string	Časové razítko pro ukončení hledání do (UTC)
limit	integer	Omezte úlohu hledání tak, aby vracela až zadaný počet řádků.
query	string	Dotaz úlohy vyhledávání.
sourceTable	string	Tabulka použitá v úloze hledání.
startSearchTime	string	Časové razítko pro zahájení vyhledávání od (UTC)

SourceEnum

Tvůrce tabulky.

Name	Typ	Description
customer	string	Tabulky vytvořené vlastníkem pracovního prostoru a nalezené pouze v tomto pracovním prostoru.
microsoft	string	Tabulky zřízené systémem, které jsou shromažďovány prostřednictvím nastavení diagnostiky, agentů nebo jiných standardních prostředků shromažďování dat.

systemData

Metadata týkající se vytvoření a poslední změny prostředku

Name	Typ	Description
createdAt	string	Časové razítko vytvoření prostředku (UTC)
createdBy	string	Identita, která prostředek vytvořila.
createdByType	createdByType	Typ identity, která vytvořila prostředek.
lastModifiedAt	string	Časové razítko poslední změny prostředku (UTC)
lastModifiedBy	string	Identita, která naposledy změnila prostředek.
lastModifiedByType	createdByType	Typ identity, která naposledy změnila prostředek.

Table

Definice tabulky dat pracovního prostoru

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.archiveRetentionInDays	integer	Uchovávání dat v archivu tabulky ve dnech. Vypočteno jako (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	Časové razítko plánu tabulky bylo naposledy změněno (UTC).
properties.plan	TablePlanEnum	Instruujte systém, jak zpracovávat a účtovat protokoly ingestované do této tabulky.
properties.provisioningState	ProvisioningStateEnum	Aktuální stav zřizování tabulky Pokud je nastavená hodnota aktualizace, označuje zámek prostředku kvůli probíhající operaci, která zakazuje jakoukoli aktualizaci tabulky, dokud se probíhající operace nedokončí.
properties.restoredLogs	RestoredLogs	Parametry operace obnovení, která iniciovala tuto tabulku.
properties.resultStatistics	ResultStatistics	Statistiky provádění úloh vyhledávání.
properties.retentionInDays	integer	Uchovávání tabulek ve dnech mezi 4 a 730. Nastavením této vlastnosti na hodnotu -1 se ve výchozím nastavení použije uchování pracovního prostoru.
properties.retentionInDaysAsDefault	boolean	True – hodnota pochází z uchovávání pracovních prostorů ve dnech, False – specifická pro zákazníka.
properties.schema	Schema	Schéma tabulky.
properties.searchResults	SearchResults	Parametry úlohy hledání, která iniciovala tuto tabulku.
properties.totalRetentionInDays	integer	Celkové uchování v tabulce ve dnech mezi 4 a 4383. Nastavením této vlastnosti na hodnotu -1 se ve výchozím nastavení nastaví uchovávání tabulek.
properties.totalRetentionInDaysAsDefault	boolean	True – hodnota pochází z uchovávání ve dnech, Nepravda – specifická pro zákazníka.
systemData	systemData	Metadata týkající se vytvoření a poslední změny prostředku
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

TablePlanEnum

Instruujte systém, jak zpracovávat a účtovat protokoly ingestované do této tabulky.

Name	Typ	Description
Analytics	string	Protokoly, které umožňují monitorování a analýzy.
Basic	string	Protokoly, které jsou upraveny tak, aby podporovaly podrobné protokoly s nízkou hodnotou s vysokým objemem.

TableSubTypeEnum

Podtyp popisuje, jaká rozhraní API je možné použít k interakci s tabulkou a jaké funkce jsou pro ni k dispozici.

Name	Typ	Description
Any	string	Výchozí podtyp, pomocí kterého se vytvářejí předdefinované tabulky.
Classic	string	Označuje tabulku vytvořenou prostřednictvím rozhraní API kolektoru dat nebo s funkcí vlastních protokolů agenta MMA nebo jakoukoli tabulku, pro kterou byla vytvořena vlastní pole.
DataCollectionRuleBased	string	Tabulka, která má nárok na odesílání dat prostřednictvím některého z prostředků podporovaných pravidly shromažďování dat: rozhraní API koncového bodu shromažďování dat, transformace doby příjmu dat nebo jakýkoli jiný mechanismus poskytovaný pravidly shromažďování dat.

TableTypeEnum

Tvůrce tabulky.

Name	Typ	Description
CustomLog	string	Vlastní tabulka protokolů.
Microsoft	string	Standardní data shromažďovaná službou Azure Monitor.
RestoredLogs	string	Obnovená data.
SearchResults	string	Data shromažďovaná úlohou vyhledávání.