Tables - Get

Service:

Log Analytics

API Version:

2022-10-01

Obtiene una tabla de área de trabajo de Log Analytics.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de la suscripción de destino.
tableName	path	True	string	Nombre de la tabla.
workspaceName	path	True	string	El nombre del área de trabajo. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	Table	Definición de respuesta correcta.
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo OAuth2 de Azure Active Directory

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

TablesGet

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/table1_SRCH?api-version=2022-10-01

Java

/** Samples for Tables Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesGet.json
     */
    /**
     * Sample code: TablesGet.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void tablesGet(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager
            .tables()
            .getWithResponse("oiautorest6685", "oiautorest6685", "table1_SRCH", com.azure.core.util.Context.NONE);
    }
}

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_get.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.get(
        resource_group_name="oiautorest6685",
        workspace_name="oiautorest6685",
        table_name="table1_SRCH",
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesGet.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 Gets a Log Analytics workspace table.
 *
 * @summary Gets a Log Analytics workspace table.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2022-10-01/examples/TablesGet.json
 */
async function tablesGet() {
  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 = "table1_SRCH";
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.tables.get(resourceGroupName, workspaceName, tableName);
  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/TablesGet.json
// this example is just showing the usage of "Tables_Get" 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 = "table1_SRCH";
ResourceIdentifier operationalInsightsTableResourceId = OperationalInsightsTableResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, tableName);
OperationalInsightsTableResource operationalInsightsTable = client.GetOperationalInsightsTableResource(operationalInsightsTableResourceId);

// invoke the operation
OperationalInsightsTableResource result = await operationalInsightsTable.GetAsync();

// 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

{
  "systemData": {
    "createdBy": "00000000-0000-0000-0000-00000000000",
    "createdAt": "2020-02-03T04:05:06Z"
  },
  "properties": {
    "resultStatistics": {
      "progress": 75,
      "ingestedRecords": 5,
      "scannedGb": 23.5
    },
    "searchResults": {
      "query": "Heartbeat | where SourceSystem != '' | project SourceSystem",
      "description": "This table was created using a Search Job with the following query: 'Heartbeat | where SourceSystem != '' | project SourceSystem'.",
      "limit": 1000,
      "startSearchTime": "2020-02-03T04:05:06Z",
      "endSearchTime": "2020-02-02T04:05:06Z",
      "sourceTable": "Heartbeat"
    },
    "schema": {
      "name": "table1_SRCH",
      "tableSubType": "DataCollectionRuleBased",
      "tableType": "SearchResults",
      "displayName": null,
      "description": null,
      "columns": [],
      "standardColumns": [
        {
          "isHidden": false,
          "name": "TenantId",
          "type": "guid",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "SourceSystem",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "MG",
          "type": "guid",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "ManagementGroupName",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "TimeGenerated",
          "type": "dateTime",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "Computer",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        },
        {
          "isHidden": false,
          "name": "RawData",
          "type": "string",
          "dataTypeHint": null,
          "displayName": null,
          "description": null,
          "isDefaultDisplay": false
        }
      ],
      "categories": null,
      "labels": null,
      "source": null,
      "solutions": [
        "LogManagement"
      ]
    },
    "provisioningState": "InProgress",
    "retentionInDays": 50,
    "totalRetentionInDays": 50,
    "archiveRetentionInDays": 0,
    "retentionInDaysAsDefault": false,
    "totalRetentionInDaysAsDefault": true,
    "plan": "Analytics"
  },
  "id": "/subscriptions/00000000-0000-0000-0000-00000000000/resourceGroups/oiautorest6685/providers/Microsoft.OperationalInsights/workspaces/oiautorest6685/tables/table1_SRCH",
  "name": "table1_SRCH"
}

Definiciones

