Tables - Update

Service:

Log Analytics

API Version:

2022-10-01

Een Log Analytics-werkruimtetabel bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string	De id van het doelabonnement.
tableName	path	True	string	De naam van de tabel.
workspaceName	path	True	string	De naam van de werkruimte. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
properties.plan	TablePlanEnum	Instrueer het systeem hoe de logboeken die in deze tabel worden opgenomen, moeten worden verwerkt en opgeladen.
properties.restoredLogs	RestoredLogs	Parameters van de herstelbewerking waarmee deze tabel is gestart.
properties.retentionInDays	integer	De tabelretentie in dagen, tussen 4 en 730. Als u deze eigenschap instelt op -1, wordt standaard de werkruimteretentie gebruikt.
properties.schema	Schema	Tabelschema.
properties.searchResults	SearchResults	Parameters van de zoektaak waarmee deze tabel is gestart.
properties.totalRetentionInDays	integer	De totale retentie in de tabel in dagen, tussen 4 en 4383. Als u deze eigenschap instelt op -1, wordt standaard tabelretentie gebruikt.

Antwoorden

Name	Type	Description
200 OK	Table	Definitie van OK-antwoord.
202 Accepted		Geaccepteerde antwoorddefinitie (langdurige bewerking).
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

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

Scopes

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name	Description
Column	Tabelkolom.
ColumnDataTypeHintEnum	Logische hint voor kolomgegevenstype.
ColumnTypeEnum	Kolomgegevenstype.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ProvisioningStateEnum	De huidige inrichtingsstatus van de tabel. Als dit is ingesteld op 'bijwerken', geeft dit een resourcevergrendeling aan vanwege een lopende bewerking, waarbij elke update van de tabel wordt geblokkeerd totdat de lopende bewerking is voltooid.
RestoredLogs	Parameters herstellen.
ResultStatistics	Statistieken over de uitvoering van zoektaken.
Schema	Schema van de tabel.
SearchResults	Parameters van de zoektaak die deze tabel heeft geïnitieerd.
SourceEnum	De maker van de tafel.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
Table	Definitie van werkruimtegegevenstabel.
TablePlanEnum	Instrueer het systeem hoe de logboeken die in deze tabel worden opgenomen, moeten worden verwerkt en in rekening worden gebracht.
TableSubTypeEnum	In het subtype wordt beschreven welke API's kunnen worden gebruikt voor interactie met de tabel en welke functies er beschikbaar zijn.
TableTypeEnum	De maker van de tafel.

Column

Tabelkolom.

Name	Type	Description
dataTypeHint	ColumnDataTypeHintEnum	Logische hint voor kolomgegevenstype.
description	string	Kolombeschrijving.
displayName	string	Kolomweergavenaam.
isDefaultDisplay	boolean	Wordt standaard weergegeven.
isHidden	boolean	Is de kolom verborgen.
name	string	Kolomnaam.
type	ColumnTypeEnum	Kolomgegevenstype.

ColumnDataTypeHintEnum

Logische hint voor kolomgegevenstype.

Name	Type	Description
armPath	string	Een ARM-pad (Azure Resource Model): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	Een standaard 128-bits GUID volgens de standaardvorm xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ip	string	Een standaard IP-adres V4/V6 volgens de standaardvorm x.x.x.x/y:y:y:y:y:y:y:y:y:y
uri	string	Een tekenreeks die overeenkomt met het patroon van een URI, bijvoorbeeld scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Kolomgegevenstype.

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

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ProvisioningStateEnum

De huidige inrichtingsstatus van de tabel. Als dit is ingesteld op 'bijwerken', geeft dit een resourcevergrendeling aan vanwege een lopende bewerking, waarbij elke update van de tabel wordt geblokkeerd totdat de lopende bewerking is voltooid.

Name	Type	Description
Deleting	string	Tabelstatus wordt verwijderd.
InProgress	string	Tabelschema is stabiel en zonder wijzigingen worden tabelgegevens bijgewerkt.
Succeeded	string	De tabelstatus is stabiel en zonder wijzigingen, de tabel wordt ontgrendeld en geopend voor nieuwe updates.
Updating	string	Het tabelschema wordt nog steeds gebouwd en bijgewerkt. De tabel is momenteel vergrendeld voor eventuele wijzigingen totdat de procedure is voltooid.

RestoredLogs

Parameters herstellen.

Name	Type	Description
azureAsyncOperationId	string	Asynchrone bewerkings-id voor zoekresultaten.
endRestoreTime	string	De tijdstempel om het herstel te beëindigen op (UTC).
sourceTable	string	De tabel waaruit u gegevens wilt herstellen.
startRestoreTime	string	De tijdstempel om het herstel te starten vanaf (UTC).

ResultStatistics

Statistieken over de uitvoering van zoektaken.

Name	Type	Description
ingestedRecords	integer	Het aantal rijen dat door de zoektaak is geretourneerd.
progress	number	Voltooiingspercentage van zoektaak.
scannedGb	number	Zoektaak: de hoeveelheid gescande gegevens.

Schema

Schema van de tabel.

