Exports - Get

Операция получения экспорта для определенной области по имени экспорта.

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}

Параметры URI

Name In Required Type Description
exportName
path True
  • string

Имя экспорта.

scope
path True
  • string

Область, связанная с операциями экспорта. Сюда входят "/subscriptions/{subscriptionId}/" для области подписки, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}" для области resourceGroup, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}" для области учетной записи выставления счетов и "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}" для области "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{ enrollmentAccountId}" для области EnrollmentAccount, "/providers/Microsoft.Management/managementGroups/{managementGroupId} для области группы управления, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}" для области billingProfile, "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}" для области invoiceSection и "/providers/Microsoft". Выставление счетов,выставление счетов/выставление счетов/{billingAccountId}/customers/{customerId}' для партнеров.

api-version
query True
  • string

Версия API, используемая с клиентским запросом.

$expand
query
  • string

Может использоваться для расширения свойств в рамках экспорта. В настоящее время поддерживается только runHistory и возвращает сведения о последних 10 выполнений экспорта.

Ответы

Name Type Description
200 OK

Все в порядке. Запрос выполнен успешно.

Other Status Codes

Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

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"
          ]
        }
      }
    }
  }
}

Определения

CommonExportProperties

Общие свойства экспорта.

ErrorDetails

Сведения об ошибке.

ErrorResponse

Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

  • 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.

ExecutionStatus

Последнее известное состояние выполнения экспорта.

ExecutionType

Тип выполнения экспорта.

Export

Ресурс экспорта.

ExportDataset

Определение данных в экспорте.

ExportDatasetConfiguration

Конфигурация экспортируемых наборов данных. Позволяет выбирать столбцы для экспорта. Если этот параметр не указан, экспорт будет включать все доступные столбцы.

ExportDefinition

Определение экспорта.

ExportDeliveryDestination

