Alerts - Dismiss

  • Riferimento
Servizio:
Cost Management
Versione API:
2023-11-01

Ignora l'avviso specificato

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
alertId
 path True

string

ID avviso
scope
 path True

string

Ambito associato alle operazioni degli avvisi. Include '/subscriptions/{subscriptionId}/' per l'ambito della sottoscrizione, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' per l'ambito resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' per l'ambito account di fatturazione e '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/department/{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 l'ambito billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' per l'ambito invoiceSection e '/providers/Microsoft. Fatturazione/fatturazioneAccounts/{billingAccountId}/customers/{customerId}' specifici per i partner.
api-version
 query True

string

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 avviso
properties.details

Details

Dettagli dell'avviso
properties.modificationTime

string

dateTime in cui è stato modificato l'ultimo avviso
properties.source

AlertSource

Origine dell'avviso
properties.status

AlertStatus

stato avviso
properties.statusModificationTime

string

dateTime in cui è stato modificato lo stato dell'avviso
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 perché 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

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

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

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

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 usato per confrontare currentSpend con quantità
AlertSource

Origine dell'avviso
AlertStatus

stato avviso
AlertTimeGrainType

Tipo di cadenza timegrain
AlertType

tipo di avviso
Definition

definisce il tipo di avviso
Details

Dettagli dell'avviso
DismissAlertPayload

Payload della richiesta per aggiornare un avviso
ErrorDetails

Dettagli dell'errore.
ErrorResponse

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 l'attesa dell'ora specificata nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable : il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".
TagFilter

tag da filtrare per

Alert

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 la versione più recente o meno.
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 avviso
properties.details

Details

Dettagli dell'avviso
properties.modificationTime

string

dateTime in cui è stato modificato l'ultimo avviso
properties.source

AlertSource

Origine dell'avviso
properties.status

AlertStatus

stato avviso
properties.statusModificationTime

string

dateTime in cui è stato modificato lo stato dell'avviso
properties.statusModificationUserName

string

Utente che ha modificato l'ultimo avviso
type

string

Tipo di risorsa.

AlertCategory

Categoria avviso

Nome Tipo Descrizione
Billing

string

Cost

string

System

string

Usage

string

AlertCriteria

Criteri che hanno attivato l'avviso

Nome Tipo Descrizione
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

operatore usato per confrontare currentSpend con quantità

Nome Tipo Descrizione
EqualTo

string

GreaterThan

string

GreaterThanOrEqualTo

string

LessThan

string

LessThanOrEqualTo

string

None

string

AlertSource

Origine dell'avviso

Nome Tipo Descrizione
Preset

string

User

string

AlertStatus

stato avviso

Nome Tipo Descrizione
Active

string

Dismissed

string

None

string

Overridden

string

Resolved

string

AlertTimeGrainType

Tipo di cadenza timegrain

Nome Tipo Descrizione
Annually

string

BillingAnnual

string

BillingMonth

string

BillingQuarter

string

Monthly

string

None

string

Quarterly

string

AlertType

tipo di avviso

Nome Tipo Descrizione
Budget

string

BudgetForecast

string

Credit

string

General

string

Invoice

string

Quota

string

xCloud

string

Definition

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

Dettagli dell'avviso

Nome Tipo Descrizione
amount

number

importo della soglia di budget
companyName

string

nome della 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

spesa corrente
departmentName

string

nome reparto
enrollmentEndDate

string

datetime di registrazioneEndDate
enrollmentNumber

string

numero di registrazione
enrollmentStartDate

string

datetime di registrazioneStartDate
invoicingThreshold

number

soglia di fatturazione
meterFilter

AlertProperties.details.MeterFilter[]

matrice di contatori da filtrare
operator

AlertOperator

operatore usato per confrontare currentSpend con quantità
overridingAlert

string

override dell'avviso
periodStartDate

string

datetime di periodStartDate
resourceFilter

AlertProperties.details.ResourceFilter[]

matrice di risorse da filtrare
resourceGroupFilter

AlertProperties.details.ResourceGroupFilter[]

matrice di resourceGroup da filtrare
tagFilter

TagFilter

tag da filtrare per
threshold

number

percentuale di soglia di notifica come decimale che ha attivato questo avviso
timeGrainType

AlertTimeGrainType

Tipo di cadenza timegrain
triggeredBy

string

notificationId che ha attivato questo avviso
unit

string

unità di valuta usata

DismissAlertPayload

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 avviso
properties.details

Details

Dettagli dell'avviso
properties.modificationTime

string

dateTime in cui è stato modificato l'ultimo avviso
properties.source

AlertSource

Origine dell'avviso
properties.status

AlertStatus

stato avviso
properties.statusModificationTime

string

dateTime in cui è stato modificato lo stato dell'avviso
properties.statusModificationUserName

string

Utente che ha modificato l'ultimo avviso

ErrorDetails

Dettagli dell'errore.

Nome Tipo Descrizione
code

string

Codice di errore.
message

string

Messaggio di errore che indica perché l'operazione non è riuscita.

ErrorResponse

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 l'attesa dell'ora specificata nell'intestazione "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable : il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".

Nome Tipo Descrizione
error

ErrorDetails

Dettagli dell'errore.

TagFilter

tag da filtrare per