Użycie platformy Azure
Interfejsy API użycia platformy Azure zapewniają programowy dostęp do danych dotyczących kosztów i użycia zasobów platformy Azure. Interfejsy API obsługują obecnie tylko rejestracje Enterprise, subskrypcje Web Direct (z kilkoma wyjątkami) i subskrypcje planu platformy Azure dostawcy usług w chmurze. Interfejsy API są stale aktualizowane do obsługi innych typów subskrypcji platformy Azure.
Interfejsy API użycia platformy Azure zapewniają dostęp do następujących elementów:
- Tylko klienci korporacyjni
- Arkusz cen
- Budżety
- Prognozy
- Salda
- Tagi
- Tagi kosztów
- Bezpośredni klienci internetowi i klienci korporacyjni
- Szczegóły rezerwacji
- Podsumowania rezerwacji
- Opłaty za korzystanie z witryny Marketplace
- Szczegóły użycia
- Rekomendacje dotyczące rezerwacji
Lista nieobsługiwanych typów subskrypcji
- MS-AZR-0145P (CSP)
- MS-AZR-0146P (CSP)
- MS-AZR-159P (CSP)
- MS-AZR-0036P (sponsorowana)
- MS-AZR-0143P (sponsorowana)
- MS-AZR-0015P (wewnętrzna)
- MS-AZR-0144P (DreamSpark)
Praca z okresami rozliczeniowymi i zakresami dat
Szczegóły użycia i Opłaty za korzystanie z witryny Marketplace akceptują okresy rozliczeniowe lub zakresy dat definiowania dat rozpoczęcia i zakończenia dla danych użycia.
Oto zachowanie interfejsu API oparte na okresach rozliczeniowych i zakresach dat w żądaniu.
Okres rozliczeniowy obecny w żądaniu | Data rozpoczęcia obecna w żądaniu | Data zakończenia obecna w żądaniu | Zachowanie interfejsu API |
---|---|---|---|
nie | nie | nie | Dane dla bieżącego okresu rozliczeniowego są zwracane w odpowiedzi |
nie | tak | nie | Dane dla bieżącego okresu rozliczeniowego są zwracane w odpowiedzi |
nie | nie | tak | Dane dla bieżącego okresu rozliczeniowego są zwracane w odpowiedzi |
nie | tak | tak | Dane dla określonej daty rozpoczęcia i zakończenia są zwracane w odpowiedzi |
tak | nie | nie | Dane dla określonego okresu rozliczeniowego są zwracane w odpowiedzi |
tak | tak | nie | Dane dla określonego okresu rozliczeniowego są zwracane w odpowiedzi |
tak | nie | tak | Dane dla określonego okresu rozliczeniowego są zwracane w odpowiedzi |
tak | tak | tak | Dane dla określonej daty rozpoczęcia i zakończenia są zwracane w odpowiedzi, jeśli podany okres rozliczeniowy jest ignorowany |
Maksymalny dozwolony zakres dat to 12 miesięcy w jednym żądaniu, a dane są dostępne od 1 maja 2014 r. lub nowszego.
Pobieranie listy okresów rozliczeniowych
Aby zapewnić prawidłowy okres rozliczeniowy w żądaniu, klient powinien najpierw uzyskać listę dostępnych okresów rozliczeniowych według subskrypcji przy użyciu następującego interfejsu API
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods?api-version=2017-04-24-preview
Korzystając z tej listy, klient może wybrać określony okres rozliczeniowy, aby uzyskać dane użycia.
Dane o opóźnieniu przybycia
Aby uwzględnić usługi innych firm, które mają opóźnienia w raportowaniu użycia, zgłoszona data użycia jest ustawiana na czas, w którym dane użycia zostały wysłane, w przeciwieństwie do czasu rzeczywistego użycia.
W związku z tym użycie zostanie ocenione i zastosowane do zgłoszonego czasu. W celu reprezentowania rzeczywistego czasu zużycia właściwości. Pole AdditionalProperties będzie teraz zawierać dwie dodatkowe właściwości. ConsumptionBeginTime i ConsumptionEndTime to nowe pola, które odpowiadają rzeczywistemu przedziałowi czasu zużycia.
Te zmiany spowodują powstanie kilku scenariuszy, które należy rozwiązać podczas wywoływania interfejsu API szczegółów użycia:
Raportowanie zakończenia miesiąca: w przypadku użycia, które wystąpiło w ciągu miesiąca, ale zgłoszonego w następnym miesiącu, klienci będą musieli zapoznać się z polem additionalProperties , aby przypisać użycie do odpowiedniego miesiąca.
Szczegóły użycia zapytania: podczas wykonywania zapytania względem interfejsu API szczegółów użycia według zakresu dat zapytanie dotyczy tylko daty raportu użycia, a nie czasu użycia w polu additionalProperties . W przypadku klientów, którzy chcą mapować szczegóły użycia na faktury, ta aktualizacja nie ma wpływu na proces, ponieważ faktura będzie przetwarzać użycie na podstawie daty raportu użycia. W przypadku klientów, którzy chcą zamapować szczegóły użycia na określoną datę/miesiąc kalendarza, ta aktualizacja stanowi przełomową zmianę. W przypadku tych scenariuszy nie można użyć daty raportu użycia i daty wystąpienia użycia w sekcji additionalProperties .
Przykładowe wywołanie dodatkowych szczegółów:
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/usageDetails?api-version=2018-03-31&$expand=properties/additionalProperties
Przykładowy fragment kodu odpowiedzi:
"properties": {
"billingPeriodId":"/subscriptions/{subscriptionid}/providers/Microsoft.Billing/billingPeriods/20180501",
"usageStart":"2018-05-01T00:00:00.0000000Z",
"usageEnd":"2018-05-01T23:59:59.0000000Z",
"instanceId":"/subscriptions/{subscriptionid}/resourceGroups/{resourcegroup}/providers/Microsoft.Cdn/profiles/{profile}",
"instanceName":"{id}",
"instanceLocation":"SouthCentralUS",
"meterId":"6b88ada0-cbc0-4874-be0e-23004f8b4de7",
"usageQuantity":0.002065,
"pretaxCost":0,
"currency":"USD",
"additionalProperties": {
"Provider": "1",
"ConsumptionBeginTime": "2018-05-01T19:00:00",
"ConsumptionEndTime": "2018-05-01T20:00:00"
}
}
Zobacz też
Aby uzyskać więcej informacji na temat korzystania z tego interfejsu API w jednym z zestawów SDK specyficznych dla języka, odwiedź następujące tematy
Zestaw SDK użycia platformy Azure — Python
Interfejs wiersza polecenia użycia platformy Azure