Alerts - Dismiss

Riferimento

Servizio:: Cost Management

Versione API:: 2024-08-01

Ignora l'avviso specificato

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
alertId	path	True	string	ID avviso
scope	path	True	string	Ambito associato alle operazioni di avvisi. Sono inclusi '/subscriptions/{subscriptionId}/' per l'ambito della sottoscrizione, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per ambito resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per ambito account di fatturazione e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' per ambito reparto, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}' per ambito EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} per ambito gruppo di gestione, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' per ambito billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' per l'ambito invoiceSection e '/providers/Microsoft. Fatturazione/billingAccounts/{billingAccountId}/customers/{customerId}' specifici per i partner.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.closeTime	string	dateTime in cui è stato chiuso l'avviso
properties.costEntityId	string	budget correlato
properties.creationTime	string	dateTime in cui è stato creato l'avviso
properties.definition	Definition	definisce il tipo di avviso
properties.description	string	Descrizione dell'avviso
properties.details	Details	Dettagli avviso
properties.modificationTime	string	dateTime in cui l'avviso è stato modificato per l'ultima volta
properties.source	AlertSource	Origine dell'avviso
properties.status	AlertStatus	stato avviso
properties.statusModificationTime	string	dateTime in cui lo stato dell'avviso è stato modificato per l'ultima volta
properties.statusModificationUserName	string	Utente che ha modificato l'ultimo avviso

Risposte

Nome	Tipo	Descrizione
200 OK	Alert	OK. La richiesta ha avuto esito positivo.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

PatchResourceGroupAlerts

PatchSubscriptionAlerts

PatchResourceGroupAlerts

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
  }
}

Definizioni

Nome	Descrizione
Alert	Un singolo avviso.
AlertCategory	Categoria avviso
AlertCriteria	Criteri che hanno attivato l'avviso
AlertOperator	operatore utilizzato per confrontare currentSpend con quantità
AlertSource	Origine dell'avviso
AlertStatus	stato avviso
AlertTimeGrainType	Tipo di cadenza cronologica
AlertType	tipo di avviso
Definition	definisce il tipo di avviso
Details	Dettagli avviso
DismissAlertPayload	Payload della richiesta per aggiornare un avviso
ErrorDetails	Dettagli dell'errore.
ErrorResponse	La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore. Alcune risposte di errore: 429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after". 503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".
TagFilter	tag da filtrare in base

Alert

Object

Un singolo avviso.

Nome	Tipo	Descrizione
eTag	string	eTag della risorsa. Per gestire lo scenario di aggiornamento simultaneo, questo campo verrà usato per determinare se l'utente sta aggiornando o meno la versione più recente.
id	string	ID risorsa.
name	string	Nome risorsa.
properties.closeTime	string	dateTime in cui è stato chiuso l'avviso
properties.costEntityId	string	budget correlato
properties.creationTime	string	dateTime in cui è stato creato l'avviso
properties.definition	Definition	definisce il tipo di avviso
properties.description	string	Descrizione dell'avviso
properties.details	Details	Dettagli avviso
properties.modificationTime	string	dateTime in cui l'avviso è stato modificato per l'ultima volta
properties.source	AlertSource	Origine dell'avviso
properties.status	AlertStatus	stato avviso
properties.statusModificationTime	string	dateTime in cui lo stato dell'avviso è stato modificato per l'ultima volta
properties.statusModificationUserName	string	Utente che ha modificato l'ultimo avviso
type	string	Tipo di risorsa.

AlertCategory

Enumerazione

Categoria avviso

Valore	Descrizione
Billing
Cost
System
Usage

AlertCriteria

Enumerazione

Criteri che hanno attivato l'avviso

Valore	Descrizione
CostThresholdExceeded
CreditThresholdApproaching
CreditThresholdReached
CrossCloudCollectionError
CrossCloudNewDataAvailable
ForecastCostThresholdExceeded
ForecastUsageThresholdExceeded
GeneralThresholdError
InvoiceDueDateApproaching
InvoiceDueDateReached
MultiCurrency
QuotaThresholdApproaching
QuotaThresholdReached
UsageThresholdExceeded

