Tables - Update

Riferimento

Service:: Log Analytics

API Version:: 2022-10-01

Aggiornare una tabella dell'area di lavoro Log Analytics.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
tableName	path	True	string	Nome della tabella.
workspaceName	path	True	string	Nome dell'area di lavoro. Regex pattern: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.plan	TablePlanEnum	Indicare al sistema come gestire e caricare i log inseriti in questa tabella.
properties.restoredLogs	RestoredLogs	Parametri dell'operazione di ripristino che ha avviato questa tabella.
properties.retentionInDays	integer	Conservazione della tabella in giorni compresi tra 4 e 730. L'impostazione di questa proprietà su -1 verrà impostata per impostazione predefinita sulla conservazione dell'area di lavoro.
properties.schema	Schema	Schema della tabella.
properties.searchResults	SearchResults	Parametri del processo di ricerca che ha avviato questa tabella.
properties.totalRetentionInDays	integer	La conservazione totale della tabella in giorni, compresa tra 4 e 4383. L'impostazione di questa proprietà su -1 verrà impostata per impostazione predefinita sulla conservazione delle tabelle.

Risposte

Nome	Tipo	Descrizione
200 OK	Table	Definizione di risposta OK.
202 Accepted		Definizione di risposta accettata (operazione a esecuzione prolungata).
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

Definizioni

Nome	Descrizione
Column	Colonna tabella.
ColumnDataTypeHintEnum	Hint logico per il tipo di dati della colonna.
ColumnTypeEnum	Tipo di dati della colonna.
createdByType	Tipo di identità che ha creato la risorsa.
ErrorAdditionalInfo	Informazioni aggiuntive sulla gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
ProvisioningStateEnum	Stato di provisioning corrente della tabella. Se impostato su "aggiornamento", indica un blocco di risorse a causa di un'operazione in corso, vietando qualsiasi aggiornamento alla tabella fino alla conclusione dell'operazione in corso.
RestoredLogs	Ripristinare i parametri.
ResultStatistics	Cercare le statistiche di esecuzione del processo.
Schema	Schema della tabella.
SearchResults	Parametri del processo di ricerca che ha avviato questa tabella.
SourceEnum	Creatore della tabella.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
Table	Definizione della tabella dati dell'area di lavoro.
TablePlanEnum	Indicare al sistema come gestire e caricare i log inseriti in questa tabella.
TableSubTypeEnum	Il sottotipo descrive le API che è possibile usare per interagire con la tabella e quali funzionalità sono disponibili.
TableTypeEnum	Creatore della tabella.

Column

Colonna tabella.

Nome	Tipo	Descrizione
dataTypeHint	ColumnDataTypeHintEnum	Hint logico per il tipo di dati della colonna.
description	string	Descrizione colonna.
displayName	string	Nome visualizzato colonna.
isDefaultDisplay	boolean	Viene visualizzato per impostazione predefinita.
isHidden	boolean	Colonna nascosta.
name	string	Nome colonna.
type	ColumnTypeEnum	Tipo di dati della colonna.

ColumnDataTypeHintEnum

Hint logico per il tipo di dati della colonna.

Nome	Tipo	Descrizione
armPath	string	Percorso di Azure Resource Model (ARM): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	GUID standard a 128 bit seguendo la forma standard xxxxxxxx-xxxx-xxxx-xxx
ip	string	Indirizzo ip V4/V6 standard che segue la forma standard, x.x.x.x/y:
uri	string	Stringa che corrisponde al modello di un URI, ad esempio scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Tipo di dati della colonna.

Nome	Tipo	Descrizione
boolean	string
dateTime	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informazioni aggiuntive sulla gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

ProvisioningStateEnum

Stato di provisioning corrente della tabella. Se impostato su "aggiornamento", indica un blocco di risorse a causa di un'operazione in corso, vietando qualsiasi aggiornamento alla tabella fino alla conclusione dell'operazione in corso.

Nome	Tipo	Descrizione
Deleting	string	Lo stato della tabella viene eliminato.
InProgress	string	Lo schema della tabella è stabile e senza modifiche, i dati della tabella vengono aggiornati.
Succeeded	string	Lo stato della tabella è stabile e senza modifiche, la tabella viene sbloccata e aperta per i nuovi aggiornamenti.
Updating	string	Lo schema di tabella è ancora in fase di compilazione e aggiornamento, la tabella è attualmente bloccata per tutte le modifiche fino a quando non viene eseguita la procedura.

RestoredLogs

Ripristinare i parametri.

Nome	Tipo	Descrizione
azureAsyncOperationId	string	Tabella dei risultati della ricerca con ID operazione asincrona.
endRestoreTime	string	Timestamp per terminare il ripristino entro (UTC).
sourceTable	string	Tabella da cui ripristinare i dati.
startRestoreTime	string	Timestamp per avviare il ripristino da (UTC).

ResultStatistics

Cercare le statistiche di esecuzione del processo.

Nome	Tipo	Descrizione
ingestedRecords	integer	Numero di righe restituite dal processo di ricerca.
progress	number	Percentuale di completamento del processo di ricerca.
scannedGb	number	Processo di ricerca: quantità di dati analizzati.

Schema

Schema della tabella.

