Alerts - Dismiss

Reference

Služba:: Cost Management

Verze rozhraní API:: 2024-08-01

Zavře zadanou výstrahu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
alertId	path	True	string	ID upozornění
scope	path	True	string	Obor přidružený k operacím výstrah. To zahrnuje předplatné /subscriptions/{subscriptionId}/' pro rozsah předplatného. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' pro obor resourceGroup, /providers/Microsoft.Billing/billingAccounts/{billingAccountId} pro rozsah fakturačního účtu a /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} pro obor oddělení, /providers/Microsoft.Billing/billingAccounts/{billingAccounts}/enrollmentAccounts/{ enrollmentAccountId} pro obor EnrollmentAccount, /providers/Microsoft.Management/managementGroups/{managementGroupId} pro obor skupiny pro správu, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId} pro rozsah billingProfile, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' pro rozsah invoiceSection a /providers/Microsoft. Fakturace/billingAccounts/{billingAccountId}/customers/{customerId} specifická pro partnery.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
properties.closeTime	string	dateTime, ve kterém se výstraha zavřela
properties.costEntityId	string	související rozpočet
properties.creationTime	string	dateTime, ve kterém se upozornění vytvořilo
properties.definition	Definition	definuje typ výstrahy.
properties.description	string	Popis výstrahy
properties.details	Details	Podrobnosti výstrahy
properties.modificationTime	string	dateTime, ve kterém se výstraha naposledy změnila
properties.source	AlertSource	Zdroj upozornění
properties.status	AlertStatus	stav upozornění
properties.statusModificationTime	string	dateTime, ve kterém byl stav výstrahy naposledy změněn
properties.statusModificationUserName	string	Uživatel, který výstrahu naposledy upravil

Odpovědi

Name	Typ	Description
200 OK	Alert	OK. Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

PatchResourceGroupAlerts

PatchSubscriptionAlerts

PatchResourceGroupAlerts

Ukázkový požadavek

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=2024-08-01

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 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"
  }
}

Definice

Name	Description
Alert	Jednotlivá výstraha.
AlertCategory	Kategorie upozornění
AlertCriteria	Kritéria aktivovaná výstrahou
AlertOperator	operátor použitý k porovnání currentSpend s hodnotou
AlertSource	Zdroj upozornění
AlertStatus	stav upozornění
AlertTimeGrainType	Typ časového intervalu
AlertType	typ výstrahy
Definition	definuje typ výstrahy.
Details	Podrobnosti výstrahy
DismissAlertPayload	Datová část požadavku pro aktualizaci výstrahy
ErrorDetails	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě. Některé chybové odpovědi: 429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after. 503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.
TagFilter	značky pro filtrování podle

Alert

Jednotlivá výstraha.

Name	Typ	Description
eTag	string	eTag prostředku. Pro zpracování scénáře souběžné aktualizace se toto pole použije k určení, jestli uživatel aktualizuje nejnovější verzi, nebo ne.
id	string	ID prostředku.
name	string	Název prostředku
properties.closeTime	string	dateTime, ve kterém se výstraha zavřela
properties.costEntityId	string	související rozpočet
properties.creationTime	string	dateTime, ve kterém se upozornění vytvořilo
properties.definition	Definition	definuje typ výstrahy.
properties.description	string	Popis výstrahy
properties.details	Details	Podrobnosti výstrahy
properties.modificationTime	string	dateTime, ve kterém se výstraha naposledy změnila
properties.source	AlertSource	Zdroj upozornění
properties.status	AlertStatus	stav upozornění
properties.statusModificationTime	string	dateTime, ve kterém byl stav výstrahy naposledy změněn
properties.statusModificationUserName	string	Uživatel, který výstrahu naposledy upravil
type	string	Typ prostředku.

AlertCategory

Kategorie upozornění

Name	Typ	Description
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

Kritéria aktivovaná výstrahou

