Partilhar via

Módulos BICEP de ação programada de Gerenciamento de Custos

  • Artigo

Este artigo descreve as ações agendadas do Gerenciamento de Custos, os módulos do Registro Bicep que ajudam você a enviar um e-mail em um cronograma ou quando uma anomalia é detetada.

As ações agendadas permitem configurar alertas de 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, uma ligação para um ficheiro CSV com os dados de custo resumidos. Você também pode usar ações agendadas para configurar alertas de deteção de anomalias para assinaturas.

Para saber mais sobre alertas agendados, consulte Salvar e compartilhar modos de exibição. 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 agendada:

Nome Tipo Description
name string Obrigatório. 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 false, a ação agendada é compartilhada com outros usuários no mesmo escopo. Ignorado se o tipo é InsightAlert. Predefinição: false.
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 o tipo for Email e o builtInView não estiver definido. A ID do recurso do modo de exibição para o qual a ação agendada é enviada. A exibição deve ser privada (nível de locatário) ou de propriedade do mesmo escopo da ação agendada. Ignorado se o tipo é InsightAlert ou se builtInView está definido.
displayName string Opcional. O nome para exibição a ser exibido no portal ao exibir a lista de ações agendadas. Padrão: (nome da ação agendada).
status string Opcional. O status da ação agendada. Predefinição: Activado.
notificationEmail string Obrigatório. Endereço de e-mail da pessoa ou equipa 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 implanta o modelo).
emailRecipients array Obrigatório. 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 para os destinatários do e-mail. Padrão: (nome da exibição).
emailMessage string Opcional. Inclua uma mensagem para que os destinatários adicionem contexto sobre por que estão recebendo o e-mail, o que fazer e/ou quem contatar. 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 ser incluído um link para um arquivo CSV com os dados de suporte para o gráfico. Ignorado se o tipo é InsightAlert. Predefinição: false.
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 o tipo é Email e scheduleFrequency é Weekly. Lista de dias da semana em que os e-mails devem ser entregues. Permitido: Segunda-feira, Terça-feira, Quarta-feira, Quinta-feira, Sexta-feira, Sábado, Domingo. Padrão: segunda-feira.
scheduleDayOfMonth int Opcional. Obrigatório se o tipo é Email e scheduleFrequency é Monthly. O dia do mês em que os e-mails devem ser entregues. O custo mensal não é final 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 é necessário se scheduleFrequency for Monthly. Permitido: primeiro, segundo, terceiro, quarto, último. Padrão [] (não definido).
scheduleStartDate string Opcional. No primeiro dia o horário deve correr. 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 o horário deve correr. 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 e-mail em um cronograma ou quando uma anomalia é detetada.

Agendar um e-mail para uma vista incorporada

Grupo de Recursos de Subscrição

Cria uma ação agendada compartilhada para o modo de exibição interno 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' ]
  }
}

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

Grupo de Recursos de Subscrição

Cria uma ação agendada privada para o modo de exibição interno 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

Subscrição

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údos relacionados

Recursos relacionados:

Recursos de FinOps relacionados:

Produtos relacionados:

Soluções relacionadas: