Pakiety zapytań w dziennikach usługi Azure Monitor

  • Artykuł

Pakiety zapytań działają jako kontenery zapytań dzienników w usłudze Azure Monitor. Umożliwiają one zapisywanie zapytań dzienników i udostępnianie ich w obszarach roboczych i innych kontekstach w usłudze Log Analytics.

Uprawnienia

Uprawnienia do pakietu zapytań można ustawić podczas wyświetlania go w witrynie Azure Portal. Do korzystania z pakietów zapytań potrzebne są następujące uprawnienia:

  • Czytelnik: użytkownicy mogą wyświetlać i uruchamiać wszystkie zapytania w pakiecie zapytań.

  • Współautor: użytkownicy mogą modyfikować istniejące zapytania i dodawać nowe zapytania do pakietu zapytań.

    Ważne

    Gdy użytkownik musi zmodyfikować lub dodać zapytania, zawsze przyznaj użytkownikowi uprawnienie Współautor w obiekcie DefaultQueryPack. W przeciwnym razie użytkownik nie będzie mógł zapisać żadnych zapytań w subskrypcji, w tym w innych pakietach zapytań.

Wyświetlanie pakietów zapytań

Pakiety zapytań usługi Log Analytics można wyświetlać w witrynie Azure Portal i zarządzać nimi z menu pakietów zapytań usługi Log Analytics. Wybierz pakiet zapytań, aby wyświetlić i edytować jego uprawnienia. W tym artykule opisano sposób tworzenia pakietu zapytań przy użyciu interfejsu API.

Screenshot that shows query packs.

Domyślny pakiet zapytań

Usługa Azure Monitor automatycznie tworzy pakiet zapytań o nazwie DefaultQueryPack w każdej subskrypcji w grupie zasobów wywoływanej LogAnalyticsDefaultResources podczas zapisywania pierwszego zapytania. Zapytania można zapisywać w tym pakiecie zapytań lub tworzyć inne pakiety zapytań w zależności od wymagań.

Używanie wielu pakietów zapytań

Domyślny pakiet zapytań jest wystarczający dla większości użytkowników do zapisywania i ponownego używania zapytań. Możesz utworzyć wiele pakietów zapytań dla użytkowników w organizacji, jeśli na przykład chcesz załadować różne zestawy zapytań w różnych sesjach usługi Log Analytics i zapewnić różne uprawnienia dla różnych kolekcji zapytań.

Podczas tworzenia nowego pakietu zapytań można dodawać tagi, które klasyfikują zapytania na podstawie potrzeb biznesowych. Możesz na przykład oznaczyć pakiet zapytań, aby powiązać go z określonym działem w organizacji lub na wagę problemów, z którymi mają być rozwiązywane dołączone zapytania. Za pomocą tagów można tworzyć różne zestawy zapytań przeznaczonych dla różnych zestawów użytkowników i różnych sytuacji.

Aby dodać pakiety zapytań do obszaru roboczego usługi Log Analytics:

  1. Otwórz usługę Log Analytics i wybierz pozycję Zapytania w prawym górnym rogu.
  2. W lewym górnym rogu okna dialogowego Zapytania obok pozycji Pakiety zapytań kliknij pozycję Wybierz pakiety zapytań lub 0 wybrane.
  3. Wybierz pakiety zapytań, które chcesz dodać do obszaru roboczego.

Screenshot that shows the Select query packs page in Log Analytics, where you can add query packs to a Log Analytics workspace.

Ważne

Do obszaru roboczego usługi Log Analytics można dodać maksymalnie pięć pakietów zapytań.

Tworzenie pakietu zapytań

Pakiet zapytań można utworzyć przy użyciu interfejsu API REST lub w okienku pakietów zapytań usługi Log Analytics w witrynie Azure Portal. Aby otworzyć okienko pakietów zapytań usługi Log Analytics w portalu, wybierz pozycję Wszystkie usługi>Inne.

Uwaga

Zapytania zapisane w pakiecie zapytań nie są szyfrowane przy użyciu klucza zarządzanego przez klienta. Wybierz pozycję Zapisz jako starsze zapytanie podczas zapisywania zapytań , aby chronić je przy użyciu klucza zarządzanego przez klienta.

Tworzenie tokenu

Musisz mieć token na potrzeby uwierzytelniania żądania interfejsu API. Istnieje wiele metod uzyskiwania tokenu. Jedną z metod jest użycie metody armclient.

Najpierw zaloguj się do platformy Azure przy użyciu następującego polecenia:

armclient login

Następnie utwórz token przy użyciu następującego polecenia. Token jest automatycznie kopiowany do schowka, aby można było go wkleić do innego narzędzia.

armclient token

Tworzenie ładunku

Ładunek żądania to kod JSON, który definiuje co najmniej jedno zapytanie i lokalizację, w której powinien być przechowywany pakiet zapytań. Nazwa pakietu zapytania jest określona w żądaniu interfejsu API opisanym w następnej sekcji.

{
    "location": "eastus",
    "properties":
    {
        "displayName": "Query name that will be displayed in the UI",
        "description": "Query description that will be displayed in the UI",
        "body": "<<query text, standard KQL code>>",
        "related": {
            "categories": [
                "workloads"
            ],
            "resourceTypes": [
                "microsoft.insights/components"
            ],
            "solutions": [
                "logmanagement"
            ]
        },
        "tags": {
            "Tag1": [
                "Value1",
                "Value2"
            ]
        }
    }
}

Każde zapytanie w pakiecie zapytań ma następujące właściwości:

Właściwości opis
displayName Nazwa wyświetlana wyświetlana wyświetlana w usłudze Log Analytics dla każdego zapytania.
description Opis zapytania wyświetlanego w usłudze Log Analytics dla każdego zapytania.
body Zapytanie napisane w język zapytań Kusto.
related Powiązane kategorie, typy zasobów i rozwiązania dla zapytania. Służy do grupowania i filtrowania w usłudze Log Analytics przez użytkownika w celu ułatwienia zlokalizowania zapytania. Każde zapytanie może mieć maksymalnie 10 każdego typu. Pobierz dozwolone wartości z https://api.loganalytics.io/v1/metadata?select=resourceTypeskategorii , rozwiązań i kategorii.
tags Inne tagi używane przez użytkownika do sortowania i filtrowania w usłudze Log Analytics. Każdy tag zostanie dodany do kategorii, typu zasobu i rozwiązania podczas grupowania i filtrowania zapytań.

Utwórz żądanie

Użyj następującego żądania, aby utworzyć nowy pakiet zapytań przy użyciu interfejsu API REST. Żądanie powinno używać autoryzacji tokenu elementu nośnego. Typ zawartości powinien mieć wartość application/json.

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/querypacks/my-query-pack?api-version=2019-09-01

Użyj narzędzia, które może przesłać żądanie interfejsu API REST, takie jak Fiddler lub Postman, aby przesłać żądanie przy użyciu ładunku opisanego w poprzedniej sekcji. Identyfikator zapytania zostanie wygenerowany i zwrócony w ładunku.

Aktualizowanie pakietu zapytań

Aby zaktualizować pakiet zapytań, prześlij następujące żądanie ze zaktualizowanym ładunkiem. To polecenie wymaga identyfikatora pakietu zapytań.

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/querypacks/my-query-pack/queries/query-id/?api-version=2019-09-01

Następne kroki

Zobacz Używanie zapytań w usłudze Azure Monitor Log Analytics , aby zobaczyć, jak użytkownicy wchodzą w interakcje z pakietami zapytań w usłudze Log Analytics.