Scheduled Actions - Create Or Update

Referens

Tjänst:: Cost Management

API-version:: 2024-08-01

Skapa eller uppdatera en privat schemalagd åtgärd.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namn på schemalagd åtgärd.
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å typ av schemalagd åtgärd.
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	ViewId för kostnadsanalys som 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. Det här är valfritt.
properties.notificationEmail		string	E-postadress till den kontaktpunkt som ska få begäranden om att avbryta prenumerationen och e-postaviseringar.
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-omfattning, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfång, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningsomfånget providers/Microsoft. Fakturering/faktureringKonton/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId} för EnrollmentAccount-omfång, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' för BillingProfile scope, '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ånget.

Svar

Name	Typ	Description
200 OK	ScheduledAction	OKEJ. 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.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

CreateOrUpdatePrivateScheduledAction

Exempelbegäran

HTTP

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


{
  "kind": "Email",
  "properties": {
    "displayName": "Monthly Cost By Resource",
    "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"
  }
}

Exempelsvar

Statuskod:: 201

{
  "id": "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",
    "notification": {
      "language": "fr",
      "regionalFormat": "fr",
      "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": "",
    "status": "Enabled",
    "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample"
  }
}

Statuskod:: 200

{
  "id": "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": {
      "language": "fr",
      "regionalFormat": "fr",
      "to": [
        "user@gmail.com",
        "team@gmail.com"
      ],
      "subject": "Cost by resource this month"
    },
    "scope": "",
    "status": "Enabled",
    "schedule": {
      "frequency": "Monthly",
      "weeksOfMonth": [
        "First",
        "Third"
      ],
      "daysOfWeek": [
        "Monday"
      ],
      "hourOfDay": 10,
      "startDate": "2020-06-19T22:21:51.1287144Z",
      "endDate": "2021-06-19T22:21:51.1287144Z"
    },
    "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. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".
FileDestination	Målet för visningsdata. Det här ä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	Schemalagd åtgärdsdefinition.
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. Försök igen efter att ha väntat på den tid som anges i rubriken "Försök igen".

Name	Typ	Description
error	ErrorDetailsWithNestedDetails	Information om felet.

FileDestination

Målet för visningsdata. Det här ä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 att formatera 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.