Share via

Generate Cost Details Report - Create Operation

  • Riferimento
Service:
Cost Management
API Version:
2023-11-01

Questa API è la sostituzione di tutte le API di dettagli di utilizzo precedentemente rilasciate. Richiedere di generare un report dei dettagli dei costi per l'intervallo di date specificato, il periodo di fatturazione (solo i clienti aziendali) o l'ID fattura in modo asincrono in un determinato ambito. La chiamata iniziale alla richiesta di un report restituirà un valore 202 con un'intestazione "Location" e "Retry-After". L'intestazione "Location" fornirà l'endpoint per eseguire il polling per ottenere il risultato della generazione di report. "Retry-After" fornisce la durata di attesa prima del polling per il report generato. Una chiamata al polling dell'operazione di report fornirà una risposta 202 con un'intestazione "Location" se l'operazione è ancora in corso. Al termine dell'operazione di generazione del report, l'endpoint di polling fornirà una risposta 200 insieme ai dettagli sui BLOB del report disponibili per il download. I dettagli sui file disponibili per il download saranno disponibili nel corpo della risposta al polling. Per informazioni sui dettagli sui costi (in precedenza noti come dettagli sull'utilizzo) trovati nei file , vedere https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
scope
 path True

string

ID risorsa ARM per la sottoscrizione, l'account di fatturazione o altri ambiti di fatturazione. Attualmente il gruppo di risorse e il gruppo di gestione non sono supportati. Per informazioni dettagliate, vedere https://aka.ms/costmgmt/scopes.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
billingPeriod

string

Questo parametro può essere usato solo dai clienti Enterprise Agreement. Usare il formato YearMonth(ad esempio 202008). Questo parametro non può essere usato insieme ai parametri invoiceId o timePeriod. Se un parametro timePeriod, invoiceId o billingPeriod non viene fornito nel corpo della richiesta, l'API restituirà il costo del mese corrente.
invoiceId

string

Questo parametro può essere usato solo dai clienti Contratto del cliente Microsoft. Inoltre, può essere usato solo nell'ambito del profilo di fatturazione o del cliente. Questo parametro non può essere usato insieme ai parametri billingPeriod o timePeriod. Se un parametro timePeriod, invoiceId o billingPeriod non viene fornito nel corpo della richiesta, l'API restituirà il costo del mese corrente.
metric

CostDetailsMetricType

Tipo del report dettagliato. Per impostazione predefinita Viene fornito ActualCost
timePeriod

CostDetailsTimePeriod

Intervallo di date specifico dei dettagli sui costi richiesti per il report. Questo parametro non può essere usato insieme ai parametri invoiceId o billingPeriod. Se un parametro timePeriod, invoiceId o billingPeriod non viene fornito nel corpo della richiesta, l'API restituirà il costo del mese corrente. L'API consente solo il pull dei dati per 1 mese o meno e non più di 13 mesi. Se non viene fornito alcun valore timePeriod o fatturazionePeriod o invoiceId, l'API viene predefinita per il periodo di tempo di apertura del mese

Risposte

Nome Tipo Descrizione
200 OK

CostDetailsOperationResults

Elaborazione richiesta completata.
202 Accepted

Accettato. La richiesta verrà elaborata. Usare l'intestazione Location per controllare lo stato.

Headers

  • Location: string
  • Retry-After: integer
204 No Content

Nessun contenuto. La richiesta ha avuto esito positivo, ma non ha restituito risultati.
Other Status Codes

GenerateCostDetailsReportErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "billingPeriod": "202205"
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceId

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567"
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "invoiceId": "M1234567"
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "requestBody": {
        "metric": "ActualCost",
        "billingPeriod": "202205"
      }
    },
    "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByCustomerAndTimePeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
      "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByDepartmentsAndTimePeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/departments/12345",
      "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod

Sample Request

POST https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
200 
{
  "id": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
  "name": "00000000-0000-0000-0000-000000000000",
  "status": "Completed",
  "manifest": {
    "manifestVersion": "2023-11-01",
    "dataFormat": "Csv",
    "blobCount": 1,
    "byteCount": 32741,
    "compressData": false,
    "requestContext": {
      "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234",
      "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"
}
Status code:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

GenerateCostDetailsReportBySubscriptionAndTimePeriod

Sample Request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01

{
  "metric": "ActualCost",
  "timePeriod": {
    "start": "2020-03-01",
    "end": "2020-03-15"
  }
}

Sample Response

Status code:
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": "2023-11-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"
}
Status code:
202 
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
Status code:
204

Definizioni

Nome Descrizione
BlobInfo

Informazioni BLOB generate da questa operazione.
CostDetailsDataFormat

Formato dati del report
CostDetailsMetricType

Tipo del report dettagliato. Per impostazione predefinita Viene fornito ActualCost
CostDetailsOperationResults

Risultato dell'operazione a esecuzione prolungata per l'API dei dettagli sui costi.
CostDetailsStatusType

Stato dell'operazione dei dettagli dei costi
CostDetailsTimePeriod

Data di inizio e fine per il pull dei dati per il report dettagliato sui costi. L'API consente solo il pull dei dati per 1 mese o meno e non più di 13 mesi.
ErrorDetails

Dettagli dell'errore.
GenerateCostDetailsReportErrorResponse

Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

  • 400 Richiesta non valida - Payload richiesta non valida. Il payload della richiesta fornito non è in formato json o ha un membro non valido non accettato nel payload della richiesta.

  • 400 Richiesta non valida- Payload della richiesta non valida: può avere solo timePeriod o invoiceId o fatturazionePeriod. L'API consente solo il pull dei dati per timePeriod o invoiceId o fatturazionePeriod. Il cliente deve fornire solo uno di questi parametri.

  • 400 Richiesta non valida: la data di inizio deve essere successiva a . L'API consente solo il pull dei dati senza più di 13 mesi da ora.

  • 400 Richiesta non valida: l'intervallo massimo di date consentito è di 1 mesi. L'API consente solo il pull dei dati per 1 mese o meno.

  • 429 TooManyRequests - La richiesta è limitata. Riprovare dopo l'attesa dell'ora specificata nell'intestazione "retry-after".

  • 503 ServiceUnavailable : il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".
GenerateCostDetailsReportRequestDefinition

Definizione di un report dettagliato sui costi.

BlobInfo

Informazioni BLOB generate da questa operazione.

Nome Tipo Descrizione
blobLink

string

Collegamento al BLOB per scaricare il file.
byteCount

integer

Byte nel BLOB.

CostDetailsDataFormat

Formato dati del report

Nome Tipo Descrizione
Csv

string

Formato dati Csv.

CostDetailsMetricType

Tipo del report dettagliato. Per impostazione predefinita Viene fornito ActualCost

Nome Tipo Descrizione
ActualCost

string

Dati dei costi effettivi.
AmortizedCost

string

Dati dei costi ammortizzati.

CostDetailsOperationResults

Risultato dell'operazione a esecuzione prolungata per l'API dei dettagli sui costi.

Nome Tipo Descrizione
error

ErrorDetails

Dettagli dell'errore.
id

string

ID dell'operazione a esecuzione prolungata.
manifest.blobCount

integer

Numero totale di BLOB.
manifest.blobs

BlobInfo[]

Elenco di informazioni BLOB generate da questa operazione.
manifest.byteCount

integer

Numero totale di byte in tutti i BLOB.
manifest.compressData

boolean

Dati in formato compresso.
manifest.dataFormat

CostDetailsDataFormat

Formato dati del report
manifest.manifestVersion

string

Versione manifesto.
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

Corpo del payload della richiesta fornito nella chiamata Dettagli costo
manifest.requestContext.requestScope

string

Ambito della richiesta.
name

string

Nome dell'operazione a esecuzione prolungata.
status

CostDetailsStatusType

Stato dell'operazione dei dettagli dei costi
type

string

Tipo dell'operazione a esecuzione prolungata.
validTill

string

Ora in cui l'URL del report diventa non valido/scade in UTC, ad esempio 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

Stato dell'operazione dei dettagli dei costi

Nome Tipo Descrizione
Completed

string

L'operazione è completata.
Failed

string

Operazione non riuscita.
NoDataFound

string

L'operazione è completata e non sono stati trovati dati relativi ai costi.

CostDetailsTimePeriod

Data di inizio e fine per il pull dei dati per il report dettagliato sui costi. L'API consente solo il pull dei dati per 1 mese o meno e non più di 13 mesi.

Nome Tipo Descrizione
end

string

Data di fine in cui eseguire il pull dei dati. formato di esempio 2020-03-15
start

string

Data di inizio da cui eseguire il pull dei dati. formato di esempio 2020-03-15

ErrorDetails

Dettagli dell'errore.

Nome Tipo Descrizione
code

string

Codice di errore.
message

string

Messaggio di errore che indica perché l'operazione non è riuscita.

GenerateCostDetailsReportErrorResponse

Risposta di errore indica che il servizio non è in grado di elaborare la richiesta in ingresso. Il motivo viene fornito nel messaggio di errore.

Alcune risposte di errore:

  • 400 Richiesta non valida - Payload richiesta non valida. Il payload della richiesta fornito non è in formato json o ha un membro non valido non accettato nel payload della richiesta.

  • 400 Richiesta non valida- Payload della richiesta non valida: può avere solo timePeriod o invoiceId o fatturazionePeriod. L'API consente solo il pull dei dati per timePeriod o invoiceId o fatturazionePeriod. Il cliente deve fornire solo uno di questi parametri.

  • 400 Richiesta non valida: la data di inizio deve essere successiva a . L'API consente solo il pull dei dati senza più di 13 mesi da ora.

  • 400 Richiesta non valida: l'intervallo massimo di date consentito è di 1 mesi. L'API consente solo il pull dei dati per 1 mese o meno.

  • 429 TooManyRequests - La richiesta è limitata. Riprovare dopo l'attesa dell'ora specificata nell'intestazione "retry-after".

  • 503 ServiceUnavailable : il servizio non è temporaneamente disponibile. Riprovare dopo aver atteso il tempo specificato nell'intestazione "Retry-After".

Nome Tipo Descrizione
error

ErrorDetails

Dettagli dell'errore.

GenerateCostDetailsReportRequestDefinition

Definizione di un report dettagliato sui costi.

Nome Tipo Descrizione
billingPeriod

string

Questo parametro può essere usato solo dai clienti Enterprise Agreement. Usare il formato YearMonth(ad esempio 202008). Questo parametro non può essere usato insieme ai parametri invoiceId o timePeriod. Se un parametro timePeriod, invoiceId o billingPeriod non viene fornito nel corpo della richiesta, l'API restituirà il costo del mese corrente.
invoiceId

string

Questo parametro può essere usato solo dai clienti Contratto del cliente Microsoft. Inoltre, può essere usato solo nell'ambito del profilo di fatturazione o del cliente. Questo parametro non può essere usato insieme ai parametri billingPeriod o timePeriod. Se un parametro timePeriod, invoiceId o billingPeriod non viene fornito nel corpo della richiesta, l'API restituirà il costo del mese corrente.
metric

CostDetailsMetricType

Tipo del report dettagliato. Per impostazione predefinita Viene fornito ActualCost
timePeriod

CostDetailsTimePeriod

Intervallo di date specifico dei dettagli sui costi richiesti per il report. Questo parametro non può essere usato insieme ai parametri invoiceId o billingPeriod. Se un parametro timePeriod, invoiceId o billingPeriod non viene fornito nel corpo della richiesta, l'API restituirà il costo del mese corrente. L'API consente solo il pull dei dati per 1 mese o meno e non più di 13 mesi. Se non viene fornito alcun valore timePeriod o fatturazionePeriod o invoiceId, l'API viene predefinita per il periodo di tempo di apertura del mese