Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Artykuł
12/21/2024

Uwagi

Aby uzyskać wskazówki dotyczące wdrażania rozwiązań do monitorowania, zobacz Create monitoring resources by using Bicep.

Definicja zasobu Bicep

Typ zasobu scheduledQueryRules można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Insights/scheduledQueryRules, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Insights/scheduledQueryRules@2020-05-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionGroupId: 'string'
        webHookProperties: {
          {customized property}: 'string'
        }
      }
    ]
    criteria: {
      allOf: [
        {
          dimensions: [
            {
              name: 'string'
              operator: 'string'
              values: [
                'string'
              ]
            }
          ]
          failingPeriods: {
            minFailingPeriodsToAlert: int
            numberOfEvaluationPeriods: int
          }
          metricMeasureColumn: 'string'
          operator: 'string'
          query: 'string'
          resourceIdColumn: 'string'
          threshold: int
          timeAggregation: 'string'
        }
      ]
    }
    description: 'string'
    displayName: 'string'
    enabled: bool
    evaluationFrequency: 'string'
    muteActionsDuration: 'string'
    overrideQueryTimeRange: 'string'
    scopes: [
      'string'
    ]
    severity: int
    targetResourceTypes: [
      'string'
    ]
    windowSize: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Wartości właściwości

Akcja

Nazwa	Opis	Wartość
actionGroupId	Identyfikator zasobu grupy akcji, który ma być wywoływany, gdy alert zostanie wyzwolony.	struna
webHookProperties	Właściwości obiektu elementu webhook.	ActionWebHookProperties

ActionWebHookProperties

Nazwa	Opis	Wartość

Warunek

Nazwa	Opis	Wartość
Wymiary	Lista warunków wymiarów	Wymiar[]
failPeriods	Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganym do zgłaszania alertu.	ConditionFailingPeriods
metricMeasureColumn	Kolumna zawierająca numer miary metryki.	struna
operator	Operator kryteriów.	"Równa się" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane)
zapytanie	Alert zapytania dziennika	struna
resourceIdColumn	Kolumna zawierająca identyfikator zasobu. Zawartość kolumny musi być identyfikatorem URI sformatowanym jako identyfikator zasobu	struna
próg	wartość progowa kryteriów, która aktywuje alert.	int (wymagane)
timeAggregation	Typ agregacji	"Średnia" "Liczba" "Maksimum" "Minimum" "Total" (wymagane)

ConditionFailingPeriods

Nazwa	Opis	Wartość
minFailingPeriodsToAlert	Liczba naruszeń wyzwalania alertu. Powinna być mniejsza lub równa numberOfEvaluationPeriods. Wartość domyślna to 1	Int
numberOfEvaluationPeriods	Liczba zagregowanych punktów wyszukiwania. Przedział czasu wyszukiwania jest obliczany na podstawie stopnia szczegółowości agregacji (windowSize) i wybranej liczby zagregowanych punktów. Wartość domyślna to 1	Int

Wymiar

Nazwa	Opis	Wartość
nazwa	Nazwa wymiaru	ciąg (wymagany)
operator	Operator dla wartości wymiarów	"Wyklucz" "Dołącz" (wymagane)
Wartości	Lista wartości wymiarów	string[] (wymagane)

Microsoft.Insights/scheduledQueryRules

Nazwa	Opis	Wartość
lokalizacja	Lokalizacja geograficzna, w której znajduje się zasób	ciąg (wymagany)
nazwa	Nazwa zasobu	struna Ograniczenia: Wzorzec = `^[^#<>%&:\?/{}*]{1,260}$` (wymagane)
Właściwości	Właściwości reguły zasobu.	ScheduledQueryRuleProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach

ScheduledQueryRuleCriteria

Nazwa	Opis	Wartość
allOf	Lista warunków do oceny pod kątem określonych zakresów	warunek[]

ScheduledQueryRuleProperties

