Generate Cost Details Report - Get Operation Results

Referenz

Dienst:: Cost Management

API-Version:: 2024-08-01

Ruft das Ergebnis des angegebenen Vorgangs ab. Dieser Link wird im Anforderungsantwortheader "CostDetails" bereitgestellt.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}?api-version=2024-08-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
operationId	path	True	string	Die Zielvorgangs-ID.
scope	path	True	string	Die ARM-Ressourcen-ID für Abonnement, Abrechnungskonto oder andere Abrechnungsbereiche. Derzeit werden Ressourcengruppe und Verwaltungsgruppe nicht unterstützt. Weitere Informationen finden Sie unter https://aka.ms/costmgmt/scopes.
api-version	query	True	string	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	CostDetailsOperationResults	OKAY. Die Anforderung ist erfolgreich.
202 Accepted		Angenommen. Der Vorgang wird ausgeführt.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

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

Get details of the operation result

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2024-08-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
      "requestBody": {
        "metric": "ActualCost",
        "timePeriod": {
          "start": "2020-03-01",
          "end": "2020-03-15"
        }
      }
    },
    "blobs": [
      {
        "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
        "byteCount": 32741
      }
    ]
  },
  "validTill": "2022-05-10T08:08:46.1973252Z"
}

Statuscode:: 202

Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60

Definitionen

Name	Beschreibung
BlobInfo	Die von diesem Vorgang generierten BLOB-Informationen.
CostDetailsDataFormat	Das Datenformat des Berichts
CostDetailsMetricType	Der Typ des detaillierten Berichts. ActualCost wird standardmäßig bereitgestellt.
CostDetailsOperationResults	Das Ergebnis des lang ausgeführten Vorgangs für die Kostendetails-API.
CostDetailsStatusType	Der Status des Vorgangs "Kostendetails"
CostDetailsTimePeriod	Das Start- und Enddatum für das Abrufen von Daten für den detaillierten Kostenbericht. DIE API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger und nicht älter als 13 Monate.
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. Einige Fehlerantworten: 429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit. 503 ServiceUnavailable – Dienst ist vorübergehend nicht verfügbar. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "Retry-After" angegebene Zeit.
GenerateCostDetailsReportRequestDefinition	Die Definition eines detaillierten Kostenberichts.

BlobInfo

Die von diesem Vorgang generierten BLOB-Informationen.

Name	Typ	Beschreibung
blobLink	string	Link zum Blob zum Herunterladen der Datei.
byteCount	integer	Bytes im Blob.

CostDetailsDataFormat

Das Datenformat des Berichts

Name	Typ	Beschreibung
Csv	string	CSV-Datenformat.

CostDetailsMetricType

Der Typ des detaillierten Berichts. ActualCost wird standardmäßig bereitgestellt.

Name	Typ	Beschreibung
ActualCost	string	Ist-Kostendaten.
AmortizedCost	string	Amortisierte Kostendaten.

CostDetailsOperationResults

Das Ergebnis des lang ausgeführten Vorgangs für die Kostendetails-API.

Name	Typ	Beschreibung
error	ErrorDetails	Die Details des Fehlers.
id	string	Die ID des vorgangs mit langer Ausführung.
manifest.blobCount	integer	Die Gesamtanzahl der Blobs.
manifest.blobs	BlobInfo[]	Liste der blob-Informationen, die von diesem Vorgang generiert werden.
manifest.byteCount	integer	Die Gesamtanzahl der Bytes in allen Blobs.
manifest.compressData	boolean	Ist die Daten im komprimierten Format.
manifest.dataFormat	CostDetailsDataFormat	Das Datenformat des Berichts
manifest.manifestVersion	string	Die Manifestversion.
manifest.requestContext.requestBody	GenerateCostDetailsReportRequestDefinition	Der Anforderungsnutzlasttext, der im Anruf "Kostendetails" bereitgestellt wird
manifest.requestContext.requestScope	string	Der Anforderungsbereich der Anforderung.
name	string	Der Name des vorgangs mit langer Ausführung.
status	CostDetailsStatusType	Der Status des Vorgangs "Kostendetails"
type	string	Der Typ des vorgangs mit langer Ausführung.
validTill	string	Die Uhrzeit, zu der die Berichts-URL in UTC ungültig/abläuft, z. B. 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

Der Status des Vorgangs "Kostendetails"

Name	Typ	Beschreibung
Completed	string	Der Vorgang ist abgeschlossen.
Failed	string	Vorgang fehlgeschlagen.
NoDataFound	string	Der Vorgang ist abgeschlossen, und es wurden keine Kostendaten gefunden.

CostDetailsTimePeriod

Das Start- und Enddatum für das Abrufen von Daten für den detaillierten Kostenbericht. DIE API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger und nicht älter als 13 Monate.

Name	Typ	Beschreibung
end	string	Das Enddatum, in das Daten abgerufen werden sollen. Beispielformat 2020-03-15
start	string	Das Startdatum, aus dem Daten abgerufen werden sollen. Beispielformat 2020-03-15

ErrorDetails

Die Details des Fehlers.

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

ErrorResponse

Fehlerantwort gibt an, dass der Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Einige Fehlerantworten:

429 TooManyRequests – Anforderung wird gedrosselt. Wiederholen Sie den Vorgang nach dem Warten auf die im Header "x-ms-ratelimit-microsoft.consumption-retry-after" angegebene Zeit.
503 ServiceUnavailable – Dienst 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.

GenerateCostDetailsReportRequestDefinition

Die Definition eines detaillierten Kostenberichts.

Name	Typ	Beschreibung
billingPeriod	string	Dieser Parameter kann nur von Enterprise Agreement-Kunden verwendet werden. Verwenden Sie das YearMonth(z. B. 202008)-Format. Dieser Parameter kann nicht zusammen mit den parametern "invoiceId" oder "timePeriod" verwendet werden. Wenn ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück.
invoiceId	string	Dieser Parameter kann nur von Kunden des Microsoft-Kundenvertrags verwendet werden. Darüber hinaus kann sie nur im Bereich "Abrechnungsprofil" oder "Kunde" verwendet werden. Dieser Parameter kann nicht zusammen mit den parametern billingPeriod oder timePeriod verwendet werden. Wenn ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück.
metric	CostDetailsMetricType	Der Typ des detaillierten Berichts. ActualCost wird standardmäßig bereitgestellt.
timePeriod	CostDetailsTimePeriod	Der spezifische Datumsbereich der für den Bericht angeforderten Kostendetails. Dieser Parameter kann nicht zusammen mit den parametern "invoiceId" oder "billingPeriod" verwendet werden. Wenn ein timePeriod-, invoiceId- oder billingPeriod-Parameter nicht im Anforderungstext angegeben wird, gibt die API die Kosten des aktuellen Monats zurück. DIE API ermöglicht nur das Abrufen von Daten für 1 Monat oder weniger und nicht älter als 13 Monate. Wenn "timePeriod" oder "billingPeriod" oder "invoiceId" nicht angegeben wird, wird die API standardmäßig für den Zeitraum des geöffneten Monats verwendet.

Freigeben über