Byta API-inställning för loggaviseringarSwitch API preference for Log Alerts

Anteckning

Innehåll som anges gäller endast för användare Azures offentliga moln och inte för Azure Government-eller Azure Kina-moln.Content stated applicable to users Azure public cloud only and not for Azure Government or Azure China cloud.

Till nyligen hanterade du aviseringsregler i Microsoft Operations Management Suite-portalen.Until recently, you managed alert rules in the Microsoft Operations Management Suite portal. Den nya aviserings upplevelsen har integrerats med olika tjänster i Microsoft Azure inklusive Log Analytics och vi har bett att Utöka dina aviserings regler från OMS-portalen till Azure.The new alerts experience was integrated with various services in Microsoft Azure including Log Analytics and we asked to extend your alert rules from OMS portal to Azure. Men för att säkerställa minimalt avbrott för kunderna ändrade processen inte programmerings gränssnittet för dess användnings Log Analytics aviserings-API baserat på SavedSearch.But to ensure minimal disruption for customers, the process did not alter the programmatic interface for its consumption - Log Analytics Alert API based on SavedSearch.

Men nu kan du meddela Log Analytics aviserar användare om ett äkta Azure-programalternativ, Azure Monitor-SCHEDULEDQUERYRULES API, som också reflekteras i din Azure-fakturering – för logg aviseringar.But now you announce for Log Analytics alerting users a true Azure programmatic alternative, Azure Monitor - ScheduledQueryRules API, which is also reflective in your Azure billing - for log alerts. Om du vill veta mer om hur du hanterar logg aviseringar med hjälp av API: et, se Hantera logg aviseringar med Azure-resurs mal len och Hantera logg aviseringar med PowerShell.To learn more on how to manage your log alerts using the API, see Managing log alerts using Azure Resource Template and Managing log alerts using PowerShell.

Fördelar med att växla till New Azure-APIBenefits of switching to new Azure API

Det finns flera fördelar med att skapa och hantera aviseringar med hjälp av SCHEDULEDQUERYRULES API över äldre Log Analytics aviserings-API; Vi har listat några av de viktigaste nedan:There are several advantages of creating and managing alerts using scheduledQueryRules API over legacy Log Analytics Alert API; we have listed some of the major ones below:

  • Möjlighet att söka mellan arbets ytans loggs ökning i aviserings regler och utöka externa resurser som Log Analytics arbets ytor eller till och med Application Insights apparAbility to cross workspace log search in alert rules and span up external resources like Log Analytics workspaces or even Application Insights apps
  • När flera fält används för att gruppera i frågor kan du använda SCHEDULEDQUERYRULES API -användare för att ange vilket fält som ska aggregeras i Azure PortalWhen multiple fields used to Group in query, using scheduledQueryRules API user can specify which field to aggregate-on in Azure portal
  • Logg aviseringar som skapats med SCHEDULEDQUERYRULES API kan ha en definierad period på upp till 48 timmar och hämta data under en längre period än tidigareLog alerts created using scheduledQueryRules API can have period defined up to 48 hours and fetch data for longer period than before
  • Skapa aviserings regler i en bild som en enskild resurs utan att behöva skapa tre resurs nivåer som med äldre Log Analytics aviserings-APICreate alert rules in one shot as a single resource without the need to create three levels of resources as with legacy Log Analytics Alert API
  • Ett enda programmerings gränssnitt för alla varianter av frågor baserade logg aviseringar i Azure – New scheduledQueryRules-API kan användas för att hantera regler för Log Analytics samt Application InsightsSingle programmatic interface for all variants of query-based log alerts in Azure - new scheduledQueryRules API can be used to manage rules for Log Analytics as well as Application Insights
  • Hantera dina logg aviseringar med PowerShell-cmdletarManage your log alerts using Powershell cmdlets
  • Alla nya logg aviserings funktioner och framtida utveckling kommer bara att vara tillgängliga via den nya scheduledQueryRules-API: nAll new log alert functionality and future development will be available only via the new scheduledQueryRules API

Process för att växla från äldre logg aviserings-APIProcess of switching from legacy Log Alerts API

Användarna är kostnads fria att använda antingen äldre Log Analytics aviserings-API eller det nya scheduledQueryRules-API: et.Users are free to use either legacy Log Analytics Alert API or the new scheduledQueryRules API. Aviserings regler som skapats av något av API: et kan endast hanteras av samma API – och från Azure Portal.Alert rules created by either API, will be manageable by the same API only - as well as from Azure portal. Som standard fortsätter Azure Monitor att använda äldre Log Analytics varnings-API för att skapa en ny varnings regel från Azure Portal för befintliga arbets ytor i Log Analytics.By default, Azure Monitor will continue to use legacy Log Analytics Alert API for creating any new alert rule from Azure portal for existing workspaces of Log Analytics. Som aviserad ny logg arbets yta som skapats den 1 juni 2019 , kommer automatiskt att använda New scheduledQueryRules-API som standard, inklusive i Azure Portal.As announced new Log workspace created on or after June 1, 2019 - will automatically use new scheduledQueryRules API by default including in Azure portal.