Nazwa	Opis	Wartość
akcje		akcja[]
Kryteria	Kryteria reguły definiujące warunki reguły zaplanowanego zapytania.	ScheduledQueryRuleCriteria
opis	Opis reguły zaplanowanego zapytania.	struna
displayName	Nazwa wyświetlana reguły alertu	struna
Włączone	Flaga wskazująca, czy ta zaplanowana reguła zapytania jest włączona. Wartość powinna mieć wartość true lub false	Bool
evaluationFrequency	Częstotliwość oceniania reguły zaplanowanego zapytania jest reprezentowana w formacie czasu trwania ISO 8601.	struna
muteActionsDuration	Akcje wyciszania dla wybranego okresu (w formacie czasu trwania ISO 8601) po wyzwoleniu alertu.	struna
overrideQueryTimeRange	Jeśli zostanie określony, zastąpi zakres czasu zapytania (wartość domyślna to WindowSize*NumberOfEvaluationPeriods)	struna
Zakresów	Lista identyfikatorów zasobów, do których jest ograniczona ta zaplanowana reguła zapytania.	string[]
dotkliwość	Ważność alertu. Powinna być liczbą całkowitą z zakresu od [0 do 4]. Wartość 0 jest najcięższa	Int
targetResourceTypes	Lista typów zasobów docelowych zasobów, na których jest tworzony/aktualizowany alert. Jeśli na przykład zakres to grupa zasobów, a targetResourceTypes to Microsoft.Compute/virtualMachines, zostanie wyzwolony inny alert dla każdej maszyny wirtualnej w grupie zasobów, która spełnia kryteria alertu	string[]
windowSize	Okres czasu (w formacie czasu trwania ISO 8601), na którym zostanie wykonane zapytanie alertu (rozmiar pojemnika).	struna

TrackedResourceTags

Nazwa	Opis	Wartość

Definicja zasobu szablonu usługi ARM

Typ zasobu scheduledQueryRules można wdrożyć przy użyciu operacji docelowych:

grupy zasobów — zobacz polecenia wdrażania grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Insights/scheduledQueryRules, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Insights/scheduledQueryRules",
  "apiVersion": "2020-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [
      {
        "actionGroupId": "string",
        "webHookProperties": {
          "{customized property}": "string"
        }
      }
    ],
    "criteria": {
      "allOf": [
        {
          "dimensions": [
            {
              "name": "string",
              "operator": "string",
              "values": [ "string" ]
            }
          ],
          "failingPeriods": {
            "minFailingPeriodsToAlert": "int",
            "numberOfEvaluationPeriods": "int"
          },
          "metricMeasureColumn": "string",
          "operator": "string",
          "query": "string",
          "resourceIdColumn": "string",
          "threshold": "int",
          "timeAggregation": "string"
        }
      ]
    },
    "description": "string",
    "displayName": "string",
    "enabled": "bool",
    "evaluationFrequency": "string",
    "muteActionsDuration": "string",
    "overrideQueryTimeRange": "string",
    "scopes": [ "string" ],
    "severity": "int",
    "targetResourceTypes": [ "string" ],
    "windowSize": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Wartości właściwości

Akcja

Nazwa	Opis	Wartość
actionGroupId	Identyfikator zasobu grupy akcji, który ma być wywoływany, gdy alert zostanie wyzwolony.	struna
webHookProperties	Właściwości obiektu elementu webhook.	ActionWebHookProperties

ActionWebHookProperties

Nazwa	Opis	Wartość

Warunek

Nazwa	Opis	Wartość
Wymiary	Lista warunków wymiarów	Wymiar[]
failPeriods	Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganym do zgłaszania alertu.	ConditionFailingPeriods
metricMeasureColumn	Kolumna zawierająca numer miary metryki.	struna
operator	Operator kryteriów.	"Równa się" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane)
zapytanie	Alert zapytania dziennika	struna
resourceIdColumn	Kolumna zawierająca identyfikator zasobu. Zawartość kolumny musi być identyfikatorem URI sformatowanym jako identyfikator zasobu	struna
próg	wartość progowa kryteriów, która aktywuje alert.	int (wymagane)
timeAggregation	Typ agregacji	"Średnia" "Liczba" "Maksimum" "Minimum" "Total" (wymagane)

ConditionFailingPeriods

Nazwa	Opis	Wartość
minFailingPeriodsToAlert	Liczba naruszeń wyzwalania alertu. Powinna być mniejsza lub równa numberOfEvaluationPeriods. Wartość domyślna to 1	Int
numberOfEvaluationPeriods	Liczba zagregowanych punktów wyszukiwania. Przedział czasu wyszukiwania jest obliczany na podstawie stopnia szczegółowości agregacji (windowSize) i wybranej liczby zagregowanych punktów. Wartość domyślna to 1	Int

Wymiar

Nazwa	Opis	Wartość
nazwa	Nazwa wymiaru	ciąg (wymagany)
operator	Operator dla wartości wymiarów	"Wyklucz" "Dołącz" (wymagane)
Wartości	Lista wartości wymiarów	string[] (wymagane)

Microsoft.Insights/scheduledQueryRules

Nazwa	Opis	Wartość
apiVersion	Wersja interfejsu API	"2020-05-01-preview"
lokalizacja	Lokalizacja geograficzna, w której znajduje się zasób	ciąg (wymagany)
nazwa	Nazwa zasobu	struna Ograniczenia: Wzorzec = `^[^#<>%&:\?/{}*]{1,260}$` (wymagane)
Właściwości	Właściwości reguły zasobu.	ScheduledQueryRuleProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ	Typ zasobu	"Microsoft.Insights/scheduledQueryRules"

