Exports - Get

Opération permettant d’obtenir l’exportation de l’étendue définie par nom d’exportation.

GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2021-10-01
GET https://management.azure.com/{scope}/providers/Microsoft.CostManagement/exports/{exportName}?api-version=2021-10-01&$expand={$expand}

Paramètres URI

Name In Required Type Description
exportName
path True
  • string

Nom de l’exportation.

scope
path True
  • string

Étendue associée aux opérations d’exportation. Cela inclut « /subscriptions/{subscriptionId} / » pour l’étendue de l’abonnement, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' pour l’étendue resourceGroup, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId} for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId} pour l’étendue EnrollmentAccount, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' pour l’étendue billingProfile, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' pour l’étendue invoiceSection et '/providers/Microsoft. Billing/billingAccounts/{billingAccountId}/customers/{customerId}' spécifique aux partenaires.

api-version
query True
  • string

Version de l’API à utiliser avec la demande du client.

$expand
query
  • string

Peut être utilisé pour développer les propriétés au sein d’une exportation. Actuellement, seul « runHistory » est pris en charge et retourne des informations pour les 10 dernières exécutions de l’exportation.

Réponses

Name Type Description
200 OK

OK. La demande a réussi.

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

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

Exemples

ExportGetByBillingAccount
ExportGetByDepartment
ExportGetByEnrollmentAccount
ExportGetByManagementGroup
ExportGetByResourceGroup
ExportGetBySubscription

ExportGetByBillingAccount

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-05-01T00:00:00Z",
        "to": "2020-05-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByDepartment

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByEnrollmentAccount

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2019-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetByManagementGroup

Sample Request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-09-01T00:00:00Z",
        "to": "2020-10-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "UsageDate",
            "MeterId",
            "InstanceId",
            "ResourceLocation",
            "UsageQuantity"
          ]
        }
      }
    }
  }
}

ExportGetByResourceGroup

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2020-06-01T00:00:00Z",
        "to": "2020-06-30T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

ExportGetBySubscription

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport?api-version=2021-10-01

Sample Response

{
  "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport",
  "name": "TestExport",
  "type": "Microsoft.CostManagement/exports",
  "properties": {
    "format": "Csv",
    "deliveryInfo": {
      "destination": {
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182",
        "container": "exports",
        "rootFolderPath": "ad-hoc"
      }
    },
    "definition": {
      "type": "ActualCost",
      "timeframe": "Custom",
      "timePeriod": {
        "from": "2019-06-01T00:00:00Z",
        "to": "2019-07-31T00:00:00Z"
      },
      "dataSet": {
        "granularity": "Daily",
        "configuration": {
          "columns": [
            "Date",
            "MeterId",
            "ResourceId",
            "ResourceLocation",
            "Quantity"
          ]
        }
      }
    }
  }
}

Définitions

CommonExportProperties

Propriétés communes de l’exportation.

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 le temps spécifié dans l’en-tête « Retry-After ».

ExecutionStatus

Dernier état connu de l’exécution de l’exportation.

ExecutionType

Type de l’exécution de l’exportation.

Export

Ressource d’exportation.

ExportDataset

Définition des données dans l’exportation.

ExportDatasetConfiguration

Configuration du jeu de données d’exportation. Permet de sélectionner des colonnes pour l’exportation. Si elle n’est pas fournie, l’exportation inclut toutes les colonnes disponibles.

ExportDefinition

Définition d’une exportation.

ExportDeliveryDestination

