Udostępnij za pośrednictwem


Microsoft.AlertsManagement actionRules

Definicja zasobu Bicep

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

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

Format zasobu

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

resource symbolicname 'Microsoft.AlertsManagement/actionRules@2021-08-08' = {
  location: 'string'
  name: 'string'
  properties: {
    actions: [
      {
        actionType: 'string'
        // For remaining properties, see Action objects
      }
    ]
    conditions: [
      {
        field: 'string'
        operator: 'string'
        values: [
          'string'
        ]
      }
    ]
    description: 'string'
    enabled: bool
    schedule: {
      effectiveFrom: 'string'
      effectiveUntil: 'string'
      recurrences: [
        {
          endTime: 'string'
          startTime: 'string'
          recurrenceType: 'string'
          // For remaining properties, see Recurrence objects
        }
      ]
      timeZone: 'string'
    }
    scopes: [
      'string'
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Obiekty akcji

Ustaw właściwość actionType, aby określić typ obiektu.

W przypadku addActionGroupsużyj:

{
  actionGroupIds: [
    'string'
  ]
  actionType: 'AddActionGroups'
}

W przypadku RemoveAllActionGroupsużyj:

{
  actionType: 'RemoveAllActionGroups'
}

Obiekty cyklu

Ustaw właściwość recurrenceType, aby określić typ obiektu.

W przypadku dailyużyj:

{
  recurrenceType: 'Daily'
}

W przypadku miesięcznegoużyj:

{
  daysOfMonth: [
    int
  ]
  recurrenceType: 'Monthly'
}

W przypadku cotygodniowegoużyj:

{
  daysOfWeek: [
    'string'
  ]
  recurrenceType: 'Weekly'
}

Wartości właściwości

Akcja

Nazwa Opis Wartość
actionType Ustaw wartość "AddActionGroups" dla typu AddActionGroups. Ustaw wartość "RemoveAllActionGroups" dla typu RemoveAllActionGroups. "AddActionGroups"
"RemoveAllActionGroups" (wymagane)

AddActionGroups

Nazwa Opis Wartość
actionGroupIds Lista identyfikatorów grupy akcji do dodania do reguły przetwarzania alertów. string[] (wymagane)
actionType Akcja, która powinna zostać zastosowana. "AddActionGroups" (wymagane)

AlertProcessingRuleProperties

Nazwa Opis Wartość
akcje Akcje do zastosowania. akcja[] (wymagane)
Warunki Warunki, w których będą filtrowane alerty. warunek[]
opis Opis reguły przetwarzania alertów. struna
Włączone Wskazuje, czy dana reguła przetwarzania alertów jest włączona lub wyłączona. Bool
harmonogram Planowanie reguły przetwarzania alertów. harmonogram
Zakresów Zakresy, w których zostanie zastosowana reguła przetwarzania alertów. string[] (wymagane)

Warunek

Nazwa Opis Wartość
pole Pole dla danego warunku. "AlertContext"
"AlertRuleId"
"AlertRuleName"
"Opis"
"MonitorCondition"
"MonitorService"
"Ważność"
"SignalType"
"TargetResource"
"TargetResourceGroup"
"TargetResourceType"
operator Operator dla danego warunku. "Zawiera"
"DoesNotContain"
"Równa się"
"NotEquals"
Wartości Lista wartości, które mają być zgodne z danym warunkiem. string[]

DailyRecurrence

Nazwa Opis Wartość
recurrenceType Określa, kiedy ma być stosowany cykl. "Codziennie" (wymagane)

ManagedResourceTags

Nazwa Opis Wartość

Microsoft.AlertsManagement/actionRules

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości reguły przetwarzania alertów. AlertProcessingRuleProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

MonthlyRecurrence

Nazwa Opis Wartość
daysOfMonth Określa wartości wzorca cyklu miesięcznego. int[] (wymagane)
recurrenceType Określa, kiedy ma być stosowany cykl. "Co miesiąc" (wymagane)

Nawrót

Nazwa Opis Wartość
endTime Godzina zakończenia cyklu. struna
recurrenceType Ustaw wartość "Daily" dla typu DailyRecurrence. Ustaw wartość "Monthly" dla typu MonthlyRecurrence. Ustaw wartość "Weekly" dla typu WeeklyRecurrence. "Codziennie"
"Co miesiąc"
"Co tydzień" (wymagane)
startTime Godzina rozpoczęcia cyklu. struna

RemoveAllActionGroups

Nazwa Opis Wartość
actionType Akcja, która powinna zostać zastosowana. "RemoveAllActionGroups" (wymagane)

Harmonogram

Nazwa Opis Wartość
effectiveFrom Planowanie efektywne od czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej. struna

Ograniczenia:
Wzorzec = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectiveUntil Planowanie skuteczne do czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej. struna

Ograniczenia:
Wzorzec = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Nawrotów Lista cykli. cykl[]
strefa czasowa Planowanie strefy czasowej. struna

Co tydzieńRecurrence

Nazwa Opis Wartość
daysOfWeek Określa wartości wzorca cyklu tygodniowego. Tablica ciągów zawierająca dowolną z:
"Piątek"
"Poniedziałek"
"Sobota"
"Niedziela"
"Czwartek"
"Wtorek"
"Środa" (wymagane)
recurrenceType Określa, kiedy ma być stosowany cykl. "Co tydzień" (wymagane)

Przykłady użycia

Moduły zweryfikowane na platformie Azure

Następujące moduły zweryfikowane platformy Azure mogą służyć do wdrażania tego typu zasobu.

Moduł Opis
reguł akcji Moduł zasobów AVM dla reguł akcji

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
powiadomienia instalatora alertów kopii zapasowej przy użyciu usługi Azure Monitor Ten szablon umożliwia konfigurowanie powiadomień e-mail dla magazynów usługi Recovery Services przy użyciu usługi Azure Monitor przez wdrożenie reguły przetwarzania alertów i grupy akcji

Definicja zasobu szablonu usługi ARM

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

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

Format zasobu

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

{
  "type": "Microsoft.AlertsManagement/actionRules",
  "apiVersion": "2021-08-08",
  "name": "string",
  "location": "string",
  "properties": {
    "actions": [ {
      "actionType": "string"
      // For remaining properties, see Action objects
    } ],
    "conditions": [
      {
        "field": "string",
        "operator": "string",
        "values": [ "string" ]
      }
    ],
    "description": "string",
    "enabled": "bool",
    "schedule": {
      "effectiveFrom": "string",
      "effectiveUntil": "string",
      "recurrences": [ {
        "endTime": "string",
        "startTime": "string",
        "recurrenceType": "string"
        // For remaining properties, see Recurrence objects
      } ],
      "timeZone": "string"
    },
    "scopes": [ "string" ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Obiekty akcji

Ustaw właściwość actionType, aby określić typ obiektu.

W przypadku addActionGroupsużyj:

{
  "actionGroupIds": [ "string" ],
  "actionType": "AddActionGroups"
}

W przypadku RemoveAllActionGroupsużyj:

{
  "actionType": "RemoveAllActionGroups"
}

Obiekty cyklu

Ustaw właściwość recurrenceType, aby określić typ obiektu.

W przypadku dailyużyj:

{
  "recurrenceType": "Daily"
}

W przypadku miesięcznegoużyj:

{
  "daysOfMonth": [ "int" ],
  "recurrenceType": "Monthly"
}

W przypadku cotygodniowegoużyj:

{
  "daysOfWeek": [ "string" ],
  "recurrenceType": "Weekly"
}

Wartości właściwości

Akcja

Nazwa Opis Wartość
actionType Ustaw wartość "AddActionGroups" dla typu AddActionGroups. Ustaw wartość "RemoveAllActionGroups" dla typu RemoveAllActionGroups. "AddActionGroups"
"RemoveAllActionGroups" (wymagane)

AddActionGroups

Nazwa Opis Wartość
actionGroupIds Lista identyfikatorów grupy akcji do dodania do reguły przetwarzania alertów. string[] (wymagane)
actionType Akcja, która powinna zostać zastosowana. "AddActionGroups" (wymagane)

AlertProcessingRuleProperties

Nazwa Opis Wartość
akcje Akcje do zastosowania. akcja[] (wymagane)
Warunki Warunki, w których będą filtrowane alerty. warunek[]
opis Opis reguły przetwarzania alertów. struna
Włączone Wskazuje, czy dana reguła przetwarzania alertów jest włączona lub wyłączona. Bool
harmonogram Planowanie reguły przetwarzania alertów. harmonogram
Zakresów Zakresy, w których zostanie zastosowana reguła przetwarzania alertów. string[] (wymagane)

Warunek

Nazwa Opis Wartość
pole Pole dla danego warunku. "AlertContext"
"AlertRuleId"
"AlertRuleName"
"Opis"
"MonitorCondition"
"MonitorService"
"Ważność"
"SignalType"
"TargetResource"
"TargetResourceGroup"
"TargetResourceType"
operator Operator dla danego warunku. "Zawiera"
"DoesNotContain"
"Równa się"
"NotEquals"
Wartości Lista wartości, które mają być zgodne z danym warunkiem. string[]

DailyRecurrence

Nazwa Opis Wartość
recurrenceType Określa, kiedy ma być stosowany cykl. "Codziennie" (wymagane)

ManagedResourceTags

Nazwa Opis Wartość

Microsoft.AlertsManagement/actionRules

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2021-08-08'
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości reguły przetwarzania alertów. AlertProcessingRuleProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.AlertsManagement/actionRules"

MonthlyRecurrence

Nazwa Opis Wartość
daysOfMonth Określa wartości wzorca cyklu miesięcznego. int[] (wymagane)
recurrenceType Określa, kiedy ma być stosowany cykl. "Co miesiąc" (wymagane)

Nawrót

Nazwa Opis Wartość
endTime Godzina zakończenia cyklu. struna
recurrenceType Ustaw wartość "Daily" dla typu DailyRecurrence. Ustaw wartość "Monthly" dla typu MonthlyRecurrence. Ustaw wartość "Weekly" dla typu WeeklyRecurrence. "Codziennie"
"Co miesiąc"
"Co tydzień" (wymagane)
startTime Godzina rozpoczęcia cyklu. struna

RemoveAllActionGroups

Nazwa Opis Wartość
actionType Akcja, która powinna zostać zastosowana. "RemoveAllActionGroups" (wymagane)

Harmonogram

Nazwa Opis Wartość
effectiveFrom Planowanie efektywne od czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej. struna

Ograniczenia:
Wzorzec = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectiveUntil Planowanie skuteczne do czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej. struna

Ograniczenia:
Wzorzec = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Nawrotów Lista cykli. cykl[]
strefa czasowa Planowanie strefy czasowej. struna

Co tydzieńRecurrence

Nazwa Opis Wartość
daysOfWeek Określa wartości wzorca cyklu tygodniowego. Tablica ciągów zawierająca dowolną z:
"Piątek"
"Poniedziałek"
"Sobota"
"Niedziela"
"Czwartek"
"Wtorek"
"Środa" (wymagane)
recurrenceType Określa, kiedy ma być stosowany cykl. "Co tydzień" (wymagane)

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
powiadomienia instalatora alertów kopii zapasowej przy użyciu usługi Azure Monitor

wdrażanie w usłudze Azure
Ten szablon umożliwia konfigurowanie powiadomień e-mail dla magazynów usługi Recovery Services przy użyciu usługi Azure Monitor przez wdrożenie reguły przetwarzania alertów i grupy akcji

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu actionRules 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.AlertsManagement/actionRules, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AlertsManagement/actionRules@2021-08-08"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      actions = [
        {
          actionType = "string"
          // For remaining properties, see Action objects
        }
      ]
      conditions = [
        {
          field = "string"
          operator = "string"
          values = [
            "string"
          ]
        }
      ]
      description = "string"
      enabled = bool
      schedule = {
        effectiveFrom = "string"
        effectiveUntil = "string"
        recurrences = [
          {
            endTime = "string"
            startTime = "string"
            recurrenceType = "string"
            // For remaining properties, see Recurrence objects
          }
        ]
        timeZone = "string"
      }
      scopes = [
        "string"
      ]
    }
  })
}

Obiekty akcji

Ustaw właściwość actionType, aby określić typ obiektu.

W przypadku addActionGroupsużyj:

{
  actionGroupIds = [
    "string"
  ]
  actionType = "AddActionGroups"
}

W przypadku RemoveAllActionGroupsużyj:

{
  actionType = "RemoveAllActionGroups"
}

Obiekty cyklu

Ustaw właściwość recurrenceType, aby określić typ obiektu.

W przypadku dailyużyj:

{
  recurrenceType = "Daily"
}

W przypadku miesięcznegoużyj:

{
  daysOfMonth = [
    int
  ]
  recurrenceType = "Monthly"
}

W przypadku cotygodniowegoużyj:

{
  daysOfWeek = [
    "string"
  ]
  recurrenceType = "Weekly"
}

Wartości właściwości

Akcja

Nazwa Opis Wartość
actionType Ustaw wartość "AddActionGroups" dla typu AddActionGroups. Ustaw wartość "RemoveAllActionGroups" dla typu RemoveAllActionGroups. "AddActionGroups"
"RemoveAllActionGroups" (wymagane)

AddActionGroups

Nazwa Opis Wartość
actionGroupIds Lista identyfikatorów grupy akcji do dodania do reguły przetwarzania alertów. string[] (wymagane)
actionType Akcja, która powinna zostać zastosowana. "AddActionGroups" (wymagane)

AlertProcessingRuleProperties

Nazwa Opis Wartość
akcje Akcje do zastosowania. akcja[] (wymagane)
Warunki Warunki, w których będą filtrowane alerty. warunek[]
opis Opis reguły przetwarzania alertów. struna
Włączone Wskazuje, czy dana reguła przetwarzania alertów jest włączona lub wyłączona. Bool
harmonogram Planowanie reguły przetwarzania alertów. harmonogram
Zakresów Zakresy, w których zostanie zastosowana reguła przetwarzania alertów. string[] (wymagane)

Warunek

Nazwa Opis Wartość
pole Pole dla danego warunku. "AlertContext"
"AlertRuleId"
"AlertRuleName"
"Opis"
"MonitorCondition"
"MonitorService"
"Ważność"
"SignalType"
"TargetResource"
"TargetResourceGroup"
"TargetResourceType"
operator Operator dla danego warunku. "Zawiera"
"DoesNotContain"
"Równa się"
"NotEquals"
Wartości Lista wartości, które mają być zgodne z danym warunkiem. string[]

DailyRecurrence

Nazwa Opis Wartość
recurrenceType Określa, kiedy ma być stosowany cykl. "Codziennie" (wymagane)

ManagedResourceTags

Nazwa Opis Wartość

Microsoft.AlertsManagement/actionRules

Nazwa Opis Wartość
lokalizacja Lokalizacja zasobu ciąg (wymagany)
nazwa Nazwa zasobu ciąg (wymagany)
Właściwości Właściwości reguły przetwarzania alertów. AlertProcessingRuleProperties
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.AlertsManagement/actionRules@2021-08-08"

MonthlyRecurrence

Nazwa Opis Wartość
daysOfMonth Określa wartości wzorca cyklu miesięcznego. int[] (wymagane)
recurrenceType Określa, kiedy ma być stosowany cykl. "Co miesiąc" (wymagane)

Nawrót

Nazwa Opis Wartość
endTime Godzina zakończenia cyklu. struna
recurrenceType Ustaw wartość "Daily" dla typu DailyRecurrence. Ustaw wartość "Monthly" dla typu MonthlyRecurrence. Ustaw wartość "Weekly" dla typu WeeklyRecurrence. "Codziennie"
"Co miesiąc"
"Co tydzień" (wymagane)
startTime Godzina rozpoczęcia cyklu. struna

RemoveAllActionGroups

Nazwa Opis Wartość
actionType Akcja, która powinna zostać zastosowana. "RemoveAllActionGroups" (wymagane)

Harmonogram

Nazwa Opis Wartość
effectiveFrom Planowanie efektywne od czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej. struna

Ograniczenia:
Wzorzec = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectiveUntil Planowanie skuteczne do czasu. Date-Time w formacie ISO-8601 bez sufiksu strefy czasowej. struna

Ograniczenia:
Wzorzec = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Nawrotów Lista cykli. cykl[]
strefa czasowa Planowanie strefy czasowej. struna

Co tydzieńRecurrence

Nazwa Opis Wartość
daysOfWeek Określa wartości wzorca cyklu tygodniowego. Tablica ciągów zawierająca dowolną z:
"Piątek"
"Poniedziałek"
"Sobota"
"Niedziela"
"Czwartek"
"Wtorek"
"Środa" (wymagane)
recurrenceType Określa, kiedy ma być stosowany cykl. "Co tydzień" (wymagane)