Microsoft.AlertsManagement actionRules

Artigo
07/20/2023

Definição de recurso do Bicep

O tipo de recurso actionRules pode ser implantado em:

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.AlertsManagement/actionRules, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.AlertsManagement/actionRules@2021-08-08' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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'
    ]
  }
}

Objetos de ação

Defina a propriedade actionType para especificar o tipo de objeto.

Para AddActionGroups, use:

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

Para RemoveAllActionGroups, use:

  actionType: 'RemoveAllActionGroups'

Objetos de recorrência

Defina a propriedade recurrenceType para especificar o tipo de objeto.

Para Diário, use:

  recurrenceType: 'Daily'

Para Mensal, use:

  recurrenceType: 'Monthly'
  daysOfMonth: [
    int
  ]

Para Semanalmente, use:

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

Valores de propriedade

actionRules

Nome	Descrição	Valor
name	O nome do recurso	cadeia de caracteres (obrigatório)
local	Localização do recurso	cadeia de caracteres (obrigatório)
marcas	Marcações de recursos	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties	Propriedades da regra de processamento de alertas.	AlertProcessingRuleProperties

AlertProcessingRuleProperties

Nome	Descrição	Valor
Ações	Ações a serem aplicadas.	Action[] (obrigatório)
condições	Condições nas quais os alertas serão filtrados.	Condição[]
descrição	Descrição da regra de processamento de alertas.	string
Habilitado	Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada.	bool
schedule	Agendamento para a regra de processamento de alertas.	Agenda
escopos	Escopos nos quais a regra de processamento de alerta será aplicada.	string[] (obrigatório)

Ação

Nome	Descrição	Valor
actionType	Definir o tipo de objeto	AddActionGroups RemoveAllActionGroups (obrigatório)

AddActionGroups

Nome	Descrição	Valor
actionType	Ação que deve ser aplicada.	'AddActionGroups' (obrigatório)
actionGroupIds	Lista de IDs do grupo de ações a serem adicionadas à regra de processamento de alertas.	string[] (obrigatório)

RemoveAllActionGroups

Nome	Descrição	Valor
actionType	Ação que deve ser aplicada.	'RemoveAllActionGroups' (obrigatório)

Condição

Nome	Descrição	Valor
field	Campo para uma determinada condição.	'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Description' 'MonitorCondition' 'MonitorService' 'Severidade' 'SignalType' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType'
operador	Operador para uma determinada condição.	'Contains' 'DoesNotContain' 'Equals' 'NotEquals'
valores	Lista de valores a serem correspondentes a uma determinada condição.	string[]

Agenda

Nome	Descrição	Valor
effectiveFrom	Agendamento em vigor a partir do momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário.	string
effectiveUntil	Agendamento em vigor até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário.	string
Recorrências	Lista de recorrências.	Recorrência[]
timeZone	Fuso horário de agendamento.	string

Recorrência

Nome	Descrição	Valor
endTime	Hora de término da recorrência.	string
startTime	Hora de início da recorrência.	string
recurrenceType	Definir o tipo de objeto	Diariamente Mensalmente Semanal (obrigatório)

Dailyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	'Daily' (obrigatório)

Monthlyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	'Monthly' (obrigatório)
daysOfMonth	Especifica os valores para o padrão de recorrência mensal.	int[] (obrigatório)

Weeklyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	'Weekly' (obrigatório)
Daysofweek	Especifica os valores para o padrão de recorrência semanal.	Matriz de cadeia de caracteres que contém qualquer um dos: 'Sexta-feira' 'Segunda-feira' 'Sábado' 'Domingo' 'Quinta-feira' 'Terça-feira' 'Quarta-feira' (obrigatório)

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Configurar notificações para alertas de backup usando o Azure Monitor	Este modelo permite configurar notificações por email para seus cofres dos Serviços de Recuperação usando o Azure Monitor, implantando uma regra de processamento de alertas e um grupo de ações

Definição de recurso de modelo do ARM

O tipo de recurso actionRules pode ser implantado em:

Grupos de recursos – Consulte comandos de implantação do grupo de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.AlertsManagement/actionRules, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.AlertsManagement/actionRules",
  "apiVersion": "2021-08-08",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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" ]
  }
}

Objetos de ação

Defina a propriedade actionType para especificar o tipo de objeto.

Para AddActionGroups, use:

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

Para RemoveAllActionGroups, use:

  "actionType": "RemoveAllActionGroups"