Cela représente l’emplacement du compte de stockage d’objets blob où les exportations de coûts seront remises. Il existe deux façons de configurer la destination. L’approche recommandée pour la plupart des clients consiste à spécifier l’ID de ressource du compte de stockage. Cela nécessite une inscription unique de l’abonnement du compte auprès du fournisseur de ressources Microsoft.CostManagementExports pour permettre aux services Cost Management d’accéder au stockage. Lors de la création d’une exportation dans le Portail Azure cette inscription est effectuée automatiquement, mais les utilisateurs d’API peuvent avoir besoin d’inscrire explicitement l’abonnement (pour plus d’informations, voir https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Une autre façon de configurer la destination est disponible uniquement pour les partenaires disposant d’un plan de Contrat Partenaire Microsoft qui sont des administrateurs généraux de leur compte de facturation. Ces partenaires, au lieu de spécifier l’ID de ressource d’un compte de stockage, peuvent spécifier le nom du compte de stockage avec un jeton SAP pour le compte. Cela permet d’exporter des coûts vers un compte de stockage dans n’importe quel locataire. Le jeton SAP doit être créé pour le service blob avec des types de ressources Service/Container/Object et avec des autorisations Lecture/Écriture/Supprimer/Liste/Ajouter/Créer (pour plus d’informations, voir https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

ExportDeliveryInfo

Informations de remise associées à une exportation.

ExportExecution

Exécution d’exportation.

ExportExecutionListResult

Résultat de la liste de l’historique d’exécution d’une exportation.

ExportRecurrencePeriod

Date de début et de fin de la planification de périodicité.

ExportSchedule

Planification associée à l’exportation.

ExportTimePeriod

Plage de dates pour les données de l’exportation. Cela ne doit être spécifié qu’avec timeFrame défini sur « Personnalisé ». La plage de dates maximale est de 3 mois.

ExportType

Type de l'exportation. Notez que « Utilisation » équivaut à « ActualCost » et s’applique aux exportations qui ne fournissent pas encore de données pour les frais ou l’amortissement des réservations de service.

FormatType

Format de l’exportation en cours de remise. Actuellement, seul « Csv » est pris en charge.

GranularityType

Granularité des lignes dans l’exportation. Actuellement, seul « Quotidien » est pris en charge.

RecurrenceType

Périodicité de la planification.

StatusType

État de la planification de l’exportation. Si la valeur est « inactive », la planification de l’exportation est suspendue.

TimeframeType

Délai d’extraction des données pour l’exportation. Si elle est personnalisée, une période spécifique doit être fournie.

CommonExportProperties

Propriétés communes de l’exportation.

Name Type Description
definition

A la définition de l’exportation.

deliveryInfo

Contient des informations de remise pour l’exportation.

format

Format de l’exportation en cours de remise. Actuellement, seul « Csv » est pris en charge.

nextRunTimeEstimate
  • string

Si l’exportation a une planification active, fournit une estimation de la prochaine exécution.

partitionData
  • boolean

Si la valeur est true, les données exportées sont partitionnée par taille et placées dans un répertoire d’objets blob avec un fichier manifeste. Remarque : cette option est actuellement disponible uniquement pour les étendues commerciales modernes.

runHistory

Si nécessaire, contient l’historique d’exécution le plus récent pour l’exportation.

ErrorDetails

Détails de l’erreur.

Name Type Description
code
  • string

Code d’erreur.

message
  • string

Message d’erreur indiquant la raison de l’échec de l’opération.

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 le temps spécifié dans l’en-tête « Retry-After ».

Name Type Description
error

Détails de l’erreur.

ExecutionStatus

Dernier état connu de l’exécution de l’exportation.

Name Type Description
Completed
  • string
DataNotAvailable
  • string
Failed
  • string
InProgress
  • string
NewDataNotAvailable
  • string
Queued
  • string
Timeout
  • string

ExecutionType

Type de l’exécution de l’exportation.

Name Type Description
OnDemand
  • string
Scheduled
  • string

Export

Ressource d’exportation.

Name Type Description
eTag
  • string

eTag de la ressource. Pour gérer le scénario de mise à jour simultanée, ce champ sera utilisé pour déterminer si l’utilisateur met à jour la dernière version ou non.

id
  • string

ID de ressource.

name
  • string

Nom de la ressource.

properties.definition

A la définition de l’exportation.

properties.deliveryInfo

Contient des informations de remise pour l’exportation.

properties.format

Format de l’exportation en cours de remise. Actuellement, seul « Csv » est pris en charge.

properties.nextRunTimeEstimate
  • string

Si l’exportation a une planification active, fournit une estimation de la prochaine exécution.

properties.partitionData
  • boolean

Si la valeur est true, les données exportées sont partitionnée par taille et placées dans un répertoire d’objets blob avec un fichier manifeste. Remarque : cette option est actuellement disponible uniquement pour les étendues commerciales modernes.

properties.runHistory

Si nécessaire, contient l’historique d’exécution le plus récent pour l’exportation.

properties.schedule

Contient des informations de planification pour l’exportation.

type
  • string

Type de ressource.

ExportDataset

Définition des données dans l’exportation.

Name Type Description
configuration

Configuration du jeu de données d’exportation.

granularity

Granularité des lignes dans l’exportation. Actuellement, seul « Quotidien » est pris en charge.

ExportDatasetConfiguration

Configuration du jeu de données d’exportation. Permet de sélectionner des colonnes pour l’exportation. Si elle n’est pas fournie, l’exportation inclut toutes les colonnes disponibles.

Name Type Description
columns
  • string[]

Tableau de noms de colonnes à inclure dans l’exportation. Si elle n’est pas fournie, l’exportation inclut toutes les colonnes disponibles. Les colonnes disponibles peuvent varier selon le canal client (voir des exemples).

ExportDefinition

Définition d’une exportation.

Name Type Description
dataSet

Définition des données dans l’exportation.

timePeriod

A la période d’extraction des données pour l’exportation.

timeframe

Délai d’extraction des données pour l’exportation. Si elle est personnalisée, une période spécifique doit être fournie.

type

Type de l'exportation. Notez que « Utilisation » équivaut à « ActualCost » et s’applique aux exportations qui ne fournissent pas encore de données pour les frais ou l’amortissement des réservations de service.

ExportDeliveryDestination

Cela représente l’emplacement du compte de stockage d’objets blob où les exportations de coûts seront remises. Il existe deux façons de configurer la destination. L’approche recommandée pour la plupart des clients consiste à spécifier l’ID de ressource du compte de stockage. Cela nécessite une inscription unique de l’abonnement du compte auprès du fournisseur de ressources Microsoft.CostManagementExports pour permettre aux services Cost Management d’accéder au stockage. Lors de la création d’une exportation dans le Portail Azure cette inscription est effectuée automatiquement, mais les utilisateurs d’API peuvent avoir besoin d’inscrire explicitement l’abonnement (pour plus d’informations, voir https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Une autre façon de configurer la destination est disponible uniquement pour les partenaires disposant d’un plan de Contrat Partenaire Microsoft qui sont des administrateurs généraux de leur compte de facturation. Ces partenaires, au lieu de spécifier l’ID de ressource d’un compte de stockage, peuvent spécifier le nom du compte de stockage avec un jeton SAP pour le compte. Cela permet d’exporter des coûts vers un compte de stockage dans n’importe quel locataire. Le jeton SAP doit être créé pour le service blob avec des types de ressources Service/Container/Object et avec des autorisations Lecture/Écriture/Supprimer/Liste/Ajouter/Créer (pour plus d’informations, voir https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Name Type Description
container
  • string

Nom du conteneur dans lequel les exportations seront chargées. Si le conteneur n’existe pas, il sera créé.

resourceId
  • string

ID de ressource du compte de stockage où les exportations seront remises. Cela n’est pas obligatoire si un sasToken et storageAccount sont spécifiés.

rootFolderPath
  • string

Nom du répertoire dans lequel les exportations seront chargées.

sasToken
  • string

Jeton SAP pour le compte de stockage. Pour un ensemble restreint de clients Azure, cela peut être spécifié avec storageAccount au lieu de resourceId. Remarque : la valeur retournée par l’API pour cette propriété est toujours obfusqué. Le renvoi de cette même valeur obfusqué n’entraîne pas la mise à jour du jeton SAP. Pour mettre à jour cette valeur, un nouveau jeton SAP doit être spécifié.

storageAccount
  • string

Compte de stockage dans lequel les exportations seront chargées. Pour un ensemble restreint de clients Azure, cela avec sasToken peut être spécifié au lieu de resourceId.

ExportDeliveryInfo

Informations de remise associées à une exportation.

Name Type Description
destination

A la destination de l’exportation en cours de livraison.

ExportExecution

Exécution d’exportation.

Name Type Description
eTag
  • string

eTag de la ressource. Pour gérer le scénario de mise à jour simultanée, ce champ sera utilisé pour déterminer si l’utilisateur met à jour la dernière version ou non.

id
  • string

ID de ressource.

name
  • string

Nom de la ressource.

properties.error

Détails de toute erreur.

properties.executionType

Type de l’exécution de l’exportation.

properties.fileName
  • string

Nom du fichier exporté.

properties.processingEndTime
  • string

Heure de fin de l’exécution de l’exportation.

properties.processingStartTime
  • string

Heure à laquelle l’exportation a été récupérée pour être exécutée.

properties.runSettings

Paramètres d’exportation qui étaient en vigueur pour cette exécution.

properties.status

Dernier état connu de l’exécution de l’exportation.

properties.submittedBy
  • string

Identificateur de l’entité qui a exécuté l’exportation. Pour les exécutions OnDemand, il s’agit de l’e-mail de l’utilisateur. Pour les exécutions planifiées, il s’agit de « Système ».

properties.submittedTime
  • string

Heure d’exécution de l’exportation.

type
  • string

Type de ressource.

ExportExecutionListResult

Résultat de la liste de l’historique d’exécution d’une exportation.

Name Type Description
value

Liste des exécutions d’exportation.

ExportRecurrencePeriod

Date de début et de fin de la planification de périodicité.

Name Type Description
from
  • string

Date de début de la périodicité.

to
  • string

Date de fin de la périodicité.

ExportSchedule

Planification associée à l’exportation.

Name Type Description
recurrence

Périodicité de la planification.

recurrencePeriod

A la date de début et de fin de la périodicité. La date de début doit être à l’avenir. Si elle est présente, la date de fin doit être supérieure à la date de début.

status

État de la planification de l’exportation. Si la valeur est « inactive », la planification de l’exportation est suspendue.

ExportTimePeriod

Plage de dates pour les données de l’exportation. Cela ne doit être spécifié qu’avec timeFrame défini sur « Personnalisé ». La plage de dates maximale est de 3 mois.

Name Type Description
from
  • string

Date de début des données d’exportation.

to
  • string

Date de fin des données d’exportation.

ExportType

Type de l'exportation. Notez que « Utilisation » équivaut à « ActualCost » et s’applique aux exportations qui ne fournissent pas encore de données pour les frais ou l’amortissement des réservations de service.

Name Type Description
ActualCost
  • string
AmortizedCost
  • string
Usage
  • string

FormatType

Format de l’exportation en cours de remise. Actuellement, seul « Csv » est pris en charge.

Name Type Description
Csv
  • string

GranularityType

Granularité des lignes dans l’exportation. Actuellement, seul « Quotidien » est pris en charge.

Name Type Description
Daily
  • string

RecurrenceType

Périodicité de la planification.

Name Type Description
Annually
  • string
Daily
  • string
Monthly
  • string
Weekly
  • string

StatusType

État de la planification de l’exportation. Si la valeur est « inactive », la planification de l’exportation est suspendue.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

Délai d’extraction des données pour l’exportation. Si elle est personnalisée, une période spécifique doit être fournie.

Name Type Description
BillingMonthToDate
  • string
Custom
  • string
MonthToDate
  • string
TheLastBillingMonth
  • string
TheLastMonth
  • string
WeekToDate
  • string