| Generate Benefit Utilization Summaries Report | 您所在的位置：网站首页 › api配置文件 › Generate Benefit Utilization Summaries Report |
|
你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。 Generate Benefit Utilization Summaries Report - Generate By Billing Profile 参考 Service: Cost Management API Version: 2023-03-01触发为提供的计费帐户和计费配置文件生成权益利用率摘要报告。 POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-03-01 URI 参数 名称 在 必需 类型 说明 billingAccountId path Truestring 计费帐户 ID billingProfileId path Truestring 计费对象信息 ID。 api-version query Truestring 要用于此操作的 API 版本。 请求正文 名称 必需 类型 说明 endDate Truestring 将在报表中提供的摘要数据的结束日期。 grain Truegrain 汇总数据在报表中提供的粒度。 接受的值为“Daily”或“Monthly”。 startDate Truestring 将在报表中提供的汇总数据的开始日期。 benefitIdstring 权益 ID，这是权益利用率摘要报告所针对的。 权益 ID 范围是必需的。 权益订单或任何计费范围都不支持。 benefitOrderIdstring 权益顺序 ID，是效益利用率摘要报告所针对的。 权益顺序和权益 ID 范围是必需的。 任何计费范围都不支持。 billingAccountIdstring 权益利用率摘要报告所针对的计费帐户。 计费帐户和计费对象信息范围是必需的。 任何权益范围都不支持。 billingProfileIdstring 计费配置文件 ID，用于权益利用率摘要报告。 计费对象信息范围是必需的。 计费帐户或任何权益范围都不支持。 kindbenefitKind 请求的权益数据的类型。 计费帐户和计费对象信息范围是必需的。 默示且不会在权益范围内传递。 支持的值是 Reservation 和 SavingsPlan 响应 名称 类型 说明 200 OKBenefitUtilizationSummariesOperationStatus 权益利用率摘要报告的生成状态。 这可能正在进行、失败或已完成。 202 Accepted已接受。 将处理请求。 使用位置标头检查状态。 Headers Location: string Retry-After: integer Other Status CodesErrorResponse 描述操作失败原因的错误响应。 安全性 azure_authAzure Active Directory OAuth2 Flow。 Type: oauth2 Flow: implicit Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize Scopes 名称 说明 user_impersonation 模拟用户帐户 示例 GenerateUtilizationSummariesReportByBillingProfile Sample Request HTTP POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-03-01 { "kind": "Reservation", "endDate": "2022-08-31T00:00:00Z", "startDate": "2022-06-01T00:00:00Z", "grain": "Daily" } Sample Response Status code: 202 Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-03-01 Retry-After: 60 Status code: 200 { "input": { "grain": "Daily", "billingAccountId": "00000000-0000-0000-0000-000000000000", "billingProfileId": "CZSFR-SDFXC-DSDF", "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异步权益利用率摘要请求的属性。 BenefitUtilizationSummaryReportSchemareportUrl 和 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 的对象，在生成异步报表的日期之前有效。 名称 类型 说明 reportUrlBenefitUtilizationSummaryReportSchema 异步权益利用率摘要报告的 Sas URL。 如果报表处于“正在运行”或“失败”状态，则为空。 secondaryReportUrlBenefitUtilizationSummaryReportSchema 在发生主要中断时，辅助存储中异步权益利用率摘要报告的 Sas URL。 如果报表处于“正在运行”或“失败”状态，则为空。 validUntilstring reportUrl 中提供的 sas URL 过期的日期。 benefitKind预留或 SavingsPlan。 名称 类型 说明 IncludedQuantitystring 权益为 IncludedQuantity。 Reservationstring 权益是预留。 SavingsPlanstring 好处是 SavingsPlan。 BenefitUtilizationSummariesOperationStatus权益利用率摘要报告的状态。 提供异步权益利用率摘要请求输入、状态和报告 sas URL。 名称 类型 说明 inputBenefitUtilizationSummariesRequest 为创建权益利用率摘要报告而提供的输入。 propertiesAsyncOperationStatusProperties 包含异步权益利用率摘要报告的 sas URL 和 URL 的有效日期。 如果报表处于“正在运行”或“失败”状态，则这些值将为空 statusOperationStatusType 权益利用率摘要报表的创建状态。 BenefitUtilizationSummariesRequest异步权益利用率摘要请求的属性。 名称 类型 说明 benefitIdstring 权益 ID，这是权益利用率摘要报告所针对的。 权益 ID 范围是必需的。 权益订单或任何计费范围都不支持。 benefitOrderIdstring 权益顺序 ID，是效益利用率摘要报告所针对的。 权益顺序和权益 ID 范围是必需的。 任何计费范围都不支持。 billingAccountIdstring 权益利用率摘要报告所针对的计费帐户。 计费帐户和计费对象信息范围是必需的。 任何权益范围都不支持。 billingProfileIdstring 计费配置文件 ID，用于权益利用率摘要报告。 计费对象信息范围是必需的。 计费帐户或任何权益范围都不支持。 endDatestring 将在报表中提供的摘要数据的结束日期。 graingrain 汇总数据在报表中提供的粒度。 接受的值为“Daily”或“Monthly”。 kindbenefitKind 请求的权益数据的类型。 计费帐户和计费对象信息范围是必需的。 默示且不会在权益范围内传递。 支持的值是 Reservation 和 SavingsPlan startDatestring 将在报表中提供的汇总数据的开始日期。 BenefitUtilizationSummaryReportSchemareportUrl 和 secondaryReportUrl blob 链接中的 CSV 文件将包含以下权益利用率数据列。 对于节省计划报告和非数据块预留，UtilizedPercentage 将为 0。 对于数据块预留，利用率百分比将为 0。 名称 类型 说明 AvgUtilizationPercentagestring BenefitIdstring BenefitOrderIdstring BenefitTypestring Kindstring MaxUtilizationPercentagestring MinUtilizationPercentagestring UsageDatestring UtilizedPercentagestring ErrorDetails错误的详细信息。 名称 类型 说明 codestring 错误代码。 messagestring 指示操作失败原因的错误消息。 ErrorResponse错误响应指示服务无法处理传入请求。 错误消息中提供了原因。 某些错误响应： 429 TooManyRequests - 请求受到限制。 等待“x-ms-ratelimit-microsoft.consumption-retry-after”标头中指定的时间后重试。 503 ServiceUnavailable - 服务暂时不可用。 等待“Retry-After”标头中指定的时间后重试。 名称 类型 说明 errorErrorDetails 错误的详细信息。 grain用法的粒度。 支持的值：“Hourly” 名称 类型 说明 Dailystring 每小时粒度对应于每天的值。 Hourlystring 每小时粒度对应于每小时的值。 Monthlystring 每小时粒度对应于每月的值。 OperationStatusType权益利用率摘要报表的创建状态。 名称 类型 说明 Completestring Failedstring Runningstring |
| CopyRight 2018-2019 实验室设备网 版权所有 |