Tables - Update

Service:

Log Analytics

API Version:

2022-10-01

Mettre à jour une table d’espace de travail Log Analytics.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
tableName	path	True	string	Nom de la table.
workspaceName	path	True	string	Nom de l’espace de travail. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.plan	TablePlanEnum	Indiquez au système comment gérer et facturer les journaux ingérés dans cette table.
properties.restoredLogs	RestoredLogs	Paramètres de l’opération de restauration qui a initié cette table.
properties.retentionInDays	integer	Conservation de la table en jours, entre 4 et 730. La définition de cette propriété sur -1 est définie par défaut sur la rétention de l’espace de travail.
properties.schema	Schema	Schéma de la table
properties.searchResults	SearchResults	Paramètres du travail de recherche à l’origine de cette table.
properties.totalRetentionInDays	integer	Rétention totale de la table en jours, comprise entre 4 et 4383. Si vous définissez cette propriété sur -1, la rétention de la table est définie par défaut.

Réponses

Nom	Type	Description
200 OK	Table	Définition de réponse OK.
202 Accepted		Définition de réponse acceptée (opération de longue durée).
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Définitions

Nom	Description
Column	Colonne de table.
ColumnDataTypeHintEnum	Indicateur logique du type de données de colonne.
ColumnTypeEnum	Type de données de la colonne.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
ProvisioningStateEnum	État d’approvisionnement actuel de table. Si la valeur est « update », indique un verrou de ressource en raison d’une opération en cours, interdisant toute mise à jour de la table jusqu’à ce que l’opération en cours soit terminée.
RestoredLogs	Paramètres de restauration.
ResultStatistics	Statistiques d’exécution des travaux de recherche.
Schema	Schéma de la table.
SearchResults	Paramètres du travail de recherche qui a lancé cette table.
SourceEnum	Créateur de table.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
Table	Définition de table de données d’espace de travail.
TablePlanEnum	Indiquez au système comment gérer et charger les journaux ingérés dans cette table.
TableSubTypeEnum	Le sous-type décrit les API qui peuvent être utilisées pour interagir avec la table et les fonctionnalités disponibles pour celle-ci.
TableTypeEnum	Créateur de table.

Column

Colonne de table.

Nom	Type	Description
dataTypeHint	ColumnDataTypeHintEnum	Indicateur logique du type de données de colonne.
description	string	Description de la colonne.
displayName	string	Nom complet de la colonne.
isDefaultDisplay	boolean	Est affiché par défaut.
isHidden	boolean	Colonne masquée.
name	string	Nom de la colonne.
type	ColumnTypeEnum	Type de données de la colonne.

ColumnDataTypeHintEnum

Indicateur logique du type de données de colonne.

Nom	Type	Description
armPath	string	Chemin d’accès ARM (Azure Resource Model) : /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	GUID 128 bits standard suivant la forme standard, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx
ip	string	Adresse IP V4/V6 standard suivant la forme standard, x.x.x.x/y :y :y :y :y :y :y :y :y :y :y
uri	string	Chaîne qui correspond au modèle d’un URI, par exemple, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Type de données de la colonne.

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

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet error.

ProvisioningStateEnum

État d’approvisionnement actuel de table. Si la valeur est « update », indique un verrou de ressource en raison d’une opération en cours, interdisant toute mise à jour de la table jusqu’à ce que l’opération en cours soit terminée.

Nom	Type	Description
Deleting	string	L’état de la table est supprimé.
InProgress	string	Le schéma de table est stable et sans modification, les données de table sont mises à jour.
Succeeded	string	L’état de la table est stable et sans modification, la table est déverrouillée et ouverte pour les nouvelles mises à jour.
Updating	string	Le schéma de table est toujours en cours de génération et de mise à jour, la table est actuellement verrouillée pour toutes les modifications jusqu’à ce que la procédure soit terminée.

RestoredLogs

Paramètres de restauration.

Nom	Type	Description
azureAsyncOperationId	string	Id d’opération asynchrone de la table des résultats de la recherche.
endRestoreTime	string	Horodatage pour terminer la restauration par (UTC).
sourceTable	string	Table à partir de laquelle restaurer les données.
startRestoreTime	string	Horodatage à partir duquel démarrer la restauration à partir de (UTC).

ResultStatistics

Statistiques d’exécution des travaux de recherche.

Nom	Type	Description
ingestedRecords	integer	Nombre de lignes retournées par le travail de recherche.
progress	number	Pourcentage d’achèvement du travail de recherche.
scannedGb	number	Travail de recherche : quantité de données analysées.

