Scheduled Actions - Create Or Update By Scope

Service:

Cost Management

API Version:

2023-11-01

Een gedeelde geplande actie binnen het opgegeven bereik maken of bijwerken.

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van geplande actie.
scope	path	True	string	Het bereik dat is gekoppeld aan geplande actiebewerkingen. Dit omvat abonnementen/{subscriptionId} voor abonnementsbereik, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor factureringsaccountbereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' voor Afdelingsbereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} voor enrollmentAccount-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor billingProfile-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor invoiceSection-bereik, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' voor het bereik van het externe factureringsaccount en 'providers/Microsoft'. CostManagement/externalSubscriptions/{externalSubscriptionName}' voor het bereik Extern abonnement. Opmerking: Inzichtwaarschuwingen zijn alleen beschikbaar voor het abonnementsbereik.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	ETag van de entiteit. Niet vereist bij het maken van een entiteit. Optioneel bij het bijwerken van een entiteit en kan worden opgegeven om optimistische gelijktijdigheid te bereiken.

Aanvraagbody

Name	Vereist	Type	Description
properties.displayName	True	string	Naam van geplande actie.
properties.notification	True	NotificationProperties	Meldingseigenschappen op basis van geplande actie.
properties.schedule	True	ScheduleProperties	Planning van de geplande actie.
properties.status	True	ScheduledActionStatus	Status van de geplande actie.
properties.viewId	True	string	Kostenanalyse viewId die wordt gebruikt voor geplande actie. Bijvoorbeeld '/providers/Microsoft.CostManagement/views/swaggerExample'
kind		ScheduledActionKind	Soort geplande actie.
properties.fileDestination		FileDestination	Doelindeling van de weergavegegevens. Dit is optioneel.
properties.notificationEmail		string	Email adres van het contactpunt dat de afmeldingsaanvragen en e-mailmeldingen moet ontvangen.
properties.scope		string	Voor een geplande privéactie (Maken of Bijwerken) is het bereik leeg. Voor een gedeelde geplande actie (Maken of Bijwerken op bereik) kan het Cost Management-bereik 'subscriptions/{subscriptionId}' zijn voor abonnementsbereik, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccount/billingAccount}' voor het bereik van de factureringsaccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' voor Afdelingsbereik, 'providers/Microsoft'. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' voor enrollmentAccount-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor billingProfile-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor InvoiceSection-bereik, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' voor Het bereik ExternalBillingAccount en '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' voor het bereik ExternalSubscription.

Antwoorden

Name	Type	Description
200 OK	ScheduledAction	OK. De aanvraag is geslaagd.
201 Created	ScheduledAction	Gemaakt.
Other Status Codes	ErrorResponseWithNestedDetails	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CreateOrUpdateInsightAlertScheduledActionByScope

CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Sample Request

HTTP

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

HTTP

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

Definities

Name	Description
createdByType	Het type identiteit waarmee de resource is gemaakt.
DaysOfWeek	Dagen van de week.
ErrorDetailsWithNestedDetails	De details van de fout.
ErrorResponseWithNestedDetails	Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht. Enkele foutreacties: 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'x-ms-ratelimit-microsoft.consumption-retry-after'. 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.
FileDestination	Doel van de weergavegegevens. Dit is optioneel. Momenteel wordt alleen de CSV-indeling ondersteund.
FileFormat	Doel van de weergavegegevens. Momenteel wordt alleen de CSV-indeling ondersteund.
NotificationProperties	De eigenschappen van de melding van de geplande actie.
ScheduledAction	Definitie van geplande actie.
ScheduledActionKind	Soort geplande actie.
ScheduledActionStatus	Status van de geplande actie.
ScheduleFrequency	Frequentie van de planning.
ScheduleProperties	De eigenschappen van de planning.
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
WeeksOfMonth	Weken van de maand.

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DaysOfWeek

Dagen van de week.

Name	Type	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorDetailsWithNestedDetails

De details van de fout.

Name	Type	Description
code	string	Foutcode.
details	ErrorDetailsWithNestedDetails[]	De aanvullende details van de fout.
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

ErrorResponseWithNestedDetails

Foutreactie geeft aan dat de service de binnenkomende aanvraag niet kan verwerken. De reden wordt opgegeven in het foutbericht.

Enkele foutreacties:

• 429 TooManyRequests - Aanvraag wordt beperkt. Probeer het opnieuw nadat u hebt gewacht op de tijd die is opgegeven in de header 'x-ms-ratelimit-microsoft.consumption-retry-after'.

• 503 ServiceUnavailable - Service is tijdelijk niet beschikbaar. Probeer het opnieuw nadat u net zolang hebt gewacht zoals aangegeven in de header 'Retry-After'.

Name	Type	Description
error	ErrorDetailsWithNestedDetails	De details van de fout.

FileDestination

Doel van de weergavegegevens. Dit is optioneel. Momenteel wordt alleen de CSV-indeling ondersteund.

Name	Type	Description
fileFormats	FileFormat[]	Doel van de weergavegegevens. Momenteel wordt alleen de CSV-indeling ondersteund.