AlertOperator

Enumerazione

operatore utilizzato per confrontare currentSpend con quantità

Valore	Descrizione
EqualTo
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo
None

AlertSource

Enumerazione

Origine dell'avviso

Valore	Descrizione
Preset
User

AlertStatus

Enumerazione

stato avviso

Valore	Descrizione
Active
Dismissed
None
Overridden
Resolved

AlertTimeGrainType

Enumerazione

Tipo di cadenza cronologica

Valore	Descrizione
Annually
BillingAnnual
BillingMonth
BillingQuarter
Monthly
None
Quarterly

AlertType

Enumerazione

tipo di avviso

Valore	Descrizione
Budget
BudgetForecast
Credit
General
Invoice
Quota
xCloud

Definition

Object

definisce il tipo di avviso

Nome	Tipo	Descrizione
category	AlertCategory	Categoria avviso
criteria	AlertCriteria	Criteri che hanno attivato l'avviso
type	AlertType	tipo di avviso

Details

Object

Dettagli avviso

Nome	Tipo	Descrizione
amount	number (decimal)	importo soglia budget
companyName	string	nome società
contactEmails	string[]	elenco di messaggi di posta elettronica da contattare
contactGroups	string[]	elenco di gruppi di azioni da trasmettere a
contactRoles	string[]	elenco dei ruoli di contatto
currentSpend	number (decimal)	spesa corrente
departmentName	string	nome reparto
enrollmentEndDate	string	datetime of enrollmentEndDate
enrollmentNumber	string	numero di registrazione
enrollmentStartDate	string	datetime of enrollmentStartDate
invoicingThreshold	number (decimal)	soglia di fatturazione
meterFilter	AlertProperties.details.MeterFilter[]	matrice di contatori da filtrare in base
operator	AlertOperator	operatore utilizzato per confrontare currentSpend con quantità
overridingAlert	string	override dell'avviso
periodStartDate	string	datetime di periodStartDate
resourceFilter	AlertProperties.details.ResourceFilter[]	matrice di risorse da filtrare in base
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	matrice di resourceGroups da filtrare in base
tagFilter	TagFilter	tag da filtrare in base
threshold	number (decimal)	percentuale di soglia di notifica come decimale che ha attivato l'avviso
timeGrainType	AlertTimeGrainType	Tipo di cadenza cronologica
triggeredBy	string	notificationId che ha attivato questo avviso
unit	string	unità di valuta utilizzata

DismissAlertPayload

Object

Payload della richiesta per aggiornare un avviso

Nome	Tipo	Descrizione
properties.closeTime	string	dateTime in cui è stato chiuso l'avviso
properties.costEntityId	string	budget correlato
properties.creationTime	string	dateTime in cui è stato creato l'avviso
properties.definition	Definition	definisce il tipo di avviso
properties.description	string	Descrizione dell'avviso
properties.details	Details	Dettagli avviso
properties.modificationTime	string	dateTime in cui l'avviso è stato modificato per l'ultima volta
properties.source	AlertSource	Origine dell'avviso
properties.status	AlertStatus	stato avviso
properties.statusModificationTime	string	dateTime in cui lo stato dell'avviso è stato modificato per l'ultima volta
properties.statusModificationUserName	string	Utente che ha modificato l'ultimo avviso

ErrorDetails

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

ErrorResponse

Object

La risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

429 TooManyRequests - La richiesta è limitata. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable - Il servizio non è temporaneamente disponibile. Riprovare dopo aver aspettato il tempo specificato nell'intestazione "Retry-After".

Nome	Tipo	Descrizione
error	ErrorDetails	Dettagli dell'errore.

TagFilter

Object

tag da filtrare in base

Condividi tramite

Alerts - Dismiss

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

PatchResourceGroupAlerts

Esempio di richiesta

Risposta di esempio

PatchSubscriptionAlerts

Esempio di richiesta

Risposta di esempio

Definizioni

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

DismissAlertPayload

ErrorDetails

ErrorResponse

TagFilter

Risorse aggiuntive