Query Pack Queries - Update

Referencia

Servicio:: Monitor

Versión de la API:: 2019-09-01

Agrega o Novedades una consulta específica dentro de un queryPack de Log Analytics.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/queryPacks/{queryPackName}/queries/{id}?api-version=2019-09-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	string	El identificador de una consulta específica definida en el QueryPack de Log Analytics
queryPackName	path	True	string	Nombre del recurso QueryPack de Log Analytics.
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.
api-version	query	True	string	Versión de API que se usará para la operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.body	True	string	Cuerpo de la consulta.
properties.displayName	True	string	Nombre para mostrar único para la consulta en el paquete de consultas.
properties.description		string	Descripción de la consulta.
properties.properties		object	Propiedades adicionales que se pueden establecer para la consulta.
properties.related		Related	Los elementos de metadatos relacionados de la función.
properties.tags		object	Etiquetas asociadas a la consulta.

Respuestas

Nombre	Tipo	Description
200 OK	LogAnalyticsQueryPackQuery	La consulta nueva o actualizada contenida en el QueryPack de Log Analytics.
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

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

Ámbitos

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

QueryPatch

Solicitud de ejemplo

PATCH https://management.azure.com/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/Microsoft.OperationalInsights/queryPacks/my-querypack/queries/a449f8af-8e64-4b3a-9b16-5a7165ff98c4?api-version=2019-09-01

{
  "properties": {
    "displayName": "Exceptions - New in the last 24 hours",
    "description": "my description",
    "body": "let newExceptionsTimeRange = 1d;\nlet timeRangeToCheckBefore = 7d;\nexceptions\n| where timestamp < ago(timeRangeToCheckBefore)\n| summarize count() by problemId\n| join kind= rightanti (\nexceptions\n| where timestamp >= ago(newExceptionsTimeRange)\n| extend stack = tostring(details[0].rawStack)\n| summarize count(), dcount(user_AuthenticatedId), min(timestamp), max(timestamp), any(stack) by problemId  \n) on problemId \n| order by  count_ desc\n",
    "related": {
      "categories": [
        "analytics"
      ]
    },
    "tags": {
      "my-label": [
        "label1"
      ],
      "my-other-label": [
        "label2"
      ]
    }
  }
}

