Alerts - Get

Başvuru

Hizmet:: Cost Management

API Sürümü:: 2023-11-01

Kapsamın uyarısını uyarı kimliğine göre alır.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
alertId	path	True	string	Uyarı Kimliği
scope	path	True	string	Uyarı işlemleriyle ilişkili kapsam. Buna abonelik kapsamı için '/subscriptions/{subscriptionId}/' dahildir, resourceGroup kapsamı için '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', Faturalama Hesabı kapsamı için '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' ve Departman kapsamı için '/providers/Microsoft.Billing/billingAccountId}/departments/{departmentId}' Bölüm kapsamı için '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ EnrollmentAccount kapsamı için enrollmentAccountId}', Yönetim Grubu kapsamı için '/providers/Microsoft.Management/managementGroups/{managementGroupId} billingProfile kapsamı için '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}', invoiceSection kapsamı için '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' ve '/providers/Microsoft. İş ortakları için billing/billingAccounts/{billingAccountId}/customers/{customerId}' özel.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	Alert	Tamam ögesini seçin. İstek başarılı oldu.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Flow.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

SingleResourceGroupAlerts

SingleSubscriptionAlerts

SingleResourceGroupAlerts

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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

Örnek isteği

HTTP

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

Örnek yanıt

Durum kodu:: 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"
  }
}

Tanımlar

Name	Description
Alert	Tek bir uyarı.
AlertCategory	Uyarı kategorisi
AlertCriteria	Uyarıyı tetikleyen ölçütler
AlertOperator	currentSpend öğesini tutarla karşılaştırmak için kullanılan işleç
AlertSource	Uyarı kaynağı
AlertStatus	uyarı durumu
AlertTimeGrainType	Zaman dilimi temposu türü
AlertType	uyarı türü
Definition	uyarı türünü tanımlar
Details	Uyarı ayrıntıları
ErrorDetails	Hatanın ayrıntıları.
ErrorResponse	Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir. Bazı Hata yanıtları: 429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin. 503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Retry-After" üst bilgisinde belirtilen süre bekledikten sonra yeniden deneyin.
TagFilter	filtre uygulanacak etiketler

Alert

Tek bir uyarı.

Name	Tür	Description
eTag	string	Kaynağın eTag'i. Eşzamanlı güncelleştirme senaryolarını işlemek için bu alan, kullanıcının en son sürümü güncelleştirip güncelleştirmediğini belirlemek için kullanılır.
id	string	Kaynak Kimliği.
name	string	Kaynak adı.
properties.closeTime	string	uyarının kapatıldığı dateTime
properties.costEntityId	string	ilgili bütçe
properties.creationTime	string	uyarının oluşturulduğu dateTime
properties.definition	Definition	uyarı türünü tanımlar
properties.description	string	Uyarı açıklaması
properties.details	Details	Uyarı ayrıntıları
properties.modificationTime	string	uyarının en son değiştirildiği dateTime
properties.source	AlertSource	Uyarı kaynağı
properties.status	AlertStatus	uyarı durumu
properties.statusModificationTime	string	uyarı durumunun en son değiştirildiği dateTime
properties.statusModificationUserName	string	Uyarıyı en son değiştiren kullanıcı
type	string	Kaynak türü.

AlertCategory

Uyarı kategorisi

Name	Tür	Description
Billing	string
Cost	string
System	string
Usage	string

AlertCriteria

Uyarıyı tetikleyen ölçütler

Name	Tür	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

currentSpend öğesini tutarla karşılaştırmak için kullanılan işleç

Name	Tür	Description
EqualTo	string
GreaterThan	string
GreaterThanOrEqualTo	string
LessThan	string
LessThanOrEqualTo	string
None	string

AlertSource

Uyarı kaynağı

Name	Tür	Description
Preset	string
User	string

AlertStatus

uyarı durumu

Name	Tür	Description
Active	string
Dismissed	string
None	string
Overridden	string
Resolved	string

AlertTimeGrainType

Zaman dilimi temposu türü

Name	Tür	Description
Annually	string
BillingAnnual	string
BillingMonth	string
BillingQuarter	string
Monthly	string
None	string
Quarterly	string

AlertType

uyarı türü

Name	Tür	Description
Budget	string
BudgetForecast	string
Credit	string
General	string
Invoice	string
Quota	string
xCloud	string

Definition

uyarı türünü tanımlar

Name	Tür	Description
category	AlertCategory	Uyarı kategorisi
criteria	AlertCriteria	Uyarıyı tetikleyen ölçütler
type	AlertType	uyarı türü

Details

Uyarı ayrıntıları

Name	Tür	Description
amount	number	bütçe eşiği tutarı
companyName	string	şirket adı
contactEmails	string[]	iletişim kurulacak e-postaların listesi
contactGroups	string[]	yayına alınacak eylem gruplarının listesi
contactRoles	string[]	kişi rolleri listesi
currentSpend	number	geçerli harcama
departmentName	string	bölüm adı
enrollmentEndDate	string	enrollmentEndDate'in datetime değeri
enrollmentNumber	string	kayıt numarası
enrollmentStartDate	string	enrollmentStartDate'ın datetime değeri
invoicingThreshold	number	faturalama eşiği
meterFilter	AlertProperties.details.MeterFilter[]	filtre uygulanacak metre dizisi
operator	AlertOperator	currentSpend öğesini tutarla karşılaştırmak için kullanılan işleç
overridingAlert	string	uyarıyı geçersiz kılma
periodStartDate	string	periodStartDate'ın tarih saati
resourceFilter	AlertProperties.details.ResourceFilter[]	filtre uygulanacak kaynak dizisi
resourceGroupFilter	AlertProperties.details.ResourceGroupFilter[]	filtre uygulanacak resourceGroups dizisi
tagFilter	TagFilter	filtre uygulanacak etiketler
threshold	number	bu uyarıyı etkinleştiren ondalık olarak bildirim eşiği yüzdesi
timeGrainType	AlertTimeGrainType	Zaman dilimi temposu türü
triggeredBy	string	Bu uyarıyı tetikleyen notificationId
unit	string	kullanılan para birimi

ErrorDetails

Hatanın ayrıntıları.

Name	Tür	Description
code	string	Hata kodu.
message	string	İşlemin neden başarısız olduğunu belirten hata iletisi.

ErrorResponse

Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.

Bazı Hata yanıtları:

429 TooManyRequests - İstek kısıtlandı. "x-ms-ratelimit-microsoft.consumption-retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin.
503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Retry-After" üst bilgisinde belirtilen süre bekledikten sonra yeniden deneyin.

Name	Tür	Description
error	ErrorDetails	Hatanın ayrıntıları.

TagFilter

filtre uygulanacak etiketler

Aracılığıyla paylaş

Alerts - Get

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

SingleResourceGroupAlerts

Örnek isteği

Örnek yanıt

SingleSubscriptionAlerts

Örnek isteği

Örnek yanıt

Tanımlar

Alert

AlertCategory

AlertCriteria

AlertOperator

AlertSource

AlertStatus

AlertTimeGrainType

AlertType

Definition

Details

ErrorDetails

ErrorResponse

TagFilter

Ek kaynaklar