Objetos de recorrência

Defina a propriedade recurrenceType para especificar o tipo de objeto .

Para Diário, use:

  "recurrenceType": "Daily"

Para Mensal, use:

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

Para Semanalmente, use:

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

Valores de propriedade

actionRules

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.AlertsManagement/actionRules'
apiVersion	A versão da API do recurso	'2021-08-08'
name	O nome do recurso	cadeia de caracteres (obrigatório)
local	Localização do recurso	cadeia de caracteres (obrigatório)
marcas	Marcações de recursos	Dicionário de nomes e valores de marcas. Confira Marcas em modelos
properties	Propriedades da regra de processamento de alertas.	AlertProcessingRuleProperties

AlertProcessingRuleProperties

Nome	Descrição	Valor
Ações	Ações a serem aplicadas.	Action[] (obrigatório)
condições	Condições nas quais os alertas serão filtrados.	Condição[]
descrição	Descrição da regra de processamento de alertas.	string
Habilitado	Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada.	bool
schedule	Agendamento para a regra de processamento de alertas.	Agenda
escopos	Escopos nos quais a regra de processamento de alerta será aplicada.	string[] (obrigatório)

Ação

Nome	Descrição	Valor
actionType	Definir o tipo de objeto	AddActionGroups RemoveAllActionGroups (obrigatório)

AddActionGroups

Nome	Descrição	Valor
actionType	Ação que deve ser aplicada.	'AddActionGroups' (obrigatório)
actionGroupIds	Lista de IDs do grupo de ações a serem adicionadas à regra de processamento de alertas.	string[] (obrigatório)

RemoveAllActionGroups

Nome	Descrição	Valor
actionType	Ação que deve ser aplicada.	'RemoveAllActionGroups' (obrigatório)

Condição

Nome	Descrição	Valor
field	Campo para uma determinada condição.	'AlertContext' 'AlertRuleId' 'AlertRuleName' 'Description' 'MonitorCondition' 'MonitorService' 'Severidade' 'SignalType' 'TargetResource' 'TargetResourceGroup' 'TargetResourceType'
operador	Operador para uma determinada condição.	'Contains' 'DoesNotContain' 'Equals' 'NotEquals'
valores	Lista de valores a serem correspondidos para uma determinada condição.	string[]

Agenda

Nome	Descrição	Valor
effectiveFrom	Agendamento em vigor a partir do momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário.	string
effectiveUntil	Agendamento em vigor até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário.	string
Recorrências	Lista de recorrências.	Recorrência[]
timeZone	Fuso horário de agendamento.	string

Recorrência

Nome	Descrição	Valor
endTime	Hora de término da recorrência.	string
startTime	Hora de início da recorrência.	string
recurrenceType	Definir o tipo de objeto	Diariamente Mensalmente Semanal (obrigatório)

Dailyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	'Daily' (obrigatório)

Monthlyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	'Monthly' (obrigatório)
daysOfMonth	Especifica os valores para o padrão de recorrência mensal.	int[] (obrigatório)

Weeklyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	'Weekly' (obrigatório)
Daysofweek	Especifica os valores para o padrão de recorrência semanal.	Matriz de cadeia de caracteres que contém qualquer um dos: 'Sexta-feira' 'Segunda-feira' 'Sábado' 'Domingo' 'Quinta-feira' 'Terça-feira' 'Quarta-feira' (obrigatório)

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Configurar notificações para alertas de backup usando o Azure Monitor	Este modelo permite configurar notificações por email para seus cofres dos Serviços de Recuperação usando o Azure Monitor, implantando uma regra de processamento de alertas e um grupo de ações

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso actionRules pode ser implantado em:

Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.AlertsManagement/actionRules, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AlertsManagement/actionRules@2021-08-08"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  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"
      ]
    }
  })
}

Objetos de ação

Defina a propriedade actionType para especificar o tipo de objeto.

Para AddActionGroups, use:

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

Para RemoveAllActionGroups, use:

  actionType = "RemoveAllActionGroups"

Objetos de recorrência

Defina a propriedade recurrenceType para especificar o tipo de objeto .

Para Diário, use:

  recurrenceType = "Daily"

Para Mensalmente, use:

  recurrenceType = "Monthly"
  daysOfMonth = [
    int
  ]

Para Semanal, use:

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

Valores de propriedade