Nome	Tipo	Descrizione
categories	string[]	Categoria tabella.
columns	Column[]	Elenco di colonne personalizzate della tabella.
description	string	Descrizione della tabella.
displayName	string	Nome visualizzato tabella.
labels	string[]	Etichette di tabella.
name	string	Nome della tabella.
solutions	string[]	Elenco di soluzioni a cui la tabella è affiliata
source	SourceEnum	Creatore della tabella.
standardColumns	Column[]	Elenco di colonne standard della tabella.
tableSubType	TableSubTypeEnum	Il sottotipo descrive le API che è possibile usare per interagire con la tabella e quali funzionalità sono disponibili.
tableType	TableTypeEnum	Creatore della tabella.

SearchResults

Parametri del processo di ricerca che ha avviato questa tabella.

Nome	Tipo	Descrizione
azureAsyncOperationId	string	Tabella dei risultati della ricerca con ID operazione asincrona.
description	string	Descrizione del processo di ricerca.
endSearchTime	string	Timestamp per terminare la ricerca in base alle ore (UTC)
limit	integer	Limitare il processo di ricerca per restituire fino al numero specificato di righe.
query	string	Query del processo di ricerca.
sourceTable	string	Tabella utilizzata nel processo di ricerca.
startSearchTime	string	Timestamp per avviare la ricerca da (UTC)

SourceEnum

Creatore della tabella.

Nome	Tipo	Descrizione
customer	string	Tabelle create dal proprietario dell'area di lavoro e disponibili solo in questa area di lavoro.
microsoft	string	Tabelle di cui è stato effettuato il provisioning dal sistema, raccolte tramite impostazioni di diagnostica, agenti o qualsiasi altro mezzo di raccolta dati standard.

systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string	Timestamp della creazione di risorse (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

Table

Definizione della tabella dati dell'area di lavoro.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.archiveRetentionInDays	integer	Conservazione dell'archivio dati della tabella in giorni. Calcolato come (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	Timestamp dell'ultima modifica del piano di tabella (UTC).
properties.plan	TablePlanEnum	Indicare al sistema come gestire e caricare i log inseriti in questa tabella.
properties.provisioningState	ProvisioningStateEnum	Stato di provisioning corrente della tabella. Se impostato su "aggiornamento", indica un blocco di risorse a causa di un'operazione in corso, vietando qualsiasi aggiornamento alla tabella fino alla conclusione dell'operazione in corso.
properties.restoredLogs	RestoredLogs	Parametri dell'operazione di ripristino che ha avviato questa tabella.
properties.resultStatistics	ResultStatistics	Cercare le statistiche di esecuzione del processo.
properties.retentionInDays	integer	Conservazione della tabella in giorni compresa tra 4 e 730. L'impostazione di questa proprietà su -1 verrà impostata per impostazione predefinita sulla conservazione dell'area di lavoro.
properties.retentionInDaysAsDefault	boolean	True: il valore ha origine dalla conservazione dell'area di lavoro in giorni, False- Specifica del cliente.
properties.schema	Schema	Schema della tabella.
properties.searchResults	SearchResults	Parametri del processo di ricerca che ha avviato questa tabella.
properties.totalRetentionInDays	integer	Conservazione totale della tabella in giorni compresa tra 4 e 4383. L'impostazione di questa proprietà su -1 verrà impostata per impostazione predefinita sulla conservazione delle tabelle.
properties.totalRetentionInDaysAsDefault	boolean	True: il valore ha origine dalla conservazione in giorni, False- Specifica del cliente.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

TablePlanEnum

Indicare al sistema come gestire e caricare i log inseriti in questa tabella.

Nome	Tipo	Descrizione
Analytics	string	Log che consentono il monitoraggio e l'analisi.
Basic	string	Log modificati per supportare log dettagliati con volumi elevati con un valore basso.

TableSubTypeEnum

Il sottotipo descrive le API che è possibile usare per interagire con la tabella e quali funzionalità sono disponibili.

Nome	Tipo	Descrizione
Any	string	Sottotipo predefinito con cui vengono create le tabelle predefinite.
Classic	string	Indica una tabella creata tramite l'API dell'agente di raccolta dati o con la funzionalità log personalizzati dell'agente MMA o qualsiasi tabella in base alla quale sono stati creati campi personalizzati.
DataCollectionRuleBased	string	Una tabella idonea per l'invio dei dati tramite uno qualsiasi dei mezzi supportati dalle regole di raccolta dati: l'API endpoint di raccolta dati, le trasformazioni in fase di inserimento o qualsiasi altro meccanismo fornito dalle regole di raccolta dati

TableTypeEnum

Creatore della tabella.

Nome	Tipo	Descrizione
CustomLog	string	Tabella di log personalizzata.
Microsoft	string	Dati standard raccolti da Monitoraggio di Azure.
RestoredLogs	string	Dati ripristinati.
SearchResults	string	Dati raccolti da un processo di ricerca.

Share via

Tables - Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Scopes

Esempio

TablesUpsert

Sample Request

Sample Response

Definizioni

Column

ColumnDataTypeHintEnum

ColumnTypeEnum

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ProvisioningStateEnum

RestoredLogs

ResultStatistics

Schema

SearchResults

SourceEnum

systemData

Table

TablePlanEnum

TableSubTypeEnum

TableTypeEnum

Risorse aggiuntive