Compartilhar via


Microsoft.AlertsManagement actionRules 2021-08-08

Definição de recurso do Bicep

O tipo de recurso actionRules pode ser implantado com operações de destino:

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

Formato de recurso

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

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'
  }
}

Objetos de ação

Defina a propriedade actionType para especificar o tipo de objeto.

Para AddActionGroups, use:

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

Para RemoveAllActionGroups, use:

{
  actionType: 'RemoveAllActionGroups'
}

Objetos de recorrência

Defina a propriedade recurrenceType para especificar o tipo de objeto.

Para Diariamente, use:

{
  recurrenceType: 'Daily'
}

Para Mensal, use:

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

Para Semanal, use:

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

Valores de propriedade

Ação

Nome Descrição Valor
actionType Defina como 'AddActionGroups' para o tipo AddActionGroups. Defina como 'RemoveAllActionGroups' para o tipo RemoveAllActionGroups. 'AddActionGroups'
'RemoveAllActionGroups' (obrigatório)

AddActionGroups

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

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. de Condição []
descrição Descrição da regra de processamento de alerta. corda
Habilitado Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada. Bool
horário Agendamento para a regra de processamento de alerta. agendar
Escopos Escopos nos quais a regra de processamento de alerta será aplicada. string[] (obrigatório)

Condição

Nome Descrição Valor
campo Campo para uma determinada condição. 'AlertContext'
'AlertRuleId'
'AlertRuleName'
'Descrição'
'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[]

DailyRecurrence

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

ManagedResourceTags

Nome Descrição Valor

Microsoft.AlertsManagement/actionRules

Nome Descrição Valor
localização Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da regra de processamento de alerta. AlertProcessingRuleProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

MonthlyRecurrence

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

Recorrência

Nome Descrição Valor
endTime Hora de término para recorrência. corda
recurrenceType Definido como 'Diário' para o tipo DailyRecurrence. Defina como 'Mensal' para o tipo MonthlyRecurrence. Defina como 'Semanal' para o tipo WeeklyRecurrence. 'Diariamente'
'Mensal'
'Semanal' (obrigatório)
startTime Hora de início da recorrência. corda

RemoveAllActionGroups

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

Horário

Nome Descrição Valor
effectiveFrom Agendamento em vigor a partir do momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. corda

Restrições:
Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectiveUntil Agendamento em vigor até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. corda

Restrições:
Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Recorrências Lista de recorrências. de recorrência []
Fuso horário Agendamento de fuso horário. corda

WeeklyRecurrence

Nome Descrição Valor
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)
recurrenceType Especifica quando a recorrência deve ser aplicada. 'Semanal' (obrigatório)

Exemplos de início rápido

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

Arquivo Bicep Descrição
notificações de instalação para alertas de backup usando o Azure Monitor Este modelo permite que você configure 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 com operações de destino:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de 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",
  "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"
  }
}

Objetos de ação

Defina a propriedade actionType para especificar o tipo de objeto.

Para AddActionGroups, use:

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

Para RemoveAllActionGroups, use:

{
  "actionType": "RemoveAllActionGroups"
}

Objetos de recorrência

Defina a propriedade recurrenceType para especificar o tipo de objeto.

Para Diariamente, use:

{
  "recurrenceType": "Daily"
}

Para Mensal, use:

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

Para Semanal, use:

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

Valores de propriedade

Ação

Nome Descrição Valor
actionType Defina como 'AddActionGroups' para o tipo AddActionGroups. Defina como 'RemoveAllActionGroups' para o tipo RemoveAllActionGroups. 'AddActionGroups'
'RemoveAllActionGroups' (obrigatório)

AddActionGroups

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

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. de Condição []
descrição Descrição da regra de processamento de alerta. corda
Habilitado Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada. Bool
horário Agendamento para a regra de processamento de alerta. agendar
Escopos Escopos nos quais a regra de processamento de alerta será aplicada. string[] (obrigatório)

Condição

Nome Descrição Valor
campo Campo para uma determinada condição. 'AlertContext'
'AlertRuleId'
'AlertRuleName'
'Descrição'
'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[]

DailyRecurrence

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