Name	Typ	Description
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

operátor použitý k porovnání currentSpend s hodnotou

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

AlertSource

Zdroj upozornění

Name	Typ	Description
Preset	string
User	string

AlertStatus

stav upozornění

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

AlertTimeGrainType

Typ časového intervalu

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

AlertType

typ výstrahy

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

Definition

definuje typ výstrahy.

Name	Typ	Description
category	AlertCategory	Kategorie upozornění
criteria	AlertCriteria	Kritéria aktivovaná výstrahou
type	AlertType	typ výstrahy

Details

Podrobnosti výstrahy

Name	Typ	Description
amount	number	částka prahové hodnoty rozpočtu
companyName	string	název společnosti
contactEmails	string[]	seznam e-mailů, které se mají kontaktovat
contactGroups	string[]	seznam skupin akcí k vysílání do
contactRoles	string[]	seznam rolí kontaktů
currentSpend	number	aktuální útrata
departmentName	string	název oddělení
enrollmentEndDate	string	datetime of enrollmentEndDate
enrollmentNumber	string	číslo registrace
enrollmentStartDate	string	datetime of enrollmentStartDate
invoicingThreshold	number	prahová hodnota fakturace
meterFilter	AlertProperties.details.MeterFilter[]	pole měřičů k filtrování podle
operator	AlertOperator	operátor použitý k porovnání currentSpend s hodnotou
overridingAlert	string	přepsání výstrahy
periodStartDate	string	datetime obdobíStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	pole prostředků k filtrování podle
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	array of resourceGroups to filter by
tagFilter	TagFilter	značky pro filtrování podle
threshold	number	procento prahové hodnoty oznámení jako desetinné místo, které aktivovalo toto upozornění
timeGrainType	AlertTimeGrainType	Typ časového intervalu
triggeredBy	string	notificationId, která aktivovala tuto výstrahu
unit	string	používaná jednotka měny

DismissAlertPayload

Datová část požadavku pro aktualizaci výstrahy

Name	Typ	Description
properties.closeTime	string	dateTime, ve kterém se výstraha zavřela
properties.costEntityId	string	související rozpočet
properties.creationTime	string	dateTime, ve kterém se upozornění vytvořilo
properties.definition	Definition	definuje typ výstrahy.
properties.description	string	Popis výstrahy
properties.details	Details	Podrobnosti výstrahy
properties.modificationTime	string	dateTime, ve kterém se výstraha naposledy změnila
properties.source	AlertSource	Zdroj upozornění
properties.status	AlertStatus	stav upozornění
properties.statusModificationTime	string	dateTime, ve kterém byl stav výstrahy naposledy změněn
properties.statusModificationUserName	string	Uživatel, který výstrahu naposledy upravil

ErrorDetails

Podrobnosti o chybě.

Name	Typ	Description
code	string	Kód chyby
message	string	Chybová zpráva označující, proč operace selhala.

ErrorResponse

Chybová odpověď značí, že služba nemůže zpracovat příchozí požadavek. Důvod je uvedený v chybové zprávě.

Některé chybové odpovědi:

429 TooManyRequests – Požadavek je omezený. Opakujte akci po čekání na dobu uvedenou v hlavičce x-ms-ratelimit-microsoft.consumption-retry-after.
503 ServiceUnavailable – Služba je dočasně nedostupná. Opakujte akci po čekání na dobu uvedenou v hlavičce Opakovat až po spuštění.

Name	Typ	Description
error	ErrorDetails	Podrobnosti o chybě.

TagFilter

značky pro filtrování podle

Sdílet prostřednictvím

Alerts - Dismiss

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

PatchResourceGroupAlerts

Ukázkový požadavek

Ukázková odpověď

PatchSubscriptionAlerts

Ukázkový požadavek

Ukázková odpověď

Definice

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

DismissAlertPayload

ErrorDetails

ErrorResponse

TagFilter

Další materiály