Freigeben über

Scheduled Actions - Create Or Update By Scope

  • Referenz
Dienst:
Cost Management
API-Version:
2024-08-01

Erstellen oder Aktualisieren einer freigegebenen geplanten Aktion innerhalb des angegebenen Bereichs.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
name
 path True

string

Name der geplanten Aktion.
scope
 path True

string

Der Bereich, der geplanten Aktionsvorgängen zugeordnet ist. Dies umfasst "abonnements/{subscriptionId}" für den Abonnementbereich, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' für resourceGroup-Bereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' für Abteilungsbereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für enrollmentAccount-Bereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft. CostManagement/externalSubscriptions/{externalSubscriptionName}' für den Bereich externes Abonnement. Hinweis: Insight Alerts sind nur im Abonnementbereich verfügbar.
api-version
 query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

ETag der Entität. Beim Erstellen einer Entität nicht erforderlich. Optional beim Aktualisieren einer Entität und kann angegeben werden, um eine optimistische Parallelität zu erzielen.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.displayName True

string

Name der geplanten Aktion.
properties.notification True

NotificationProperties

Benachrichtigungseigenschaften basierend auf der art der geplanten Aktion.
properties.schedule True

ScheduleProperties

Zeitplan der geplanten Aktion.
properties.status True

ScheduledActionStatus

Status der geplanten Aktion.
properties.viewId True

string

Cost analysis viewId used for scheduled action. Beispiel: "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Art der geplanten Aktion.
properties.fileDestination

FileDestination

Zielformat der Ansichtsdaten. Dies ist optional.
properties.notificationEmail

string

E-Mail-Adresse des Kontaktpunkts, der die Abonnementanforderungen und Benachrichtigungs-E-Mails erhalten soll.
properties.scope

string

Für private geplante Aktion (Erstellen oder Aktualisieren) ist der Bereich leer.
Für freigegebene geplante Aktion(Erstellen oder Aktualisieren nach Bereich) kann der Kostenverwaltungsbereich "Abonnements/{subscriptionId}" für den Abonnementbereich, "abonnements/{subscriptionId}/resourceGroups/{resourceGroupName}" für den Ressourcengruppenbereich, "Providers/Microsoft.Billing/billingAccounts/{billingAccountId}" für den Abrechnungskontobereich, "Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingAccountId}" für den Bereich "Abteilung", "Anbieter/Microsoft" sein. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' für enrollmentAccount-Bereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' für Bereich 'ExternalBillingAccount' und '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' für externalSubscription-Bereich.

Antworten

Name Typ Beschreibung
200 OK

ScheduledAction

OKAY. Die Anforderung ist erfolgreich.
201 Created

ScheduledAction

Erstellt.
Other Status Codes

ErrorResponseWithNestedDetails

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

CreateOrUpdateInsightAlertScheduledActionByScope
CreateOrUpdateScheduledActionByScope

CreateOrUpdateInsightAlertScheduledActionByScope

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
createdByType

Der Identitätstyp, der die Ressource erstellt hat.
DaysOfWeek

Wochentage.
ErrorDetailsWithNestedDetails

Die Details des Fehlers.
ErrorResponseWithNestedDetails

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

  • 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.

  • 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
FileDestination

Ziel der Ansichtsdaten. Dies ist optional. Derzeit wird nur das CSV-Format unterstützt.
FileFormat

Ziel der Ansichtsdaten. Derzeit wird nur das CSV-Format unterstützt.
NotificationProperties

Die Eigenschaften der geplanten Aktionsbenachrichtigung.
ScheduledAction

Definition der geplanten Aktion.
ScheduledActionKind

Art der geplanten Aktion.
ScheduledActionStatus

Status der geplanten Aktion.
ScheduleFrequency

Häufigkeit des Zeitplans.
ScheduleProperties

Die Eigenschaften des Zeitplans.
systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.
WeeksOfMonth

Wochen des Monats.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

DaysOfWeek

Wochentage.

Name Typ Beschreibung
Friday

string

Monday

string

Saturday

string

Sunday

string

Thursday

string

Tuesday

string

Wednesday

string

ErrorDetailsWithNestedDetails

Die Details des Fehlers.

Name Typ Beschreibung
code

string

Fehlercode.
details

ErrorDetailsWithNestedDetails[]

Die zusätzlichen Details des Fehlers.
message

string

Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponseWithNestedDetails

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

  • 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.

  • 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

Name Typ Beschreibung
error

ErrorDetailsWithNestedDetails

Die Details des Fehlers.

FileDestination

Ziel der Ansichtsdaten. Dies ist optional. Derzeit wird nur das CSV-Format unterstützt.

Name Typ Beschreibung
fileFormats

FileFormat[]

Ziel der Ansichtsdaten. Derzeit wird nur das CSV-Format unterstützt.

FileFormat

Ziel der Ansichtsdaten. Derzeit wird nur das CSV-Format unterstützt.

Name Typ Beschreibung
Csv

string

NotificationProperties

Die Eigenschaften der geplanten Aktionsbenachrichtigung.

Name Typ Beschreibung
language

string

Gebietsschema der E-Mail.
message

string

Optionale Nachricht, die in der E-Mail hinzugefügt werden soll. Die Länge ist auf 250 Zeichen begrenzt.
regionalFormat

string

