Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Odwołanie

Usługa:: Cost Management

Wersja interfejsu API:: 2024-08-01

Wyzwala generowanie raportu podsumowania wykorzystania korzyści dla podanego planu oszczędnościowego.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
savingsPlanId	path	True	string	Identyfikator planu oszczędności.
savingsPlanOrderId	path	True	string	Identyfikator zamówienia planu oszczędności.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Wymagane	Typ	Opis
endDate	True	string (date-time)	Data zakończenia danych podsumowań, które będą obsługiwane w raporcie.
grain	True	grain	Ziarno danych podsumowań jest obsługiwane w raporcie. Akceptowane wartości to "Daily" lub "Monthly".
startDate	True	string (date-time)	Data rozpoczęcia danych podsumowań, które zostaną obsłużone w raporcie.
benefitId		string	Identyfikator korzyści raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresu identyfikatora korzyści. Nieobsługiwane w przypadku zamówienia korzyści ani żadnych zakresów rozliczeniowych.
benefitOrderId		string	Identyfikator zamówienia korzyści raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresu zamówienia korzyści i identyfikatora korzyści. Nieobsługiwane w przypadku żadnych zakresów rozliczeniowych.
billingAccountId		string	Konto rozliczeniowe raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresów konta rozliczeniowego i profilu rozliczeniowego. Nieobsługiwane dla żadnych zakresów korzyści.
billingProfileId		string	Identyfikator profilu rozliczeniowego raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresu profilu rozliczeniowego. Nieobsługiwane w przypadku konta rozliczeniowego ani żadnych zakresów korzyści.
kind		benefitKind	Żądany typ danych korzyści. Wymagane dla zakresów konta rozliczeniowego i profilu rozliczeniowego. Implikowane i nie są przekazywane w zakresach korzyści. Obsługiwane wartości to Reservation and SavingsPlan

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BenefitUtilizationSummariesOperationStatus	Stan generowania raportu podsumowań wykorzystania korzyści. Może to być w toku, niepowodzenie lub ukończone.
202 Accepted		Akceptowane. Żądanie zostanie przetworzone. Użyj nagłówka lokalizacji, aby sprawdzić stan. Nagłówki Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

BenefitUtilizationSummariesOperationStatus

Stan generowania raportu podsumowań wykorzystania korzyści. Może to być w toku, niepowodzenie lub ukończone.

202 Accepted

Akceptowane. Żądanie zostanie przetworzone. Użyj nagłówka lokalizacji, aby sprawdzić stan.

Nagłówki

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

GenerateUtilizationSummariesReportBySavingsPlan

Przykładowe żądanie

HTTP

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

{
  "endDate": "2022-08-31T00:00:00Z",
  "startDate": "2022-06-01T00:00:00Z",
  "grain": "Daily"
}

Przykładowa odpowiedź

Kod stanu:: 202

Location: https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60

Kod stanu:: 200

{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "SavingsPlan",
    "endDate": "2022-08-31T00:00:00Z",
    "startDate": "2022-06-01T00:00:00Z"
  },
  "status": "Complete",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2022-06-12T02:56:55.5021869Z"
  }
}

Definicje

Nazwa	Opis
AsyncOperationStatusProperties	Obiekt reprezentujący adres URL raportu i prawidłowy do daty wygenerowania raportu asynchronicznego.
benefitKind	Rezerwacja lub plan oszczędnościowy.
BenefitUtilizationSummariesOperationStatus	Raport podsumowania wykorzystania korzyści. Udostępnia asynchroniczne podsumowanie wykorzystania korzyści Żądanie danych wejściowych, stanu i adresu URL sygnatury dostępu współdzielonego raportu.
BenefitUtilizationSummariesRequest	Właściwości żądania podsumowania asynchronicznego wykorzystania korzyści.
BenefitUtilizationSummaryReportSchema	Plik CSV z linku obiektu blob reportUrl i secondaryReportUrl będzie składać się z następujących kolumn danych wykorzystania korzyści. Wykorzystanepercentage będzie 0 w przypadku raportów planów oszczędnościowych i rezerwacji niezwiązanych z danymi. Wartości procentowe wykorzystania będą wynosić 0 w przypadku rezerwacji cegieł danych.
ErrorDetails	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. 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. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".
grain	Ziarno użycia. Obsługiwane wartości: "Hourly"
OperationStatusType	Stan tworzenia raportu podsumowań wykorzystania korzyści.

AsyncOperationStatusProperties

Objekt

Obiekt reprezentujący adres URL raportu i prawidłowy do daty wygenerowania raportu asynchronicznego.

