Share via

Scheduled Actions - Create Or Update By Scope

  • Odwołanie
Service:
Cost Management
API Version:
2023-11-01

Utwórz lub zaktualizuj udostępnioną zaplanowaną akcję w danym zakresie.

PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2023-11-01

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
name
 path True

string

Nazwa zaplanowanej akcji.
scope
 path True

string

Zakres skojarzony z zaplanowanymi operacjami akcji. Obejmuje to ciąg "subscriptions/{subscriptionId}" dla zakresu subskrypcji, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" dla zakresu grupy zasobów, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" dla zakresu konta rozliczeniowego, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingAccountId}/departments/{departmentId}" dla zakresu działu, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" dla zakresu EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" dla zakresu BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" dla zakresu InvoiceSection, "providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" dla zakresu zewnętrznego konta rozliczeniowego i "providers/Microsoft". CostManagement/externalSubscriptions/{externalSubscriptionName}" dla zakresu subskrypcji zewnętrznej. Uwaga: Alerty szczegółowych informacji są dostępne tylko w zakresie subskrypcji.
api-version
 query True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

ETag jednostki. Nie jest wymagane podczas tworzenia jednostki. Opcjonalnie podczas aktualizowania jednostki i można określić, aby osiągnąć optymistyczną współbieżność.

Treść żądania

Nazwa Wymagane Typ Opis
properties.displayName True

string

Nazwa zaplanowanej akcji.
properties.notification True

NotificationProperties

Właściwości powiadomień oparte na typie zaplanowanej akcji.
properties.schedule True

ScheduleProperties

Harmonogram zaplanowanej akcji.
properties.status True

ScheduledActionStatus

Stan zaplanowanej akcji.
properties.viewId True

string

Identyfikator viewId analizy kosztów używany do zaplanowanej akcji. Na przykład "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Rodzaj zaplanowanej akcji.
properties.fileDestination

FileDestination

Format docelowy danych widoku. Jest to opcjonalne.
properties.notificationEmail

string

Email adres punktu kontaktu, który powinien otrzymywać żądania anulowania subskrypcji i wiadomości e-mail z powiadomieniami.
properties.scope

string

W przypadku prywatnej zaplanowanej akcji (tworzenie lub aktualizowanie) zakres będzie pusty.
W przypadku udostępnionej zaplanowanej akcji (tworzenie lub aktualizowanie według zakresu) zakres usługi Cost Management może mieć wartość "subscriptions/{subscriptionId}" dla zakresu subskrypcji, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" dla zakresu resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" dla zakresu konta rozliczeniowego, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" dla zakresu działu, "providers/Microsoft". Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" dla zakresu EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" dla zakresu BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" dla zakresu InvoiceSection, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" dla elementu Zakres ExternalBillingAccount i "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" dla zakresu ExternalSubscription.

Odpowiedzi

Nazwa Typ Opis
200 OK

ScheduledAction

OK. Żądanie zakończyło się pomyślnie.
201 Created

ScheduledAction

Utworzone.
Other Status Codes

ErrorResponseWithNestedDetails

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource?api-version=2023-11-01


