通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Generate Benefit Utilization Summaries Report - Generate By Billing Account

  • 参考
服务:
Cost Management
API 版本:
2024-08-01

触发为提供的计费帐户生成权益利用率摘要报告。 此 API 仅支持注册帐户。

POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2024-08-01

URI 参数

名称 在 必需 类型 说明
billingAccountId
 path True

string

计费帐户 ID
api-version
 query True

string

用于此操作的 API 版本。

请求正文

名称 必需 类型 说明
endDate True

string

将在报表中提供的摘要数据的结束日期。
grain True

grain

摘要数据的粒度在报表中提供。 接受的值是“每日”或“每月”。
startDate True

string

将在报表中提供的摘要数据的开始日期。
benefitId

string

权益 ID 权益利用率摘要报告适用于。 权益 ID 范围是必需的。 权益订单或任何计费范围不受支持。
benefitOrderId

string

权益订单 ID 权益利用率摘要报告适用于。 权益顺序和权益 ID 范围是必需的。 任何计费范围都不受支持。
billingAccountId

string

权益利用率摘要报告适用于的计费帐户。 计费帐户和计费配置文件范围是必需的。 任何权益范围都不受支持。
billingProfileId

string

用于权益利用率摘要报告的计费配置文件 ID。 计费配置文件范围是必需的。 计费帐户或任何权益范围不受支持。
kind

benefitKind

请求的权益数据类型。 计费帐户和计费配置文件范围是必需的。 隐含且不会在权益范围内传递。 支持的值为 Reservation 和 SavingsPlan

响应

名称 类型 说明
200 OK

BenefitUtilizationSummariesOperationStatus

生成权益利用率摘要报告的状态。 这可能正在进行、失败或已完成。
202 Accepted

接受。 将处理请求。 使用位置标头检查状态。

标头

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

GenerateUtilizationSummariesReportByBillingAccount

示例请求

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

{
  "kind": "Reservation",
  "endDate": "2022-08-31T00:00:00Z",
  "startDate": "2022-06-01T00:00:00Z",
  "grain": "Daily"
}

示例响应

状态代码:
202 
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/8099099/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2024-08-01
Retry-After: 60
状态代码:
200 
{
  "input": {
    "grain": "Daily",
    "billingAccountId": "8099099",
    "kind": "Reservation",
    "endDate": "2022-08-31T00:00:00Z",
    "startDate": "2022-06-01T00:00:00Z"
  },
  "status": "Complete",
  "properties": {
    "reportUrl": "https://storage.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "secondaryReportUrl": "https://storage-secondary.blob.core.windows.net/details/20220611/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ",
    "validUntil": "2022-06-12T02:56:55.5021869Z"
  }
}

定义

名称 说明
AsyncOperationStatusProperties

对象，表示报表 URL 和有效，直到生成的异步报表的日期。
benefitKind

预留或 SavingsPlan。
BenefitUtilizationSummariesOperationStatus

权益利用率摘要报告的状态。 提供异步权益利用率摘要请求输入、状态和报告 sas URL。
BenefitUtilizationSummariesRequest

异步权益利用率摘要请求的属性。
BenefitUtilizationSummaryReportSchema

reportUrl 和 secondaryReportUrl blob 链接中的 CSV 文件由以下权益利用率数据列组成。 UtilizedPercentage 将为 0，用于节省计划报告和非数据砖预留。 数据砖预留的利用率百分比将为 0。
ErrorDetails

错误的详细信息。
ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应：

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。
grain

使用情况的粒度。 支持的值：“Hourly”
OperationStatusType

创建权益利用率摘要报告的状态。

AsyncOperationStatusProperties

对象，表示报表 URL 和有效，直到生成的异步报表的日期。

名称 类型 说明
reportUrl

BenefitUtilizationSummaryReportSchema

异步权益利用率摘要报告的 Sas URL。 如果报表处于“正在运行”或“失败”状态，则为空。
secondaryReportUrl

BenefitUtilizationSummaryReportSchema

在发生主中断时，辅助存储中异步权益利用率摘要报告的 Sas URL。 如果报表处于“正在运行”或“失败”状态，则为空。
validUntil

string

reportUrl 中提供的 sas URL 过期的日期。

benefitKind

预留或 SavingsPlan。

名称 类型 说明
IncludedQuantity

string

权益为 IncludedQuantity。
Reservation

string

权益是预留。
SavingsPlan

string

权益是 SavingsPlan。

BenefitUtilizationSummariesOperationStatus

权益利用率摘要报告的状态。 提供异步权益利用率摘要请求输入、状态和报告 sas URL。

名称 类型 说明
input

BenefitUtilizationSummariesRequest

给定用于创建权益利用率摘要报表的输入。
properties

AsyncOperationStatusProperties

包含异步权益利用率摘要报告的 sas URL，以及 URL 在到期前有效的日期。 如果报表处于“正在运行”或“失败”状态，则这些值将为空
status

OperationStatusType

创建权益利用率摘要报告的状态。

BenefitUtilizationSummariesRequest

异步权益利用率摘要请求的属性。

名称 类型 说明
benefitId

string

权益 ID 权益利用率摘要报告适用于。 权益 ID 范围是必需的。 权益订单或任何计费范围不受支持。
benefitOrderId

string

权益订单 ID 权益利用率摘要报告适用于。 权益顺序和权益 ID 范围是必需的。 任何计费范围都不受支持。
billingAccountId

string

权益利用率摘要报告适用于的计费帐户。 计费帐户和计费配置文件范围是必需的。 任何权益范围都不受支持。
billingProfileId

string

用于权益利用率摘要报告的计费配置文件 ID。 计费配置文件范围是必需的。 计费帐户或任何权益范围不受支持。
endDate

string

将在报表中提供的摘要数据的结束日期。
grain

grain

摘要数据的粒度在报表中提供。 接受的值是“每日”或“每月”。
kind

benefitKind

请求的权益数据类型。 计费帐户和计费配置文件范围是必需的。 隐含且不会在权益范围内传递。 支持的值为 Reservation 和 SavingsPlan
startDate

string

将在报表中提供的摘要数据的开始日期。

BenefitUtilizationSummaryReportSchema

reportUrl 和 secondaryReportUrl blob 链接中的 CSV 文件由以下权益利用率数据列组成。 UtilizedPercentage 将为 0，用于节省计划报告和非数据砖预留。 数据砖预留的利用率百分比将为 0。

名称 类型 说明
AvgUtilizationPercentage

string

BenefitId

string

BenefitOrderId

string

BenefitType

string

Kind

string

MaxUtilizationPercentage

string

MinUtilizationPercentage

string

UsageDate

string

UtilizedPercentage

string

ErrorDetails

错误的详细信息。

名称 类型 说明
code

string

错误代码。
message

string

指示操作失败的原因的错误消息。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

一些错误响应：

  • 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。

  • 503 ServiceUnavailable - 服务暂时不可用。 在等待“Retry-After”标头中指定的时间后重试。

名称 类型 说明
error

ErrorDetails

错误的详细信息。

grain

使用情况的粒度。 支持的值：“Hourly”

名称 类型 说明
Daily

string

每小时粒度对应于每天的值。
Hourly

string

每小时粒度对应于每小时的值。
Monthly

string

每小时粒度对应于每月的值。

OperationStatusType

创建权益利用率摘要报告的状态。

名称 类型 说明
Complete

string

Failed

string

Running

string