Generate Reservation Details Report - By Billing Account Id

Dienst:

Cost Management

API-Version:

2025-03-01

Generiert den Reservierungsdetails-Bericht für den angegebenen Datumsbereich asynchron basierend auf der Registrierungs-ID. Die Reservierungsnutzungsdetails können nur von bestimmten Unternehmensrollen angezeigt werden. Weitere Informationen zu den Rollen finden Sie unter https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role

POST https://management.azure.com/providers/microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport?api-version=2025-03-01&startDate={startDate}&endDate={endDate}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
billingAccountId	path	True	string	BillingAccount-ID
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
endDate	query	True	string	Enddatum
startDate	query	True	string	Startdatum

Antworten

Name	Typ	Beschreibung
200 OK	OperationStatus	Der Azure-Vorgang wurde erfolgreich abgeschlossen.
202 Accepted		Ressourcenvorgang akzeptiert. Header Location: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ReservationDetails

Beispielanforderung

HTTP

POST https://management.azure.com/providers/microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/generateReservationDetailsReport?api-version=2025-03-01&startDate=2020-01-01&endDate=2020-01-30

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.costmanagement import CostManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-costmanagement
# USAGE
    python generate_reservation_details_report_by_billing_account.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CostManagementClient(
        credential=DefaultAzureCredential(),
    )

    response = client.generate_reservation_details_report.begin_by_billing_account_id(
        billing_account_id="9845612",
        start_date="2020-01-01",
        end_date="2020-01-30",
    ).result()
    print(response)


# x-ms-original-file: 2025-03-01/GenerateReservationDetailsReportByBillingAccount.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcostmanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/costmanagement/armcostmanagement/v3"
)

// Generated from example definition: 2025-03-01/GenerateReservationDetailsReportByBillingAccount.json
func ExampleGenerateReservationDetailsReportClient_BeginByBillingAccountID() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcostmanagement.NewClientFactory(cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewGenerateReservationDetailsReportClient().BeginByBillingAccountID(ctx, "9845612", "2020-01-01", "2020-01-30", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to poll the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armcostmanagement.GenerateReservationDetailsReportClientByBillingAccountIDResponse{
	// 	OperationStatus: armcostmanagement.OperationStatus{
	// 		Properties: &armcostmanagement.ReportURL{
	// 			ReportURL: to.Ptr(armcostmanagement.ReservationReportSchema("https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ")),
	// 			ValidUntil: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-09-12T02:56:55.5021869Z"); return t}()),
	// 		},
	// 		Status: to.Ptr(armcostmanagement.OperationStatusTypeCompleted),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Beispiel für eine Antwort

Statuscode:

200

{
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2020-09-12T02:56:55.5021869Z"
  },
  "status": "Completed"
}

Statuscode:

202

Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01
Retry-After: 60

Definitionen

Name	Beschreibung
ErrorDetails	Die Details des Fehlers.
ErrorResponse	Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. \n\nEinige Fehlerantworten: \n\n * 429 TooManyRequests – Anfrage wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. \n\n * 503 Service Nicht verfügbar – Service ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
OperationStatus	Der Status des vorgangs mit langer Ausführung.
OperationStatusType	Enum repräsentiert den Status einer asynchronen Operation.
ReservationReportSchema	Die CSV-Datei aus der reportUrl-BLOB-Verknüpfung besteht aus Reservierungsnutzungsdaten mit dem folgenden Schema bei täglicher Granularität

ErrorDetails

Objekt

Die Details des Fehlers.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

ErrorResponse

Objekt

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben. \n\nEinige Fehlerantworten: \n\n * 429 TooManyRequests – Anfrage wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. \n\n * 503 Service Nicht verfügbar – Service ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.

OperationStatus

Objekt

Der Status des vorgangs mit langer Ausführung.

Name	Typ	Beschreibung
properties.reportUrl	ReservationReportSchema	Die CSV-Datei aus der reportUrl-BLOB-Verknüpfung besteht aus Reservierungsnutzungsdaten mit dem folgenden Schema bei täglicher Granularität
properties.validUntil	string (date-time)	Der Zeitpunkt, zu dem die Berichts-URL ungültig wird.
status	OperationStatusType	Der Status des vorgangs mit langer Ausführung.

OperationStatusType

Enumeration

Enum repräsentiert den Status einer asynchronen Operation.

Wert	Beschreibung
Running
Completed
Failed

ReservationReportSchema

Enumeration

Die CSV-Datei aus der reportUrl-BLOB-Verknüpfung besteht aus Reservierungsnutzungsdaten mit dem folgenden Schema bei täglicher Granularität

Wert	Beschreibung
InstanceFlexibilityGroup
InstanceFlexibilityRatio
InstanceId
Kind
ReservationId
ReservationOrderId
ReservedHours
SkuName
TotalReservedQuantity
UsageDate
UsedHours