Tables - Create Or Update

Service:

Log Analytics

API Version:

2022-10-01

Atualizar ou Criar uma tabela de área de trabalho do Log Analytics.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
tableName	path	True	string	O nome da tabela.
workspaceName	path	True	string	O nome da área de trabalho. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.plan	TablePlanEnum	Indique ao sistema como processar e carregar os registos ingeridos nesta tabela.
properties.restoredLogs	RestoredLogs	Parâmetros da operação de restauro que iniciou esta tabela.
properties.retentionInDays	integer	A retenção da tabela em dias, entre 4 e 730. Definir esta propriedade como -1 irá predefinir a retenção da área de trabalho.
properties.schema	Schema	Esquema de tabela.
properties.searchResults	SearchResults	Parâmetros da tarefa de pesquisa que iniciou esta tabela.
properties.totalRetentionInDays	integer	A retenção total da tabela em dias, entre 4 e 4383. Definir esta propriedade como -1 irá predefinir a retenção da tabela.

Respostas

Name	Tipo	Description
200 OK	Table	Definição de resposta OK.
202 Accepted		Definição de resposta aceite (operação de execução prolongada).
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

TablesUpsert

Sample Request

HTTP

PUT 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

Definições

Name	Description
Column	Coluna da tabela.
ColumnDataTypeHintEnum	Sugestão lógica do tipo de dados de coluna.
ColumnTypeEnum	Tipo de dados de coluna.
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
ProvisioningStateEnum	O estado de aprovisionamento atual da tabela. Se estiver definido como "a atualizar", indica um bloqueio de recurso devido a uma operação em curso, proibindo qualquer atualização à tabela até que a operação em curso esteja concluída.
RestoredLogs	Restaurar parâmetros.
ResultStatistics	Estatísticas de execução de tarefas de pesquisa.
Schema	Esquema da tabela.
SearchResults	Parâmetros da tarefa de pesquisa que iniciou esta tabela.
SourceEnum	Criador da tabela.
systemData	Metadados relativos à criação e última modificação do recurso.
Table	Definição da tabela de dados da área de trabalho.
TablePlanEnum	Indique ao sistema como processar e carregar os registos ingeridos nesta tabela.
TableSubTypeEnum	O subtipo descreve que APIs podem ser utilizadas para interagir com a tabela e que funcionalidades estão disponíveis para a mesma.
TableTypeEnum	Criador da tabela.

Column

Coluna da tabela.

Name	Tipo	Description
dataTypeHint	ColumnDataTypeHintEnum	Sugestão lógica do tipo de dados de coluna.
description	string	Descrição da coluna.
displayName	string	Nome a apresentar da coluna.
isDefaultDisplay	boolean	É apresentado por predefinição.
isHidden	boolean	A coluna está oculta.
name	string	Nome da coluna.
type	ColumnTypeEnum	Tipo de dados de coluna.

ColumnDataTypeHintEnum

Sugestão lógica do tipo de dados de coluna.

Name	Tipo	Description
armPath	string	Um caminho do Modelo de Recurso do Azure (ARM): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	Um GUID padrão de 128 bits seguindo a forma padrão, xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx
ip	string	Um endereço IP V4/V6 padrão seguindo a forma padrão, x.x.x.x/y:y:y:y:y:y:y:y:y
uri	string	Uma cadeia que corresponde ao padrão de um URI, por exemplo, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Tipo de dados de coluna.

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

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

ProvisioningStateEnum

O estado de aprovisionamento atual da tabela. Se estiver definido como "a atualizar", indica um bloqueio de recurso devido a uma operação em curso, proibindo qualquer atualização à tabela até que a operação em curso esteja concluída.

Name	Tipo	Description
Deleting	string	O estado da tabela está a ser eliminado.
InProgress	string	O esquema da tabela é estável e, sem alterações, os dados da tabela estão a ser atualizados.
Succeeded	string	O estado da tabela é estável e, sem alterações, a tabela é desbloqueada e aberta para novas atualizações.
Updating	string	O esquema de tabela ainda está a ser criado e atualizado. A tabela está atualmente bloqueada para quaisquer alterações até que o procedimento esteja concluído.

RestoredLogs

Restaurar parâmetros.

Name	Tipo	Description
azureAsyncOperationId	string	ID da operação assíncrona da tabela de resultados da pesquisa.
endRestoreTime	string	O carimbo de data/hora para terminar o restauro por (UTC).
sourceTable	string	A tabela a partir da qual restaurar dados.
startRestoreTime	string	O carimbo de data/hora para iniciar o restauro a partir de (UTC).

ResultStatistics

Estatísticas de execução de tarefas de pesquisa.

Name	Tipo	Description
ingestedRecords	integer	O número de linhas devolvidas pela tarefa de pesquisa.
progress	number	Percentagem de conclusão da tarefa de pesquisa.
scannedGb	number	Tarefa de pesquisa: quantidade de dados analisados.

