Tables - Update

Service:

Log Analytics

API Version:

2022-10-01

Uppdatera en Log Analytics-arbetsytetabell.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string	ID för målprenumerationen.
tableName	path	True	string	Namnet på tabellen.
workspaceName	path	True	string	Namnet på arbetsytan. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
properties.plan	TablePlanEnum	Instruera systemet hur de loggar som matas in till den här tabellen ska hanteras och debiteras.
properties.restoredLogs	RestoredLogs	Parametrar för återställningsåtgärden som initierade den här tabellen.
properties.retentionInDays	integer	Kvarhållning av tabeller i dagar, mellan 4 och 730. Om du anger den här egenskapen till -1 används som standard kvarhållning av arbetsytan.
properties.schema	Schema	Tabellschema.
properties.searchResults	SearchResults	Parametrar för sökjobbet som initierade den här tabellen.
properties.totalRetentionInDays	integer	Tabellens totala kvarhållning i dagar, mellan 4 och 4383. Om du ställer in den här egenskapen på -1 används som standard kvarhållning av tabeller.

Svar

Name	Typ	Description
200 OK	Table	OK svarsdefinition.
202 Accepted		Accepterad svarsdefinition (tidskrävande åtgärd).
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
Column	Tabellkolumn.
ColumnDataTypeHintEnum	Logisk ledtråd för kolumndatatyp.
ColumnTypeEnum	Kolumndatatyp.
createdByType	Den typ av identitet som skapade resursen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
ProvisioningStateEnum	Tabellens aktuella etableringstillstånd. Om värdet är "uppdatering" anger du ett resurslås på grund av pågående åtgärd, vilket förbjuder alla uppdateringar till tabellen tills den pågående åtgärden har avslutats.
RestoredLogs	Återställ parametrar.
ResultStatistics	Körningsstatistik för sökjobb.
Schema	Tabellens schema.
SearchResults	Parametrar för sökjobbet som initierade den här tabellen.
SourceEnum	Tables skapare.
systemData	Metadata som rör skapande och senaste ändring av resursen.
Table	Definition av arbetsytans datatabell.
TablePlanEnum	Instruera systemet hur de loggar som matas in till den här tabellen ska hanteras och debiteras.
TableSubTypeEnum	Undertypen beskriver vilka API:er som kan användas för att interagera med tabellen och vilka funktioner som är tillgängliga mot den.
TableTypeEnum	Tables skapare.

Column

Tabellkolumn.

Name	Typ	Description
dataTypeHint	ColumnDataTypeHintEnum	Logisk ledtråd för kolumndatatyp.
description	string	Kolumnbeskrivning.
displayName	string	Kolumnvisningsnamn.
isDefaultDisplay	boolean	Visas som standard.
isHidden	boolean	Är kolumnen dold.
name	string	Kolumnnamn.
type	ColumnTypeEnum	Kolumndatatyp.

ColumnDataTypeHintEnum

Logisk ledtråd för kolumndatatyp.

Name	Typ	Description
armPath	string	En ARM-sökväg (Azure Resource Model): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	En standard-128-bitars GUID som följer standardformen xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
ip	string	En standard-V4/V6 ip-adress som följer standardformen x.x.x.x/y:y:y:y:y:y:y:y
uri	string	En sträng som matchar mönstret för en URI, till exempel scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Kolumndatatyp.

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

createdByType

Den typ av identitet som skapade resursen.

Name	Typ	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Den ytterligare informationen.
type	string	Ytterligare informationstyp.

ErrorDetail

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

ProvisioningStateEnum

Tabellens aktuella etableringstillstånd. Om värdet är "uppdatering" anger du ett resurslås på grund av pågående åtgärd, vilket förbjuder alla uppdateringar till tabellen tills den pågående åtgärden har avslutats.

Name	Typ	Description
Deleting	string	Tabelltillståndet tas bort.
InProgress	string	Tabellschemat är stabilt och utan ändringar uppdateras tabelldata.
Succeeded	string	Tabelltillståndet är stabilt och utan ändringar är tabellen upplåst och öppen för nya uppdateringar.
Updating	string	Tabellschemat håller fortfarande på att skapas och uppdateras. Tabellen är för närvarande låst för alla ändringar tills proceduren är klar.

RestoredLogs

Återställ parametrar.

Name	Typ	Description
azureAsyncOperationId	string	Asynkron åtgärds-ID för sökresultattabell.
endRestoreTime	string	Tidsstämpeln för att avsluta återställningen av (UTC).
sourceTable	string	Tabellen som data ska återställas från.
startRestoreTime	string	Tidsstämpeln för att starta återställningen från (UTC).

ResultStatistics

Körningsstatistik för sökjobb.