Name	Type	Description
categories	string[]	Tabelcategorie.
columns	Column[]	Een lijst met aangepaste tabelkolommen.
description	string	Tabelbeschrijving.
displayName	string	Weergavenaam van tabel.
labels	string[]	Tabellabels.
name	string	Tabelnaam.
solutions	string[]	Lijst met oplossingen waarmee de tabel is gekoppeld
source	SourceEnum	De maker van de tafel.
standardColumns	Column[]	Een lijst met tabelstandaardkolommen.
tableSubType	TableSubTypeEnum	In het subtype wordt beschreven welke API's kunnen worden gebruikt voor interactie met de tabel en welke functies er beschikbaar zijn.
tableType	TableTypeEnum	De maker van de tafel.

SearchResults

Parameters van de zoektaak die deze tabel heeft geïnitieerd.

Name	Type	Description
azureAsyncOperationId	string	Asynchrone bewerkings-id voor zoekresultaten.
description	string	Beschrijving van zoektaak.
endSearchTime	string	De tijdstempel om de zoekopdracht te beëindigen op (UTC)
limit	integer	Beperk de zoektaak tot het opgegeven aantal rijen.
query	string	Zoektaakquery.
sourceTable	string	De tabel die wordt gebruikt in de zoektaak.
startSearchTime	string	De tijdstempel om de zoekopdracht te starten vanaf (UTC)

SourceEnum

De maker van de tafel.

Name	Type	Description
customer	string	Tabellen die zijn gemaakt door de eigenaar van de werkruimte en die alleen in deze werkruimte te vinden zijn.
microsoft	string	Tabellen die door het systeem zijn ingericht, zoals verzameld via Diagnostische instellingen, de agents of andere standaardgegevensverzamelingsmiddelen.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

Table

Definitie van werkruimtegegevenstabel.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.archiveRetentionInDays	integer	De retentie van het gegevensarchief van de tabel in dagen. Berekend als (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	De tijdstempel dat het tabelplan het laatst is gewijzigd (UTC).
properties.plan	TablePlanEnum	Instrueer het systeem hoe de logboeken die in deze tabel worden opgenomen, moeten worden verwerkt en in rekening worden gebracht.
properties.provisioningState	ProvisioningStateEnum	De huidige inrichtingsstatus van de tabel. Als dit is ingesteld op 'bijwerken', geeft dit een resourcevergrendeling aan vanwege een lopende bewerking, waarbij elke update van de tabel wordt geblokkeerd totdat de lopende bewerking is voltooid.
properties.restoredLogs	RestoredLogs	Parameters van de herstelbewerking die deze tabel heeft geïnitieerd.
properties.resultStatistics	ResultStatistics	Statistieken over de uitvoering van zoektaken.
properties.retentionInDays	integer	De tabelretentie in dagen, tussen 4 en 730. Als u deze eigenschap instelt op -1, wordt standaard de werkruimteretentie gebruikt.
properties.retentionInDaysAsDefault	boolean	True - Waarde is afkomstig van werkruimteretentie in dagen, Onwaar - Klantspecifiek.
properties.schema	Schema	Tabelschema.
properties.searchResults	SearchResults	Parameters van de zoektaak die deze tabel heeft geïnitieerd.
properties.totalRetentionInDays	integer	De totale retentie van de tabel in dagen, tussen 4 en 4383. Als u deze eigenschap instelt op -1, wordt standaard de tabelretentie gebruikt.
properties.totalRetentionInDaysAsDefault	boolean	True - Waarde is afkomstig van retentie in dagen, Onwaar - Klantspecifiek.
systemData	systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

TablePlanEnum

Instrueer het systeem hoe de logboeken die in deze tabel worden opgenomen, moeten worden verwerkt en in rekening worden gebracht.

Name	Type	Description
Analytics	string	Logboeken die bewaking en analyse toestaan.
Basic	string	Logboeken die zijn aangepast om uitgebreide logboeken met een hoog volume lage waarde te ondersteunen.

TableSubTypeEnum

In het subtype wordt beschreven welke API's kunnen worden gebruikt voor interactie met de tabel en welke functies er beschikbaar zijn.

Name	Type	Description
Any	string	Het standaardsubtype waarmee ingebouwde tabellen worden gemaakt.
Classic	string	Geeft een tabel aan die is gemaakt via de Gegevensverzamelaar-API of met de functie voor aangepaste logboeken van de MMA-agent of een tabel waarop aangepaste velden zijn gemaakt.
DataCollectionRuleBased	string	Een tabel die in aanmerking komt voor het verzenden van gegevens via een van de manieren die worden ondersteund door regels voor gegevensverzameling: de EINDPUNT-API voor gegevensverzameling, opnametijdtransformaties of een ander mechanisme dat wordt geboden door regels voor gegevensverzameling

TableTypeEnum

De maker van de tafel.

Name	Type	Description
CustomLog	string	Aangepaste logboektabel.
Microsoft	string	Standaardgegevens die worden verzameld door Azure Monitor.
RestoredLogs	string	Herstelde gegevens.
SearchResults	string	Gegevens die worden verzameld door een zoektaak.