Schema

Esquema da tabela.

Name	Tipo	Description
categories	string[]	Categoria da tabela.
columns	Column[]	Uma lista de colunas personalizadas de tabela.
description	string	Descrição da tabela.
displayName	string	Nome a apresentar da tabela.
labels	string[]	Etiquetas de tabela.
name	string	Nome da tabela.
solutions	string[]	Lista de soluções a que a tabela está afiliada
source	SourceEnum	Criador da tabela.
standardColumns	Column[]	Uma lista de colunas padrão de tabela.
tableSubType	TableSubTypeEnum	O subtipo descreve que APIs podem ser utilizadas para interagir com a tabela e que funcionalidades estão disponíveis para a mesma.
tableType	TableTypeEnum	Criador da tabela.

SearchResults

Parâmetros da tarefa de pesquisa que iniciou esta tabela.

Name	Tipo	Description
azureAsyncOperationId	string	ID da operação assíncrona da tabela de resultados da pesquisa.
description	string	Descrição da tarefa de pesquisa.
endSearchTime	string	O carimbo de data/hora para terminar a pesquisa por (UTC)
limit	integer	Limite a tarefa de pesquisa para devolver até ao número especificado de linhas.
query	string	Consulta da tarefa de pesquisa.
sourceTable	string	A tabela utilizada na tarefa de pesquisa.
startSearchTime	string	O carimbo de data/hora para iniciar a pesquisa a partir de (UTC)

SourceEnum

Criador da tabela.

Name	Tipo	Description
customer	string	Tabelas criadas pelo proprietário da Área de Trabalho e só encontradas nesta Área de Trabalho.
microsoft	string	Tabelas aprovisionadas pelo sistema, conforme recolhido através das Definições de Diagnóstico, dos Agentes ou de qualquer outro meio de recolha de dados padrão.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Table

Definição da tabela de dados da área de trabalho.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.archiveRetentionInDays	integer	A retenção do arquivo de dados da tabela em dias. Calculado como (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	O carimbo de data/hora em que o plano de tabela foi modificado pela última vez (UTC).
properties.plan	TablePlanEnum	Indique ao sistema como processar e carregar os registos ingeridos nesta tabela.
properties.provisioningState	ProvisioningStateEnum	O estado de aprovisionamento atual da tabela. Se estiver definido como "a atualizar", indica um bloqueio de recurso devido a uma operação em curso, proibindo qualquer atualização à tabela até que a operação em curso esteja concluída.
properties.restoredLogs	RestoredLogs	Parâmetros da operação de restauro que iniciou esta tabela.
properties.resultStatistics	ResultStatistics	Estatísticas de execução de tarefas de pesquisa.
properties.retentionInDays	integer	A retenção da tabela em dias, entre 4 e 730. Definir esta propriedade como -1 irá predefinir a retenção da área de trabalho.
properties.retentionInDaysAsDefault	boolean	True – o valor tem origem na retenção da área de trabalho em dias, Falso – Específico do cliente.
properties.schema	Schema	Esquema de tabela.
properties.searchResults	SearchResults	Parâmetros da tarefa de pesquisa que iniciou esta tabela.
properties.totalRetentionInDays	integer	A retenção total da tabela em dias, entre 4 e 4383. Definir esta propriedade como -1 irá predefinir a retenção da tabela.
properties.totalRetentionInDaysAsDefault	boolean	True – o valor tem origem na retenção em dias, Falso – Específico do cliente.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

TablePlanEnum

Indique ao sistema como processar e carregar os registos ingeridos nesta tabela.

Name	Tipo	Description
Analytics	string	Registos que permitem monitorização e análise.
Basic	string	Registos que são ajustados para suportar registos verbosos de valor baixo de volume elevado.

TableSubTypeEnum

O subtipo descreve que APIs podem ser utilizadas para interagir com a tabela e que funcionalidades estão disponíveis para a mesma.

Name	Tipo	Description
Any	string	O subtipo predefinido com o qual as tabelas incorporadas são criadas.
Classic	string	Indica uma tabela criada através da API do Recoletor de Dados ou com a funcionalidade de registos personalizados do agente MMA ou qualquer tabela na qual foram criados Campos Personalizados.
DataCollectionRuleBased	string	Uma tabela elegível para enviar dados para a mesma através de qualquer um dos meios suportados pelas Regras de Recolha de Dados: a API de Ponto Final de Recolha de Dados, transformações de tempo de ingestão ou qualquer outro mecanismo fornecido pelas Regras de Recolha de Dados

TableTypeEnum

Criador da tabela.

Name	Tipo	Description
CustomLog	string	Tabela de registo personalizada.
Microsoft	string	Dados padrão recolhidos pelo Azure Monitor.
RestoredLogs	string	Dados restaurados.
SearchResults	string	Dados recolhidos por uma tarefa de pesquisa.