actionRules

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.AlertsManagement/actionRules@2021-08-08"
name	O nome do recurso	cadeia de caracteres (obrigatório)
local	Localização do recurso	cadeia de caracteres (obrigatório)
parent_id	Para implantar em um grupo de recursos, use a ID desse grupo de recursos.	cadeia de caracteres (obrigatório)
marcas	Marcações de recursos	Dicionário de nomes e valores de marcas.
properties	Propriedades da regra de processamento de alertas.	AlertProcessingRuleProperties

AlertProcessingRuleProperties

Nome	Descrição	Valor
Ações	Ações a serem aplicadas.	Action[] (obrigatório)
condições	Condições nas quais os alertas serão filtrados.	Condição[]
descrição	Descrição da regra de processamento de alertas.	string
Habilitado	Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada.	bool
schedule	Agendamento para a regra de processamento de alertas.	Agenda
escopos	Escopos nos quais a regra de processamento de alerta será aplicada.	string[] (obrigatório)

Ação

Nome	Descrição	Valor
actionType	Definir o tipo de objeto	AddActionGroups RemoveAllActionGroups (obrigatório)

AddActionGroups

Nome	Descrição	Valor
actionType	Ação que deve ser aplicada.	"AddActionGroups" (obrigatório)
actionGroupIds	Lista de IDs do grupo de ações a serem adicionadas à regra de processamento de alertas.	string[] (obrigatório)

RemoveAllActionGroups

Nome	Descrição	Valor
actionType	Ação que deve ser aplicada.	"RemoveAllActionGroups" (obrigatório)

Condição

Nome	Descrição	Valor
field	Campo para uma determinada condição.	"AlertContext" "AlertRuleId" "AlertRuleName" "Descrição" "MonitorCondition" "MonitorService" "Gravidade" "SignalType" "TargetResource" "TargetResourceGroup" "TargetResourceType"
operador	Operador para uma determinada condição.	"Contains" "DoesNotContain" "Igual a" "NotEquals"
valores	Lista de valores a serem correspondidos para uma determinada condição.	string[]

Agenda

Nome	Descrição	Valor
effectiveFrom	Agendamento em vigor a partir do momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário.	string
effectiveUntil	Agendamento efetivo até o tempo. Date-Time no formato ISO-8601 sem sufixo de fuso horário.	string
Recorrências	Lista de recorrências.	Recorrência[]
timeZone	Fuso horário de agendamento.	string

Recorrência

Nome	Descrição	Valor
endTime	Hora de término da recorrência.	string
startTime	Hora de início da recorrência.	string
recurrenceType	Definir o tipo de objeto	Diariamente Mensalmente Semanal (obrigatório)

Dailyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	"Diariamente" (obrigatório)

Monthlyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	"Mensal" (obrigatório)
daysOfMonth	Especifica os valores para o padrão de recorrência mensal.	int[] (obrigatório)

Weeklyrecurrence

Nome	Descrição	Valor
recurrenceType	Especifica quando a recorrência deve ser aplicada.	"Semanal" (obrigatório)
Daysofweek	Especifica os valores para o padrão de recorrência semanal.	Matriz de cadeia de caracteres que contém qualquer um dos: "Sexta-feira" "Segunda-feira" "Sábado" "Domingo" "Quinta-Feira" "Terça-feira" "Quarta-feira" (obrigatório)

Compartilhar via

Microsoft.AlertsManagement actionRules

Definição de recurso do Bicep

Formato de recurso

Objetos de ação

Objetos de recorrência

Valores de propriedade

actionRules

AlertProcessingRuleProperties

Ação

AddActionGroups

RemoveAllActionGroups

Condição

Agenda

Recorrência

Dailyrecurrence

Monthlyrecurrence

Weeklyrecurrence

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato de recurso

Objetos de ação

Objetos de recorrência

Valores de propriedade

actionRules

AlertProcessingRuleProperties

Ação

AddActionGroups

RemoveAllActionGroups

Condição

Agenda

Recorrência

Dailyrecurrence

Monthlyrecurrence

Weeklyrecurrence

Modelos de início rápido

Definição de recurso do Terraform (provedor AzAPI)

Formato de recurso

Objetos de ação

Objetos de recorrência

Valores de propriedade

actionRules

AlertProcessingRuleProperties

Ação

AddActionGroups

RemoveAllActionGroups

Condição

Agenda

Recorrência

Dailyrecurrence

Monthlyrecurrence

Weeklyrecurrence

Recursos adicionais