Alerts - Dismiss

Referenz

Service:: Cost Management

API Version:: 2023-11-01

Schließt die angegebene Warnung ab.

PATCH https://management.azure.com/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}?api-version=2023-11-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
alertId	path	True	string	Warnungs-ID
scope	path	True	string	Der Bereich, der Warnungsvorgängen zugeordnet ist. Dies schließt "/subscriptions/{subscriptionId}/" für den Abonnementbereich ein. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/billingAccounts/billing{{AccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für EnrollmentAccount-Bereich, "/providers/Microsoft.Management/managementGroups/{managementGroupId}" für Den Bereich "Verwaltungsgruppe", "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" für billingProfile-Bereich, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}" für den bereich invoiceSection und "/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' spezifisch für Partner.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties.closeTime	string	dateTime, in der die Warnung geschlossen wurde
properties.costEntityId	string	Zugehöriges Budget
properties.creationTime	string	dateTime, in der warnung erstellt wurde
properties.definition	Definition	definiert den Warnungstyp
properties.description	string	Beschreibung der Warnung
properties.details	Details	Warnungsdetails
properties.modificationTime	string	dateTime, in der die Warnung zuletzt geändert wurde
properties.source	AlertSource	Quelle der Warnung
properties.status	AlertStatus	warnung status
properties.statusModificationTime	string	dateTime, in der die Warnung status zuletzt geändert wurde
properties.statusModificationUserName	string	Benutzer, der die Warnung zuletzt geändert hat

Antworten

Name	Typ	Beschreibung
200 OK	Alert	OK. Die Anforderung wurde erfolgreich durchgeführt.
Other Status Codes	ErrorResponse	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

PatchResourceGroupAlerts

PatchSubscriptionAlerts

PatchResourceGroupAlerts

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2023-11-01

{
  "properties": {
    "status": "Dismissed"
  }
}

Sample Response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Dismissed",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

PatchSubscriptionAlerts

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222?api-version=2023-11-01

{
  "properties": {
    "status": "Dismissed"
  }
}

Sample Response

Status code:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222",
  "name": "22222222-2222-2222-2222-222222222222",
  "type": "Microsoft.CostManagement/alerts",
  "properties": {
    "definition": {
      "type": "Budget",
      "category": "Cost",
      "criteria": "CostThresholdExceeded"
    },
    "description": "",
    "source": "Preset",
    "details": {
      "timeGrainType": "Quarterly",
      "periodStartDate": "2020-03-01T00:00:00Z",
      "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01",
      "resourceGroupFilter": [],
      "resourceFilter": [],
      "meterFilter": [],
      "tagFilter": {},
      "threshold": 0.8,
      "operator": "GreaterThan",
      "amount": 200000,
      "unit": "USD",
      "currentSpend": 161000.12,
      "contactEmails": [
        "1234@contoso.com"
      ],
      "contactGroups": [],
      "contactRoles": [],
      "overridingAlert": null
    },
    "costEntityId": "budget1",
    "status": "Dismissed",
    "creationTime": "2020-04-27T11:07:52.7143901Z",
    "closeTime": "0001-01-01T00:00:00",
    "modificationTime": "2020-04-28T11:06:02.8999373Z",
    "statusModificationUserName": null,
    "statusModificationTime": "0001-01-01T00:00:00"
  }
}

Definitionen

Name	Beschreibung
Alert	Eine individuelle Warnung.
AlertCategory	Kategorie „Warnung“
AlertCriteria	Kriterien, die Warnung ausgelöst haben
AlertOperator	Operator zum Vergleichen von currentSpend mit amount
AlertSource	Quelle der Warnung
AlertStatus	warnung status
AlertTimeGrainType	Art des Zeitgrainrhythmus
AlertType	Warnungstyp
Definition	definiert den Warnungstyp
Details	Warnungsdetails
DismissAlertPayload	Die Anforderungsnutzlast zum Aktualisieren einer Warnung
ErrorDetails	Die Details des Fehlers.
ErrorResponse	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.
TagFilter	Zu filternde Tags

Alert

Eine individuelle Warnung.

Name	Typ	Beschreibung
eTag	string	eTag der Ressource. Um gleichzeitiges Updateszenario zu behandeln, wird dieses Feld verwendet, um zu bestimmen, ob der Benutzer die neueste Version aktualisiert oder nicht.
id	string	Ressourcen-ID.
name	string	Name der Ressource.
properties.closeTime	string	dateTime, in der die Warnung geschlossen wurde
properties.costEntityId	string	Zugehöriges Budget
properties.creationTime	string	dateTime, in der warnung erstellt wurde
properties.definition	Definition	definiert den Warnungstyp
properties.description	string	Beschreibung der Warnung
properties.details	Details	Warnungsdetails
properties.modificationTime	string	dateTime, in der die Warnung zuletzt geändert wurde
properties.source	AlertSource	Quelle der Warnung
properties.status	AlertStatus	warnung status
properties.statusModificationTime	string	dateTime, in der die Warnung status zuletzt geändert wurde
properties.statusModificationUserName	string	Benutzer, der die Warnung zuletzt geändert hat
type	string	Der Ressourcentyp.

