Share via

Scheduled Actions - Create Or Update By Scope

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

Skapa eller uppdatera en delad schemalagd åtgärd inom det angivna omfånget.

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

URI-parametrar

Name I Obligatorisk Typ Description
name
 path True

string

Namn på schemalagd åtgärd.
scope
 path True

string

Omfånget som är associerat med schemalagda åtgärdsåtgärder. Detta inkluderar "subscriptions/{subscriptionId}" för prenumerationsomfånget, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfånget, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfånget, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningens omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfånget providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} för BillingProfile-omfånget. "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" för InvoiceSection-omfång, "providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" för externt faktureringskontoomfång och "providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName} för omfång för extern prenumeration. Obs! Insiktsaviseringar är bara tillgängliga i prenumerationsomfånget.
api-version
 query True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för entiteten. Krävs inte när du skapar en entitet. Valfritt när du uppdaterar en entitet och kan anges för att uppnå optimistisk samtidighet.

Begärandetext

Name Obligatorisk Typ Description
properties.displayName True

string

Namn på schemalagd åtgärd.
properties.notification True

NotificationProperties

Meddelandeegenskaper baserat på schemalagd åtgärdstyp.
properties.schedule True

ScheduleProperties

Schema för den schemalagda åtgärden.
properties.status True

ScheduledActionStatus

Status för den schemalagda åtgärden.
properties.viewId True

string

Cost analysis viewId används för schemalagd åtgärd. Till exempel "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Typ av schemalagd åtgärd.
properties.fileDestination

FileDestination

Målformat för visningsdata. Detta är valfritt.
properties.notificationEmail

string

Email adress till den kontaktpunkt som ska få avregistreringsbegäranden och e-postmeddelanden om aviseringar.
properties.scope

string

För privat schemalagd åtgärd (skapa eller uppdatera) är omfånget tomt.
För delad schemalagd åtgärd (Skapa eller uppdatera efter omfång) kan Cost Management-omfånget vara "subscriptions/{subscriptionId}" för prenumerationsomfånget. "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningsomfånget providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId} för EnrollmentAccount-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" för BillingProfile-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" för InvoiceSection-omfång, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" för ExternalBillingAccount-omfång och "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" för ExternalSubscription-omfång.

Svar

Name Typ Description
200 OK

ScheduledAction

OK. Begäran har slutförts.
201 Created

ScheduledAction

Skapad.
Other Status Codes

ErrorResponseWithNestedDetails

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Definitioner

Name Description
createdByType

Den typ av identitet som skapade resursen.
DaysOfWeek

Veckodagar.
ErrorDetailsWithNestedDetails

Information om felet.
ErrorResponseWithNestedDetails

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.
FileDestination

Målet för visningsdata. Detta är valfritt. För närvarande stöds endast CSV-format.
FileFormat

Målet för visningsdata. För närvarande stöds endast CSV-format.
NotificationProperties

Egenskaperna för det schemalagda åtgärdsmeddelandet.
ScheduledAction

Definition av schemalagd åtgärd.
ScheduledActionKind

Typ av schemalagd åtgärd.
ScheduledActionStatus

Status för den schemalagda åtgärden.
ScheduleFrequency

Schemats frekvens.
ScheduleProperties

Egenskaperna för schemat.
systemData

Metadata som rör skapande och senaste ändring av resursen.
WeeksOfMonth

Veckor i månaden.

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Veckodagar.

Name Typ Description
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

Information om felet.

Name Typ Description
code

string

Felkod.
details

ErrorDetailsWithNestedDetails[]

Ytterligare information om felet.
message

string

Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponseWithNestedDetails

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

Name Typ Description
error

ErrorDetailsWithNestedDetails

Information om felet.

FileDestination

Målet för visningsdata. Detta är valfritt. För närvarande stöds endast CSV-format.

Name Typ Description
fileFormats

FileFormat[]

Målet för visningsdata. För närvarande stöds endast CSV-format.

FileFormat

Målet för visningsdata. För närvarande stöds endast CSV-format.

Name Typ Description
Csv

string

NotificationProperties

Egenskaperna för det schemalagda åtgärdsmeddelandet.

Name Typ Description
language

string

Språkvariant för e-postmeddelandet.
message

string

Valfritt meddelande som ska läggas till i e-postmeddelandet. Längden är begränsad till 250 tecken.
regionalFormat

string

Regionalt format som används för formatering av datum/tid och valutavärden i e-postmeddelandet.
subject

string