Nazwa	Typ	Opis
reportUrl	BenefitUtilizationSummaryReportSchema	Adres URL sygnatury dostępu współdzielonego do raportu podsumowań użycia asynchronicznych korzyści. Jeśli raport ma stan Uruchomiono lub Niepowodzenie, będzie pusty.
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	Adres URL sygnatury dostępu współdzielonego do podsumowań użycia asynchronicznych korzyści raport w magazynie pomocniczym w przypadku awarii podstawowej. Jeśli raport ma stan Uruchomiono lub Niepowodzenie, będzie pusty.
validUntil	string (date-time)	Data wygaśnięcia adresu URL sygnatury dostępu współdzielonego podanego w elemencie reportUrl.

benefitKind

Wyliczanie

Rezerwacja lub plan oszczędnościowy.

Wartość	Opis
IncludedQuantity	Korzyść jest uwzględnionaQuantity.
Reservation	Korzyść to Rezerwacja.
SavingsPlan	Korzyść to OszczędnościPlan.

BenefitUtilizationSummariesOperationStatus

Objekt

Raport podsumowania wykorzystania korzyści. Udostępnia asynchroniczne podsumowanie wykorzystania korzyści Żądanie danych wejściowych, stanu i adresu URL sygnatury dostępu współdzielonego raportu.

Nazwa	Typ	Opis
input	BenefitUtilizationSummariesRequest	Dane wejściowe podane w celu utworzenia raportu podsumowań wykorzystania korzyści.
properties	AsyncOperationStatusProperties	Zawiera adres URL sygnatury dostępu współdzielonego do raportu podsumowania korzyści asynchronicznych oraz datę, do którego adres URL jest prawidłowy. Te wartości będą puste, jeśli raport jest w stanie Uruchomiony lub Niepowodzenie
status	OperationStatusType	Stan tworzenia raportu podsumowań wykorzystania korzyści.

BenefitUtilizationSummariesRequest

Objekt

Właściwości żądania podsumowania asynchronicznego wykorzystania korzyści.

Nazwa	Typ	Opis
benefitId	string	Identyfikator korzyści raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresu identyfikatora korzyści. Nieobsługiwane w przypadku zamówienia korzyści ani żadnych zakresów rozliczeniowych.
benefitOrderId	string	Identyfikator zamówienia korzyści raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresu zamówienia korzyści i identyfikatora korzyści. Nieobsługiwane w przypadku żadnych zakresów rozliczeniowych.
billingAccountId	string	Konto rozliczeniowe raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresów konta rozliczeniowego i profilu rozliczeniowego. Nieobsługiwane dla żadnych zakresów korzyści.
billingProfileId	string	Identyfikator profilu rozliczeniowego raport podsumowań wykorzystania korzyści jest przeznaczony. Wymagane dla zakresu profilu rozliczeniowego. Nieobsługiwane w przypadku konta rozliczeniowego ani żadnych zakresów korzyści.
endDate	string (date-time)	Data zakończenia danych podsumowań, które będą obsługiwane w raporcie.
grain	grain	Ziarno danych podsumowań jest obsługiwane w raporcie. Akceptowane wartości to "Daily" lub "Monthly".
kind	benefitKind	Żądany typ danych korzyści. Wymagane dla zakresów konta rozliczeniowego i profilu rozliczeniowego. Implikowane i nie są przekazywane w zakresach korzyści. Obsługiwane wartości to Reservation and SavingsPlan
startDate	string (date-time)	Data rozpoczęcia danych podsumowań, które zostaną obsłużone w raporcie.

BenefitUtilizationSummaryReportSchema

Wyliczanie

Plik CSV z linku obiektu blob reportUrl i secondaryReportUrl będzie składać się z następujących kolumn danych wykorzystania korzyści. Wykorzystanepercentage będzie 0 w przypadku raportów planów oszczędnościowych i rezerwacji niezwiązanych z danymi. Wartości procentowe wykorzystania będą wynosić 0 w przypadku rezerwacji cegieł danych.

Wartość	Opis
AvgUtilizationPercentage
BenefitId
BenefitOrderId
BenefitType
Kind
MaxUtilizationPercentage
MinUtilizationPercentage
UsageDate
UtilizedPercentage

ErrorDetails

Objekt

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

Objekt

Odpowiedź na błąd wskazuje, że usługa nie może przetworzyć przychodzącego żądania. 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. Ponów próbę po upływie czasu określonego w nagłówku "Ponów próbę po".

Nazwa	Typ	Opis
error	ErrorDetails	Szczegóły błędu.

grain

Wyliczanie

Ziarno użycia. Obsługiwane wartości: "Hourly"

Wartość	Opis
Daily	Ziarno godzinowe odpowiada wartości na dzień.
Hourly	Ziarno godzinowe odpowiada wartości na godzinę.
Monthly	Ziarno godzinowe odpowiada wartości na miesiąc.

OperationStatusType

Wyliczanie

Stan tworzenia raportu podsumowań wykorzystania korzyści.

Wartość	Opis
Complete
Failed
Running

Udostępnij za pośrednictwem

Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

GenerateUtilizationSummariesReportBySavingsPlan

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

Dodatkowe zasoby