AlertCategory

Kategorie „Warnung“

Name	Typ	Beschreibung
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

Kriterien, die Warnung ausgelöst haben

Name	Typ	Beschreibung
CostThresholdExceeded	string
CreditThresholdApproaching	string
CreditThresholdReached	string
CrossCloudCollectionError	string
CrossCloudNewDataAvailable	string
ForecastCostThresholdExceeded	string
ForecastUsageThresholdExceeded	string
GeneralThresholdError	string
InvoiceDueDateApproaching	string
InvoiceDueDateReached	string
MultiCurrency	string
QuotaThresholdApproaching	string
QuotaThresholdReached	string
UsageThresholdExceeded	string

AlertOperator

Operator zum Vergleichen von currentSpend mit amount

Name	Typ	Beschreibung
EqualTo	string
GreaterThan	string
GreaterThanOrEqualTo	string
LessThan	string
LessThanOrEqualTo	string
None	string

AlertSource

Quelle der Warnung

Name	Typ	Beschreibung
Preset	string
User	string

AlertStatus

warnung status

Name	Typ	Beschreibung
Active	string
Dismissed	string
None	string
Overridden	string
Resolved	string

AlertTimeGrainType

Art des Zeitgrainrhythmus

Name	Typ	Beschreibung
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
None	string
Quarterly	string

AlertType

Warnungstyp

Name	Typ	Beschreibung
Budget	string
BudgetForecast	string
Credit	string
General	string
Invoice	string
Quota	string
xCloud	string

Definition

definiert den Warnungstyp

Name	Typ	Beschreibung
category	AlertCategory	Kategorie „Warnung“
criteria	AlertCriteria	Kriterien, die Warnung ausgelöst haben
type	AlertType	Warnungstyp

Details

Warnungsdetails

Name	Typ	Beschreibung
amount	number	Budgetschwellenwert
companyName	string	Name des Unternehmens
contactEmails	string[]	Liste der E-Mails, die kontaktiert werden sollen
contactGroups	string[]	Liste der Aktionsgruppen, an die gesendet werden soll
contactRoles	string[]	Liste der Kontaktrollen
currentSpend	number	aktuelle Ausgaben
departmentName	string	Abteilungsname
enrollmentEndDate	string	datetime of enrollmentEndDate
enrollmentNumber	string	Registrierungsnummer
enrollmentStartDate	string	datetime of enrollmentStartDate
invoicingThreshold	number	Abrechnungsschwellenwert
meterFilter	AlertProperties.details.MeterFilter[]	Array von Zählern zum Filtern nach
operator	AlertOperator	Operator zum Vergleichen von currentSpend mit amount
overridingAlert	string	Überschreiben von Warnungen
periodStartDate	string	datetime von periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	Array von Ressourcen, nach der gefiltert werden soll
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	Array von resourceGroups, nach dem gefiltert werden soll
tagFilter	TagFilter	Zu filternde Tags
threshold	number	Benachrichtigungsschwellenwertprozentsatz als Dezimalwert, durch den diese Warnung aktiviert wurde
timeGrainType	AlertTimeGrainType	Art des Zeitgrainrhythmus
triggeredBy	string	notificationId, die diese Warnung ausgelöst hat
unit	string	Verwendete Währungseinheit

DismissAlertPayload

Die Anforderungsnutzlast zum Aktualisieren einer Warnung

Name	Typ	Beschreibung
properties.closeTime	string	dateTime, in der die Warnung geschlossen wurde
properties.costEntityId	string	Zugehöriges Budget
properties.creationTime	string	dateTime, in der warnung erstellt wurde
properties.definition	Definition	definiert den Warnungstyp
properties.description	string	Beschreibung der Warnung
properties.details	Details	Warnungsdetails
properties.modificationTime	string	dateTime, in der die Warnung zuletzt geändert wurde
properties.source	AlertSource	Quelle der Warnung
properties.status	AlertStatus	warnung status
properties.statusModificationTime	string	dateTime, in der die Warnung status zuletzt geändert wurde
properties.statusModificationUserName	string	Benutzer, der die Warnung zuletzt geändert hat

ErrorDetails

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

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	ErrorDetails	Die Details des Fehlers.

TagFilter

Zu filternde Tags

Share via

Alerts - Dismiss

URI-Parameter

Anforderungstext

Antworten

Sicherheit

azure_auth

Scopes

Beispiele

PatchResourceGroupAlerts

Sample Request

Sample Response

PatchSubscriptionAlerts

Sample Request

Sample Response

Definitionen

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

DismissAlertPayload

ErrorDetails

ErrorResponse

TagFilter

Zusätzliche Ressourcen