Freigeben über

Scheduled Actions - Create Or Update By Scope

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

Erstellen oder aktualisieren Sie eine freigegebene geplante Aktion innerhalb des angegebenen Bereichs.

PUT https://management.azure.com/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}?api-version=2023-11-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 schließt "subscriptions/{subscriptionId}" für den Abonnementbereich ein, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" für resourceGroup-Bereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}" für Abrechnungskontobereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" für abteilungsbereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für den Bereich EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" für BillingProfile-Bereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" für den Bereich "InvoiceSection", "providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" für den Bereich "Externes Abrechnungskonto" und "providers/Microsoft". CostManagement/externalSubscriptions/{externalSubscriptionName}' für den Bereich "Externes Abonnement". Hinweis: Insight-Warnungen sind nur im Abonnementbereich verfügbar.
api-version
 query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

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 erreichen.

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

ViewId der Kostenanalyse, die für geplante Aktionen verwendet wird. Beispiel: "/providers/Microsoft.CostManagement/views/swaggerExample"
kind

ScheduledActionKind

Art der geplanten Aktion.
properties.fileDestination

FileDestination

Zielformat der Ansichtsdaten. Diese Eingabe ist optional.
properties.notificationEmail

string

Email Adresse der Kontaktstelle, die die Abmeldeanforderungen 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 Aktionen (Erstellen oder Aktualisieren nach Bereich) kann der Kostenverwaltungsbereich "subscriptions/{subscriptionId}" für den Abonnementbereich, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" für den Ressourcengruppenbereich, "providers/Microsoft.Billing/billingAccountId/{billingAccountId}" für den Bereich "Abrechnungskonto", "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" für den Bereich "providers/Microsoft" sein. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' für den Bereich EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" für billingProfile-Bereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" für den Bereich "InvoiceSection", "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" für Der Bereich "ExternalBillingAccount" und "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" für den ExternalSubscription-Bereich.

Antworten

Name Typ Beschreibung
200 OK

ScheduledAction

OK. Die Anforderung war erfolgreich.
201 Created

ScheduledAction

Erstellt.
Other Status Codes

ErrorResponseWithNestedDetails

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name Beschreibung
createdByType

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

Wochentage.
ErrorDetailsWithNestedDetails

Die Details des Fehlers.
ErrorResponseWithNestedDetails

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

Einige Fehlerantworten:

  • 429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.

  • 503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.
FileDestination

Ziel der Ansichtsdaten. Diese Eingabe 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 Benachrichtigung über geplante Aktionen.
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, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
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

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponseWithNestedDetails

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

Einige Fehlerantworten:

  • 429 TooManyRequests: Die Anforderung wird gedrosselt. Wiederholen Sie den Vorgang, nachdem Sie auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit gewartet haben.

  • 503 ServiceUnavailable: Der Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang, nachdem Sie die im Header „Retry-After“ angegebene Zeit abgewartet haben.

Name Typ Beschreibung
error

ErrorDetailsWithNestedDetails

Die Details des Fehlers.

FileDestination

Ziel der Ansichtsdaten. Diese Eingabe 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 Benachrichtigung über geplante Aktionen.

Name Typ Beschreibung
language

string

Gebietsschema der E-Mail.
message

string

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

string

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

string

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

string[]

Array von E-Mail-Adressen.

ScheduledAction

Definition der geplanten Aktion.

Name Typ Beschreibung
eTag

string

Ressourcen-Etag. Für Updateaufrufe 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 If-Match-Headers einschließen, während Sie das Update ausführen. Für Erstellungsaufrufe ist eTag nicht erforderlich.
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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. Diese Eingabe ist optional.
properties.notification

NotificationProperties

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

string

Email Adresse der Kontaktstelle, die die Abmeldeanforderungen 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 Aktionen (Erstellen oder Aktualisieren nach Bereich) kann der Kostenverwaltungsbereich "subscriptions/{subscriptionId}" für den Abonnementbereich, "subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" für den Ressourcengruppenbereich, "providers/Microsoft.Billing/billingAccountId/{billingAccountId}" für den Bereich "Abrechnungskonto", "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" für den Bereich "providers/Microsoft" sein. Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' für den Bereich EnrollmentAccount, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" für billingProfile-Bereich, "providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}" für den Bereich "InvoiceSection", "/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}" für Der Bereich "ExternalBillingAccount" und "/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}" für den ExternalSubscription-Bereich.
properties.status

ScheduledActionStatus

Status der geplanten Aktion.
properties.viewId

string

ViewId der Kostenanalyse, die für geplante Aktionen verwendet wird. 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

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

ScheduledActionStatus

Status der geplanten Aktion.

Name Typ Beschreibung
Disabled

string

Die geplante Aktion wird gespeichert, aber nicht ausgeführt.
Enabled

string

Die geplante Aktion wird gespeichert und ausgeführt.
Expired

string

Die 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 frequency den Wert Monthly hat und weeksOfMonth oder daysOfWeek außer Kraft setzt.
daysOfWeek

DaysOfWeek[]

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

string

Das Enddatum und die 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

Startdatum und -uhrzeit der geplanten Aktion (UTC).
weeksOfMonth

WeeksOfMonth[]

Wochen, in denen Kostenanalysedaten per E-Mail gesendet werden. Diese Eigenschaft ist anwendbar, wenn frequency auf Monthly festgelegt ist und in Kombination mit daysOfWeek verwendet wird.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

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