Dela via


Alerts - Get

Hämtar aviseringen för omfånget efter aviserings-ID.

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

URI-parametrar

Name I Obligatorisk Typ Description
alertId
path True

string

Aviserings-ID

scope
path True

string

Omfånget som är associerat med aviseringsåtgärder. Detta inkluderar "/subscriptions/{subscriptionId}/" för prenumerationsomfånget "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" för resourceGroup-omfånget, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" för faktureringskontoomfånget och "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" för avdelningens omfattning, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} för EnrollmentAccount-omfång, "/providers/Microsoft.Management/managementGroups/{managementGroupId} för hanteringsgruppsomfång, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' för billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' för invoiceSection-omfång och '/providers/Microsoft. Fakturering/faktureringKonton/{billingAccountId}/customers/{customerId} som är specifika för partner.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

Alert

OK. Begäran har slutförts.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

SingleResourceGroupAlerts
SingleSubscriptionAlerts

SingleResourceGroupAlerts

Sample Request

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=2023-11-01

Sample Response

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

Sample Request

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

Sample Response

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

Definitioner

Name Description
Alert

En enskild avisering.

AlertCategory

Aviseringskategori

AlertCriteria

Villkor som utlöste aviseringen

AlertOperator

operator som används för att jämföra currentSpend med mängd

AlertSource

Källa för avisering

AlertStatus

aviseringsstatus

AlertTimeGrainType

Typ av tidsintervall

AlertType

typ av avisering

Definition

definierar typen av avisering

Details

Aviseringsinformation

ErrorDetails

Information om felet.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

TagFilter

taggar att filtrera efter

Alert

En enskild avisering.

Name Typ Description
eTag

string

eTag för resursen. För att hantera samtidiga uppdateringsscenarion används det här fältet för att avgöra om användaren uppdaterar den senaste versionen eller inte.

id

string

Resurs-ID.

name

string

Resursnamn.

properties.closeTime

string

dateTime där aviseringen stängdes

properties.costEntityId

string

relaterad budget

properties.creationTime

string

dateTime där aviseringen skapades

properties.definition

Definition

definierar typen av avisering

properties.description

string

Aviseringsbeskrivning

properties.details

Details

Aviseringsinformation

properties.modificationTime

string

dateTime där aviseringen senast ändrades

properties.source

AlertSource

Källa för avisering

properties.status

AlertStatus

aviseringsstatus

properties.statusModificationTime

string

dateTime där aviseringsstatusen senast ändrades

properties.statusModificationUserName

string

Användare som senast ändrade aviseringen

type

string

Resurstyp.

AlertCategory

Aviseringskategori

Name Typ Description
Billing

string

Cost

string

System

string

Usage

string

AlertCriteria

Villkor som utlöste aviseringen

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

operator som används för att jämföra currentSpend med mängd

Name Typ Description
EqualTo

string

GreaterThan

string

GreaterThanOrEqualTo

string

LessThan

string

LessThanOrEqualTo

string

None

string

AlertSource

Källa för avisering

Name Typ Description
Preset

string

User

string

AlertStatus

aviseringsstatus

Name Typ Description
Active

string

Dismissed

string

None

string

Overridden

string

Resolved

string

AlertTimeGrainType

Typ av tidsintervall

Name Typ Description
Annually

string

BillingAnnual

string

BillingMonth

string

BillingQuarter

string

Monthly

string

None

string

Quarterly

string

AlertType

typ av avisering

Name Typ Description
Budget

string

BudgetForecast

string

Credit

string

General

string

Invoice

string

Quota

string

xCloud

string

Definition

definierar typen av avisering

Name Typ Description
category

AlertCategory

Aviseringskategori

criteria

AlertCriteria

Villkor som utlöste aviseringen

type

AlertType

typ av avisering

Details

Aviseringsinformation

Name Typ Description
amount

number

budgettröskelbelopp

companyName

string

företagsnamn

contactEmails

string[]

lista över e-postmeddelanden att kontakta

contactGroups

string[]

lista över åtgärdsgrupper som ska sändas till

contactRoles

string[]

lista över kontaktroller

currentSpend

number

aktuella utgifter

departmentName

string

avdelningsnamn

enrollmentEndDate

string

datetime för registreringEndDate

enrollmentNumber

string

registreringsnummer

enrollmentStartDate

string

datetime för registreringStartDate

invoicingThreshold

number

tröskelvärde för fakturering

meterFilter

AlertProperties.details.MeterFilter[]

matris med mätare som ska filtreras efter

operator

AlertOperator

operator som används för att jämföra currentSpend med mängd

overridingAlert

string

åsidosättande avisering

periodStartDate

string

datetime för periodStartDate

resourceFilter

AlertProperties.details.ResourceFilter[]

matris med resurser som ska filtreras efter

resourceGroupFilter

AlertProperties.details.ResourceGroupFilter[]

matris med resourceGroups som ska filtreras efter

tagFilter

TagFilter

taggar att filtrera efter

threshold

number

meddelandetröskelprocent som en decimal som aktiverade den här aviseringen

timeGrainType

AlertTimeGrainType

Typ av tidsintervall

triggeredBy

string

notificationId som utlöste den här aviseringen

unit

string

valutaenhet som används

ErrorDetails

Information om felet.

Name Typ Description
code

string

Felkod.

message

string

Felmeddelande som anger varför åtgärden misslyckades.

ErrorResponse

Felsvaret anger att tjänsten inte kan bearbeta den inkommande begäran. Orsaken anges i felmeddelandet.

Några felsvar:

  • 429 TooManyRequests – Begäran begränsas. Försök igen efter att ha väntat på den tid som anges i rubriken "x-ms-ratelimit-microsoft.consumption-retry-after".

  • 503 ServiceUnavailable – Tjänsten är inte tillgänglig för tillfället. Vänta så lång tid som anges i rubriken ”Retry-After” och försök igen.

Name Typ Description
error

ErrorDetails

Information om felet.

TagFilter

taggar att filtrera efter