Schema

Schéma de la table.

Nom	Type	Description
categories	string[]	Catégorie de table.
columns	Column[]	Liste de colonnes personnalisées de table.
description	string	Description de la table.
displayName	string	Nom complet de la table.
labels	string[]	Étiquettes de table.
name	string	Nom de la table.
solutions	string[]	Liste des solutions associées à la table
source	SourceEnum	Créateur de table.
standardColumns	Column[]	Liste des colonnes standard de table.
tableSubType	TableSubTypeEnum	Le sous-type décrit les API qui peuvent être utilisées pour interagir avec la table et les fonctionnalités disponibles pour celle-ci.
tableType	TableTypeEnum	Créateur de table.

SearchResults

Paramètres du travail de recherche qui a lancé cette table.

Nom	Type	Description
azureAsyncOperationId	string	Id d’opération asynchrone de la table des résultats de la recherche.
description	string	Description du travail de recherche.
endSearchTime	string	Horodatage pour mettre fin à la recherche par (UTC)
limit	integer	Limitez le travail de recherche à retourner jusqu’au nombre de lignes spécifié.
query	string	Requête de travail de recherche.
sourceTable	string	Table utilisée dans le travail de recherche.
startSearchTime	string	Horodatage à partir duquel démarrer la recherche à partir de (UTC)

SourceEnum

Créateur de table.

Nom	Type	Description
customer	string	Tables créées par le propriétaire de l’espace de travail et trouvées uniquement dans cet espace de travail.
microsoft	string	Tables approvisionnées par le système, telles qu’elles sont collectées via les paramètres de diagnostic, les agents ou tout autre moyen de collecte de données standard.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Table

Définition de table de données d’espace de travail.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.archiveRetentionInDays	integer	Conservation des données de la table en jours. Calculé comme (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	Horodatage de la dernière modification du plan de table (UTC).
properties.plan	TablePlanEnum	Indiquez au système comment gérer et charger les journaux ingérés dans cette table.
properties.provisioningState	ProvisioningStateEnum	État d’approvisionnement actuel de table. Si la valeur est « update », indique un verrou de ressource en raison d’une opération en cours, interdisant toute mise à jour de la table jusqu’à ce que l’opération en cours soit terminée.
properties.restoredLogs	RestoredLogs	Paramètres de l’opération de restauration qui a lancé cette table.
properties.resultStatistics	ResultStatistics	Statistiques d’exécution des travaux de recherche.
properties.retentionInDays	integer	Conservation de la table en jours, entre 4 et 730. La définition de cette propriété sur -1 est définie par défaut sur la rétention de l’espace de travail.
properties.retentionInDaysAsDefault	boolean	True : la valeur provient de la rétention de l’espace de travail en jours, false - spécifique au client.
properties.schema	Schema	Schéma de la table
properties.searchResults	SearchResults	Paramètres du travail de recherche qui a lancé cette table.
properties.totalRetentionInDays	integer	Conservation totale de la table en jours, comprise entre 4 et 4383. Si vous affectez la valeur -1 à cette propriété, la rétention de la table est définie par défaut.
properties.totalRetentionInDaysAsDefault	boolean	True : la valeur provient de la rétention en jours, False - Spécifique au client.
systemData	systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

TablePlanEnum

Indiquez au système comment gérer et charger les journaux ingérés dans cette table.

Nom	Type	Description
Analytics	string	Journaux qui autorisent la surveillance et l’analytique.
Basic	string	Journaux qui sont ajustés pour prendre en charge les journaux détaillés à faible volume élevé.

TableSubTypeEnum

Le sous-type décrit les API qui peuvent être utilisées pour interagir avec la table et les fonctionnalités disponibles pour celle-ci.

Nom	Type	Description
Any	string	Sous-type par défaut avec lequel les tables intégrées sont créées.
Classic	string	Indique une table créée via l’API Collecteur de données ou avec la fonctionnalité de journaux personnalisés de l’agent MMA, ou toute table sur laquelle les champs personnalisés ont été créés.
DataCollectionRuleBased	string	Une table éligible à l’envoi de données via l’un des moyens pris en charge par les règles de collecte de données : l’API de point de terminaison de collecte de données, les transformations au moment de l’ingestion ou tout autre mécanisme fourni par les règles de collecte de données

TableTypeEnum

Créateur de table.

Nom	Type	Description
CustomLog	string	Table de journaux personnalisée.
Microsoft	string	Données standard collectées par Azure Monitor.
RestoredLogs	string	Données restaurées.
SearchResults	string	Données collectées par un travail de recherche.