Partager via

Generate Cost Details Report - Create Operation

  • Référence
Service:
Cost Management
Version d'API:
2024-08-01

Cette API est le remplacement de toutes les API Détails de l’utilisation précédemment mises en production. Demandez de générer un rapport de détails sur les coûts pour la plage de dates, la période de facturation (seuls les clients d’entreprise) ou l’ID de facture de manière asynchrone dans une certaine étendue. L’appel initial pour demander un rapport retourne un 202 avec un en-tête « Location » et « Retry-After ». L’en-tête « Emplacement » fournit le point de terminaison à interroger pour obtenir le résultat de la génération de rapport. « Réessayer-After » fournit la durée d’attente avant l’interrogation du rapport généré. Un appel pour interroger l’opération de rapport fournit une réponse 202 avec un en-tête « Location » si l’opération est toujours en cours. Une fois l’opération de génération de rapports terminée, le point de terminaison d’interrogation fournit une réponse de 200, ainsi que des détails sur les objets blob de rapport disponibles en téléchargement. Les détails sur le ou les fichiers disponibles pour le téléchargement seront disponibles dans le corps de la réponse d’interrogation. Pour comprendre les détails des coûts (anciennement appelés détails d’utilisation) trouvés dans les fichiers, consultez 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=2024-08-01

Paramètres URI

Nom Dans Obligatoire Type Description
scope
 path True

string

ID de ressource ARM pour l’abonnement, le compte de facturation ou d’autres étendues de facturation. Actuellement, le groupe de ressources et le groupe d’administration ne sont pas pris en charge. Pour plus d’informations, consultez https://aka.ms/costmgmt/scopes.
api-version
 query True

string

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Type Description
billingPeriod

string

Ce paramètre ne peut être utilisé que par les clients Contrat Entreprise. Utilisez le format YearMonth(par exemple, 202008). Ce paramètre ne peut pas être utilisé avec les paramètres invoiceId ou timePeriod. Si un paramètre timePeriod, invoiceId ou billingPeriod n’est pas fourni dans le corps de la demande, l’API retourne le coût du mois actuel.
invoiceId

string

Ce paramètre ne peut être utilisé que par les clients du Contrat client Microsoft. En outre, elle ne peut être utilisée qu’au niveau du profil de facturation ou de l’étendue client. Ce paramètre ne peut pas être utilisé avec les paramètres billingPeriod ou timePeriod. Si un paramètre timePeriod, invoiceId ou billingPeriod n’est pas fourni dans le corps de la demande, l’API retourne le coût du mois actuel.
metric

CostDetailsMetricType

Type du rapport détaillé. Par défaut, ActualCost est fourni
timePeriod

CostDetailsTimePeriod

Plage de dates spécifique des détails de coût demandés pour le rapport. Ce paramètre ne peut pas être utilisé avec les paramètres invoiceId ou billingPeriod. Si un paramètre timePeriod, invoiceId ou billingPeriod n’est pas fourni dans le corps de la demande, l’API retourne le coût du mois actuel. L’API autorise uniquement l’extraction des données pendant 1 mois ou moins et pas plus de 13 mois. Si aucun timePeriod ou billingPeriod ou invoiceId n’est fourni, l’API est définie par défaut sur la période du mois ouvert

Réponses

Nom Type Description
200 OK

CostDetailsOperationResults

Traitement des demandes terminé.
202 Accepted

Accepté. La demande sera traitée. Utilisez l’en-tête Location pour vérifier l’état.

En-têtes

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

Aucun contenu. La demande a réussi, mais n’a retourné aucun résultat.
Other Status Codes

GenerateCostDetailsReportErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
GenerateCostDetailsReportByBillingProfileAndInvoiceId
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
GenerateCostDetailsReportByCustomerAndTimePeriod
GenerateCostDetailsReportByDepartmentsAndTimePeriod
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
GenerateCostDetailsReportBySubscriptionAndTimePeriod

GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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": "2024-08-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"
}
Code d’état:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Code d’état:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceId

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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": "2024-08-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"
}
Code d’état:
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=2024-08-01
Retry-After: 60
Code d’état:
204

GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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": "2024-08-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"
}
Code d’état:
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=2024-08-01
Retry-After: 60
Code d’état:
204

GenerateCostDetailsReportByCustomerAndTimePeriod

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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": "2024-08-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"
}
Code d’état:
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=2024-08-01
Retry-After: 60
Code d’état:
204

GenerateCostDetailsReportByDepartmentsAndTimePeriod

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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": "2024-08-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"
}
Code d’état:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Code d’état:
204

GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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": "2024-08-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"
}
Code d’état:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2024-08-01
Retry-After: 60
Code d’état:
204

GenerateCostDetailsReportBySubscriptionAndTimePeriod

Exemple de requête

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

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

Exemple de réponse

Code d’état:
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"
}
Code d’état:
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
Code d’état:
204

Définitions

Nom Description
BlobInfo

Informations sur l’objet blob générées par cette opération.
CostDetailsDataFormat

Format des données du rapport
CostDetailsMetricType

Type du rapport détaillé. Par défaut, ActualCost est fourni
CostDetailsOperationResults

Résultat de l’opération de longue durée pour l’API détails des coûts.
CostDetailsStatusType

État de l’opération de détails du coût
CostDetailsTimePeriod

Date de début et de fin de l’extraction des données pour le rapport détaillé sur le coût. L’API autorise uniquement l’extraction des données pendant 1 mois ou moins et pas plus de 13 mois.
ErrorDetails

Détails de l’erreur.
GenerateCostDetailsReportErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • Demande incorrecte 400 - Charge utile de la demande non valide. La charge utile de la demande fournie n’est pas au format json ou n’a pas accepté de membre non valide dans la charge utile de la demande.

  • 400 Demande incorrecte - Charge utile de la demande non valide : peut avoir uniquement timePeriod ou invoiceId ou billingPeriod. L’API autorise uniquement l’extraction des données pour timePeriod ou invoiceId ou billingPeriod. Le client ne doit fournir qu’un seul de ces paramètres.

  • 400 Demande incorrecte - La date de début doit être postérieure. L’API autorise uniquement l’extraction des données de plus de 13 mois à partir de maintenant.

  • 400 Demande incorrecte : la plage de dates maximale autorisée est de 1 mois. L’API autorise uniquement l’extraction des données pendant 1 mois ou moins.

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».
GenerateCostDetailsReportRequestDefinition

Définition d’un rapport détaillé sur les coûts.

BlobInfo

Informations sur l’objet blob générées par cette opération.

Nom Type Description
blobLink

string

Lien vers l’objet blob pour télécharger le fichier.
byteCount

integer

Octets dans l’objet blob.

CostDetailsDataFormat

Format des données du rapport

Nom Type Description
Csv

string

Format de données csv.

CostDetailsMetricType

Type du rapport détaillé. Par défaut, ActualCost est fourni

Nom Type Description
ActualCost

string

Données de coût réelles.
AmortizedCost

string

Données de coût amorties.

CostDetailsOperationResults

Résultat de l’opération de longue durée pour l’API détails des coûts.

Nom Type Description
error

ErrorDetails

Détails de l’erreur.
id

string

ID de l’opération de longue durée.
manifest.blobCount

integer

Nombre total d’objets blob.
manifest.blobs

BlobInfo[]

Liste des informations d’objet blob générées par cette opération.
manifest.byteCount

integer

Nombre total d’octets dans tous les objets blob.
manifest.compressData

boolean

Données au format compressé.
manifest.dataFormat

CostDetailsDataFormat

Format des données du rapport
manifest.manifestVersion

string

Version du manifeste.
manifest.requestContext.requestBody

GenerateCostDetailsReportRequestDefinition

Corps de la charge utile de la demande fourni dans l’appel Détails du coût
manifest.requestContext.requestScope

string

Étendue de la requête.
name

string

Nom de l’opération de longue durée.
status

CostDetailsStatusType

