Share via

Scheduled Actions - Create Or Update By Scope

  • Reference
Service:
Cost Management
API Version:
2023-11-01

Vytvořte nebo aktualizujte sdílenou naplánovanou akci v daném oboru.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
name
 path True

string

Název naplánované akce.
scope
 path True

string

Obor přidružený k plánovaným operacím akcí. To zahrnuje subscriptions/{subscriptionId} pro rozsah předplatného, Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pro obor EnrollmentAccount, Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro rozsah BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId} pro rozsah InvoiceSection, providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName} pro rozsah externího fakturačního účtu a providery/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName} pro obor externího předplatného. Poznámka: Upozornění přehledu jsou k dispozici pouze v rozsahu předplatného.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name Vyžadováno Typ Description
If-Match

string

Značka ETag entity. Při vytváření entity se nevyžaduje. Volitelné při aktualizaci entity a je možné ji zadat, aby se dosáhlo optimistické souběžnosti.

Text požadavku

Name Vyžadováno Typ Description
properties.displayName True

string

Název naplánované akce.
properties.notification True

NotificationProperties

Vlastnosti oznámení založené na druhu naplánované akce.
properties.schedule True

ScheduleProperties

Plán naplánované akce
properties.status True

ScheduledActionStatus

Stav naplánované akce
properties.viewId True

string

Id zobrazení analýzy nákladů použité pro naplánovanou akci. Například /providers/Microsoft.CostManagement/views/swaggerExample
kind

ScheduledActionKind

Druh naplánované akce
properties.fileDestination

FileDestination

Cílový formát dat zobrazení. Tato položka je nepovinná.
properties.notificationEmail

string

Email adresu kontaktního místa, které by mělo dostávat žádosti o odhlášení odběru a e-maily s oznámením.
properties.scope

string

U privátních plánovaných akcí (vytvoření nebo aktualizace) bude rozsah prázdný.
Pro sdílenou naplánovanou akci (vytvoření nebo aktualizaci podle rozsahu) může být rozsah služby Cost Management subscriptions/{subscriptionId} pro rozsah předplatného. subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro rozsah oddělení, "providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId} pro rozsah EnrollmentAccount, Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro obor BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingId}/invoiceSections/{invoiceSectionId} pro rozsah InvoiceSection, /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName} pro Rozsah ExternalBillingAccount a /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} pro obor ExternalSubscription.

Odpovědi

Name Typ Description
200 OK

ScheduledAction

OK. Žádost byla úspěšná.
201 Created

ScheduledAction

Vytvořen.
Other Status Codes

ErrorResponseWithNestedDetails

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

Definice

Name Description
createdByType

Typ identity, která prostředek vytvořila.
DaysOfWeek

Dny v týdnu.
ErrorDetailsWithNestedDetails

Podrobnosti o chybě.
ErrorResponseWithNestedDetails

Chybová odpověď znamená, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Některé chybové odpovědi:

  • 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po uplynutí doby určené v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.
FileDestination

Cíl dat zobrazení. Tato položka je nepovinná. Aktuálně se podporuje jenom formát CSV.
FileFormat

Cíl dat zobrazení. Aktuálně se podporuje jenom formát CSV.
NotificationProperties

Vlastnosti oznámení naplánované akce.
ScheduledAction

Definice naplánované akce
ScheduledActionKind

Druh naplánované akce
ScheduledActionStatus

Stav naplánované akce
ScheduleFrequency

Frekvence plánu.
ScheduleProperties

Vlastnosti plánu.
systemData

Metadata týkající se vytvoření a poslední změny prostředku.
WeeksOfMonth

Týdny v měsíci.

createdByType

Typ identity, která prostředek vytvořila.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Dny v týdnu.

Name Typ Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

Podrobnosti o chybě.

Name Typ Description
code

string

Kód chyby
details

ErrorDetailsWithNestedDetails[]

Další podrobnosti o chybě.
message

string

Chybová zpráva s informacemi o tom, proč operace selhala.

ErrorResponseWithNestedDetails

Chybová odpověď znamená, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Některé chybové odpovědi:

  • 429 TooManyRequests – Požadavek je omezený. Zkuste to znovu po uplynutí doby určené v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Po uplynutí časového limitu uvedeného v hlavičce Retry-After zkuste operaci zopakovat.

Name Typ Description
error

ErrorDetailsWithNestedDetails

Podrobnosti o chybě.

FileDestination

Cíl dat zobrazení. Tato položka je nepovinná. Aktuálně se podporuje jenom formát CSV.

Name Typ Description
fileFormats

FileFormat[]

Cíl dat zobrazení. Aktuálně se podporuje jenom formát CSV.

FileFormat

Cíl dat zobrazení. Aktuálně se podporuje jenom formát CSV.

Name Typ Description
Csv

string

NotificationProperties

Vlastnosti oznámení naplánované akce.

