Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

참조

서비스:: Cost Management

API 버전:: 2023-11-01

제공된 절감 계획에 대한 혜택 사용률 요약 보고서 생성을 트리거합니다.

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
savingsPlanId	path	True	string	절감 플랜 ID입니다.
savingsPlanOrderId	path	True	string	절감 플랜 주문 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	필수	형식	Description
endDate	True	string	보고서에 제공될 요약 데이터의 종료 날짜입니다.
grain	True	grain	요약 데이터가 보고서에서 제공되는 조직입니다. 허용되는 값은 'Daily' 또는 'Monthly'입니다.
startDate	True	string	보고서에 제공될 요약 데이터의 시작 날짜입니다.
benefitId		string	혜택 사용률 요약 보고서에 대한 혜택 ID입니다. 혜택 ID scope 필요합니다. 혜택 주문 또는 청구 범위에 대해 지원되지 않습니다.
benefitOrderId		string	혜택 사용률 요약 보고서에 대한 혜택 순서 ID입니다. 혜택 순서 및 혜택 ID 범위에 필요합니다. 청구 범위에 대해 지원되지 않습니다.
billingAccountId		string	혜택 사용률 요약 보고서에 대한 청구 계정입니다. 청구 계정 및 청구 프로필 범위에 필요합니다. 혜택 범위에 대해 지원되지 않습니다.
billingProfileId		string	혜택 사용률 요약 보고서에 대한 청구 프로필 ID입니다. 청구 프로필 scope 필요합니다. 청구 계정 또는 혜택 범위에 대해 지원되지 않습니다.
kind		benefitKind	요청된 혜택 데이터의 유형입니다. 청구 계정 및 청구 프로필 범위에 필요합니다. 혜택 범위에서 묵시적이고 전달되지 않습니다. 지원되는 값은 Reservation 및 SavingsPlan입니다.

응답

Name	형식	Description
200 OK	BenefitUtilizationSummariesOperationStatus	혜택 사용률 요약 보고서 생성의 상태. 이 작업은 진행 중, 실패 또는 완료될 수 있습니다.
202 Accepted		수락됨 요청이 처리됩니다. 위치 헤더를 사용하여 상태 검사. 헤더 Location: string Retry-After: integer
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

Name

형식

Description

200 OK

BenefitUtilizationSummariesOperationStatus

혜택 사용률 요약 보고서 생성의 상태. 이 작업은 진행 중, 실패 또는 완료될 수 있습니다.

202 Accepted

수락됨 요청이 처리됩니다. 위치 헤더를 사용하여 상태 검사.

헤더

Location: string
Retry-After: integer

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

GenerateUtilizationSummariesReportBySavingsPlan

샘플 요청

HTTP

POST https://management.azure.com/providers/Microsoft.BillingBenefits/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateBenefitUtilizationSummariesReport?api-version=2023-11-01

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

샘플 응답

상태 코드:: 202

Location: https://management.azure.com/providers/Microsoft.Capacity/savingsPlanOrders/00000000-0000-0000-0000-000000000000/savingsPlans/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/benefitUtilizationSummariesOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2023-11-01
Retry-After: 60

상태 코드:: 200

{
  "input": {
    "grain": "Daily",
    "benefitOrderId": "00000000-0000-0000-0000-000000000000",
    "benefitId": "00000000-0000-0000-0000-000000000000",
    "kind": "SavingsPlan",
    "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"
  }
}

정의

Name	Description
AsyncOperationStatusProperties	보고서 URL을 나타내는 개체이며 생성된 비동기 보고서의 날짜까지 유효합니다.
benefitKind	예약 또는 저축 계획.
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	사용량의 조직입니다. 지원되는 값: '시간별'
OperationStatusType	혜택 사용률 요약 보고서 만들기의 상태.

AsyncOperationStatusProperties

보고서 URL을 나타내는 개체이며 생성된 비동기 보고서의 날짜까지 유효합니다.

Name	형식	Description
reportUrl	BenefitUtilizationSummaryReportSchema	비동기 혜택 사용률 요약 보고서에 대한 Sas URL입니다. 보고서가 실행 중 또는 실패 상태인 경우 비어 있습니다.
secondaryReportUrl	BenefitUtilizationSummaryReportSchema	기본 중단 시 보조 스토리지의 비동기 혜택 사용률 요약 보고서에 대한 Sas URL입니다. 보고서가 실행 중 또는 실패 상태인 경우 비어 있습니다.
validUntil	string	reportUrl에 제공된 sas URL이 만료되는 날짜입니다.

benefitKind

예약 또는 저축 계획.

Name	형식	Description
IncludedQuantity	string	혜택은 IncludedQuantity입니다.
Reservation	string	혜택은 예약입니다.
SavingsPlan	string	이점은 SavingsPlan입니다.

