Query Pack Queries - Get

Referenz

Dienst:: Monitor

API-Version:: 2019-09-01

Ruft eine bestimmte Log Analytics-Abfrage ab, die in einem Log Analytics QueryPack definiert ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Die ID einer bestimmten Abfrage, die im Log Analytics QueryPack definiert ist
queryPackName	path	True	string	Der Name der Log Analytics QueryPack-Ressource.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	LogAnalyticsQueryPackQuery	Eine einzelne Abfrage, die im Log Analytics QueryPack enthalten ist.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

QueryGet

Beispielanforderung

GET 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


/**
 * Samples for Queries Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/examples/
     * QueryPackQueriesGet.json
     */
    /**
     * Sample code: QueryGet.
     * 
     * @param manager Entry point to LogAnalyticsManager.
     */
    public static void queryGet(com.azure.resourcemanager.loganalytics.LogAnalyticsManager manager) {
        manager.queries().getWithResponse("my-resource-group", "my-querypack", "a449f8af-8e64-4b3a-9b16-5a7165ff98c4",
            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

from azure.identity import DefaultAzureCredential

from azure.mgmt.loganalytics import LogAnalyticsManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-loganalytics
# USAGE
    python query_pack_queries_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="86dc51d3-92ed-4d7e-947a-775ea79b4918",
    )

    response = client.queries.get(
        resource_group_name="my-resource-group",
        query_pack_name="my-querypack",
        id="a449f8af-8e64-4b3a-9b16-5a7165ff98c4",
    )
    print(response)


# x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/examples/QueryPackQueriesGet.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

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/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/QueryPackQueriesGet.json
func ExampleQueriesClient_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("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewQueriesClient().Get(ctx, "my-resource-group", "my-querypack", "a449f8af-8e64-4b3a-9b16-5a7165ff98c4", 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("Thie query fetcges the recent exceptions from the last 24 hours"),
	// 		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"),
	// 		TimeCreated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-12T11:44:39.298Z"); return t}()),
	// 		TimeModified: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-14T13:13:19.338Z"); 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 Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.
 *
 * @summary Gets a specific Log Analytics Query defined within a Log Analytics QueryPack.
 * x-ms-original-file: specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2019-09-01/examples/QueryPackQueriesGet.json
 */
async function queryGet() {
  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 credential = new DefaultAzureCredential();
  const client = new OperationalInsightsManagementClient(credential, subscriptionId);
  const result = await client.queries.get(resourceGroupName, queryPackName, id);
  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/QueryPackQueriesGet.json
// this example is just showing the usage of "Queries_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 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
LogAnalyticsQueryResource result = await logAnalyticsQuery.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
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

Beispiel für eine Antwort

Statuscode:: 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": {
    "displayName": "Exceptions - New in the last 24 hours",
    "id": "a449f8af-8e64-4b3a-9b16-5a7165ff98c4",
    "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",
    "timeModified": "2018-02-14T13:13:19.3381394Z",
    "timeCreated": "2018-02-12T11:44:39.2980634Z",
    "description": "Thie query fetcges the recent exceptions from the last 24 hours"
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IdentityType	Der Identitätstyp, der Ressourcen erstellt/ändert
LogAnalyticsQueryPackQuery	Eine Log Analytics-QueryPack-Query Definition.
Related	Die zugehörigen Metadatenelemente für die Funktion.
SystemData	Schreibgeschützte Systemdaten

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IdentityType

Enumeration

Der Identitätstyp, der Ressourcen erstellt/ändert

Wert	Beschreibung
application
key
managedIdentity
user

LogAnalyticsQueryPackQuery

Objekt

Eine Log Analytics-QueryPack-Query Definition.

Name	Typ	Beschreibung
id	string	Azure-Ressourcen-ID
name	string	Name der Azure-Ressource
properties.author	string	Objekt-ID des Benutzers, der die Abfrage erstellt.
properties.body	string	Textkörper der Abfrage.
properties.description	string	Beschreibung der Abfrage.
properties.displayName	string	Eindeutiger Anzeigename für Ihre Abfrage im Abfragepaket.
properties.id	string	Die eindeutige ID Ihrer Anwendung. Dieses Feld kann nicht geändert werden.
properties.properties	object	Zusätzliche Eigenschaften, die für die Abfrage festgelegt werden können.
properties.related	Related	Die zugehörigen Metadatenelemente für die Funktion.
properties.tags	object	Tags, die der Abfrage zugeordnet sind.
properties.timeCreated	string (date-time)	Erstellungsdatum für die Log Analytics-Abfrage im ISO 8601-Format.
properties.timeModified	string (date-time)	Datum der letzten Änderung der Log Analytics-Abfrage im ISO 8601-Format.
systemData	SystemData	Schreibgeschützte Systemdaten
type	string	Azure-Ressourcentyp

Objekt

Die zugehörigen Metadatenelemente für die Funktion.

Name	Typ	Beschreibung
categories	string[]	Die zugehörigen Kategorien für die Funktion.
resourceTypes	string[]	Die zugehörigen Ressourcentypen für die Funktion.
solutions	string[]	Die zugehörigen Log Analytics-Lösungen für die Funktion.

SystemData

Objekt

Schreibgeschützte Systemdaten

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC)
createdBy	string	Ein Bezeichner für die Identität, die die Ressource erstellt hat
createdByType	IdentityType	Der Identitätstyp, der die Ressource erstellt hat
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Ein Bezeichner für die Identität, die die Ressource zuletzt geändert hat
lastModifiedByType	IdentityType	Der Identitätstyp, der die Ressource zuletzt geändert hat