Påverkan av växeln av preferens till scheduledQueryRules-API: n kompileras nedan:The impacts of the switch of preference to scheduledQueryRules API are compiled below:

Processen för att flytta aviserings regler från äldre Log Analytics varnings-API: t inbegriper inte ändring av aviserings definition, fråga eller konfiguration på något sätt.The process of moving alert rules from legacy Log Analytics Alert API does not involve changing your alert definition, query, or configuration in any way. Aviserings reglerna och övervakningen påverkas inte och aviseringarna kommer inte att stoppas eller stoppas, under eller efter växeln.Your alert rules and monitoring are unaffected and the alerts will not stop or be stalled, during or after the switch. De enda ändringarna är:The only changes are:

  • En ändring i API-inställningar och åtkomst till dina regler via ett nytt API.A change in API preference and access to your rules via a new API.
  • En modifierad varnings regel resurs-URI som innehåller de ID: n som används i äldre Log Analytics aviserings-API i stället för varnings regel namnet i den här strukturen <WorkspaceName>|<savedSearchId>|<scheduleId>|<ActionId>A modified alert rule resource URI containing the IDs used in the legacy Log Analytics Alert API instead of the alert rule name in this structure <WorkspaceName>|<savedSearchId>|<scheduleId>|<ActionId>. Visnings namnet för varnings regeln är oförändrat.Display name of the alert rule will remain unchanged.

Anteckning

När en användare väljer att växla inställningar till det nya scheduledQueryRules-API: et går det inte att återgå till att använda den äldre varnings-API: et för äldre Log Analytics.Once a user chooses to switch preference to the new scheduledQueryRules API it is not possible to revert to using of the older legacy Log Analytics Alert API.

En kund som vill växla frivilligt till den nya scheduledQueryRules och blockera användningen från den äldre Log Analytics varnings-API: et. kan göra detta genom att utföra ett parkera-anrop på nedanstående API för att växla alla aviserings regler som är kopplade till den aktuella Log Analytics-arbetsytan.Any customer who wishes to switch voluntarily to the new scheduledQueryRules and block usage from the legacy Log Analytics Alert API; can do so by performing a PUT call on the below API to switch all alert rules associated with the specific Log Analytics workspace.

PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Med en begär ande text som innehåller nedanstående JSON.With request body containing the below JSON.

{
    "scheduledQueryRulesEnabled" : true
}

API: et kan också nås från en PowerShell-kommandorad med hjälp av ARMClient, ett kommando rads verktyg med öppen källkod som gör det enklare att anropa Azure Resource Manager API.The API can also be accessed from a PowerShell command line using ARMClient, an open-source command-line tool that simplifies invoking the Azure Resource Manager API. Som illustreras nedan, i exempel skicka samtal med ARMclient-verktyget för att växla alla aviserings regler som är kopplade till den aktuella Log Analytics-arbetsytan.As illustrated below, in sample PUT call using ARMclient tool to switch all alert rules associated with the specific Log Analytics workspace.

$switchJSON = '{"scheduledQueryRulesEnabled": "true"}'
armclient PUT /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview $switchJSON

Om switchen av alla aviserings regler i Log Analytics arbets ytan för att använda den nya scheduledQueryRules har slutförts, kommer följande svar att tillhandahållas.If switch of all alert rules in the Log Analytics workspace to use new scheduledQueryRules is successful, the following response will be provided.

{
    "version": 2,
    "scheduledQueryRulesEnabled" : true
}

Användare kan också kontrol lera aktuell status för din Log Analytics arbets yta och se om den har eller inte har växlats till att använda scheduledQueryRules .Users can also check the current status of your Log Analytics workspace and see if it has or has not been switched to use scheduledQueryRules only. För att kontrol lera kan användarna utföra ett GET-anrop i nedanstående API.To check, users can perform a GET call on the below API.

GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Om du vill köra ovanstående kommando rad med PowerShell-kommandoraden med hjälp av ARMClient -verktyget, se exemplet nedan.To execute the above in using PowerShell command line using ARMClient tool, see the sample below.

armclient GET /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.OperationalInsights/workspaces/<workspaceName>/alertsversion?api-version=2017-04-26-preview

Om den angivna Log Analytics arbets ytan har växlats till att endast använda scheduledQueryRules . sedan visas svars-JSON enligt listan nedan.If the specified Log Analytics workspace has been switched to use scheduledQueryRules only; then the response JSON will be as listed below.

{
    "version": 2,
    "scheduledQueryRulesEnabled" : true
}

Annars, om den angivna logg analys arbets ytan ännu inte har växlats till att använda scheduledQueryRules . sedan visas svars-JSON enligt listan nedan.Else, if the specified Log Analytic workspace has not yet been switched to use scheduledQueryRules only; then the response JSON will be as listed below.

{
    "version": 2,
    "scheduledQueryRulesEnabled" : false
}

Nästa stegNext steps