Partager via

Alerts - Get

  • Référence
Service:
Cost Management
Version d'API:
2024-08-01

Obtient l’alerte pour l’étendue par ID d’alerte.

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

Paramètres URI

Nom Dans Obligatoire Type Description
alertId
 path True

string

ID d’alerte
scope
 path True

string

Étendue associée aux opérations d’alertes. Cela inclut « /subscriptions/{subscriptionId} / » pour l’étendue de l’abonnement, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' pour l’étendue resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' pour l’étendue du compte de facturation et '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pour l’étendue EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' pour l’étendue billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' pour l’étendue invoiceSection et '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' spécifique aux partenaires.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Réponses

Nom Type Description
200 OK

Alert

D’ACCORD. La demande a réussi.
Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

SingleResourceGroupAlerts
SingleSubscriptionAlerts

SingleResourceGroupAlerts

Exemple de requête

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

Exemple de réponse

Code d’état:
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

Exemple de requête

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

Exemple de réponse

Code d’état:
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"
  }
}

Définitions

Nom Description
Alert

Alerte individuelle.
AlertCategory

Catégorie d’alerte
AlertCriteria

Critères qui ont déclenché une alerte
AlertOperator

opérateur utilisé pour comparer currentSpend à la quantité
AlertSource

Source d’alerte
AlertStatus

état de l’alerte
AlertTimeGrainType

Type de cadence temporelle
AlertType

type d’alerte
Definition

définit le type d’alerte
Details

Détails de l’alerte
ErrorDetails

Détails de l’erreur.
ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».
TagFilter

balises à filtrer par

Alert

Alerte individuelle.

Nom Type Description
eTag

string

eTag de la ressource. Pour gérer le scénario de mise à jour simultanée, ce champ sera utilisé pour déterminer si l’utilisateur met à jour la dernière version ou non.
id

string

ID de ressource.
name

string

Nom de la ressource.
properties.closeTime

string

dateTime dans laquelle l’alerte a été fermée
properties.costEntityId

string

budget associé
properties.creationTime

string

dateTime dans laquelle l’alerte a été créée
properties.definition

Definition

définit le type d’alerte
properties.description

string

Description de l’alerte
properties.details

Details

Détails de l’alerte
properties.modificationTime

string

dateTime dans laquelle l’alerte a été modifiée pour la dernière fois
properties.source

AlertSource

Source d’alerte
properties.status

AlertStatus

état de l’alerte
properties.statusModificationTime

string

dateTime dans laquelle l’état de l’alerte a été modifié pour la dernière fois
properties.statusModificationUserName

string

Utilisateur qui a modifié l’alerte pour la dernière fois
type

string

Type de ressource.

AlertCategory

Catégorie d’alerte

Nom Type Description
Billing

string

Cost

string

System

string

Usage

string

AlertCriteria

Critères qui ont déclenché une alerte

Nom Type 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

opérateur utilisé pour comparer currentSpend à la quantité

Nom Type Description
EqualTo

string

GreaterThan

string

GreaterThanOrEqualTo

string

LessThan

string

LessThanOrEqualTo

string

None

string

AlertSource

Source d’alerte

Nom Type Description
Preset

string

User

string

AlertStatus

état de l’alerte

Nom Type Description
Active

string

Dismissed

string

None

string

Overridden

string

Resolved

string

AlertTimeGrainType

Type de cadence temporelle

Nom Type Description
Annually

string

BillingAnnual

string

BillingMonth

string

BillingQuarter

string

Monthly

string

None

string

Quarterly

string

AlertType

type d’alerte

Nom Type Description
Budget

string

BudgetForecast

string

Credit

string

General

string

Invoice

string

Quota

string

xCloud

string

Definition

définit le type d’alerte

Nom Type Description
category

AlertCategory

Catégorie d’alerte
criteria

AlertCriteria

Critères qui ont déclenché une alerte
type

AlertType

type d’alerte

Details

Détails de l’alerte

Nom Type Description
amount

number

montant du seuil budgétaire
companyName

string

nom de la société
contactEmails

string[]

liste des e-mails à contacter
contactGroups

string[]

liste des groupes d’actions à diffuser vers
contactRoles

string[]

liste des rôles de contact
currentSpend

number

dépenses actuelles
departmentName

string

nom du service
enrollmentEndDate

string

datetime de enrollmentEndDate
enrollmentNumber

string

numéro d’inscription
enrollmentStartDate

string

datetime de enrollmentStartDate
invoicingThreshold

number

seuil de facturation
meterFilter

AlertProperties.details.MeterFilter[]

tableau de compteurs à filtrer par
operator

AlertOperator

opérateur utilisé pour comparer currentSpend à la quantité
overridingAlert

string

substitution d’une alerte
periodStartDate

string

datetime de periodStartDate
resourceFilter

AlertProperties.details.ResourceFilter[]

tableau de ressources à filtrer par
resourceGroupFilter

AlertProperties.details.ResourceGroupFilter[]

tableau de resourceGroups à filtrer par
tagFilter

TagFilter

balises à filtrer par
threshold

number

pourcentage de seuil de notification sous la forme d’une décimale qui a activé cette alerte
timeGrainType

AlertTimeGrainType

Type de cadence temporelle
triggeredBy

string

notificationId qui a déclenché cette alerte
unit

string

unité de devise utilisée

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d’erreur.
message

string

Message d’erreur indiquant pourquoi l’opération a échoué.

ErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».

Nom Type Description
error

ErrorDetails

Détails de l’erreur.

TagFilter

balises à filtrer par