ScheduledQueryRuleCriteria

Nazwa	Opis	Wartość
allOf	Lista warunków do oceny pod kątem określonych zakresów	warunek[]

ScheduledQueryRuleProperties

Nazwa	Opis	Wartość
akcje		akcja[]
Kryteria	Kryteria reguły definiujące warunki reguły zaplanowanego zapytania.	ScheduledQueryRuleCriteria
opis	Opis reguły zaplanowanego zapytania.	struna
displayName	Nazwa wyświetlana reguły alertu	struna
Włączone	Flaga wskazująca, czy ta zaplanowana reguła zapytania jest włączona. Wartość powinna mieć wartość true lub false	Bool
evaluationFrequency	Częstotliwość oceniania reguły zaplanowanego zapytania jest reprezentowana w formacie czasu trwania ISO 8601.	struna
muteActionsDuration	Akcje wyciszania dla wybranego okresu (w formacie czasu trwania ISO 8601) po wyzwoleniu alertu.	struna
overrideQueryTimeRange	Jeśli zostanie określony, zastąpi zakres czasu zapytania (wartość domyślna to WindowSize*NumberOfEvaluationPeriods)	struna
Zakresów	Lista identyfikatorów zasobów, do których jest ograniczona ta zaplanowana reguła zapytania.	string[]
dotkliwość	Ważność alertu. Powinna być liczbą całkowitą z zakresu od [0 do 4]. Wartość 0 jest najcięższa	Int
targetResourceTypes	Lista typów zasobów docelowych zasobów, na których jest tworzony/aktualizowany alert. Jeśli na przykład zakres to grupa zasobów, a targetResourceTypes to Microsoft.Compute/virtualMachines, zostanie wyzwolony inny alert dla każdej maszyny wirtualnej w grupie zasobów, która spełnia kryteria alertu	string[]
windowSize	Okres czasu (w formacie czasu trwania ISO 8601), na którym zostanie wykonane zapytanie alertu (rozmiar pojemnika).	struna

TrackedResourceTags

Nazwa	Opis	Wartość

Szablony szybkiego startu

Następujące szablony szybkiego startu wdrażają ten typ zasobu.

Szablon	Opis
Tworzenie reguły alertu dla elementów ciągłości działania platformy Azure Wdrażanie do Azure	Te szablony tworzą regułę alertu i przypisaną przez użytkownika tożsamość usługi zarządzanej. Przypisuje również czytelnikowi tożsamości usługi zarządzanej dostęp do subskrypcji, dzięki czemu reguła alertu ma dostęp do wykonywania zapytań dotyczących wymaganych elementów chronionych i najnowszych szczegółów punktu odzyskiwania.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu scheduledQueryRules można wdrożyć przy użyciu operacji docelowych:

grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.Insights/scheduledQueryRules, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionGroupId = "string"
          webHookProperties = {
            {customized property} = "string"
          }
        }
      ]
      criteria = {
        allOf = [
          {
            dimensions = [
              {
                name = "string"
                operator = "string"
                values = [
                  "string"
                ]
              }
            ]
            failingPeriods = {
              minFailingPeriodsToAlert = int
              numberOfEvaluationPeriods = int
            }
            metricMeasureColumn = "string"
            operator = "string"
            query = "string"
            resourceIdColumn = "string"
            threshold = int
            timeAggregation = "string"
          }
        ]
      }
      description = "string"
      displayName = "string"
      enabled = bool
      evaluationFrequency = "string"
      muteActionsDuration = "string"
      overrideQueryTimeRange = "string"
      scopes = [
        "string"
      ]
      severity = int
      targetResourceTypes = [
        "string"
      ]
      windowSize = "string"
    }
  })
}

Wartości właściwości

Akcja

Nazwa	Opis	Wartość
actionGroupId	Identyfikator zasobu grupy akcji, który ma być wywoływany, gdy alert zostanie wyzwolony.	struna
webHookProperties	Właściwości obiektu elementu webhook.	ActionWebHookProperties

ActionWebHookProperties

Nazwa	Opis	Wartość

Warunek

Nazwa	Opis	Wartość
Wymiary	Lista warunków wymiarów	Wymiar[]
failPeriods	Minimalna liczba naruszeń wymaganych w wybranym przedziale czasu wyszukiwania wymaganym do zgłaszania alertu.	ConditionFailingPeriods
metricMeasureColumn	Kolumna zawierająca numer miary metryki.	struna
operator	Operator kryteriów.	"Równa się" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (wymagane)
zapytanie	Alert zapytania dziennika	struna
resourceIdColumn	Kolumna zawierająca identyfikator zasobu. Zawartość kolumny musi być identyfikatorem URI sformatowanym jako identyfikator zasobu	struna
próg	wartość progowa kryteriów, która aktywuje alert.	int (wymagane)
timeAggregation	Typ agregacji	"Średnia" "Liczba" "Maksimum" "Minimum" "Total" (wymagane)