État de l’opération de détails du coût
type

string

Type de l’opération de longue durée.
validTill

string

Heure à laquelle l’URL du rapport devient non valide/expire au format UTC, par exemple, 2020-12-08T05:55:59.4394737Z.

CostDetailsStatusType

État de l’opération de détails du coût

Nom Type Description
Completed

string

L’opération est terminée.
Failed

string

Échec de l’opération.
NoDataFound

string

L’opération est terminée et aucune donnée de coût n’a été trouvée.

CostDetailsTimePeriod

Date de début et de fin de l’extraction des données pour le rapport détaillé sur le coût. L’API autorise uniquement l’extraction des données pendant 1 mois ou moins et pas plus de 13 mois.

Nom Type Description
end

string

Date de fin vers laquelle extraire des données. exemple de format 2020-03-15
start

string

Date de début à partir de laquelle extraire des données. exemple de format 2020-03-15

ErrorDetails

Détails de l’erreur.

Nom Type Description
code

string

Code d’erreur.
message

string

Message d’erreur indiquant pourquoi l’opération a échoué.

GenerateCostDetailsReportErrorResponse

La réponse d’erreur indique que le service n’est pas en mesure de traiter la requête entrante. La raison est fournie dans le message d’erreur.

Réponses d’erreur :

  • Demande incorrecte 400 - Charge utile de la demande non valide. La charge utile de la demande fournie n’est pas au format json ou n’a pas accepté de membre non valide dans la charge utile de la demande.

  • 400 Demande incorrecte - Charge utile de la demande non valide : peut avoir uniquement timePeriod ou invoiceId ou billingPeriod. L’API autorise uniquement l’extraction des données pour timePeriod ou invoiceId ou billingPeriod. Le client ne doit fournir qu’un seul de ces paramètres.

  • 400 Demande incorrecte - La date de début doit être postérieure. L’API autorise uniquement l’extraction des données de plus de 13 mois à partir de maintenant.

  • 400 Demande incorrecte : la plage de dates maximale autorisée est de 1 mois. L’API autorise uniquement l’extraction des données pendant 1 mois ou moins.

  • 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « retry-after ».

  • 503 ServiceUnavailable - Le service est temporairement indisponible. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « Retry-After ».

Nom Type Description
error

ErrorDetails

Détails de l’erreur.

GenerateCostDetailsReportRequestDefinition

Définition d’un rapport détaillé sur les coûts.

Nom Type Description
billingPeriod

string

Ce paramètre ne peut être utilisé que par les clients Contrat Entreprise. Utilisez le format YearMonth(par exemple, 202008). Ce paramètre ne peut pas être utilisé avec les paramètres invoiceId ou timePeriod. Si un paramètre timePeriod, invoiceId ou billingPeriod n’est pas fourni dans le corps de la demande, l’API retourne le coût du mois actuel.
invoiceId

string

Ce paramètre ne peut être utilisé que par les clients du Contrat client Microsoft. En outre, elle ne peut être utilisée qu’au niveau du profil de facturation ou de l’étendue client. Ce paramètre ne peut pas être utilisé avec les paramètres billingPeriod ou timePeriod. Si un paramètre timePeriod, invoiceId ou billingPeriod n’est pas fourni dans le corps de la demande, l’API retourne le coût du mois actuel.
metric

CostDetailsMetricType

Type du rapport détaillé. Par défaut, ActualCost est fourni
timePeriod

CostDetailsTimePeriod

Plage de dates spécifique des détails de coût demandés pour le rapport. Ce paramètre ne peut pas être utilisé avec les paramètres invoiceId ou billingPeriod. Si un paramètre timePeriod, invoiceId ou billingPeriod n’est pas fourni dans le corps de la demande, l’API retourne le coût du mois actuel. L’API autorise uniquement l’extraction des données pendant 1 mois ou moins et pas plus de 13 mois. Si aucun timePeriod ou billingPeriod ou invoiceId n’est fourni, l’API est définie par défaut sur la période du mois ouvert