Alerts - List External
Listy zdefiniowany typ alertów dla zewnętrznego dostawcy usług w chmurze.
GET https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts?api-version=2023-11-01
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
external
|
path | True |
string |
Może to być "{externalSubscriptionId}" dla połączonego konta lub "{externalBillingAccountId}" dla skonsolidowanego konta używanego z operacjami wymiarów/zapytań. |
external
|
path | True |
Typ zewnętrznego dostawcy usług w chmurze skojarzony z operacjami wymiarów/zapytań. Obejmuje to "externalSubscriptions" dla połączonego konta i "externalBillingAccounts" dla skonsolidowanego konta. |
|
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
OK. Żądanie zakończyło się pomyślnie. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
External |
External |
ExternalBillingAccountAlerts
Sample Request
GET https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/alerts?api-version=2023-11-01
Sample Response
{
"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
GET https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/alerts?api-version=2023-11-01
Sample Response
{
"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
}
Definicje
Nazwa | Opis |
---|---|
Alert |
Pojedynczy alert. |
Alert |
Kategoria alertu |
Alert |
Kryteria wyzwalające alert |
Alert |
operator używany do porównywania wartości currentSpend z kwotą |
Alert |
Źródło alertu |
Alerts |
Wynik alertów. |
Alert |
stan alertu |
Alert |
Typ rytmu czasowego |
Alert |
typ alertu |
Definition |
definiuje typ alertu |
Details |
Szczegóły alertu |
Error |
Szczegóły błędu. |
Error |
Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie. Niektóre odpowiedzi na błędy:
|
external |
Typ zewnętrznego dostawcy usług w chmurze skojarzony z operacjami wymiarów/zapytań. Obejmuje to "externalSubscriptions" dla połączonego konta i "externalBillingAccounts" dla skonsolidowanego konta. |
Tag |
tagi do filtrowania według |
Alert
Pojedynczy alert.
Nazwa | Typ | Opis |
---|---|---|
eTag |
string |
eTag zasobu. Aby obsłużyć scenariusz aktualizacji współbieżnych, to pole będzie używane do określenia, czy użytkownik aktualizuje najnowszą wersję, czy nie. |
id |
string |
Identyfikator zasobu. |
name |
string |
Nazwa zasobu. |
properties.closeTime |
string |
dateTime, w którym alert został zamknięty |
properties.costEntityId |
string |
powiązany budżet |
properties.creationTime |
string |
dateTime, w którym został utworzony alert |
properties.definition |
definiuje typ alertu |
|
properties.description |
string |
Opis alertu |
properties.details |
Szczegóły alertu |
|
properties.modificationTime |
string |
dateTime, w którym alert został ostatnio zmodyfikowany |
properties.source |
Źródło alertu |
|
properties.status |
stan alertu |
|
properties.statusModificationTime |
string |
dateTime, w którym stan alertu został ostatnio zmodyfikowany |
properties.statusModificationUserName |
string |
Użytkownik, który ostatnio zmodyfikował alert |
type |
string |
Typ zasobu. |
AlertCategory
Kategoria alertu
Nazwa | Typ | Opis |
---|---|---|
Billing |
string |
|
Cost |
string |
|
System |
string |
|
Usage |
string |
AlertCriteria
Kryteria wyzwalające alert
Nazwa | Typ | Opis |
---|---|---|
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 używany do porównywania wartości currentSpend z kwotą
Nazwa | Typ | Opis |
---|---|---|
EqualTo |
string |
|
GreaterThan |
string |
|
GreaterThanOrEqualTo |
string |
|
LessThan |
string |
|
LessThanOrEqualTo |
string |
|
None |
string |
AlertSource
Źródło alertu
Nazwa | Typ | Opis |
---|---|---|
Preset |
string |
|
User |
string |
AlertsResult
Wynik alertów.
Nazwa | Typ | Opis |
---|---|---|
nextLink |
string |
Adres URL, aby uzyskać następny zestaw wyników alertów, jeśli istnieją. |
value |
Alert[] |
Lista alertów. |
AlertStatus
stan alertu
Nazwa | Typ | Opis |
---|---|---|
Active |
string |
|
Dismissed |
string |
|
None |
string |
|
Overridden |
string |
|
Resolved |
string |
AlertTimeGrainType
Typ rytmu czasowego
Nazwa | Typ | Opis |
---|---|---|
Annually |
string |
|
BillingAnnual |
string |
|
BillingMonth |
string |
|
BillingQuarter |
string |
|
Monthly |
string |
|
None |
string |
|
Quarterly |
string |
AlertType
typ alertu
Nazwa | Typ | Opis |
---|---|---|
Budget |
string |
|
BudgetForecast |
string |
|
Credit |
string |
|
General |
string |
|
Invoice |
string |
|
Quota |
string |
|
xCloud |
string |
Definition
definiuje typ alertu
Nazwa | Typ | Opis |
---|---|---|
category |
Kategoria alertu |
|
criteria |
Kryteria wyzwalające alert |
|
type |
typ alertu |
Details
Szczegóły alertu
Nazwa | Typ | Opis |
---|---|---|
amount |
number |
kwota progu budżetu |
companyName |
string |
nazwa firmy |
contactEmails |
string[] |
lista wiadomości e-mail do kontaktu |
contactGroups |
string[] |
lista grup akcji do emisji do |
contactRoles |
string[] |
lista ról kontaktów |
currentSpend |
number |
bieżące wydatki |
departmentName |
string |
nazwa działu |
enrollmentEndDate |
string |
data/godzina rejestracjiEndDate |
enrollmentNumber |
string |
numer rejestracji |
enrollmentStartDate |
string |
data/godzina rejestracjiStartDate |
invoicingThreshold |
number |
próg fakturowania |
meterFilter |
Alert |
tablica mierników do filtrowania według |
operator |
operator używany do porównywania wartości currentSpend z kwotą |
|
overridingAlert |
string |
zastępowanie alertu |
periodStartDate |
string |
data/godzina okresuStartDate |
resourceFilter |
Alert |
tablica zasobów do filtrowania według |
resourceGroupFilter |
Alert |
tablica grup zasobów do filtrowania według |
tagFilter |
tagi do filtrowania według |
|
threshold |
number |
wartość procentowa progu powiadomienia jako liczba dziesiętna, która uaktywniła ten alert |
timeGrainType |
Typ rytmu czasowego |
|
triggeredBy |
string |
notificationId, który wyzwolił ten alert |
unit |
string |
jednostka używanej waluty |
ErrorDetails
Szczegóły błędu.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu. |
message |
string |
Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się. |
ErrorResponse
Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć żądania przychodzącego. Przyczyna jest podana w komunikacie o błędzie.
Niektóre odpowiedzi na błędy:
429 TooManyRequests — żądanie jest ograniczane. Ponów próbę po upływie czasu określonego w nagłówku "x-ms-ratelimit-microsoft.consumption-retry-after".
503 ServiceUnavailable — usługa jest tymczasowo niedostępna. Poczekaj przez czas określony w nagłówku „Retry-After” i spróbuj ponownie.
Nazwa | Typ | Opis |
---|---|---|
error |
Szczegóły błędu. |
externalCloudProviderType
Typ zewnętrznego dostawcy usług w chmurze skojarzony z operacjami wymiarów/zapytań. Obejmuje to "externalSubscriptions" dla połączonego konta i "externalBillingAccounts" dla skonsolidowanego konta.
Nazwa | Typ | Opis |
---|---|---|
externalBillingAccounts |
string |
|
externalSubscriptions |
string |
TagFilter
tagi do filtrowania według