Nombre	Description
Column	Columna de tabla.
ColumnDataTypeHintEnum	Sugerencia lógica del tipo de datos de columna.
ColumnTypeEnum	Tipo de datos de la columna.
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
ProvisioningStateEnum	Estado de aprovisionamiento actual de la tabla. Si se establece en "actualización", indica un bloqueo de recursos debido a una operación en curso, prohibiendo cualquier actualización a la tabla hasta que finalice la operación en curso.
RestoredLogs	Restaurar parámetros.
ResultStatistics	Estadísticas de ejecución del trabajo de búsqueda.
Schema	Esquema de la tabla.
SearchResults	Parámetros del trabajo de búsqueda que inició esta tabla.
SourceEnum	Creador de la tabla.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
Table	Definición de la tabla de datos del área de trabajo.
TablePlanEnum	Indique al sistema cómo controlar y cargar los registros ingeridos en esta tabla.
TableSubTypeEnum	El subtipo describe qué API se pueden usar para interactuar con la tabla y qué características están disponibles en ella.
TableTypeEnum	Creador de la tabla.

Column

Columna de tabla.

Nombre	Tipo	Description
dataTypeHint	ColumnDataTypeHintEnum	Sugerencia lógica de tipo de datos de columna.
description	string	Descripción de la columna.
displayName	string	Nombre para mostrar de columna.
isDefaultDisplay	boolean	Se muestra de forma predeterminada.
isHidden	boolean	Está oculta la columna.
name	string	Nombre de la columna.
type	ColumnTypeEnum	Tipo de datos de la columna.

ColumnDataTypeHintEnum

Sugerencia lógica del tipo de datos de columna.

Nombre	Tipo	Description
armPath	string	Ruta de acceso del modelo de recursos de Azure (ARM): /subscriptions/{...} /resourceGroups/{...} /providers/Microsoft. {...} /{...} /{...} /{...} ...
guid	string	GUID estándar de 128 bits después de la forma estándar, xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
ip	string	Una dirección IP V4/V6 estándar siguiendo la forma estándar, x.x.x.x/y:y:y:y:y:y:y:y:y
uri	string	Cadena que coincide con el patrón de un URI, por ejemplo, scheme://username:password@host:1234/this/is/a/path?k1=v1&k2=v2#fragment

ColumnTypeEnum

Tipo de datos de la columna.

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

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

ProvisioningStateEnum

Estado de aprovisionamiento actual de la tabla. Si se establece en "actualización", indica un bloqueo de recursos debido a una operación en curso, prohibiendo cualquier actualización a la tabla hasta que finalice la operación en curso.

Nombre	Tipo	Description
Deleting	string	El estado de la tabla se está eliminando.
InProgress	string	El esquema de tabla es estable y sin cambios, se actualizan los datos de la tabla.
Succeeded	string	El estado de la tabla es estable y sin cambios, la tabla se desbloquea y se abre para las nuevas actualizaciones.
Updating	string	El esquema de tabla todavía se está compilando y actualizando, la tabla está bloqueada actualmente para los cambios hasta que se realice el procedimiento.

RestoredLogs

Restaurar parámetros.

Nombre	Tipo	Description
azureAsyncOperationId	string	Identificador de la operación asincrónica de la tabla de resultados de la búsqueda.
endRestoreTime	string	Marca de tiempo para finalizar la restauración por (UTC).
sourceTable	string	Tabla desde la que se van a restaurar los datos.
startRestoreTime	string	Marca de tiempo para iniciar la restauración a partir de (UTC).

ResultStatistics

Estadísticas de ejecución del trabajo de búsqueda.

Nombre	Tipo	Description
ingestedRecords	integer	Número de filas devueltas por el trabajo de búsqueda.
progress	number	Porcentaje de finalización del trabajo de búsqueda.
scannedGb	number	Trabajo de búsqueda: cantidad de datos examinados.

Schema

Esquema de la tabla.

Nombre	Tipo	Description
categories	string[]	Categoría de tabla.
columns	Column[]	Lista de columnas personalizadas de tabla.
description	string	Descripción de la tabla.
displayName	string	Nombre para mostrar de la tabla.
labels	string[]	Etiquetas de tabla.
name	string	Nombre de la tabla.
solutions	string[]	Lista de soluciones con las que está afiliada la tabla
source	SourceEnum	Creador de la tabla.
standardColumns	Column[]	Lista de columnas estándar de tabla.
tableSubType	TableSubTypeEnum	El subtipo describe qué API se pueden usar para interactuar con la tabla y qué características están disponibles en ella.
tableType	TableTypeEnum	Creador de la tabla.

