Generate Cost Details Report - Create Operation
이 API는 이전에 릴리스된 모든 사용량 세부 정보 API를 대체합니다. 특정 scope 제공된 날짜 범위, 청구 기간(엔터프라이즈 고객만) 또는 청구서 ID에 대한 비용 세부 정보 보고서를 비동기적으로 생성하도록 요청합니다. 보고서를 요청하는 초기 호출은 'Location' 및 'Retry-After' 헤더가 있는 202를 반환합니다. 'Location' 헤더는 보고서 생성 결과를 가져오기 위해 폴링할 엔드포인트를 제공합니다. 'Retry-After'는 생성된 보고서를 폴링하기 전에 대기하는 기간을 제공합니다. 작업 진행 중인 경우 보고서 작업을 폴링하는 호출은 'Location' 헤더와 함께 202 응답을 제공합니다. 보고서 생성 작업이 완료되면 폴링 엔드포인트는 다운로드할 수 있는 보고서 Blob에 대한 세부 정보와 함께 200개의 응답을 제공합니다. 다운로드할 수 있는 파일에 대한 세부 정보는 폴링 응답 본문에서 확인할 수 있습니다. 파일에 있는 비용 세부 정보(이전의 사용량 세부 정보) 필드를 이해하려면 를 참조하세요. https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields
POST https://management.azure.com/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
scope
|
path | True |
string |
구독, 청구 계정 또는 기타 청구 범위에 대한 ARM 리소스 ID입니다. 현재 리소스 그룹 및 관리 그룹은 지원되지 않습니다. 자세한 내용은 https://aka.ms/costmgmt/scopes를 참조하십시오. |
api-version
|
query | True |
string |
이 작업에 사용할 API 버전입니다. |
요청 본문
Name | 형식 | Description |
---|---|---|
billingPeriod |
string |
이 매개 변수는 기업계약 고객만 사용할 수 있습니다. YearMonth(예: 202008) 형식을 사용합니다. 이 매개 변수는 invoiceId 또는 timePeriod 매개 변수와 함께 사용할 수 없습니다. timePeriod, invoiceId 또는 billingPeriod 매개 변수가 요청 본문에 제공되지 않으면 API는 현재 월의 비용을 반환합니다. |
invoiceId |
string |
이 매개 변수는 Microsoft 고객 계약 고객만 사용할 수 있습니다. 또한 청구 프로필 또는 고객 범위에서만 사용할 수 있습니다. 이 매개 변수는 billingPeriod 또는 timePeriod 매개 변수와 함께 사용할 수 없습니다. timePeriod, invoiceId 또는 billingPeriod 매개 변수가 요청 본문에 제공되지 않으면 API는 현재 월의 비용을 반환합니다. |
metric |
자세한 보고서의 형식입니다. 기본적으로 ActualCost가 제공됩니다. |
|
timePeriod |
보고서에 요청된 특정 비용 세부 정보의 날짜 범위입니다. 이 매개 변수는 invoiceId 또는 billingPeriod 매개 변수와 함께 사용할 수 없습니다. timePeriod, invoiceId 또는 billingPeriod 매개 변수가 요청 본문에 제공되지 않으면 API는 현재 월의 비용을 반환합니다. API는 1개월 이하 및 13개월 이하의 데이터만 끌어올 수 있습니다. timePeriod 또는 billingPeriod 또는 invoiceId가 제공되지 않는 경우 API 기본값은 오픈 월 기간입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
요청 처리가 완료되었습니다. |
|
202 Accepted |
수락됨 요청이 처리됩니다. 위치 헤더를 사용하여 상태 검사. Headers
|
|
204 No Content |
콘텐츠가 없습니다. 요청이 성공했지만 결과를 반환하지 않았습니다. |
|
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 | 사용자 계정 가장 |
예제
GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"billingPeriod": "202205"
}
Sample Response
{
"id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345",
"requestBody": {
"metric": "ActualCost",
"billingPeriod": "202205"
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByBillingProfileAndInvoiceId
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"invoiceId": "M1234567"
}
Sample Response
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579",
"requestBody": {
"metric": "ActualCost",
"billingPeriod": "202205"
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"invoiceId": "M1234567"
}
Sample Response
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
"requestBody": {
"metric": "ActualCost",
"billingPeriod": "202205"
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByCustomerAndTimePeriod
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Sample Response
{
"id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByDepartmentsAndTimePeriod
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Sample Response
{
"id": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/departments/12345",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod
Sample Request
POST https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Sample Response
{
"id": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
GenerateCostDetailsReportBySubscriptionAndTimePeriod
Sample Request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
Sample Response
{
"id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000",
"name": "00000000-0000-0000-0000-000000000000",
"status": "Completed",
"manifest": {
"manifestVersion": "2023-11-01",
"dataFormat": "Csv",
"blobCount": 1,
"byteCount": 32741,
"compressData": false,
"requestContext": {
"requestScope": "subscriptions/00000000-0000-0000-0000-000000000000",
"requestBody": {
"metric": "ActualCost",
"timePeriod": {
"start": "2020-03-01",
"end": "2020-03-15"
}
}
},
"blobs": [
{
"blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd",
"byteCount": 32741
}
]
},
"validTill": "2022-05-10T08:08:46.1973252Z"
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-11-01
Retry-After: 60
정의
Name | Description |
---|---|
Blob |
이 작업에서 생성된 Blob 정보입니다. |
Cost |
보고서의 데이터 형식 |
Cost |
자세한 보고서의 형식입니다. 기본적으로 ActualCost가 제공됩니다. |
Cost |
비용 세부 정보 Api에 대한 장기 실행 작업의 결과입니다. |
Cost |
비용 세부 정보 작업의 상태 |
Cost |
비용 상세 보고서의 데이터를 끌어올리기 위한 시작 및 종료 날짜입니다. API는 1개월 이하 및 13개월 이하의 데이터만 끌어올 수 있습니다. |
Error |
오류의 세부 정보입니다. |
Generate |
오류 응답은 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 이유는 오류 메시지에 제공됩니다. 일부 오류 응답:
|
Generate |
비용 상세 보고서의 정의입니다. |
BlobInfo
이 작업에서 생성된 Blob 정보입니다.
Name | 형식 | Description |
---|---|---|
blobLink |
string |
Blob에 연결하여 파일을 다운로드합니다. |
byteCount |
integer |
Blob의 바이트입니다. |
CostDetailsDataFormat
보고서의 데이터 형식
Name | 형식 | Description |
---|---|---|
Csv |
string |
Csv 데이터 형식입니다. |
CostDetailsMetricType
자세한 보고서의 형식입니다. 기본적으로 ActualCost가 제공됩니다.
Name | 형식 | Description |
---|---|---|
ActualCost |
string |
실제 비용 데이터입니다. |
AmortizedCost |
string |
분할 상환 비용 데이터. |
CostDetailsOperationResults
비용 세부 정보 Api에 대한 장기 실행 작업의 결과입니다.
Name | 형식 | Description |
---|---|---|
error |
오류의 세부 정보입니다. |
|
id |
string |
장기 실행 작업의 ID입니다. |
manifest.blobCount |
integer |
Blob의 총 수입니다. |
manifest.blobs |
Blob |
이 작업에서 생성된 Blob 정보 목록입니다. |
manifest.byteCount |
integer |
모든 Blob의 총 바이트 수입니다. |
manifest.compressData |
boolean |
압축된 형식의 데이터입니다. |
manifest.dataFormat |
보고서의 데이터 형식 |
|
manifest.manifestVersion |
string |
매니페스트 버전입니다. |
manifest.requestContext.requestBody |
비용 세부 정보 호출에 제공된 요청 페이로드 본문 |
|
manifest.requestContext.requestScope |
string |
요청 scope. |
name |
string |
장기 실행 작업의 이름입니다. |
status |
비용 세부 정보 작업의 상태 |
|
type |
string |
장기 실행 작업의 형식입니다. |
validTill |
string |
보고서 URL이 유효하지 않거나 만료되는 시간(예: 2020-12-08T05:55:59.4394737Z). |
CostDetailsStatusType
비용 세부 정보 작업의 상태
Name | 형식 | Description |
---|---|---|
Completed |
string |
작업이 완료되었습니다. |
Failed |
string |
작업이 실패했습니다. |
NoDataFound |
string |
작업이 완료되었으며 비용 데이터를 찾을 수 없습니다. |
CostDetailsTimePeriod
비용 상세 보고서의 데이터를 끌어올리기 위한 시작 및 종료 날짜입니다. API는 1개월 이하 및 13개월 이하의 데이터만 끌어올 수 있습니다.
Name | 형식 | Description |
---|---|---|
end |
string |
데이터를 끌어올 종료 날짜입니다. 예제 형식 2020-03-15 |
start |
string |
데이터를 끌어올 시작 날짜입니다. 예제 형식 2020-03-15 |
ErrorDetails
오류의 세부 정보입니다.
Name | 형식 | Description |
---|---|---|
code |
string |
오류 코드 |
message |
string |
작업이 실패한 이유를 나타내는 오류 메시지입니다. |
GenerateCostDetailsReportErrorResponse
오류 응답은 서비스가 들어오는 요청을 처리할 수 없음을 나타냅니다. 이유는 오류 메시지에 제공됩니다.
일부 오류 응답:
400 잘못된 요청 - 잘못된 요청 페이로드. 제공된 요청 페이로드가 json 형식이 아니거나 요청 페이로드에서 잘못된 멤버가 수락되지 않았습니다.
400 잘못된 요청 - 잘못된 요청 페이로드: timePeriod 또는 invoiceId 또는 billingPeriod만 가질 수 있습니다. API는 timePeriod 또는 invoiceId 또는 billingPeriod에 대해서만 데이터를 끌어올 수 있습니다. 고객은 이러한 매개 변수 중 하나만 제공해야 합니다.
400 잘못된 요청 - 시작 날짜는 이후여야 합니다. API는 지금부터 13개월 이내의 데이터만 끌어올 수 있습니다.
400 잘못된 요청 - 허용되는 최대 날짜 범위는 1개월입니다. API는 1개월 이하의 데이터만 끌어올 수 있습니다.
429 TooManyRequests - 요청이 제한됩니다. "retry-after" 헤더에 지정된 시간을 기다린 후 다시 시도합니다.
503 ServiceUnavailable - 서비스를 일시적으로 사용할 수 없습니다. "Retry-After" 헤더에 지정된 시간 동안 기다린 후 다시 시도합니다.
Name | 형식 | Description |
---|---|---|
error |
오류의 세부 정보입니다. |
GenerateCostDetailsReportRequestDefinition
비용 상세 보고서의 정의입니다.
Name | 형식 | Description |
---|---|---|
billingPeriod |
string |
이 매개 변수는 기업계약 고객만 사용할 수 있습니다. YearMonth(예: 202008) 형식을 사용합니다. 이 매개 변수는 invoiceId 또는 timePeriod 매개 변수와 함께 사용할 수 없습니다. timePeriod, invoiceId 또는 billingPeriod 매개 변수가 요청 본문에 제공되지 않으면 API는 현재 월의 비용을 반환합니다. |
invoiceId |
string |
이 매개 변수는 Microsoft 고객 계약 고객만 사용할 수 있습니다. 또한 청구 프로필 또는 고객 범위에서만 사용할 수 있습니다. 이 매개 변수는 billingPeriod 또는 timePeriod 매개 변수와 함께 사용할 수 없습니다. timePeriod, invoiceId 또는 billingPeriod 매개 변수가 요청 본문에 제공되지 않으면 API는 현재 월의 비용을 반환합니다. |
metric |
자세한 보고서의 형식입니다. 기본적으로 ActualCost가 제공됩니다. |
|
timePeriod |
보고서에 요청된 특정 비용 세부 정보의 날짜 범위입니다. 이 매개 변수는 invoiceId 또는 billingPeriod 매개 변수와 함께 사용할 수 없습니다. timePeriod, invoiceId 또는 billingPeriod 매개 변수가 요청 본문에 제공되지 않으면 API는 현재 월의 비용을 반환합니다. API는 1개월 이하 및 13개월 이하의 데이터만 끌어올 수 있습니다. timePeriod 또는 billingPeriod 또는 invoiceId가 제공되지 않는 경우 API 기본값은 오픈 월 기간입니다. |