Name	Typ	Description
ingestedRecords	integer	Antalet rader som returnerades av sökjobbet.
progress	number	Slutförande av sökjobb i procent.
scannedGb	number	Sökjobb: Mängden skannade data.

Schema

Tabellens schema.

Name	Typ	Description
categories	string[]	Tabellkategori.
columns	Column[]	En lista över anpassade tabellkolumner.
description	string	Tabellbeskrivning.
displayName	string	Tabellvisningsnamn.
labels	string[]	Tabelletiketter.
name	string	Tabellnamn.
solutions	string[]	Lista över lösningar som tabellen är kopplad till
source	SourceEnum	Tables skapare.
standardColumns	Column[]	En lista över standardkolumner i tabellen.
tableSubType	TableSubTypeEnum	Undertypen beskriver vilka API:er som kan användas för att interagera med tabellen och vilka funktioner som är tillgängliga mot den.
tableType	TableTypeEnum	Tables skapare.

SearchResults

Parametrar för sökjobbet som initierade den här tabellen.

Name	Typ	Description
azureAsyncOperationId	string	Asynkron åtgärds-ID för sökresultattabell.
description	string	Beskrivning av sökjobb.
endSearchTime	string	Tidsstämpeln för att avsluta sökningen efter (UTC)
limit	integer	Begränsa sökjobbet så att det återgår till angivet antal rader.
query	string	Sök jobbfråga.
sourceTable	string	Tabellen som används i sökjobbet.
startSearchTime	string	Tidsstämpeln för att starta sökningen från (UTC)

SourceEnum

Tables skapare.

Name	Typ	Description
customer	string	Tabeller som skapats av arbetsytans ägare och som endast finns i den här arbetsytan.
microsoft	string	Tabeller som etableras av systemet, som samlas in via diagnostikinställningar, agenter eller andra standarddatainsamlingsmedel.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Table

Definition av arbetsytans datatabell.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.archiveRetentionInDays	integer	Kvarhållning av tabelldataarkiv i dagar. Beräknas som (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	Tidsstämpeln som tabellplanen senast ändrades (UTC).
properties.plan	TablePlanEnum	Instruera systemet hur de loggar som matas in till den här tabellen ska hanteras och debiteras.
properties.provisioningState	ProvisioningStateEnum	Tabellens aktuella etableringstillstånd. Om värdet är "uppdatering" anger du ett resurslås på grund av pågående åtgärd, vilket förbjuder alla uppdateringar till tabellen tills den pågående åtgärden har avslutats.
properties.restoredLogs	RestoredLogs	Parametrar för återställningsåtgärden som initierade den här tabellen.
properties.resultStatistics	ResultStatistics	Körningsstatistik för sökjobb.
properties.retentionInDays	integer	Kvarhållning av tabeller i dagar, mellan 4 och 730. Om du ställer in den här egenskapen på -1 blir kvarhållningen av arbetsytan som standard.
properties.retentionInDaysAsDefault	boolean	True – Värdet kommer från kvarhållning av arbetsytan i dagar, False – Kundspecifik.
properties.schema	Schema	Tabellschema.
properties.searchResults	SearchResults	Parametrar för sökjobbet som initierade den här tabellen.
properties.totalRetentionInDays	integer	Tabellens totala kvarhållning i dagar, mellan 4 och 4383. Om du ställer in den här egenskapen på -1 används som standard kvarhållning av tabeller.
properties.totalRetentionInDaysAsDefault	boolean	True – värdet kommer från kvarhållning i dagar, Falskt – Kundspecifikt.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

TablePlanEnum

Instruera systemet hur de loggar som matas in till den här tabellen ska hanteras och debiteras.

Name	Typ	Description
Analytics	string	Loggar som tillåter övervakning och analys.
Basic	string	Loggar som justeras för att stödja utförliga loggar med låga volymvärden.

TableSubTypeEnum

Undertypen beskriver vilka API:er som kan användas för att interagera med tabellen och vilka funktioner som är tillgängliga mot den.

Name	Typ	Description
Any	string	Standardundertypen som inbyggda tabeller skapas med.
Classic	string	Anger en tabell som skapats via API:et för datainsamlaren eller med funktionen för anpassade loggar i MMA-agenten eller någon tabell som anpassade fält skapades mot.
DataCollectionRuleBased	string	En tabell som är berättigad att skicka data till den via något av de metoder som stöds av datainsamlingsregler: Slutpunkts-API för datainsamling, inmatningstidstransformering eller någon annan mekanism som tillhandahålls av datainsamlingsregler

TableTypeEnum

Tables skapare.

Name	Typ	Description
CustomLog	string	Anpassad loggtabell.
Microsoft	string	Standarddata som samlas in av Azure Monitor.
RestoredLogs	string	Återställde data.
SearchResults	string	Data som samlas in av ett sökjobb.