SearchResults

Parámetros del trabajo de búsqueda que inició esta tabla.

Nombre	Tipo	Description
azureAsyncOperationId	string	Identificador de la operación asincrónica de la tabla de resultados de la búsqueda.
description	string	Descripción del trabajo de búsqueda.
endSearchTime	string	Marca de tiempo para finalizar la búsqueda por (UTC)
limit	integer	Limite el trabajo de búsqueda para que devuelva hasta el número especificado de filas.
query	string	Consulta de trabajo de búsqueda.
sourceTable	string	Tabla usada en el trabajo de búsqueda.
startSearchTime	string	Marca de tiempo para iniciar la búsqueda desde (UTC)

SourceEnum

Creador de la tabla.

Nombre	Tipo	Description
customer	string	Tablas creadas por el propietario del área de trabajo y que solo se encuentran en esta área de trabajo.
microsoft	string	Tablas aprovisionadas por el sistema, tal como se recopilan a través de la configuración de diagnóstico, los agentes o cualquier otro medio de recopilación de datos estándar.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Table

Definición de la tabla de datos del área de trabajo.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.archiveRetentionInDays	integer	Retención del archivo de datos de tabla en días. Se calcula como (totalRetentionInDays-retentionInDays)
properties.lastPlanModifiedDate	string	La marca de tiempo que el plan de tabla se modificó por última vez (UTC).
properties.plan	TablePlanEnum	Indique al sistema cómo controlar y cargar los registros ingeridos en esta tabla.
properties.provisioningState	ProvisioningStateEnum	Estado de aprovisionamiento actual de la tabla. Si se establece en "actualización", indica un bloqueo de recursos debido a una operación en curso, prohibiendo cualquier actualización a la tabla hasta que finalice la operación en curso.
properties.restoredLogs	RestoredLogs	Parámetros de la operación de restauración que inició esta tabla.
properties.resultStatistics	ResultStatistics	Estadísticas de ejecución del trabajo de búsqueda.
properties.retentionInDays	integer	Retención de la tabla en días, entre 4 y 730. Al establecer esta propiedad en -1, el valor predeterminado será la retención del área de trabajo.
properties.retentionInDaysAsDefault	boolean	True: el valor se origina en la retención del área de trabajo en días, False: específico del cliente.
properties.schema	Schema	Esquema de la tabla
properties.searchResults	SearchResults	Parámetros del trabajo de búsqueda que inició esta tabla.
properties.totalRetentionInDays	integer	La retención total de la tabla en días, entre 4 y 4383. Si se establece esta propiedad en -1, el valor predeterminado es la retención de tablas.
properties.totalRetentionInDaysAsDefault	boolean	True: el valor se origina en la retención en días, False: específico del cliente.
systemData	systemData	Metadatos relacionados con la creación y la última modificación del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

TablePlanEnum

Indique al sistema cómo controlar y cargar los registros ingeridos en esta tabla.

Nombre	Tipo	Description
Analytics	string	Registros que permiten la supervisión y el análisis.
Basic	string	Registros ajustados para admitir registros detallados de bajo valor de gran volumen.

TableSubTypeEnum

El subtipo describe qué API se pueden usar para interactuar con la tabla y qué características están disponibles en ella.

Nombre	Tipo	Description
Any	string	Subtipo predeterminado con el que se crean las tablas integradas.
Classic	string	Indica una tabla creada a través de data collector API o con la característica de registros personalizados del agente de MMA o cualquier tabla en la que se crearon campos personalizados.
DataCollectionRuleBased	string	Una tabla apta para que los datos se envíen a él a través de cualquiera de los medios admitidos por las reglas de recopilación de datos: la API de punto de conexión de recopilación de datos, las transformaciones en tiempo de ingesta o cualquier otro mecanismo proporcionado por las reglas de recopilación de datos.

TableTypeEnum

Creador de la tabla.

Nombre	Tipo	Description
CustomLog	string	Tabla de registro personalizada.
Microsoft	string	Datos estándar recopilados por Azure Monitor.
RestoredLogs	string	Datos restaurados.
SearchResults	string	Datos recopilados por un trabajo de búsqueda.