Sdílet prostřednictvím

Scheduled Actions - Create Or Update By Scope

  • Reference
Služba:
Cost Management
Verze rozhraní API:
2024-08-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=2024-08-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 předplatná/{subscriptionId} pro rozsah předplatného. Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/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 poskytovatele/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName} pro rozsah externího předplatného. Poznámka: Výstrahy 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

ETag of the 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 typu 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í Toto je volitelné.
properties.notificationEmail

string

E-mailová adresa kontaktního místa, která by měla dostávat žádosti o odhlášení odběru a e-maily s oznámením.
properties.scope

string

Pro soukromou naplánovanou akci (Vytvoření nebo aktualizace) bude obor prázdný.
Pro sdílenou naplánovanou akci (vytvořit nebo aktualizovat podle rozsahu) může být rozsah služby Cost Management pro rozsah předplatného "subscriptions/{subscriptionId}", Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, provider/Microsoft. Fakturace/ 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 ExternalBillingAccount a /providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName} pro obor ExternalSubscription.

Odpovědi

Name Typ Description
200 OK

ScheduledAction

OK. Požadavek byl úspěšný.
201 Created

ScheduledAction

Vytvořil.
Other Status Codes

ErrorResponseWithNestedDetails

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

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource?api-version=2024-08-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"
  }
}

Ukázková odpověď

Stavový kód:
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"
  }
}
Stavový kód:
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

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource?api-version=2024-08-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"
  }
}

Ukázková odpověď

Stavový kód:
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"
  }
}
Stavový kód:
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ěď značí, ž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ý. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.
FileDestination

Cíl dat zobrazení. Toto je volitelné. 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 měsíce.

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 označující, proč operace selhala.

ErrorResponseWithNestedDetails

Chybová odpověď značí, ž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ý. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

Name Typ Description
error

ErrorDetailsWithNestedDetails

Podrobnosti o chybě.

FileDestination

Cíl dat zobrazení. Toto je volitelné. 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 omezená na 250 znaků.
regionalFormat

string

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

string

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

string[]

Pole e-mailových adres

ScheduledAction

Definice naplánované akce

Name Typ Description
eTag

string

Značky Etag prostředku U volání aktualizací je funkce eTag volitelná a lze ji zadat, aby se dosáhlo optimistické souběžnosti. Načtěte značku eTag prostředku tak, že nejprve zavoláte GET a pak při aktualizaci zahrnete nejnovější značku eTag jako součást textu požadavku nebo hlavičku If-Match. Pro vytváření volání není eTag vyžadována.
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
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í Toto je volitelné.
properties.notification

NotificationProperties

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

string

E-mailová adresa kontaktního místa, která by měla 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

Pro soukromou naplánovanou akci (Vytvoření nebo aktualizace) bude obor prázdný.
Pro sdílenou naplánovanou akci (vytvořit nebo aktualizovat podle rozsahu) může být rozsah služby Cost Management pro rozsah předplatného "subscriptions/{subscriptionId}", Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName} pro obor resourceGroup, providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId} pro rozsah fakturačního účtu, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, provider/Microsoft. Fakturace/ 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 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 anomálii nákladů budou e-mailem. K dispozici pouze v rozsahu předplatného s denní frekvencí. Pokud prostředek nezjistí žádnou anomálii, neodesílají se e-maily.

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

Naplánovaná akce vypršela.

ScheduleFrequency

Frekvence plánu.

Name Typ Description
Daily

string

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

string

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

string

Data analýzy nákladů budou každý týden 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 vztahuje, pokud je frekvence Měsíční a přepisuje týdnyOfMonth nebo daysOfWeek.
daysOfWeek

DaysOfWeek[]

Názvy dnů v angličtině, na kterých se budou data analýzy nákladů generovat e-mailem. Tato vlastnost se dá použít, pokud je četnost týdně nebo měsíčně.
endDate

string

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

ScheduleFrequency

Frekvence plánu.
hourOfDay

integer

Čas UTC, kdy budou data analýzy nákladů e-mailem 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ů e-mailem. Tato vlastnost se vztahuje, 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á prostředek vytvořila.
createdByType

createdByType

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

string

Časové razítko poslední změny zdroje (UTC)
lastModifiedBy

string

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

createdByType

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

WeeksOfMonth

Týdny měsíce.

Name Typ Description
First

string

Fourth

string

Last

string

Second

string

Third

string