Schema - Get

Servicio:

Log Analytics

Versión de la API:

2025-07-01

Obtiene el esquema de un área de trabajo determinada.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/schema?api-version=2025-07-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
workspaceName	path	True	string minLength: 4 maxLength: 63 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$	Nombre del área de trabajo.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	SearchGetSchemaResponse	La operación de Azure se completó correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

WorkspacesGetSchema

Solicitud de ejemplo

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/atlantisdemo/schema?api-version=2025-07-01

Java

/**
 * Samples for Schema Get.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-07-01/SavedSearchesGetSchema.json
     */
    /**
     * Sample code: WorkspacesGetSchema.
     * 
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void workspacesGetSchema(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager.schemas().getWithResponse("mms-eus", "atlantisdemo", 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 saved_searches_get_schema.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="SUBSCRIPTION_ID",
    )

    response = client.schema.get(
        resource_group_name="mms-eus",
        workspace_name="atlantisdemo",
    )
    print(response)


# x-ms-original-file: 2025-07-01/SavedSearchesGetSchema.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

Go

package armoperationalinsights_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/operationalinsights/armoperationalinsights/v3"
)

// Generated from example definition: 2025-07-01/SavedSearchesGetSchema.json
func ExampleSchemaClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoperationalinsights.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewSchemaClient().Get(ctx, "mms-eus", "atlantisdemo", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armoperationalinsights.SchemaClientGetResponse{
	// 	SearchGetSchemaResponse: armoperationalinsights.SearchGetSchemaResponse{
	// 		Metadata: &armoperationalinsights.SearchMetadata{
	// 			Schema: &armoperationalinsights.SearchMetadataSchema{
	// 				Name: to.Ptr("CloudOps"),
	// 				Version: to.Ptr[int32](2),
	// 			},
	// 			RequestTime: to.Ptr[int64](28),
	// 			ResultType: to.Ptr("schema"),
	// 		},
	// 		Value: []*armoperationalinsights.SearchSchemaValue{
	// 			{
	// 				Name: to.Ptr("TenantId"),
	// 				Type: to.Ptr("Guid"),
	// 				DisplayName: to.Ptr("TenantId"),
	// 				Facet: to.Ptr(false),
	// 				Indexed: to.Ptr(true),
	// 				OwnerType: []*string{
	// 					to.Ptr("Alert"),
	// 					to.Ptr("AzureActivity"),
	// 					to.Ptr("AzureAudit"),
	// 					to.Ptr("AzureMetrics"),
	// 					to.Ptr("ComputerGroup"),
	// 					to.Ptr("ETWEvent"),
	// 					to.Ptr("Event"),
	// 					to.Ptr("ExtraHopDBLogin"),
	// 					to.Ptr("ExtraHopDBTransaction"),
	// 					to.Ptr("ExtraHopDNSResponse"),
	// 					to.Ptr("ExtraHopFTPResponse"),
	// 					to.Ptr("ExtraHopHTTPTransaction"),
	// 					to.Ptr("ExtraHopSMTPMessage"),
	// 					to.Ptr("ExtraHopSYNScanDetect"),
	// 					to.Ptr("ExtraHopTCPOpen"),
	// 					to.Ptr("Heartbeat"),
	// 					to.Ptr("Operation"),
	// 					to.Ptr("Perf"),
	// 					to.Ptr("ReservedAzureCommonFields"),
	// 					to.Ptr("ReservedCommonFields"),
	// 					to.Ptr("ServiceFabricOperationalEvent"),
	// 					to.Ptr("ServiceFabricReliableActorEvent"),
	// 					to.Ptr("ServiceFabricReliableServiceEvent"),
	// 					to.Ptr("Syslog"),
	// 					to.Ptr("Usage"),
	// 					to.Ptr("W3CIISLog"),
	// 				},
	// 				Stored: to.Ptr(false),
	// 			},
	// 		},
	// 	},
	// }
}

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 the schema for a given workspace.
 *
 * @summary gets the schema for a given workspace.
 * x-ms-original-file: 2025-07-01/SavedSearchesGetSchema.json
 */
async function workspacesGetSchema() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.schema.get("mms-eus", "atlantisdemo");
  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

Respuesta de muestra

status code:

200

