Generate Cost Details Report - Get Operation Results

Référence

Service:: Cost Management

Version d'API:: 2024-08-01

Obtenez le résultat de l’opération spécifiée. Ce lien est fourni dans l’en-tête Location de la demande de création CostDetails.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
operationId	path	True	string	ID de l’opération cible.
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.

Réponses

Nom	Type	Description
200 OK	CostDetailsOperationResults	D’ACCORD. La demande a réussi.
202 Accepted		Accepté. L’opération est en cours.
Other Status Codes	ErrorResponse	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

Get details of the operation result

Exemple de requête

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

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

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.
ErrorResponse	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 : 429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-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é.

ErrorResponse

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 :

429 TooManyRequests : la requête est limitée. Réessayez après avoir attendu l’heure spécifiée dans l’en-tête « x-ms-ratelimit-microsoft.consumption-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

Partager via