Ämne för e-postmeddelandet. Längden är begränsad till 70 tecken.
to

string[]

Matris med e-postadresser.

ScheduledAction

Definition av schemalagd åtgärd.

Name Typ Description
eTag

string

Resurs-Etag. För uppdateringsanrop är eTag valfritt och kan anges för att uppnå optimistisk samtidighet. Hämta resursens eTag genom att göra ett GET-anrop först och sedan inkludera den senaste eTag som en del av begärandetexten eller "If-Match"-huvudet när uppdateringen utförs. ETag krävs inte för att skapa anrop.
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Typ av schemalagd åtgärd.
name

string

Namnet på resursen
properties.displayName

string

Namn på schemalagd åtgärd.
properties.fileDestination

FileDestination

Målformat för visningsdata. Detta är valfritt.
properties.notification

NotificationProperties

Meddelandeegenskaper baserat på schemalagd åtgärdstyp.
properties.notificationEmail

string

Email adress till den kontaktpunkt som ska få avregistreringsbegäranden och e-postmeddelanden om aviseringar.
properties.schedule

ScheduleProperties

Schema för den schemalagda åtgärden.
properties.scope

string

För privat schemalagd åtgärd (skapa eller uppdatera) är omfånget tomt.
För delad schemalagd åtgärd (Skapa eller uppdatera efter omfång) kan Cost Management-omfånget vara "subscriptions/{subscriptionId}" för prenumerationsomfånget. "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningsomfånget providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId} för EnrollmentAccount-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" för BillingProfile-omfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" för InvoiceSection-omfång, "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" för ExternalBillingAccount-omfång och "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" för ExternalSubscription-omfång.
properties.status

ScheduledActionStatus

Status för den schemalagda åtgärden.
properties.viewId

string

Cost analysis viewId används för schemalagd åtgärd. Till exempel "/providers/Microsoft.CostManagement/views/swaggerExample"
systemData

systemData

Typ av schemalagd åtgärd.
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Typ av schemalagd åtgärd.

Name Typ Description
Email

string

Kostnadsanalysdata skickas via e-post.
InsightAlert

string

Information om kostnadsavvikelse skickas via e-post. Endast tillgängligt i prenumerationsomfånget med daglig frekvens. Om ingen avvikelse identifieras på resursen skickas inget e-postmeddelande.

ScheduledActionStatus

Status för den schemalagda åtgärden.

Name Typ Description
Disabled

string

Schemalagd åtgärd sparas men kommer inte att köras.
Enabled

string

Schemalagd åtgärd sparas och körs.
Expired

string

Schemalagd åtgärd har upphört att gälla.

ScheduleFrequency

Schemats frekvens.

Name Typ Description
Daily

string

Kostnadsanalysdata skickas via e-post varje dag.
Monthly

string

Kostnadsanalysdata skickas via e-post varje månad.
Weekly

string

Kostnadsanalysdata skickas via e-post varje vecka.

ScheduleProperties

Egenskaperna för schemat.

Name Typ Description
dayOfMonth

integer

UTC-dag då kostnadsanalysdata skickas via e-post. Måste vara mellan 1 och 31. Den här egenskapen gäller när frekvensen är Månadsvis och åsidosätter weeksOfMonth eller daysOfWeek.
daysOfWeek

DaysOfWeek[]

Dagnamn på engelska där kostnadsanalysdata skickas via e-post. Den här egenskapen gäller när frekvensen är Varje vecka eller Varje månad.
endDate

string

Slutdatum och tid för den schemalagda åtgärden (UTC).
frequency

ScheduleFrequency

Schemats frekvens.
hourOfDay

integer

UTC-tid då kostnadsanalysdata skickas via e-post.
startDate

string

Startdatum och tid för den schemalagda åtgärden (UTC).
weeksOfMonth

WeeksOfMonth[]

Veckor då kostnadsanalysdata skickas via e-post. Den här egenskapen gäller när frekvensen är Månatlig och används i kombination med daysOfWeek.

systemData

Metadata som rör skapande och senaste ändring av resursen.

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).
createdBy

string

Identiteten som skapade resursen.
createdByType

createdByType

Den typ av identitet som skapade resursen.
lastModifiedAt

string

Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy

string

Identiteten som senast ändrade resursen.
lastModifiedByType

createdByType

Den typ av identitet som senast ändrade resursen.

WeeksOfMonth

Veckor i månaden.

Name Typ Description
First

string

Fourth

string

Last

string

Second

string

Third

string