BenefitUtilizationSummariesOperationStatus

혜택 사용률 요약 보고서의 상태입니다. 비동기 혜택 사용률 요약 요청 입력, 상태 및 보고서 sas URL을 제공합니다.

Name	형식	Description
input	BenefitUtilizationSummariesRequest	혜택 사용률 요약 보고서를 만들기 위해 지정된 입력입니다.
properties	AsyncOperationStatusProperties	비동기 혜택 사용률 요약 보고서에 대한 sas URL과 URL이 유효할 때까지의 날짜를 포함합니다. 보고서가 실행 중 또는 실패 상태인 경우 이러한 값은 비어 있습니다.
status	OperationStatusType	혜택 사용률 요약 보고서 만들기의 상태.

BenefitUtilizationSummariesRequest

비동기 혜택 사용률 요약 요청의 속성입니다.

Name	형식	Description
benefitId	string	혜택 사용률 요약 보고서에 대한 혜택 ID입니다. 혜택 ID scope 필요합니다. 혜택 주문 또는 청구 범위에 대해 지원되지 않습니다.
benefitOrderId	string	혜택 사용률 요약 보고서에 대한 혜택 순서 ID입니다. 혜택 순서 및 혜택 ID 범위에 필요합니다. 청구 범위에 대해 지원되지 않습니다.
billingAccountId	string	혜택 사용률 요약 보고서에 대한 청구 계정입니다. 청구 계정 및 청구 프로필 범위에 필요합니다. 혜택 범위에 대해 지원되지 않습니다.
billingProfileId	string	혜택 사용률 요약 보고서에 대한 청구 프로필 ID입니다. 청구 프로필 scope 필요합니다. 청구 계정 또는 혜택 범위에 대해 지원되지 않습니다.
endDate	string	보고서에 제공될 요약 데이터의 종료 날짜입니다.
grain	grain	요약 데이터가 보고서에서 제공되는 조직입니다. 허용되는 값은 'Daily' 또는 'Monthly'입니다.
kind	benefitKind	요청된 혜택 데이터의 유형입니다. 청구 계정 및 청구 프로필 범위에 필요합니다. 혜택 범위에서 묵시적이고 전달되지 않습니다. 지원되는 값은 Reservation 및 SavingsPlan입니다.
startDate	string	보고서에 제공될 요약 데이터의 시작 날짜입니다.

BenefitUtilizationSummaryReportSchema

reportUrl 및 secondaryReportUrl Blob 링크의 CSV 파일은 다음과 같은 혜택 사용률 데이터 열로 구성됩니다. UtilizedPercentage는 저축 계획 보고서 및 비데이터 브릭 예약에 대해 0이 됩니다. 데이터 브릭 예약의 사용률은 0입니다.

Name	형식	Description
AvgUtilizationPercentage	string
BenefitId	string
BenefitOrderId	string
BenefitType	string
Kind	string
MaxUtilizationPercentage	string
MinUtilizationPercentage	string
UsageDate	string
UtilizedPercentage	string

ErrorDetails

오류의 세부 정보입니다.

Name	형식	Description
code	string	오류 코드
message	string	작업이 실패한 이유를 나타내는 오류 메시지입니다.

ErrorResponse

오류 응답은 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 그 이유는 오류 메시지에 제공됩니다.

일부 오류 응답:

429 TooManyRequests - 요청이 제한됩니다. "x-ms-ratelimit-microsoft.consumption-retry-after" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.
503 ServiceUnavailable - 서비스를 일시적으로 사용할 수 없습니다. "Retry-After" 헤더에 지정된 시간 동안 기다린 후 다시 시도합니다.

Name	형식	Description
error	ErrorDetails	오류의 세부 정보입니다.

grain

사용량의 조직입니다. 지원되는 값: '시간별'

Name	형식	Description
Daily	string	시간별 조직은 일별 값에 해당합니다.
Hourly	string	시간별 조직은 시간당 값에 해당합니다.
Monthly	string	시간별 조직은 월별 값에 해당합니다.

OperationStatusType

혜택 사용률 요약 보고서 만들기의 상태.

Name	형식	Description
Complete	string
Failed	string
Running	string

다음을 통해 공유

Generate Benefit Utilization Summaries Report - Generate By Savings Plan Id

URI 매개 변수

요청 본문

응답

보안

azure_auth

범위

예제

GenerateUtilizationSummariesReportBySavingsPlan

샘플 요청

샘플 응답

정의

AsyncOperationStatusProperties

benefitKind

BenefitUtilizationSummariesOperationStatus

BenefitUtilizationSummariesRequest

BenefitUtilizationSummaryReportSchema

ErrorDetails

ErrorResponse

grain

OperationStatusType

추가 리소스