FileFormat

Doel van de weergavegegevens. Momenteel wordt alleen de CSV-indeling ondersteund.

Name	Type	Description
Csv	string

NotificationProperties

De eigenschappen van de melding van de geplande actie.

Name	Type	Description
language	string	Landinstelling van het e-mailbericht.
message	string	Optioneel bericht dat in het e-mailbericht moet worden toegevoegd. De lengte is beperkt tot 250 tekens.
regionalFormat	string	Regionale indeling die wordt gebruikt voor het opmaken van datum/tijd en valutawaarden in het e-mailbericht.
subject	string	Onderwerp van het e-mailbericht. De lengte is beperkt tot 70 tekens.
to	string[]	Matrix van e-mailadressen.

ScheduledAction

Definitie van geplande actie.

Name	Type	Description
eTag	string	Resource-Etag. Voor update-aanroepen is eTag optioneel en kan worden opgegeven om optimistische gelijktijdigheid te bereiken. Haal de eTag van de resource op door eerst een GET-aanroep uit te voeren en vervolgens de meest recente eTag op te halen als onderdeel van de aanvraagbody of 'If-Match'-header tijdens het uitvoeren van de update. Voor het maken van aanroepen is eTag niet vereist.
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	ScheduledActionKind	Soort geplande actie.
name	string	De naam van de resource
properties.displayName	string	Naam van geplande actie.
properties.fileDestination	FileDestination	Doelindeling van de weergavegegevens. Dit is optioneel.
properties.notification	NotificationProperties	Meldingseigenschappen op basis van geplande actie.
properties.notificationEmail	string	Email adres van het contactpunt dat de afmeldingsaanvragen en e-mailmeldingen moet ontvangen.
properties.schedule	ScheduleProperties	Planning van de geplande actie.
properties.scope	string	Voor een geplande privéactie (Maken of Bijwerken) is het bereik leeg. Voor een gedeelde geplande actie (Maken of Bijwerken op bereik) kan het Cost Management-bereik 'subscriptions/{subscriptionId}' zijn voor abonnementsbereik, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccount/billingAccount}' voor het bereik van de factureringsaccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' voor Afdelingsbereik, 'providers/Microsoft'. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' voor enrollmentAccount-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor billingProfile-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor InvoiceSection-bereik, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' voor Het bereik ExternalBillingAccount en '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' voor het bereik ExternalSubscription.
properties.status	ScheduledActionStatus	Status van de geplande actie.
properties.viewId	string	Kostenanalyse viewId die wordt gebruikt voor geplande actie. Bijvoorbeeld '/providers/Microsoft.CostManagement/views/swaggerExample'
systemData	systemData	Soort geplande actie.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ScheduledActionKind

Soort geplande actie.

Name	Type	Description
Email	string	Gegevens van kostenanalyse worden per e-mail verzonden.
InsightAlert	string	Informatie over kostenafwijkingen wordt per e-mail verzonden. Alleen beschikbaar voor abonnementsbereik met dagelijkse frequentie. Als er geen anomalie wordt gedetecteerd in de resource, wordt er geen e-mail verzonden.

ScheduledActionStatus

Status van de geplande actie.

Name	Type	Description
Disabled	string	Geplande actie wordt opgeslagen, maar wordt niet uitgevoerd.
Enabled	string	Geplande actie wordt opgeslagen en wordt uitgevoerd.
Expired	string	De geplande actie is verlopen.

ScheduleFrequency

Frequentie van de planning.

Name	Type	Description
Daily	string	Gegevens van kostenanalyse worden elke dag per e-mail verzonden.
Monthly	string	Gegevens van kostenanalyse worden elke maand per e-mail verzonden.
Weekly	string	Gegevens van kostenanalyse worden elke week per e-mail verzonden.

ScheduleProperties

De eigenschappen van de planning.

Name	Type	Description
dayOfMonth	integer	UTC-dag waarop gegevens voor kostenanalyse per e-mail worden verzonden. Moet tussen 1 en 31 zijn. Deze eigenschap is van toepassing wanneer de frequentie Maandelijks is en weeksOfMonth of daysOfWeek overschrijft.
daysOfWeek	DaysOfWeek[]	Dagnamen in het Engels waarop kostenanalysegegevens worden gemaild. Deze eigenschap is van toepassing wanneer de frequentie Wekelijks of Maandelijks is.
endDate	string	De einddatum en tijd van de geplande actie (UTC).
frequency	ScheduleFrequency	Frequentie van de planning.
hourOfDay	integer	UTC-tijd waarop kostenanalysegegevens per e-mail worden verzonden.
startDate	string	De begindatum en -tijd van de geplande actie (UTC).
weeksOfMonth	WeeksOfMonth[]	Weken waarin gegevens van kostenanalyse per e-mail worden verzonden. Deze eigenschap is van toepassing wanneer de frequentie Maandelijks is en wordt gebruikt in combinatie met daysOfWeek.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

WeeksOfMonth

Weken van de maand.

Name	Type	Description
First	string
Fourth	string
Last	string
Second	string
Third	string