Alerts - List External

Referens

Service:: Cost Management

API Version:: 2023-11-01

Listor den definierade typen Aviseringar för extern molnleverantör.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
externalCloudProviderId	path	True	string	Detta kan vara {externalSubscriptionId} för det länkade kontot eller {externalBillingAccountId} för konsoliderat konto som används med dimensions-/frågeåtgärder.
externalCloudProviderType	path	True	externalCloudProviderType	Den externa molnleverantörstypen som är associerad med dimensions-/frågeåtgärder. Detta inkluderar "externalSubscriptions" för länkat konto och "externalBillingAccounts" för konsoliderat konto.
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	AlertsResult	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

ExternalBillingAccountAlerts

ExternalSubscriptionAlerts

ExternalBillingAccountAlerts

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/alerts?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "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": "00000000-0000-0000-0000-000000000000_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"
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111",
      "name": "11111111-1111-1111-111111111111",
      "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": "11111111-1111-1111-111111111111_1_01",
          "resourceGroupFilter": [],
          "resourceFilter": [],
          "meterFilter": [],
          "tagFilter": {},
          "threshold": 0.8,
          "operator": "GreaterThan",
          "amount": 200000,
          "unit": "USD",
          "currentSpend": 171000.32,
          "contactEmails": [
            "1234@contoso.com"
          ],
          "contactGroups": [],
          "contactRoles": [],
          "overridingAlert": null
        },
        "costEntityId": "budget1",
        "status": "Active",
        "creationTime": "2019-06-24T05:51:52.8713179Z",
        "closeTime": "0001-01-01T00:00:00",
        "modificationTime": "2019-08-31T17:51:55.1808807Z",
        "statusModificationUserName": null,
        "statusModificationTime": "0001-01-01T00:00:00"
      }
    }
  ],
  "nextLink": null
}

ExternalSubscriptionAlerts

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/alerts?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000",
      "name": "00000000-0000-0000-0000-000000000000",
      "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": "00000000-0000-0000-0000-000000000000_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"
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111",
      "name": "11111111-1111-1111-111111111111",
      "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": "11111111-1111-1111-111111111111_1_01",
          "resourceGroupFilter": [],
          "resourceFilter": [],
          "meterFilter": [],
          "tagFilter": {},
          "threshold": 0.8,
          "operator": "GreaterThan",
          "amount": 200000,
          "unit": "USD",
          "currentSpend": 171000.32,
          "contactEmails": [
            "1234@contoso.com"
          ],
          "contactGroups": [],
          "contactRoles": [],
          "overridingAlert": null
        },
        "costEntityId": "budget1",
        "status": "Active",
        "creationTime": "2019-06-24T05:51:52.8713179Z",
        "closeTime": "0001-01-01T00:00:00",
        "modificationTime": "2019-08-31T17:51:55.1808807Z",
        "statusModificationUserName": null,
        "statusModificationTime": "0001-01-01T00:00:00"
      }
    }
  ],
  "nextLink": null
}

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
AlertsResult	Resultatet av aviseringar.
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.
externalCloudProviderType	Den externa molnleverantörstypen som är associerad med dimensions-/frågeåtgärder. Detta inkluderar "externalSubscriptions" för länkat konto och "externalBillingAccounts" för konsoliderat konto.
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

AlertsResult

Resultatet av aviseringar.

Name	Typ	Description
nextLink	string	URL för att hämta nästa uppsättning aviseringsresultat om det finns några.
value	Alert[]	Lista över aviseringar.

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.

externalCloudProviderType

Den externa molnleverantörstypen som är associerad med dimensions-/frågeåtgärder. Detta inkluderar "externalSubscriptions" för länkat konto och "externalBillingAccounts" för konsoliderat konto.

Name	Typ	Description
externalBillingAccounts	string
externalSubscriptions	string

TagFilter

taggar att filtrera efter

Dela via

Alerts - List External

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

ExternalBillingAccountAlerts

Sample Request

Sample Response

ExternalSubscriptionAlerts

Sample Request

Sample Response

Definitioner

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertsResult

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

externalCloudProviderType

TagFilter

Ytterligare resurser