Scheduled Actions - Create Or Update By Scope

Service:

Cost Management

API-versie:

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 het bereik van de factureringsrekening, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/afdelingen/{departmentId}' voor afdelingsbereik, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} voor het bereik EnrollmentAccount, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor het bereik InvoiceSection, providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName} voor het bereik externe factureringsaccount en providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName} voor extern abonnementsbereik. Opmerking: Inzichtwaarschuwingen zijn alleen beschikbaar voor abonnementsbereik.
api-version	query	True	string minLength: 1	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 het type geplande actie.
properties.schedule	True	ScheduleProperties	Planning van de geplande actie.
properties.status	True	ScheduledActionStatus	Status van de geplande actie.
properties.viewId	True	string	Weergave-id voor kostenanalyse die wordt gebruikt voor geplande actie. Bijvoorbeeld '/providers/Microsoft.CostManagement/views/swaggerExample'
kind		ScheduledActionKind	Soort van de geplande actie.
properties.fileDestination		FileDestination	Doelindeling van de weergavegegevens. Dit is optioneel.
properties.notificationEmail		string	E-mailadres van het contactpunt dat de afmeldingsaanvragen en e-mailberichten voor meldingen moet ontvangen.
properties.scope		string	Voor een privé geplande actie (maken of bijwerken) is het bereik leeg. Voor gedeelde geplande actie (Maken of bijwerken op bereik) kan het Bereik van Cost Management 'abonnementen/{subscriptionId}' zijn voor abonnementsbereik, abonnementen/{subscriptionId}/resourceGroups/{resourceGroupName} voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor factureringsaccountbereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/afdelingen/{departmentId}' voor afdelingsbereik, providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' voor het bereik EnrollmentAccount, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor het bereik InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' voor het bereik InvoiceSection Het bereik ExternalBillingAccount en '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' voor het bereik ExternalSubscription.

Antwoorden

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

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

CreateOrUpdateInsightAlertScheduledActionByScope

CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Statuscode:

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 is opgegeven in het foutbericht. Enkele foutberichten: 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 hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.
FileDestination	Doel van de weergavegegevens. Dit is optioneel. Momenteel wordt alleen csv-indeling ondersteund.
FileFormat	Doel van de weergavegegevens. Momenteel wordt alleen csv-indeling ondersteund.
NotificationProperties	De eigenschappen van de geplande actiemelding.
ScheduledAction	Geplande actiedefinitie.
ScheduledActionKind	Soort van de 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 de laatste wijziging van de resource.
WeeksOfMonth	Weken van de maand.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

DaysOfWeek

Opsomming

Dagen van de week.

Waarde	Description
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Sunday

ErrorDetailsWithNestedDetails

Object

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

Object

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

Enkele foutberichten:

• 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 hebt gewacht op de tijd die is opgegeven in de header 'Opnieuw proberen-na'.

Name	Type	Description
error	ErrorDetailsWithNestedDetails	De details van de fout.

FileDestination

Object

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

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

FileFormat

Opsomming

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

Waarde	Description
Csv

NotificationProperties

Object

De eigenschappen van de geplande actiemelding.

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[] pattern: ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$	Matrix met e-mailadressen.

ScheduledAction

Object

Geplande actiedefinitie.

Name	Type	Description
eTag	string	Resource-Etag. Voor update-aanroepen is eTag optioneel en kan worden opgegeven om optimistische gelijktijdigheid te bereiken. Haal eerst de eTag van de resource op door eerst een GET-aanroep uit te voeren en vervolgens de nieuwste 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. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind	ScheduledActionKind	Soort van de 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 het type geplande actie.
properties.notificationEmail	string	E-mailadres van het contactpunt dat de afmeldingsaanvragen en e-mailberichten voor meldingen moet ontvangen.
properties.schedule	ScheduleProperties	Planning van de geplande actie.
properties.scope	string	Voor een privé geplande actie (maken of bijwerken) is het bereik leeg. Voor gedeelde geplande actie (Maken of bijwerken op bereik) kan het Bereik van Cost Management 'abonnementen/{subscriptionId}' zijn voor abonnementsbereik, abonnementen/{subscriptionId}/resourceGroups/{resourceGroupName} voor resourceGroup-bereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' voor factureringsaccountbereik, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/afdelingen/{departmentId}' voor afdelingsbereik, providers/Microsoft. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' voor het bereik EnrollmentAccount, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' voor het bereik BillingProfile, providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' voor het bereik InvoiceSection, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' voor het bereik InvoiceSection Het bereik ExternalBillingAccount en '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' voor het bereik ExternalSubscription.
properties.status	ScheduledActionStatus	Status van de geplande actie.
properties.viewId	string	Weergave-id voor kostenanalyse die wordt gebruikt voor geplande actie. Bijvoorbeeld '/providers/Microsoft.CostManagement/views/swaggerExample'
systemData	systemData	Soort van de geplande actie.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ScheduledActionKind

Opsomming

Soort van de geplande actie.

Waarde	Description
Email	Gegevens van kostenanalyse worden per e-mail verzonden.
InsightAlert	Kostengegevens worden 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

Opsomming

Status van de geplande actie.

Waarde	Description
Enabled	Geplande actie wordt opgeslagen en wordt uitgevoerd.
Expired	Geplande actie is verlopen.
Disabled	Geplande actie wordt opgeslagen, maar wordt niet uitgevoerd.

ScheduleFrequency

Opsomming

Frequentie van de planning.

Waarde	Description
Daily	Kostenanalysegegevens worden elke dag per e-mail verzonden.
Weekly	Kostenanalysegegevens worden elke week per e-mail verzonden.
Monthly	Kostenanalysegegevens worden elke maand per e-mail verzonden.

ScheduleProperties

Object

De eigenschappen van de planning.

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

systemData

Object

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

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

WeeksOfMonth

Opsomming

Weken van de maand.

Waarde	Description
First
Second
Third
Fourth
Last