Udostępnij za pośrednictwem

Moduły bicep zaplanowanej akcji usługi Cost Management

  • Artykuł

W tym artykule opisano zaplanowane akcje usługi Cost Management moduły rejestru Bicep, które ułatwiają wysyłanie wiadomości e-mail zgodnie z harmonogramem lub po wykryciu anomalii.

Zaplanowane akcje umożliwiają konfigurowanie alertów e-mail codziennie, co tydzień lub co miesiąc. Zaplanowane akcje są konfigurowane na podstawie widoku usługi Cost Management, który można otworzyć i edytować w analizie kosztów w witrynie Azure Portal. Alerty e-mail zawierają obraz wybranego widoku i opcjonalnie link do pliku CSV z podsumowanymi danymi kosztów. Możesz również użyć zaplanowanych akcji, aby skonfigurować alerty wykrywania anomalii dla subskrypcji.

Aby dowiedzieć się więcej o zaplanowanych alertach, zobacz Zapisywanie i udostępnianie widoków. Aby dowiedzieć się więcej o alertach anomalii, zobacz Analizowanie nieoczekiwanych opłat.


Składnia

Wersja: 1.1 Zakresy: Subskrypcja, Grupa zasobów

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

Parametry

Poniżej przedstawiono parametry dla zaplanowanych modułów akcji:

Nazwisko Pisz Opis
name string Wymagane. Nazwa zaplanowanej akcji używanej w identyfikatorze zasobu.
kind string Opcjonalny. Wskazuje rodzaj zaplanowanej akcji. Ustawienie domyślne: Poczta e-mail.
private bool Opcjonalny. Wskazuje, czy zaplanowana akcja jest prywatna i może być edytowana tylko przez bieżącego użytkownika. Jeśli wartość false, zaplanowana akcja jest udostępniana innym użytkownikom w tym samym zakresie. Ignorowane, jeśli rodzaj to InsightAlert. Wartość domyślna: false.
builtInView string Opcjonalny. Określa, który widok wbudowany ma być używany. Jest to skrót do identyfikatora pełnego widoku.
viewId string Opcjonalny. Wymagane, jeśli rodzaj jest Email i wbudowanyInView nie jest ustawiony. Identyfikator zasobu widoku, do którego wysyła zaplanowana akcja. Widok musi być prywatny (poziom dzierżawy) lub należący do tego samego zakresu co zaplanowana akcja. Ignorowane, jeśli rodzaj jest InsightAlert lub jeśli właściwość builtInView jest ustawiona.
displayName string Opcjonalny. Nazwa wyświetlana, która ma być wyświetlana w portalu podczas wyświetlania listy zaplanowanych akcji. Ustawienie domyślne: (nazwa zaplanowanej akcji).
status string Opcjonalny. Stan zaplanowanej akcji. Domyślnie: Włączone.
notificationEmail string Wymagany. Adres e-mail osoby lub zespołu odpowiedzialnego za tę zaplanowaną akcję. Ten adres e-mail jest uwzględniony w wiadomościach e-mail. Ustawienie domyślne: (adres e-mail użytkownika wdrażającego szablon).
emailRecipients array Wymagany. Lista adresów e-mail, które powinny otrzymywać wiadomości e-mail. Wymagany jest co najmniej jeden prawidłowy adres e-mail.
emailSubject string Opcjonalny. Temat wiadomości e-mail, która jest wysyłana do adresatów wiadomości e-mail. Ustawienie domyślne: (nazwa widoku).
emailMessage string Opcjonalny. Dołącz wiadomość dla adresatów, aby dodać kontekst dotyczący tego, dlaczego otrzymują wiadomość e-mail, co należy zrobić i/lub kto ma się skontaktować. Ustawienie domyślne: "" (brak komunikatu).
emailLanguage string Opcjonalny. Język używany dla szablonu wiadomości e-mail. Ustawienie domyślne: en.
emailRegionalFormat string Opcjonalny. Format regionalny używany dla dat, godzin i liczb. Ustawienie domyślne: en-us.
includeCsv bool Opcjonalny. Wskazuje, czy dołączyć link do pliku CSV z danymi zapasowymi wykresu. Ignorowane, jeśli rodzaj to InsightAlert. Wartość domyślna: false.
scheduleFrequency string Opcjonalny. Częstotliwość uruchamiania zaplanowanej akcji. Ustawienie domyślne: Codziennie dla Email i Co tydzień dla InsightAlert.
scheduleDaysOfWeek array Opcjonalny. Wymagane, jeśli rodzaj to Email i scheduleFrequency to Weekly. Lista dni tygodnia, w których powinny być dostarczane wiadomości e-mail. Dozwolone: poniedziałek, wtorek, środa, czwartek, piątek, sobota, niedziela. Ustawienie domyślne: poniedziałek.
scheduleDayOfMonth int Opcjonalny. Wymagane, jeśli rodzaj to Email i scheduleFrequency to Monthly. Dzień miesiąca, w ramach którego powinny zostać dostarczone wiadomości e-mail. Miesięczny koszt nie jest ostateczny dopiero w trzecim dniu miesiąca. Ta wartość lub scheduleWeeksOfMonth jest wymagana, jeśli parametr scheduleFrequency to Monthly. Wartość domyślna: 0 (nie ustawiono).
scheduleWeeksOfMonth array Opcjonalny. Lista tygodni miesiąca, w których powinny zostać dostarczone wiadomości e-mail. Ta wartość lub scheduleDayOfMonth jest wymagana, jeśli parametr scheduleFrequency to Monthly. Dozwolone: pierwszy, drugi, trzeci, czwarty, ostatni. Wartość domyślna [] (nie ustawiona).
scheduleStartDate string Opcjonalny. Pierwszy dzień, w ramach których powinien zostać uruchomiony harmonogram. Użyj czasu, aby wskazać, kiedy chcesz otrzymywać wiadomości e-mail. Musi być w formacie rrrr-MM-ddTHH:miZ. Wartość domyślna = teraz.
scheduleEndDate string Opcjonalny. Ostatni dzień, w ramach których powinien zostać uruchomiony harmonogram. Musi być w formacie rrrr-MM-dd. Wartość domyślna : 1 rok od daty rozpoczęcia.

Przykłady

Poniższe przykłady ułatwiają wysyłanie wiadomości e-mail zgodnie z harmonogramem lub po wykryciu anomalii.

Planowanie wiadomości e-mail dla wbudowanego widoku

Grupa zasobów subskrypcji

Tworzy udostępnioną zaplanowaną akcję dla wbudowanego widoku 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' ]
  }
}

Planowanie wiadomości e-mail z niestandardową datą rozpoczęcia

Grupa zasobów subskrypcji

Tworzy prywatną zaplanowaną akcję dla wbudowanego widoku DailyCosts z niestandardowymi datami rozpoczęcia/zakończenia.

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

Konfigurowanie alertu anomalii

Subskrypcja

Tworzy alert anomalii dla subskrypcji.

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

Powiązana zawartość

Powiązane zasoby:

Powiązane możliwości finops:

Powiązane produkty:

Powiązane rozwiązania: