Compartilhar via

Módulos de bíceps de ação programada de Gerenciamento de Custos

  • Artigo

Este artigo descreve os módulos do Registro Bicep de ações agendadas do Gerenciamento de Custos que ajudam você a enviar um email em um agendamento ou quando uma anomalia é detectada.

As ações programadas permitem que você configure alertas por e-mail diariamente, semanalmente ou mensalmente. As ações agendadas são configuradas com base em uma exibição de Gerenciamento de Custos, que pode ser aberta e editada em Análise de custos no portal do Azure. Os alertas por e-mail incluem uma imagem da vista selecionada e, opcionalmente, um link para um arquivo CSV com os dados de custo resumidos. Você também pode usar ações agendadas para configurar alertas de detecção de anomalias para assinaturas.

Para saber mais sobre alertas agendados, consulte Salvar e compartilhar exibições. Para saber mais sobre alertas de anomalias, consulte Analisar cobranças inesperadas.


Sintaxe

Versão: 1.1 Escopos: Assinatura, Grupo de recursos

module <string> 'br/public:cost/<scope>-scheduled-action:1.1' = {
  name: <string>
  params: {
    name: <string>
    kind: 'Email' | 'InsightAlert'
    private: <bool>
    builtInView: 'AccumulatedCosts' | 'CostByService' | 'DailyCosts'
    viewId: <string>
    displayName: <string>
    status: 'Enabled' | 'Disabled'
    notificationEmail: <string>
    emailRecipients: [ <string>, <string>, ... ]
    emailSubject: <string>
    emailMessage: <string>
    emailLanguage: <string>
    emailRegionalFormat: <string>
    includeCsv: <bool>
    scheduleFrequency: 'Daily' | 'Weekly' | 'Monthly'
    scheduleDaysOfWeek: [ 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' ]
    scheduleDayOfMonth: <int>
    scheduleWeeksOfMonth: [ 'First', 'Second', 'Third', 'Fourth', 'Last' ]
    scheduleStartDate: 'yyyy-MM-ddTHH:miZ'
    scheduleEndDate: 'yyyy-MM-dd'
  }
}

Parâmetros

Aqui estão os parâmetros para os módulos de ação agendados:

Nome Tipo Descrição
name string Obrigatória. Nome da ação agendada usada na ID do recurso.
kind string Opcional. Indica o tipo de ação agendada. Padrão: E-mail.
private bool Opcional. Indica se a ação agendada é privada e editável apenas pelo usuário atual. Se for falso, a ação agendada será compartilhada com outros usuários no mesmo escopo. Ignorado se o tipo for InsightAlert. Padrão: falso.
builtInView string Opcional. Especifica qual modo de exibição interno usar. É um atalho para o ID de visualização completo.
viewId string Opcional. Obrigatório se kind for Email e builtInView não estiver definido. A ID do recurso da exibição para a qual a ação agendada é enviada. A exibição deve ser privada (nível de locatário) ou de propriedade do mesmo escopo que a ação agendada. Ignorado se kind for InsightAlert ou se builtInView estiver definido.
displayName string Opcional. O nome de exibição a ser mostrado no portal ao exibir a lista de ações agendadas. Padrão: (nome da ação programada).
status string Opcional. O status da ação agendada. Padrão: Habilitado.
notificationEmail string Obrigatória. Endereço de e-mail da pessoa ou equipe responsável por esta ação agendada. Este endereço de e-mail está incluído nos e-mails. Padrão: (endereço de e-mail do usuário que está implantando o modelo).
emailRecipients array Obrigatória. Lista de endereços de e-mail que devem receber e-mails. É necessário pelo menos um endereço de e-mail válido.
emailSubject string Opcional. O assunto do e-mail que é enviado aos destinatários do e-mail. Padrão: (nome da visualização).
emailMessage string Opcional. Inclua uma mensagem para que os destinatários adicionem contexto sobre o motivo pelo qual estão recebendo o e-mail, o que fazer e/ou com quem entrar em contato. Padrão: "" (sem mensagem).
emailLanguage string Opcional. O idioma usado para o modelo de email. Padrão: en.
emailRegionalFormat string Opcional. O formato regional usado para datas, horas e números. Padrão: en-us.
includeCsv bool Opcional. Indica se deve incluir um link para um arquivo CSV com os dados de apoio do gráfico. Ignorado se o tipo for InsightAlert. Padrão: falso.
scheduleFrequency string Opcional. A frequência com que a ação agendada é executada. Padrão: Diário para Email e Semanal para InsightAlert.
scheduleDaysOfWeek array Opcional. Obrigatório se kind for Email e scheduleFrequency for Weekly. Lista de dias da semana em que os e-mails devem ser entregues. Permitido: segunda, terça, quarta, quinta, sexta, sábado, domingo. Padrão: segunda-feira.
scheduleDayOfMonth int Opcional. Obrigatório se kind for Email e scheduleFrequency for Monthly. O dia do mês em que os e-mails devem ser entregues. O custo mensal não é definitivo até o terceiro dia do mês. Esse valor ou scheduleWeeksOfMonth é necessário se scheduleFrequency for Monthly. Padrão: 0 (não definido).
scheduleWeeksOfMonth array Opcional. Lista de semanas do mês em que os e-mails devem ser entregues. Esse valor ou scheduleDayOfMonth será necessário se scheduleFrequency for Monthly. Permitido: Primeiro, Segundo, Terceiro, Quarto, Último. Padrão [] (não definido).
scheduleStartDate string Opcional. No primeiro dia, a programação deve ser executada. Use o tempo para indicar quando deseja receber e-mails. Deve estar no formato aaaa-MM-ddTHH:miZ. Padrão = Agora.
scheduleEndDate string Opcional. No último dia, a programação deve ser executada. Deve estar no formato aaaa-MM-dd. Padrão = 1 ano a partir da data de início.

Exemplos

Os exemplos a seguir ajudam você a enviar um email em uma programação ou quando uma anomalia é detectada.

Agendar um e-mail para uma exibição interna

Assinatura Grupo de recursos

Cria uma ação agendada compartilhada para a exibição interna DailyCosts.

module dailyCostsAlert 'br/public:cost/subscription-scheduled-action:1.0.2' = {
  name: 'dailyCostsAlert'
  params: {
    name: 'DailyCostsAlert'
    displayName: 'My schedule'
    builtInView: 'DailyCosts'
    emailRecipients: [ 'ema@contoso.com' ]
    notificationEmail: 'ema@contoso.com'
    scheduleFrequency: 'Weekly'
    scheduleDaysOfWeek: [ 'Monday' ]
  }
}

Programe um e-mail com uma data de início personalizada

Assinatura Grupo de recursos

Cria uma ação agendada privada para a exibição interna DailyCosts com datas de início/término personalizadas.

module privateAlert 'br/public:cost/resourcegroup-scheduled-action:1.0.2' = {
  name: 'privateAlert'
  params: {
    name: 'PrivateAlert'
    displayName: 'My private schedule'
    private: true
    builtInView: 'DailyCosts'
    emailRecipients: [ 'priya@contoso.com' ]
    notificationEmail: 'priya@contoso.com'
    scheduleFrequency: 'Monthly'
    scheduleDayOfMonth: 1
    scheduleStartDate: scheduleStartDate
    scheduleEndDate: scheduleEndDate
  }
}

Configurar um alerta de anomalia

Assinatura

Cria um alerta de anomalia para uma assinatura.

module anomalyAlert 'br/public:cost/subscription-scheduled-action:1.0.2' = {
  name: 'anomalyAlert'
  params: {
    name: 'AnomalyAlert'
    kind: 'InsightAlert'
    displayName: 'My anomaly check'
    emailRecipients: [ 'ana@contoso.com' ]
    notificationEmail: 'ana@contoso.com'
  }
}

Conteúdo relacionado

Recursos relacionados:

Recursos FinOps relacionados:

Produtos relacionados:

Soluções relacionadas: