Megosztás a következőn keresztül:

Scheduled Actions - Create Or Update By Scope

  • Referencia
Szolgáltatás:
Cost Management
API-verzió:
2024-08-01

Hozzon létre vagy frissítsen egy megosztott ütemezett műveletet az adott hatókörön belül.

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

URI-paraméterek

Name In Kötelező Típus Description
name
 path True

string

Ütemezett művelet neve.
scope
 path True

string

Az ütemezett műveletműveletekhez társított hatókör. Ide tartoznak az "előfizetések/{subscriptionId}" az előfizetés hatóköréhez, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" for resourceGroup scope, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" a számlázási fiók hatóköréhez, "providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/departments/{departmentId}" a részleg hatóköréhez, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" for EnrollmentAccount scope, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" a BillingProfile hatókörhöz, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" a InvoiceSection hatókörhöz, a "providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" a külső számlázási fiók hatóköréhez és a "szolgáltatók/Microsoft". CostManagement/externalSubscriptions/{externalSubscriptionName}" a külső előfizetés hatóköréhez. Megjegyzés: Az Elemzési riasztások csak az előfizetés hatókörében érhetők el.
api-version
 query True

string

A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name Kötelező Típus Description
If-Match

string

Az entitás ETagje. Entitás létrehozásakor nem kötelező. Nem kötelező egy entitás frissítésekor, és megadható optimista egyidejűség elérése érdekében.

Kérelem törzse

Name Kötelező Típus Description
properties.displayName True

string

Ütemezett művelet neve.
properties.notification True

NotificationProperties

Értesítési tulajdonságok ütemezett művelettípus alapján.
properties.schedule True

ScheduleProperties

Az ütemezett művelet ütemezése.
properties.status True

ScheduledActionStatus

Az ütemezett művelet állapota.
properties.viewId True

string

Az ütemezett művelethez használt költségelemzési nézetazonosító. Például: "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Az ütemezett művelet típusa.
properties.fileDestination

FileDestination

A nézetadatok célformátuma. Ez nem kötelező.
properties.notificationEmail

string

A kapcsolatfelvételi pont e-mail-címe, amely leiratkozási kéréseket és értesítési e-maileket kap.
properties.scope

string

A privát ütemezett művelet (létrehozás vagy frissítés) esetében a hatókör üres lesz.
Megosztott ütemezett művelet (Hatókör szerinti létrehozás vagy frissítés) esetén a Cost Management hatóköre lehet előfizetés/{subscriptionId}, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" a resourceGroup-hatókörhöz, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" a számlázási fiók hatóköréhez, "providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/departments/{departmentId}" a részleg hatóköréhez, "szolgáltatók/Microsoft". Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" a EnrollmentAccount hatókörhöz, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" a BillingProfile hatókörhöz, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" a InvoiceSection hatókörhöz, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" for ExternalBillingAccount hatókör és "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" a ExternalSubscription hatókörhöz.

Válaszok

Name Típus Description
200 OK

ScheduledAction

OKÉ. A kérés sikeres volt.
201 Created

ScheduledAction

Létrehozott.
Other Status Codes

ErrorResponseWithNestedDetails

Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name Description
user_impersonation a felhasználói fiók megszemélyesítése

Példák

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Mintakérelem

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

Mintaválasz

Állapotkó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"
  }
}
Állapotkó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

Mintakérelem

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

Mintaválasz

Állapotkó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"
  }
}
Állapotkó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"
  }
}

Definíciók

Name Description
createdByType

Az erőforrást létrehozó identitás típusa.
DaysOfWeek

Hét napjai.
ErrorDetailsWithNestedDetails

A hiba részletei.
ErrorResponseWithNestedDetails

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Néhány hibaválasz:

  • 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időre való várakozás után.

  • 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Próbálkozzon újra az "Újrapróbálkozás után" fejlécben megadott időre való várakozás után.
FileDestination

A nézetadatok célhelye. Ez nem kötelező. Jelenleg csak a CSV formátum támogatott.
FileFormat

A nézetadatok célhelye. Jelenleg csak a CSV formátum támogatott.
NotificationProperties

Az ütemezett műveletértesítés tulajdonságai.
ScheduledAction

Ütemezett műveletdefiníció.
ScheduledActionKind

Az ütemezett művelet típusa.
ScheduledActionStatus

Az ütemezett művelet állapota.
ScheduleFrequency

Az ütemezés gyakorisága.
ScheduleProperties

Az ütemezés tulajdonságai.
systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
WeeksOfMonth

A hónap hetei.

createdByType

Az erőforrást létrehozó identitás típusa.

Name Típus Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Hét napjai.

Name Típus Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

A hiba részletei.

Name Típus Description
code

string

Hibakód.
details

ErrorDetailsWithNestedDetails[]

A hiba további részletei.
message

string

A művelet sikertelen voltát jelző hibaüzenet.

ErrorResponseWithNestedDetails

A hibaválasz azt jelzi, hogy a szolgáltatás nem tudja feldolgozni a bejövő kérést. Ennek okát a hibaüzenet adja meg.

Néhány hibaválasz:

  • 429 TooManyRequests – A kérés szabályozva van. Próbálkozzon újra az "x-ms-ratelimit-microsoft.consumption-retry-after" fejlécben megadott időre való várakozás után.

  • 503 ServiceUnavailable – A szolgáltatás átmenetileg nem érhető el. Próbálkozzon újra az "Újrapróbálkozás után" fejlécben megadott időre való várakozás után.

Name Típus Description
error

ErrorDetailsWithNestedDetails

A hiba részletei.

FileDestination

A nézetadatok célhelye. Ez nem kötelező. Jelenleg csak a CSV formátum támogatott.

Name Típus Description
fileFormats

FileFormat[]

A nézetadatok célhelye. Jelenleg csak a CSV formátum támogatott.

FileFormat

A nézetadatok célhelye. Jelenleg csak a CSV formátum támogatott.

Name Típus Description
Csv

string

NotificationProperties

Az ütemezett műveletértesítés tulajdonságai.

Name Típus Description
language

string

Az e-mail területi beállítása.
message

string

Az e-mailben hozzáadandó nem kötelező üzenet. A hossz legfeljebb 250 karakter lehet.
regionalFormat

string

Az e-mail dátum-/idő- és pénznemértékeinek formázásához használt regionális formátum.
subject

string

Az e-mail tárgya. A hossz legfeljebb 70 karakter hosszúságú lehet.
to

string[]

E-mail-címek tömbje.

ScheduledAction

Ütemezett műveletdefiníció.

Name Típus Description
eTag

string

Erőforráscímke. Frissítési hívások esetén az eTag nem kötelező, és megadható az optimista egyidejűség eléréséhez. Kérje le az erőforrás eTagjét úgy, hogy először "GET" hívást végez, majd a legújabb eTaget is beleszámítva a kérelem törzsébe vagy az If-Match fejlécbe a frissítés végrehajtása közben. Hívások létrehozásához nincs szükség eTagre.
id

string

Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Az ütemezett művelet típusa.
name

string

Az erőforrás neve
properties.displayName

string

Ütemezett művelet neve.
properties.fileDestination

FileDestination

A nézetadatok célformátuma. Ez nem kötelező.
properties.notification

NotificationProperties

Értesítési tulajdonságok ütemezett művelettípus alapján.
properties.notificationEmail

string

A kapcsolatfelvételi pont e-mail-címe, amely leiratkozási kéréseket és értesítési e-maileket kap.
properties.schedule

ScheduleProperties

Az ütemezett művelet ütemezése.
properties.scope

string

A privát ütemezett művelet (létrehozás vagy frissítés) esetében a hatókör üres lesz.
Megosztott ütemezett művelet (Hatókör szerinti létrehozás vagy frissítés) esetén a Cost Management hatóköre lehet előfizetés/{subscriptionId}, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" a resourceGroup-hatókörhöz, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" a számlázási fiók hatóköréhez, "providers/Microsoft.Billing/billingAccounts/{billingAccounts/{billingAccountId}/departments/{departmentId}" a részleg hatóköréhez, "szolgáltatók/Microsoft". Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}" a EnrollmentAccount hatókörhöz, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" a BillingProfile hatókörhöz, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" a InvoiceSection hatókörhöz, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" for ExternalBillingAccount hatókör és "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" a ExternalSubscription hatókörhöz.
properties.status

ScheduledActionStatus

Az ütemezett művelet állapota.
properties.viewId

string

Az ütemezett művelethez használt költségelemzési nézetazonosító. Például: "/providers/Microsoft.CostManagement/views/swaggerExample"
systemData

systemData

Az ütemezett művelet típusa.
type

string

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Az ütemezett művelet típusa.

Name Típus Description
Email

string

A költségelemzési adatok e-mailben lesznek elküldve.
InsightAlert

string

A költség anomáliával kapcsolatos információkat e-mailben küldjük el. Csak az előfizetés hatókörében érhető el napi gyakorisággal. Ha az erőforrás nem észlel rendellenességet, a rendszer nem küld e-mailt.

ScheduledActionStatus

Az ütemezett művelet állapota.

Name Típus Description
Disabled

string

Az ütemezett műveletet a rendszer menti, de nem futtatja.
Enabled

string

Az ütemezett művelet mentése és futtatása történik.
Expired

string

Az ütemezett művelet lejárt.

ScheduleFrequency

Az ütemezés gyakorisága.

Name Típus Description
Daily

string

A költségelemzési adatok minden nap e-mailben lesznek elküldve.
Monthly

string

A költségelemzési adatok minden hónapban e-mailben lesznek elküldve.
Weekly

string

A költségelemzési adatok minden héten e-mailben lesznek elküldve.

ScheduleProperties

Az ütemezés tulajdonságai.

Name Típus Description
dayOfMonth

integer

UTC nap, amelyen a költségelemzési adatok e-mailben lesznek elküldve. 1 és 31 között kell lennie. Ez a tulajdonság akkor alkalmazható, ha a gyakoriság havi, és felülbírálja a hetekOfMonth vagy daysOfWeek értékét.
daysOfWeek

DaysOfWeek[]

A napnevek angol nyelven, amelyen a költségelemzési adatok e-mailben lesznek elküldve. Ez a tulajdonság akkor alkalmazható, ha a gyakoriság heti vagy havi.
endDate

string

Az ütemezett művelet záró dátuma és időpontja (UTC).
frequency

ScheduleFrequency

Az ütemezés gyakorisága.
hourOfDay

integer

UTC időpont, amikor a költségelemzési adatok e-mailben lesznek elküldve.
startDate

string

Az ütemezett művelet kezdő dátuma és időpontja (UTC).
weeksOfMonth

WeeksOfMonth[]

Hetek, amikor a költségelemzési adatok e-mailben lesznek elküldve. Ez a tulajdonság akkor alkalmazható, ha a gyakoriság havi, és a daysOfWeek kombinációval együtt használatos.

systemData

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name Típus Description
createdAt

string

Az erőforrás-létrehozás időbélyege (UTC).
createdBy

string

Az erőforrást létrehozó identitás.
createdByType

createdByType

Az erőforrást létrehozó identitás típusa.
lastModifiedAt

string

Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy

string

Az erőforrást legutóbb módosító identitás.
lastModifiedByType

createdByType

Az erőforrást legutóbb módosító identitás típusa.

WeeksOfMonth

A hónap hetei.

Name Típus Description
First

string

Fourth

string

Last

string

Second

string

Third

string