ManagedResourceTags

Nome Descrição Valor

Microsoft.AlertsManagement/actionRules

Nome Descrição Valor
apiVersion A versão da API '2021-08-08'
localização Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da regra de processamento de alerta. AlertProcessingRuleProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.AlertsManagement/actionRules'

MonthlyRecurrence

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

Recorrência

Nome Descrição Valor
endTime Hora de término para recorrência. corda
recurrenceType Definido como 'Diário' para o tipo DailyRecurrence. Defina como 'Mensal' para o tipo MonthlyRecurrence. Defina como 'Semanal' para o tipo WeeklyRecurrence. 'Diariamente'
'Mensal'
'Semanal' (obrigatório)
startTime Hora de início da recorrência. corda

RemoveAllActionGroups

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

Horário

Nome Descrição Valor
effectiveFrom Agendamento em vigor a partir do momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. corda

Restrições:
Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectiveUntil Agendamento em vigor até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. corda

Restrições:
Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Recorrências Lista de recorrências. de recorrência []
Fuso horário Agendamento de fuso horário. corda

WeeklyRecurrence

Nome Descrição Valor
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)
recurrenceType Especifica quando a recorrência deve ser aplicada. 'Semanal' (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
notificações de instalação para alertas de backup usando o Azure Monitor

Implantar no Azure
Este modelo permite que você configure 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 de AzAPI)

O tipo de recurso actionRules pode ser implantado com operações de destino:

  • grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de 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"
  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"
      ]
    }
  })
}

Objetos de ação

Defina a propriedade actionType para especificar o tipo de objeto.

Para AddActionGroups, use:

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

Para RemoveAllActionGroups, use:

{
  actionType = "RemoveAllActionGroups"
}

Objetos de recorrência

Defina a propriedade recurrenceType para especificar o tipo de objeto.

Para Diariamente, use:

{
  recurrenceType = "Daily"
}

Para Mensal, use:

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

Para Semanal, use:

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

Valores de propriedade

Ação

Nome Descrição Valor
actionType Defina como 'AddActionGroups' para o tipo AddActionGroups. Defina como 'RemoveAllActionGroups' para o tipo RemoveAllActionGroups. 'AddActionGroups'
'RemoveAllActionGroups' (obrigatório)

AddActionGroups

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

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. de Condição []
descrição Descrição da regra de processamento de alerta. corda
Habilitado Indica se a regra de processamento de alerta fornecida está habilitada ou desabilitada. Bool
horário Agendamento para a regra de processamento de alerta. agendar
Escopos Escopos nos quais a regra de processamento de alerta será aplicada. string[] (obrigatório)

Condição

Nome Descrição Valor
campo Campo para uma determinada condição. 'AlertContext'
'AlertRuleId'
'AlertRuleName'
'Descrição'
'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[]

DailyRecurrence

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

ManagedResourceTags

Nome Descrição Valor

Microsoft.AlertsManagement/actionRules

Nome Descrição Valor
localização Local do recurso cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da regra de processamento de alerta. AlertProcessingRuleProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.AlertsManagement/actionRules@2021-08-08"

MonthlyRecurrence

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

Recorrência

Nome Descrição Valor
endTime Hora de término para recorrência. corda
recurrenceType Definido como 'Diário' para o tipo DailyRecurrence. Defina como 'Mensal' para o tipo MonthlyRecurrence. Defina como 'Semanal' para o tipo WeeklyRecurrence. 'Diariamente'
'Mensal'
'Semanal' (obrigatório)
startTime Hora de início da recorrência. corda

RemoveAllActionGroups

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

Horário

Nome Descrição Valor
effectiveFrom Agendamento em vigor a partir do momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. corda

Restrições:
Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
effectiveUntil Agendamento em vigor até o momento. Date-Time no formato ISO-8601 sem sufixo de fuso horário. corda

Restrições:
Padrão = ^(?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))$
Recorrências Lista de recorrências. de recorrência []
Fuso horário Agendamento de fuso horário. corda

WeeklyRecurrence

Nome Descrição Valor
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)
recurrenceType Especifica quando a recorrência deve ser aplicada. 'Semanal' (obrigatório)