{
  "kind": "InsightAlert",
  "properties": {
    "displayName": "Daily anomaly by resource",
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost anomaly detected in the resource"
    },
    "schedule": {
      "frequency": "Daily",
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Sample Response

Status code:
201 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource",
  "name": "dailyAnomalyByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "InsightAlert",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-18T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Daily anomaly by resource",
    "fileDestination": {
      "fileFormats": []
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost anomaly detected in the resource"
    },
    "schedule": {
      "frequency": "Daily",
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}
Status code:
200 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource",
  "name": "dailyAnomalyByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "InsightAlert",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-19T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Daily anomaly by resource",
    "fileDestination": {
      "fileFormats": []
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost anomaly detected in the resource"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "schedule": {
      "frequency": "Daily",
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

CreateOrUpdateScheduledActionByScope

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2023-11-01


{
  "kind": "Email",
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "fileDestination": {
      "fileFormats": [
        "Csv"
      ]
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Sample Response

Status code:
201 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource",
  "name": "monthlyCostByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "Email",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-18T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "fileDestination": {
      "fileFormats": [
        "Csv"
      ]
    },
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}
Status code:
200 
{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource",
  "name": "monthlyCostByResource",
  "type": "Microsoft.CostManagement/ScheduledActions",
  "kind": "Email",
  "eTag": "\"1d4ff9fe66f1d10\"",
  "systemData": {
    "createdBy": "testuser",
    "createdByType": "User",
    "createdAt": "2020-06-18T22:21:51.1287144Z",
    "lastModifiedBy": "testuser",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-06-19T22:21:51.1287144Z"
  },
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "notification": {
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "scope": "subscriptions/00000000-0000-0000-0000-000000000000",
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Definicje

Nazwa Opis
createdByType

Typ tożsamości, która utworzyła zasób.
DaysOfWeek

Dni tygodnia.
ErrorDetailsWithNestedDetails

Szczegóły błędu.
ErrorResponseWithNestedDetails

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po odczekaniu czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.
FileDestination

Miejsce docelowe danych widoku. Jest to opcjonalne. Obecnie obsługiwany jest tylko format CSV.
FileFormat

Miejsce docelowe danych widoku. Obecnie obsługiwany jest tylko format CSV.
NotificationProperties

Właściwości powiadomienia o zaplanowanej akcji.
ScheduledAction

Definicja zaplanowanej akcji.
ScheduledActionKind

Rodzaj zaplanowanej akcji.
ScheduledActionStatus

Stan zaplanowanej akcji.
ScheduleFrequency

Częstotliwość harmonogramu.
ScheduleProperties

Właściwości harmonogramu.
systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
WeeksOfMonth

Tygodnie miesiąca.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa Typ Opis
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Dni tygodnia.

Nazwa Typ Opis
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

Szczegóły błędu.

Nazwa Typ Opis
code

string

Kod błędu.
details

ErrorDetailsWithNestedDetails[]

Dodatkowe szczegóły błędu.
message

string

Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

ErrorResponseWithNestedDetails

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.

Niektóre odpowiedzi na błędy:

  • 429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po odczekaniu czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.

Nazwa Typ Opis
error

ErrorDetailsWithNestedDetails

Szczegóły błędu.

FileDestination

Miejsce docelowe danych widoku. Jest to opcjonalne. Obecnie obsługiwany jest tylko format CSV.

Nazwa Typ Opis
fileFormats

FileFormat[]

Miejsce docelowe danych widoku. Obecnie obsługiwany jest tylko format CSV.

FileFormat

Miejsce docelowe danych widoku. Obecnie obsługiwany jest tylko format CSV.

Nazwa Typ Opis
Csv

string

NotificationProperties

Właściwości powiadomienia o zaplanowanej akcji.

Nazwa Typ Opis
language

string

Ustawienia regionalne wiadomości e-mail.
message

string

Opcjonalna wiadomość do dodania w wiadomości e-mail. Długość jest ograniczona do 250 znaków.
regionalFormat

string

Format regionalny używany do formatowania wartości daty/godziny i waluty w wiadomości e-mail.
subject

string

Temat wiadomości e-mail. Długość jest ograniczona do 70 znaków.
to

string[]

Tablica adresów e-mail.

ScheduledAction

Definicja zaplanowanej akcji.

Nazwa Typ Opis
eTag

string

Zasób Etag. W przypadku wywołań aktualizacji element eTag jest opcjonalny i można go określić w celu osiągnięcia optymistycznej współbieżności. Pobierz element eTag zasobu, wykonując najpierw wywołanie "GET", a następnie dołączając najnowszy element eTag jako część treści żądania lub nagłówka "If-Match" podczas przeprowadzania aktualizacji. W przypadku tworzenia wywołań element eTag nie jest wymagany.
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Rodzaj zaplanowanej akcji.
name

string

Nazwa zasobu
properties.displayName

string

Nazwa zaplanowanej akcji.
properties.fileDestination

FileDestination

Format docelowy danych widoku. Jest to opcjonalne.
properties.notification

NotificationProperties

Właściwości powiadomień oparte na typie zaplanowanej akcji.
properties.notificationEmail

string

Email adres punktu kontaktu, który powinien otrzymywać żądania anulowania subskrypcji i wiadomości e-mail z powiadomieniami.
properties.schedule

ScheduleProperties

Harmonogram zaplanowanej akcji.
properties.scope

string

W przypadku prywatnej zaplanowanej akcji (tworzenie lub aktualizowanie) zakres będzie pusty.
W przypadku udostępnionej zaplanowanej akcji (tworzenie lub aktualizowanie według zakresu) zakres usługi Cost Management może mieć wartość "subscriptions/{subscriptionId}" dla zakresu subskrypcji, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" dla zakresu resourceGroup, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" dla zakresu konta rozliczeniowego, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" dla zakresu działu, "providers/Microsoft". Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" dla zakresu EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" dla zakresu BillingProfile, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" dla zakresu InvoiceSection, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" dla elementu Zakres ExternalBillingAccount i "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" dla zakresu ExternalSubscription.
properties.status

ScheduledActionStatus

Stan zaplanowanej akcji.
properties.viewId

string

Identyfikator viewId analizy kosztów używany do zaplanowanej akcji. Na przykład "/providers/Microsoft.CostManagement/views/swaggerExample"
systemData

systemData

Rodzaj zaplanowanej akcji.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Rodzaj zaplanowanej akcji.

Nazwa Typ Opis
Email

string

Dane analizy kosztów zostaną przesłane pocztą e-mail.
InsightAlert

string

Informacje o anomalii kosztów zostaną przesłane pocztą e-mail. Dostępne tylko w zakresie subskrypcji z częstotliwością dzienną. Jeśli w zasobie nie zostanie wykryta żadna anomalia, wiadomość e-mail nie zostanie wysłana.

ScheduledActionStatus

Stan zaplanowanej akcji.

Nazwa Typ Opis
Disabled

string

Zaplanowana akcja jest zapisywana, ale nie zostanie uruchomiona.
Enabled

string

Zaplanowana akcja zostanie zapisana i zostanie uruchomiona.
Expired

string

Zaplanowana akcja wygasła.

ScheduleFrequency

Częstotliwość harmonogramu.

Nazwa Typ Opis
Daily

string

Dane analizy kosztów będą codziennie wysyłane pocztą e-mail.
Monthly

string

Dane analizy kosztów będą wysyłane pocztą e-mail co miesiąc.
Weekly

string

Dane analizy kosztów będą wysyłane pocztą e-mail co tydzień.

ScheduleProperties

Właściwości harmonogramu.

Nazwa Typ Opis
dayOfMonth

integer

dzień UTC, w którym zostaną przesłane wiadomości e-mail dotyczące danych analizy kosztów. Musi zawierać się w zakresie od 1 do 31. Ta właściwość ma zastosowanie, gdy właściwość frequency ma wartość Monthly i zastępuje tygodniOfMonth lub daysOfWeek.
daysOfWeek

DaysOfWeek[]

Nazwy dni w języku angielskim, na których będą wysyłane dane analizy kosztów. Ta właściwość ma zastosowanie, gdy częstotliwość ma wartość Co tydzień lub Co miesiąc.
endDate

string

Data i godzina zakończenia zaplanowanej akcji (UTC).
frequency

ScheduleFrequency

Częstotliwość harmonogramu.
hourOfDay

integer

Godzina UTC, o której dane analizy kosztów zostaną przesłane pocztą e-mail.
startDate

string

Data i godzina rozpoczęcia zaplanowanej akcji (UTC).
weeksOfMonth

WeeksOfMonth[]

Tygodnie, w których dane analizy kosztów zostaną przesłane pocztą e-mail. Ta właściwość ma zastosowanie, gdy właściwość frequency ma wartość Monthly i jest używana w połączeniu z daysOfWeek.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa Typ Opis
createdAt

string

Sygnatura czasowa tworzenia zasobów (UTC).
createdBy

string

Tożsamość, która utworzyła zasób.
createdByType

createdByType

Typ tożsamości, która utworzyła zasób.
lastModifiedAt

string

Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy

string

Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType

createdByType

Typ tożsamości, która ostatnio zmodyfikowała zasób.

WeeksOfMonth

Tygodnie miesiąca.

Nazwa Typ Opis
First

string

Fourth

string

Last

string

Second

string

Third

string