ConditionFailingPeriods

Nazwa	Opis	Wartość
minFailingPeriodsToAlert	Liczba naruszeń wyzwalania alertu. Powinna być mniejsza lub równa numberOfEvaluationPeriods. Wartość domyślna to 1	Int
numberOfEvaluationPeriods	Liczba zagregowanych punktów wyszukiwania. Przedział czasu wyszukiwania jest obliczany na podstawie stopnia szczegółowości agregacji (windowSize) i wybranej liczby zagregowanych punktów. Wartość domyślna to 1	Int

Wymiar

Nazwa	Opis	Wartość
nazwa	Nazwa wymiaru	ciąg (wymagany)
operator	Operator dla wartości wymiarów	"Wyklucz" "Dołącz" (wymagane)
Wartości	Lista wartości wymiarów	string[] (wymagane)

Microsoft.Insights/scheduledQueryRules

Nazwa	Opis	Wartość
lokalizacja	Lokalizacja geograficzna, w której znajduje się zasób	ciąg (wymagany)
nazwa	Nazwa zasobu	struna Ograniczenia: Wzorzec = `^[^#<>%&:\?/{}*]{1,260}$` (wymagane)
Właściwości	Właściwości reguły zasobu.	ScheduledQueryRuleProperties (wymagane)
Tagi	Tagi zasobów	Słownik nazw tagów i wartości.
typ	Typ zasobu	"Microsoft.Insights/scheduledQueryRules@2020-05-01-preview"

ScheduledQueryRuleCriteria

Nazwa	Opis	Wartość
allOf	Lista warunków do oceny pod kątem określonych zakresów	warunek[]

ScheduledQueryRuleProperties

Nazwa	Opis	Wartość
akcje		akcja[]
Kryteria	Kryteria reguły definiujące warunki reguły zaplanowanego zapytania.	ScheduledQueryRuleCriteria
opis	Opis reguły zaplanowanego zapytania.	struna
displayName	Nazwa wyświetlana reguły alertu	struna
Włączone	Flaga wskazująca, czy ta zaplanowana reguła zapytania jest włączona. Wartość powinna mieć wartość true lub false	Bool
evaluationFrequency	Częstotliwość oceniania reguły zaplanowanego zapytania jest reprezentowana w formacie czasu trwania ISO 8601.	struna
muteActionsDuration	Akcje wyciszania dla wybranego okresu (w formacie czasu trwania ISO 8601) po wyzwoleniu alertu.	struna
overrideQueryTimeRange	Jeśli zostanie określony, zastąpi zakres czasu zapytania (wartość domyślna to WindowSize*NumberOfEvaluationPeriods)	struna
Zakresów	Lista identyfikatorów zasobów, do których jest ograniczona ta zaplanowana reguła zapytania.	string[]
dotkliwość	Ważność alertu. Powinna być liczbą całkowitą z zakresu od [0 do 4]. Wartość 0 jest najcięższa	Int
targetResourceTypes	Lista typów zasobów docelowych zasobów, na których jest tworzony/aktualizowany alert. Jeśli na przykład zakres to grupa zasobów, a targetResourceTypes to Microsoft.Compute/virtualMachines, zostanie wyzwolony inny alert dla każdej maszyny wirtualnej w grupie zasobów, która spełnia kryteria alertu	string[]
windowSize	Okres czasu (w formacie czasu trwania ISO 8601), na którym zostanie wykonane zapytanie alertu (rozmiar pojemnika).	struna

TrackedResourceTags

Nazwa	Opis	Wartość

Udostępnij za pośrednictwem

Microsoft.Insights scheduledQueryRules 2020-05-01-preview

Uwagi

Definicja zasobu Bicep

Format zasobu

Wartości właściwości

Akcja

ActionWebHookProperties

Warunek

ConditionFailingPeriods

Wymiar

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Definicja zasobu szablonu usługi ARM

Format zasobu

Wartości właściwości

Akcja

ActionWebHookProperties

Warunek

ConditionFailingPeriods

Wymiar

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Szablony szybkiego startu

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Format zasobu

Wartości właściwości

Akcja

ActionWebHookProperties

Warunek

ConditionFailingPeriods

Wymiar

Microsoft.Insights/scheduledQueryRules

ScheduledQueryRuleCriteria

ScheduledQueryRuleProperties

TrackedResourceTags

Opinia

Dodatkowe zasoby