import com.azure.resourcemanager.loganalytics.models.LogAnalyticsQueryPackQuery;
import com.azure.resourcemanager.loganalytics.models.LogAnalyticsQueryPackQueryPropertiesRelated;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/** Samples for Queries Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/examples/QueryPackQueriesUpdate.json
     */
    /**
     * Sample code: QueryPatch.
     *
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void queryPatch(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        LogAnalyticsQueryPackQuery resource =
            manager
                .queries()
                .getWithResponse(
                    "my-resource-group",
                    "my-querypack",
                    "a449f8af-8e64-4b3a-9b16-5a7165ff98c4",
                    com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withTags(mapOf("my-label", Arrays.asList("label1"), "my-other-label", Arrays.asList("label2")))
            .withDisplayName("Exceptions - New in the last 24 hours")
            .withDescription("my description")
            .withBody(
                "let newExceptionsTimeRange = 1d;\n"
                    + "let timeRangeToCheckBefore = 7d;\n"
                    + "exceptions\n"
                    + "| where timestamp < ago(timeRangeToCheckBefore)\n"
                    + "| summarize count() by problemId\n"
                    + "| join kind= rightanti (\n"
                    + "exceptions\n"
                    + "| where timestamp >= ago(newExceptionsTimeRange)\n"
                    + "| extend stack = tostring(details[0].rawStack)\n"
                    + "| summarize count(), dcount(user_AuthenticatedId), min(timestamp), max(timestamp), any(stack) by"
                    + " problemId  \n"
                    + ") on problemId \n"
                    + "| order by  count_ desc\n")
            .withRelated(new LogAnalyticsQueryPackQueryPropertiesRelated().withCategories(Arrays.asList("analytics")))
            .apply();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armoperationalinsights_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4ce13e8353a25125a41bc01705c0a7794dac32a7/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/examples/QueryPackQueriesUpdate.json
func ExampleQueriesClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armoperationalinsights.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQueriesClient().Update(ctx, "my-resource-group", "my-querypack", "a449f8af-8e64-4b3a-9b16-5a7165ff98c4", armoperationalinsights.LogAnalyticsQueryPackQuery{
		Properties: &armoperationalinsights.LogAnalyticsQueryPackQueryProperties{
			Description: to.Ptr("my description"),
			Body:        to.Ptr("let newExceptionsTimeRange = 1d;\nlet timeRangeToCheckBefore = 7d;\nexceptions\n| where timestamp < ago(timeRangeToCheckBefore)\n| summarize count() by problemId\n| join kind= rightanti (\nexceptions\n| where timestamp >= ago(newExceptionsTimeRange)\n| extend stack = tostring(details[0].rawStack)\n| summarize count(), dcount(user_AuthenticatedId), min(timestamp), max(timestamp), any(stack) by problemId  \n) on problemId \n| order by  count_ desc\n"),
			DisplayName: to.Ptr("Exceptions - New in the last 24 hours"),
			Related: &armoperationalinsights.LogAnalyticsQueryPackQueryPropertiesRelated{
				Categories: []*string{
					to.Ptr("analytics")},
			},
			Tags: map[string][]*string{
				"my-label": {
					to.Ptr("label1")},
				"my-other-label": {
					to.Ptr("label2")},
			},
		},
	}, 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.LogAnalyticsQueryPackQuery = armoperationalinsights.LogAnalyticsQueryPackQuery{
	// 	Name: to.Ptr("a449f8af-8e64-4b3a-9b16-5a7165ff98c4"),
	// 	Type: to.Ptr("microsoft.operationalinsights/queryPacks/queries"),
	// 	ID: to.Ptr("/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/a449f8af-8e64-4b3a-9b16-5a7165ff98c4"),
	// 	SystemData: &armoperationalinsights.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-03T01:01:01.107Z"); return t}()),
	// 		CreatedBy: to.Ptr("string"),
	// 		CreatedByType: to.Ptr(armoperationalinsights.IdentityTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-02-04T02:03:01.197Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("string"),
	// 		LastModifiedByType: to.Ptr(armoperationalinsights.IdentityTypeApplication),
	// 	},
	// 	Properties: &armoperationalinsights.LogAnalyticsQueryPackQueryProperties{
	// 		Description: to.Ptr("my description"),
	// 		Author: to.Ptr("1809f206-263a-46f7-942d-4572c156b7e7"),
	// 		Body: to.Ptr("let newExceptionsTimeRange = 1d;\nlet timeRangeToCheckBefore = 7d;\nexceptions\n| where timestamp < ago(timeRangeToCheckBefore)\n| summarize count() by problemId\n| join kind= rightanti (\nexceptions\n| where timestamp >= ago(newExceptionsTimeRange)\n| extend stack = tostring(details[0].rawStack)\n| summarize count(), dcount(user_AuthenticatedId), min(timestamp), max(timestamp), any(stack) by problemId  \n) on problemId \n| order by  count_ desc\n"),
	// 		DisplayName: to.Ptr("Exceptions - New in the last 24 hours"),
	// 		ID: to.Ptr("a449f8af-8e64-4b3a-9b16-5a7165ff98c4"),
	// 		Related: &armoperationalinsights.LogAnalyticsQueryPackQueryPropertiesRelated{
	// 			Categories: []*string{
	// 				to.Ptr("analytics")},
	// 			},
	// 			Tags: map[string][]*string{
	// 				"my-label": []*string{
	// 					to.Ptr("label1")},
	// 					"my-other-label": []*string{
	// 						to.Ptr("label2")},
	// 					},
	// 					TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-15T10:30:32.574Z"); return t}()),
	// 					TimeModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-08-15T10:30:32.574Z"); return t}()),
	// 				},
	// 			}
}

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 Adds or Updates a specific Query within a Log Analytics QueryPack.
 *
 * @summary Adds or Updates a specific Query within a Log Analytics QueryPack.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/examples/QueryPackQueriesUpdate.json
 */
async function queryPatch() {
  const subscriptionId =
    process.env["OPERATIONALINSIGHTS_SUBSCRIPTION_ID"] || "86dc51d3-92ed-4d7e-947a-775ea79b4918";
  const resourceGroupName =
    process.env["OPERATIONALINSIGHTS_RESOURCE_GROUP"] || "my-resource-group";
  const queryPackName = "my-querypack";
  const id = "a449f8af-8e64-4b3a-9b16-5a7165ff98c4";
  const queryPayload = {
    description: "my description",
    body: "let newExceptionsTimeRange = 1d;\nlet timeRangeToCheckBefore = 7d;\nexceptions\n| where timestamp < ago(timeRangeToCheckBefore)\n| summarize count() by problemId\n| join kind= rightanti (\nexceptions\n| where timestamp >= ago(newExceptionsTimeRange)\n| extend stack = tostring(details[0].rawStack)\n| summarize count(), dcount(user_AuthenticatedId), min(timestamp), max(timestamp), any(stack) by problemId  \n) on problemId \n| order by  count_ desc\n",
    displayName: "Exceptions - New in the last 24 hours",
    related: { categories: ["analytics"] },
    tags: { myLabel: ["label1"], myOtherLabel: ["label2"] },
  };
  const credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.queries.update(resourceGroupName, queryPackName, id, queryPayload);
  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 Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.OperationalInsights.Models;
using Azure.ResourceManager.OperationalInsights;

// Generated from example definition: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/examples/QueryPackQueriesUpdate.json
// this example is just showing the usage of "Queries_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 LogAnalyticsQueryResource created on azure
// for more information of creating LogAnalyticsQueryResource, please refer to the document of LogAnalyticsQueryResource
string subscriptionId = "86dc51d3-92ed-4d7e-947a-775ea79b4918";
string resourceGroupName = "my-resource-group";
string queryPackName = "my-querypack";
string id = "a449f8af-8e64-4b3a-9b16-5a7165ff98c4";
ResourceIdentifier logAnalyticsQueryResourceId = LogAnalyticsQueryResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, queryPackName, id);
LogAnalyticsQueryResource logAnalyticsQuery = client.GetLogAnalyticsQueryResource(logAnalyticsQueryResourceId);