Name Typ Description
language

string

Národní prostředí e-mailu.
message

string

Volitelná zpráva, která se má přidat do e-mailu. Délka je omezena na 250 znaků.
regionalFormat

string

Místní formát, který se používá k formátování hodnot data a času a měny v e-mailu.
subject

string

Předmět e-mailu. Délka je omezena na 70 znaků.
to

string[]

Pole e-mailových adres

ScheduledAction

Definice naplánované akce

Name Typ Description
eTag

string

Značka ETag prostředku. Pro volání aktualizací je značka eTag volitelná a je možné ji zadat, aby se dosáhlo optimistické souběžnosti. Načtěte eTag prostředku tak, že nejprve zavoláte GET a pak při provádění aktualizace zahrnete nejnovější eTag jako součást textu požadavku nebo hlavičky If-Match. Při vytváření volání se značka eTag nevyžaduje.
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
kind

ScheduledActionKind

Druh naplánované akce
name

string

Název prostředku
properties.displayName

string

Název naplánované akce.
properties.fileDestination

FileDestination

Cílový formát dat zobrazení. Tato položka je nepovinná.
properties.notification

NotificationProperties

Vlastnosti oznámení založené na druhu naplánované akce.
properties.notificationEmail

string

Email adresu kontaktního místa, které by mělo dostávat žádosti o odhlášení odběru a e-maily s oznámením.
properties.schedule

ScheduleProperties

Plán naplánované akce
properties.scope

string

U privátních plánovaných akcí (vytvoření nebo aktualizace) bude rozsah prázdný.
Pro sdílenou naplánovanou akci (vytvoření nebo aktualizaci podle rozsahu) může být rozsah služby Cost Management subscriptions/{subscriptionId} pro rozsah předplatného. subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro rozsah oddělení, "providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId} pro rozsah EnrollmentAccount, Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro obor BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingId}/invoiceSections/{invoiceSectionId} pro rozsah InvoiceSection, /providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName} pro Rozsah ExternalBillingAccount a /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} pro obor ExternalSubscription.
properties.status

ScheduledActionStatus

Stav naplánované akce
properties.viewId

string

Id zobrazení analýzy nákladů použité pro naplánovanou akci. Například /providers/Microsoft.CostManagement/views/swaggerExample
systemData

systemData

Druh naplánované akce
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ScheduledActionKind

Druh naplánované akce

Name Typ Description
Email

string

Data analýzy nákladů budou e-mailem.
InsightAlert

string

Informace o nákladové anomálii budou e-mailem. K dispozici pouze v rozsahu předplatného s denní frekvencí. Pokud se u prostředku nezjistí žádná anomálie, e-mail se neodesílají.

ScheduledActionStatus

Stav naplánované akce

Name Typ Description
Disabled

string

Naplánovaná akce se uloží, ale nespustí se.
Enabled

string

Naplánovaná akce se uloží a spustí se.
Expired

string

Platnost naplánované akce vypršela.

ScheduleFrequency

Frekvence plánu.

Name Typ Description
Daily

string

Data analýzy nákladů se budou každý den zasílat e-mailem.
Monthly

string

Data analýzy nákladů budou každý měsíc zasílaná e-mailem.
Weekly

string

Data analýzy nákladů se budou každý týden zasílat e-mailem.

ScheduleProperties

Vlastnosti plánu.

Name Typ Description
dayOfMonth

integer

den UTC, kdy budou data analýzy nákladů e-mailem. Musí být mezi 1 a 31. Tato vlastnost se dá použít, když je frekvence nastavená na Měsíční a přepisuje weeksOfMonth nebo daysOfWeek.
daysOfWeek

DaysOfWeek[]

Názvy dnů v angličtině, pro které budou data analýzy nákladů posílána e-mailem. Tato vlastnost se dá použít, když je frekvence nastavená na Týdenní nebo Měsíční.
endDate

string

Koncové datum a čas naplánované akce (UTC).
frequency

ScheduleFrequency

Frekvence plánu.
hourOfDay

integer

Čas UTC, ve kterém budou data analýzy nákladů e-mailem.
startDate

string

Počáteční datum a čas naplánované akce (UTC)
weeksOfMonth

WeeksOfMonth[]

Týdny, ve kterých budou data analýzy nákladů posílána e-mailem. Tato vlastnost je použitelná, pokud je frekvence měsíční a používá se v kombinaci s daysOfWeek.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string

Časové razítko vytvoření prostředku (UTC)
createdBy

string

Identita, která vytvořila prostředek.
createdByType

createdByType

Typ identity, která prostředek vytvořila.
lastModifiedAt

string

Časové razítko poslední změny prostředku (UTC)
lastModifiedBy

string

Identita, která naposledy změnila prostředek.
lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

WeeksOfMonth

Týdny v měsíci.

Name Typ Description
First

string

Fourth

string

Last

string

Second

string

Third

string