{
  "metadata": {
    "schema": {
      "name": "CloudOps",
      "version": 2
    },
    "requestTime": 28,
    "resultType": "schema"
  },
  "value": [
    {
      "name": "TenantId",
      "type": "Guid",
      "displayName": "TenantId",
      "facet": false,
      "indexed": true,
      "ownerType": [
        "Alert",
        "AzureActivity",
        "AzureAudit",
        "AzureMetrics",
        "ComputerGroup",
        "ETWEvent",
        "Event",
        "ExtraHopDBLogin",
        "ExtraHopDBTransaction",
        "ExtraHopDNSResponse",
        "ExtraHopFTPResponse",
        "ExtraHopHTTPTransaction",
        "ExtraHopSMTPMessage",
        "ExtraHopSYNScanDetect",
        "ExtraHopTCPOpen",
        "Heartbeat",
        "Operation",
        "Perf",
        "ReservedAzureCommonFields",
        "ReservedCommonFields",
        "ServiceFabricOperationalEvent",
        "ServiceFabricReliableActorEvent",
        "ServiceFabricReliableServiceEvent",
        "Syslog",
        "Usage",
        "W3CIISLog"
      ],
      "stored": false
    }
  ]
}

Definiciones

Nombre	Description
CoreSummary	El resumen principal de una búsqueda.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
SearchGetSchemaResponse	La respuesta de la operación get schema.
SearchMetadata	Metadatos para los resultados de búsqueda.
SearchMetadataSchema	Metadatos de esquema para búsqueda.
SearchSchemaValue	Objeto de valor para los resultados del esquema.
SearchSort	Los parámetros de ordenación para la búsqueda.
SearchSortEnum	El criterio de ordenación de la búsqueda.

CoreSummary

Objeto

El resumen principal de una búsqueda.

Nombre	Tipo	Description
numberOfDocuments	integer (int64)	El número de documentos de un resumen básico.
status	string	El estado de un resumen central.

ErrorAdditionalInfo

Objeto

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

Objeto

Detalle del error.

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

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SearchGetSchemaResponse

Objeto

La respuesta de la operación get schema.

Nombre	Tipo	Description
metadata	SearchMetadata	Los metadatos de los resultados de búsqueda.
value	SearchSchemaValue[]	Matriz de valores de resultados.

SearchMetadata

Objeto

Metadatos para los resultados de búsqueda.

Nombre	Tipo	Description
aggregatedGroupingFields	string	Los campos de agrupación agregados.
aggregatedValueField	string	El campo de valor agregado.
coreSummaries	CoreSummary[]	Los resúmenes principales.
eTag	string	La ETag de los resultados de búsqueda.
id	string	El identificador de la solicitud de resultados de búsqueda.
lastUpdated	string (date-time)	La hora de la última actualización.
max	integer (int64)	El máximo de todos los agregados devueltos en el conjunto de resultados.
requestId	string	El identificador de solicitud de la búsqueda.
requestTime	integer (int64)	El tiempo de solicitud.
resultType	string	El tipo de resultado de búsqueda.
schema	SearchMetadataSchema	El esquema.
sort	SearchSort[]	Cómo se ordenan los resultados.
startTime	string (date-time)	La hora de inicio de la búsqueda.
status	string	El estado de los resultados de la búsqueda.
sum	integer (int64)	La suma de todos los agregados devueltos en el conjunto de resultados.
top	integer (int64)	El número de resultados de búsqueda principales.
total	integer (int64)	El número total de resultados de búsqueda.

SearchMetadataSchema

Objeto

Metadatos de esquema para búsqueda.

Nombre	Tipo	Description
name	string	El nombre del esquema de metadatos.
version	integer (int32)	La versión del esquema de metadatos.

SearchSchemaValue

Objeto

Objeto de valor para los resultados del esquema.

Nombre	Tipo	Description
displayName	string	El nombre para mostrar del esquema.
facet	boolean	El valor booleano que indica si el campo es o no una faceta.
indexed	boolean	El valor booleano que indica que el campo se puede buscar como texto libre.
name	string	Nombre del esquema.
ownerType	string[]	Matriz de flujos de trabajo que contiene el campo.
stored	boolean	El valor booleano que indica si el campo está almacenado o no.
type	string	Tipo.

SearchSort

Objeto

Los parámetros de ordenación para la búsqueda.

Nombre	Tipo	Description
name	string	El nombre del campo por el que se ordena la consulta de búsqueda.
order	SearchSortEnum	El criterio de ordenación de la búsqueda.

SearchSortEnum

Enumeración

El criterio de ordenación de la búsqueda.

Valor	Description
asc	asc
desc	desc