// invoke the operation
LogAnalyticsQueryData data = new LogAnalyticsQueryData()
{
    DisplayName = "Exceptions - New in the last 24 hours",
    Description = "my description",
    Body = "let newExceptionsTimeRange = 1d;\nlet timeRangeToCheckBefore = 7d;\nexceptions\n| where timestamp < ago(timeRangeToCheckBefore)\n| summarize count() by problemId\n| join kind= rightanti (\nexceptions\n| where timestamp >= ago(newExceptionsTimeRange)\n| extend stack = tostring(details[0].rawStack)\n| summarize count(), dcount(user_AuthenticatedId), min(timestamp), max(timestamp), any(stack) by problemId  \n) on problemId \n| order by  count_ desc\n",
    Related = new LogAnalyticsQueryRelatedMetadata()
    {
        Categories =
        {
        "analytics"
        },
    },
    Tags =
    {
    ["my-label"] = new string[]
    {
    "label1"
    },
    ["my-other-label"] = new string[]
    {
    "label2"
    },
    },
};
LogAnalyticsQueryResource result = await logAnalyticsQuery.UpdateAsync(data);

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

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/86dc51d3-92ed-4d7e-947a-775ea79b4918/resourceGroups/my-resource-group/providers/microsoft.operationalinsights/queryPacks/my-querypack/queries/a449f8af-8e64-4b3a-9b16-5a7165ff98c4",
  "name": "a449f8af-8e64-4b3a-9b16-5a7165ff98c4",
  "type": "microsoft.operationalinsights/queryPacks/queries",
  "systemData": {
    "createdBy": "string",
    "createdByType": "application",
    "createdAt": "2020-02-03T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "application",
    "lastModifiedAt": "2020-02-04T02:03:01.1974346Z"
  },
  "properties": {
    "id": "a449f8af-8e64-4b3a-9b16-5a7165ff98c4",
    "timeCreated": "2019-08-15T10:30:32.5742324Z",
    "author": "1809f206-263a-46f7-942d-4572c156b7e7",
    "timeModified": "2019-08-15T10:30:32.5742324Z",
    "displayName": "Exceptions - New in the last 24 hours",
    "description": "my description",
    "body": "let newExceptionsTimeRange = 1d;\nlet timeRangeToCheckBefore = 7d;\nexceptions\n| where timestamp < ago(timeRangeToCheckBefore)\n| summarize count() by problemId\n| join kind= rightanti (\nexceptions\n| where timestamp >= ago(newExceptionsTimeRange)\n| extend stack = tostring(details[0].rawStack)\n| summarize count(), dcount(user_AuthenticatedId), min(timestamp), max(timestamp), any(stack) by problemId  \n) on problemId \n| order by  count_ desc\n",
    "related": {
      "categories": [
        "analytics"
      ]
    },
    "tags": {
      "my-label": [
        "label1"
      ],
      "my-other-label": [
        "label2"
      ]
    }
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
IdentityType	Tipo de identidad que crea o modifica recursos.
LogAnalyticsQueryPackQuery	Una definición de QueryPack-Query de Log Analytics.
Related	Los elementos de metadatos relacionados de la función.
SystemData	Datos del sistema de solo lectura

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.

IdentityType

Tipo de identidad que crea o modifica recursos.

Nombre	Tipo	Description
application	string
key	string
managedIdentity	string
user	string

LogAnalyticsQueryPackQuery

Una definición de QueryPack-Query de Log Analytics.

Nombre	Tipo	Description
id	string	Identificador de recurso de Azure
name	string	Nombre de recurso de Azure
properties.author	string	Identificador de objeto del usuario que crea la consulta.
properties.body	string	Cuerpo de la consulta.
properties.description	string	Descripción de la consulta.
properties.displayName	string	Nombre para mostrar único para la consulta en el paquete de consultas.
properties.id	string	Identificador único de la aplicación. Este campo no se puede cambiar.
properties.properties	object	Propiedades adicionales que se pueden establecer para la consulta.
properties.related	Related	Los elementos de metadatos relacionados de la función.
properties.tags	object	Etiquetas asociadas a la consulta.
properties.timeCreated	string	Fecha de creación de la consulta de Log Analytics, en formato ISO 8601.
properties.timeModified	string	Fecha de última modificación de la consulta de Log Analytics, en formato ISO 8601.
systemData	SystemData	Datos del sistema de solo lectura
type	string	Tipo de recurso de Azure

Los elementos de metadatos relacionados de la función.

Nombre	Tipo	Description
categories	string[]	Categorías relacionadas para la función.
resourceTypes	string[]	Los tipos de recursos relacionados para la función.
solutions	string[]	Las soluciones de Log Analytics relacionadas para la función.

SystemData

Datos del sistema de solo lectura

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

Compartir a través de

Query Pack Queries - Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

QueryPatch

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityType

LogAnalyticsQueryPackQuery

SystemData

Recursos adicionales