Это представляет расположение учетной записи хранения BLOB-объектов, в которой будут доставлены экспорты затрат. Настроить назначение можно двумя способами. Для большинства клиентов рекомендуется указать идентификатор ресурса учетной записи хранения. Для этого требуется одноразовая регистрация подписки учетной записи с помощью поставщика ресурсов Microsoft.CostManagementExports, чтобы предоставить службам управления затратами доступ к хранилищу. При создании экспорта в портал Azure эта регистрация выполняется автоматически, но пользователям API может потребоваться явно зарегистрировать подписку (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Другой способ настройки назначения доступен только партнерам с планом Соглашение с партнером Майкрософт, которые являются глобальными администраторами своей учетной записи выставления счетов. Эти партнеры вместо указания resourceId учетной записи хранения могут указать имя учетной записи хранения вместе с маркером SAS для учетной записи. Это позволяет экспортировать затраты в учетную запись хранения в любом клиенте. Маркер SAS необходимо создать для службы BLOB-объектов с типами ресурсов Service/Container/Object, а также с разрешениями на чтение, запись, удаление, добавление и создание (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

ExportDeliveryInfo

Сведения о доставке, связанные с экспортом.

ExportExecution

Выполнение экспорта.

ExportExecutionListResult

Результат перечисления журнала выполнения экспорта.

ExportRecurrencePeriod

Дата начала и окончания расписания повторения.

ExportSchedule

Расписание, связанное с экспортом.

ExportTimePeriod

Диапазон дат для данных в экспорте. Это значение должно быть указано только с интервалом времени, равным Custom. Максимальный диапазон дат составляет 3 месяца.

ExportType

Тип экспорта. Обратите внимание, что "Использование" эквивалентно ActualCost и применимо к экспорту, которые еще не предоставляют данные о расходах или амортизации для резервирований служб.

FormatType

Формат доставляемого экспорта. В настоящее время поддерживается только csv- файл.

GranularityType

Степень детализации строк в экспорте. В настоящее время поддерживается только daily.

RecurrenceType

Повторение расписания.

StatusType

Состояние расписания экспорта. Если параметр "Неактивен", расписание экспорта приостанавливается.

TimeframeType

Интервал времени для извлечения данных для экспорта. Если это настраивается, необходимо указать определенный период времени.

CommonExportProperties

Общие свойства экспорта.

Name Type Description
definition

Содержит определение для экспорта.

deliveryInfo

Содержит сведения о доставке для экспорта.

format

Формат доставляемого экспорта. В настоящее время поддерживается только csv- файл.

nextRunTimeEstimate
  • string

Если экспорт имеет активное расписание, предоставляет оценку следующего времени выполнения.

partitionData
  • boolean

Если задано значение true, экспортированные данные будут секционированы по размеру и помещаются в каталог больших двоичных объектов вместе с файлом манифеста. Примечание. В настоящее время этот параметр доступен только для современных областей коммерции.

runHistory

При запросе имеет последний журнал выполнения для экспорта.

ErrorDetails

Сведения об ошибке.

Name Type Description
code
  • string

Код ошибки.

message
  • string

Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

ErrorResponse

Ответ об ошибке указывает, что служба не может обработать входящий запрос. Причина указана в сообщении об ошибке.

Некоторые ответы на ошибки:

  • 429 TooManyRequests — запрос регулируется. Повторите попытку после ожидания времени, указанного в заголовке x-ms-ratelimit-microsoft.consumption-retry-after.

  • 503 ServiceUnavailable — служба временно недоступна. Повторите попытку по окончании периода времени, указанного в заголовке Retry-After.

Name Type Description
error

Сведения об ошибке.

ExecutionStatus

Последнее известное состояние выполнения экспорта.

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

ExecutionType

Тип выполнения экспорта.

Name Type Description
OnDemand
  • string
Scheduled
  • string

Export

Ресурс экспорта.

Name Type Description
eTag
  • string

eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.

id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.definition

Содержит определение для экспорта.

properties.deliveryInfo

Содержит сведения о доставке для экспорта.

properties.format

Формат доставляемого экспорта. В настоящее время поддерживается только csv- файл.

properties.nextRunTimeEstimate
  • string

Если экспорт имеет активное расписание, предоставляет оценку следующего времени выполнения.

properties.partitionData
  • boolean

Если задано значение true, экспортированные данные будут секционированы по размеру и помещаются в каталог больших двоичных объектов вместе с файлом манифеста. Примечание. В настоящее время этот параметр доступен только для современных областей коммерции.

properties.runHistory

При запросе имеет последний журнал выполнения для экспорта.

properties.schedule

Содержит сведения о расписании для экспорта.

type
  • string

Тип ресурса.

ExportDataset

Определение данных в экспорте.

Name Type Description
configuration

Конфигурация экспортируемых наборов данных.

granularity

Степень детализации строк в экспорте. В настоящее время поддерживается только daily.

ExportDatasetConfiguration

Конфигурация экспортируемых наборов данных. Позволяет выбирать столбцы для экспорта. Если этот параметр не указан, экспорт будет включать все доступные столбцы.

Name Type Description
columns
  • string[]

Массив имен столбцов для включения в экспорт. Если этот параметр не указан, экспорт будет включать все доступные столбцы. Доступные столбцы могут отличаться в зависимости от канала клиента (см. примеры).

ExportDefinition

Определение экспорта.

Name Type Description
dataSet

Определение данных в экспорте.

timePeriod

Имеет период времени для извлечения данных для экспорта.

timeframe

Интервал времени для извлечения данных для экспорта. Если это настраивается, необходимо указать определенный период времени.

type

Тип экспорта. Обратите внимание, что "Использование" эквивалентно ActualCost и применимо к экспорту, которые еще не предоставляют данные о расходах или амортизации для резервирований служб.

ExportDeliveryDestination

Это представляет расположение учетной записи хранения BLOB-объектов, в которой будут доставлены экспорты затрат. Настроить назначение можно двумя способами. Для большинства клиентов рекомендуется указать идентификатор ресурса учетной записи хранения. Для этого требуется одноразовая регистрация подписки учетной записи с помощью поставщика ресурсов Microsoft.CostManagementExports, чтобы предоставить службам управления затратами доступ к хранилищу. При создании экспорта в портал Azure эта регистрация выполняется автоматически, но пользователям API может потребоваться явно зарегистрировать подписку (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Другой способ настройки назначения доступен только партнерам с планом Соглашение с партнером Майкрософт, которые являются глобальными администраторами своей учетной записи выставления счетов. Эти партнеры вместо указания resourceId учетной записи хранения могут указать имя учетной записи хранения вместе с маркером SAS для учетной записи. Это позволяет экспортировать затраты в учетную запись хранения в любом клиенте. Маркер SAS необходимо создать для службы BLOB-объектов с типами ресурсов Service/Container/Object, а также с разрешениями на чтение, запись, удаление, добавление и создание (дополнительные сведения см. в разделе https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).

Name Type Description
container
  • string

Имя контейнера, в который будут отправляться экспорты. Если контейнер не существует, он будет создан.

resourceId
  • string

Идентификатор ресурса учетной записи хранения, в которой будут доставлены экспорты. Это необязательно, если указаны sasToken и storageAccount.

rootFolderPath
  • string

Имя каталога, в который будут отправляться экспорты.

sasToken
  • string

Маркер SAS для учетной записи хранения. Для ограниченного набора клиентов Azure этот набор вместе с storageAccount можно указать вместо resourceId. Примечание. Значение, возвращаемое API для этого свойства, всегда будет замаскировано. Возвращение этого же замаскированного значения не приведет к обновлению маркера SAS. Чтобы обновить это значение, необходимо указать новый маркер SAS.

storageAccount
  • string

Учетная запись хранения, в которой будут отправляться экспорты. Для ограниченного набора клиентов Azure этот набор вместе с sasToken можно указать вместо resourceId.

ExportDeliveryInfo

Сведения о доставке, связанные с экспортом.

Name Type Description
destination

Имеет место назначения для доставки экспорта.

ExportExecution

Выполнение экспорта.

Name Type Description
eTag
  • string

eTag ресурса. Для обработки сценария параллельного обновления это поле будет использоваться для определения того, обновляет ли пользователь последнюю версию.

id
  • string

Идентификатор ресурса.

name
  • string

Имя ресурса.

properties.error

Сведения о любой ошибке.

properties.executionType

Тип выполнения экспорта.

properties.fileName
  • string

Имя экспортируемого файла.

properties.processingEndTime
  • string

Время завершения выполнения экспорта.

properties.processingStartTime
  • string

Время выполнения экспорта.

properties.runSettings

Параметры экспорта, которые были в силе для этого выполнения.

properties.status

Последнее известное состояние выполнения экспорта.

properties.submittedBy
  • string

Идентификатор сущности, которая выполнила экспорт. Для выполнения OnDemand это сообщение электронной почты пользователя. Для запланированных выполнений это system.

properties.submittedTime
  • string

Время выполнения экспорта в очереди.

type
  • string

Тип ресурса.

ExportExecutionListResult

Результат перечисления журнала выполнения экспорта.

Name Type Description
value

Список выполнений экспорта.

ExportRecurrencePeriod

Дата начала и окончания расписания повторения.

Name Type Description
from
  • string

Дата начала повторения.

to
  • string

Дата окончания повторения.

ExportSchedule

Расписание, связанное с экспортом.

Name Type Description
recurrence

Повторение расписания.

recurrencePeriod

Имеет дату начала и окончания повторения. Дата начала должна быть в будущем. При наличии дата окончания должна быть больше даты начала.

status

Состояние расписания экспорта. Если параметр "Неактивен", расписание экспорта приостанавливается.

ExportTimePeriod

Диапазон дат для данных в экспорте. Это значение должно быть указано только с интервалом времени, равным Custom. Максимальный диапазон дат составляет 3 месяца.

Name Type Description
from
  • string

Дата начала экспорта данных.

to
  • string

Дата окончания экспорта данных.

ExportType

Тип экспорта. Обратите внимание, что "Использование" эквивалентно ActualCost и применимо к экспорту, которые еще не предоставляют данные о расходах или амортизации для резервирований служб.

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

FormatType

Формат доставляемого экспорта. В настоящее время поддерживается только csv- файл.

Name Type Description
Csv
  • string

GranularityType

Степень детализации строк в экспорте. В настоящее время поддерживается только daily.

Name Type Description
Daily
  • string

RecurrenceType

Повторение расписания.

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

StatusType

Состояние расписания экспорта. Если параметр "Неактивен", расписание экспорта приостанавливается.

Name Type Description
Active
  • string
Inactive
  • string

TimeframeType

Интервал времени для извлечения данных для экспорта. Если это настраивается, необходимо указать определенный период времени.

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