Regionales Format zum Formatieren von Datums-/Uhrzeit- und Währungswerten in der E-Mail.
subject

string

Betreff der E-Mail. Die Länge ist auf 70 Zeichen begrenzt.
to

string[]

Array von E-Mail-Adressen.

ScheduledAction

Definition der geplanten Aktion.

Name Typ Beschreibung
eTag

string

Ressourcen-Etag. Bei Aktualisierungsaufrufen ist eTag optional und kann angegeben werden, um eine optimistische Parallelität zu erzielen. Rufen Sie das eTag der Ressource ab, indem Sie zuerst einen "GET"-Aufruf ausführen und dann das neueste eTag als Teil des Anforderungstexts oder des Headers "If-Match" einschließen, während Sie die Aktualisierung ausführen. Für das Erstellen von Anrufen ist eTag nicht erforderlich.
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
kind

ScheduledActionKind

Art der geplanten Aktion.
name

string

Der Name der Ressource
properties.displayName

string

Name der geplanten Aktion.
properties.fileDestination

FileDestination

Zielformat der Ansichtsdaten. Dies ist optional.
properties.notification

NotificationProperties

Benachrichtigungseigenschaften basierend auf der art der geplanten Aktion.
properties.notificationEmail

string

E-Mail-Adresse des Kontaktpunkts, der die Abonnementanforderungen und Benachrichtigungs-E-Mails erhalten soll.
properties.schedule

ScheduleProperties

Zeitplan der geplanten Aktion.
properties.scope

string

Für private geplante Aktion (Erstellen oder Aktualisieren) ist der Bereich leer.
Für freigegebene geplante Aktion(Erstellen oder Aktualisieren nach Bereich) kann der Kostenverwaltungsbereich "Abonnements/{subscriptionId}" für den Abonnementbereich, "abonnements/{subscriptionId}/resourceGroups/{resourceGroupName}" für den Ressourcengruppenbereich, "Providers/Microsoft.Billing/billingAccounts/{billingAccountId}" für den Abrechnungskontobereich, "Providers/Microsoft.Billing/billingAccounts/{billingAccountId}/{billingAccountId}" für den Bereich "Abteilung", "Anbieter/Microsoft" sein. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' für enrollmentAccount-Bereich, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' für Bereich 'ExternalBillingAccount' und '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' für externalSubscription-Bereich.
properties.status

ScheduledActionStatus

Status der geplanten Aktion.
properties.viewId

string

Cost analysis viewId used for scheduled action. Beispiel: "/providers/Microsoft.CostManagement/views/swaggerExample"
systemData

systemData

Art der geplanten Aktion.
type

string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ScheduledActionKind

Art der geplanten Aktion.

Name Typ Beschreibung
Email

string

Kostenanalysedaten werden per E-Mail gesendet.
InsightAlert

string

Anomalieinformationen werden per E-Mail gesendet. Nur im Abonnementbereich täglich verfügbar. Wenn für die Ressource keine Anomalie erkannt wird, wird keine E-Mail gesendet.

ScheduledActionStatus

Status der geplanten Aktion.

Name Typ Beschreibung
Disabled

string

Geplante Aktion wird gespeichert, aber nicht ausgeführt.
Enabled

string

Geplante Aktion wird gespeichert und ausgeführt.
Expired

string

Geplante Aktion ist abgelaufen.

ScheduleFrequency

Häufigkeit des Zeitplans.

Name Typ Beschreibung
Daily

string

Kostenanalysedaten werden täglich per E-Mail gesendet.
Monthly

string

Kostenanalysedaten werden jeden Monat per E-Mail gesendet.
Weekly

string

Kostenanalysedaten werden jede Woche per E-Mail gesendet.

ScheduleProperties

Die Eigenschaften des Zeitplans.

Name Typ Beschreibung
dayOfMonth

integer

UTC-Tag, an dem Kostenanalysedaten per E-Mail gesendet werden. Muss zwischen 1 und 31 sein. Diese Eigenschaft gilt, wenn die Häufigkeit monatlich ist und WochenOfMonth oder DaysOfWeek überschreibt.
daysOfWeek

DaysOfWeek[]

Tagesnamen in Englisch, auf denen Kostenanalysedaten per E-Mail gesendet werden. Diese Eigenschaft gilt, wenn die Häufigkeit wöchentlich oder monatlich ist.
endDate

string

Enddatum und -uhrzeit der geplanten Aktion (UTC).
frequency

ScheduleFrequency

Häufigkeit des Zeitplans.
hourOfDay

integer

UTC-Zeit, zu der Kostenanalysedaten per E-Mail gesendet werden.
startDate

string

Das Startdatum und die Uhrzeit der geplanten Aktion (UTC).
weeksOfMonth

WeeksOfMonth[]

Wochen, in denen Kostenanalysedaten per E-Mail gesendet werden. Diese Eigenschaft gilt, wenn die Häufigkeit monatlich ist und in Kombination mit "daysOfWeek" verwendet wird.

systemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name Typ Beschreibung
createdAt

string

Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy

string

Die Identität, die die Ressource erstellt hat.
createdByType

createdByType

Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt

string

Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy

string

Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType

createdByType

Der Identitätstyp, der die Ressource zuletzt geändert hat.

WeeksOfMonth

Wochen des Monats.

Name Typ Beschreibung
First

string

Fourth

string

Last

string

Second

string

Third

string