Alerts - Get

Referenz

Dienst:: Cost Management

API-Version:: 2024-08-01

Ruft die Warnung für den Bereich nach Warnungs-ID ab.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}?api-version=2024-08-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}' für resourceGroup-Bereich, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' für Abrechnungskontobereich und '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' für Abteilungsbereich, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' für enrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}, for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' für billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' für invoiceSection scope, and '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' speziell für Partner.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	Alert	OKAY. Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	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

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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": "Active",
    "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"
  }
}

SingleSubscriptionAlerts

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 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": "Active",
    "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 einzelne Warnung.
AlertCategory	Warnungskategorie
AlertCriteria	Kriterien, die Warnung ausgelöst haben
AlertOperator	Operator, der verwendet wird, um currentSpend mit Betrag zu vergleichen
AlertSource	Quelle der Warnung
AlertStatus	Warnungsstatus
AlertTimeGrainType	Art des Zeitgrainrhythmus
AlertType	Warnungstyp
Definition	definiert den Typ der Warnung.
Details	Warnungsdetails
ErrorDetails	Die Details des Fehlers.
ErrorResponse	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.
TagFilter	zu filternde Tags nach

Alert

Eine einzelne Warnung.

Name	Typ	Beschreibung
eTag	string	eTag der Ressource. Um das Szenario für gleichzeitige Updates zu behandeln, wird dieses Feld verwendet, um zu bestimmen, ob der Benutzer die neueste Version aktualisiert oder nicht.
id	string	Ressourcen-ID.
name	string	Ressourcenname.
properties.closeTime	string	dateTime, in der die Warnung geschlossen wurde
properties.costEntityId	string	Verwandtes Budget
properties.creationTime	string	dateTime, in der die Warnung erstellt wurde
properties.definition	Definition	definiert den Typ der Warnung.
properties.description	string	Warnungsbeschreibung
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	Warnungsstatus
properties.statusModificationTime	string	dateTime, in der der Warnungsstatus zuletzt geändert wurde
properties.statusModificationUserName	string	Benutzer, der die Benachrichtigung zuletzt geändert hat
type	string	Ressourcentyp.

AlertCategory

Warnungskategorie

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, der verwendet wird, um currentSpend mit Betrag zu vergleichen

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

Warnungsstatus

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 Typ der Warnung.

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

Details

Warnungsdetails

Name	Typ	Beschreibung
amount	number	Budgetschwellenwert
companyName	string	Firmenname
contactEmails	string[]	Liste der zu kontaktierenden E-Mails
contactGroups	string[]	Liste der zu übertragenden Aktionsgruppen
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	Rechnungsschwellenwert
meterFilter	AlertProperties.details.MeterFilter[]	Array von Zählern, nach der gefiltert werden soll
operator	AlertOperator	Operator, der verwendet wird, um currentSpend mit Betrag zu vergleichen
overridingAlert	string	Außerkraftsetzungswarnung
periodStartDate	string	datetime of periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	Array von Ressourcen, nach der gefiltert werden soll
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	Array von resourceGroups, nach der gefiltert werden soll
tagFilter	TagFilter	zu filternde Tags nach
threshold	number	Prozentsatz des Benachrichtigungsschwellenwerts als Dezimalzahl, die diese Warnung aktiviert hat
timeGrainType	AlertTimeGrainType	Art des Zeitgrainrhythmus
triggeredBy	string	notificationId, die diese Warnung ausgelöst hat
unit	string	Währungseinheit, die verwendet wird

ErrorDetails

Die Details des Fehlers.

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

ErrorResponse

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

TagFilter

zu filternde Tags nach

Freigeben über

Alerts - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

SingleResourceGroupAlerts

Beispielanforderung

Beispiel für eine Antwort

SingleSubscriptionAlerts

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

Zusätzliche Ressourcen