Generate Cost Details Report - Create Operation
Bu API, daha önce yayınlanan tüm Kullanım Ayrıntıları API'lerinin yerini alır. Belirli bir kapsamda sağlanan tarih aralığı, faturalama dönemi (Yalnızca kurumsal müşteriler) veya Fatura Kimliği için zaman uyumsuz olarak bir maliyet ayrıntıları raporu oluşturma isteği. Rapor istemek için yapılan ilk çağrıda 'Konum' ve 'Retry-After' üst bilgilerine sahip bir 202 döndürülecektir. 'Konum' üst bilgisi, rapor oluşturma işleminin sonucunu almak için yoklama uç noktasını sağlar. 'Retry-After', oluşturulan raporu yoklamadan önce beklenmesi gereken süreyi sağlar. Rapor işlemini yoklama çağrısı, işlem devam ediyorsa 'Konum' üst bilgisi içeren bir 202 yanıtı sağlar. Rapor oluşturma işlemi tamamlandıktan sonra yoklama uç noktası, indirilebilir rapor bloblarıyla ilgili ayrıntıların yanı sıra 200 yanıt sağlar. İndirilebilecek dosyalarla ilgili ayrıntılar yoklama yanıt gövdesinde bulunabilir. Dosyalarda bulunan maliyet ayrıntılarını (eski adıyla kullanım ayrıntıları) anlamak için bkz. 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 Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
scope
|
path | True |
string |
Abonelik, ödeme hesabı veya diğer faturalama kapsamları için ARM Kaynak Kimliği. Şu anda Kaynak Grubu ve Yönetim Grubu desteklenmiyor. Ayrıntılar için bkz. https://aka.ms/costmgmt/scopes. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
billingPeriod |
string |
Bu parametre yalnızca Kurumsal Anlaşma müşteriler tarafından kullanılabilir. YearMonth (örneğin 202008) biçimini kullanın. Bu parametre invoiceId veya timePeriod parametreleriyle birlikte kullanılamaz. İstek gövdesinde timePeriod, invoiceId veya billingPeriod parametresi sağlanmazsa API geçerli ayın maliyetini döndürür. |
invoiceId |
string |
Bu parametre yalnızca Microsoft Müşteri Sözleşmesi müşteriler tarafından kullanılabilir. Ayrıca, yalnızca Faturalama Profili veya Müşteri kapsamında kullanılabilir. Bu parametre billingPeriod veya timePeriod parametreleriyle birlikte kullanılamaz. İstek gövdesinde timePeriod, invoiceId veya billingPeriod parametresi sağlanmazsa API geçerli ayın maliyetini döndürür. |
metric |
Ayrıntılı raporun türü. Varsayılan olarak ActualCost sağlanır |
|
timePeriod |
Rapor için istenen maliyet ayrıntılarının belirli bir tarih aralığı. Bu parametre invoiceId veya billingPeriod parametreleriyle birlikte kullanılamaz. İstek gövdesinde timePeriod, invoiceId veya billingPeriod parametresi sağlanmazsa API geçerli ayın maliyetini döndürür. API, verilerin yalnızca 1 ay veya daha kısa ve en fazla 13 ay çekilmesine izin verir. TimePeriod, billingPeriod veya invoiceId sağlanmazsa API varsayılan olarak açık ay zaman aralığına ayarlanır |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
İstek işleme tamamlandı. |
|
202 Accepted |
Kabul. İstek işlenir. Durumu denetlemek için Konum üst bilgisini kullanın. Üst Bilgiler
|
|
204 No Content |
İçerik Yok. İstek başarılı oldu ancak sonuç döndürmedi. |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod
Örnek isteği
POST https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/generateCostDetailsReport?api-version=2023-11-01
{
"metric": "ActualCost",
"billingPeriod": "202205"
}
Örnek yanıt
{
"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
Örnek isteği
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"
}
Örnek yanıt
{
"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
Örnek isteği
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"
}
Örnek yanıt
{
"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
Örnek isteği
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"
}
}
Örnek yanıt
{
"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
Örnek isteği
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"
}
}
Örnek yanıt
{
"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
Örnek isteği
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"
}
}
Örnek yanıt
{
"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
Örnek isteği
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"
}
}
Örnek yanıt
{
"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
Tanımlar
Name | Description |
---|---|
Blob |
Bu işlem tarafından oluşturulan blob bilgileri. |
Cost |
Raporun veri biçimi |
Cost |
Ayrıntılı raporun türü. Varsayılan olarak ActualCost sağlanır |
Cost |
Maliyet ayrıntıları Api'sinde uzun süre çalışan işlemin sonucu. |
Cost |
Maliyet ayrıntıları işleminin durumu |
Cost |
Maliyetle ilgili ayrıntılı rapor için veri çekme işleminin başlangıç ve bitiş tarihi. API, verilerin yalnızca 1 ay veya daha kısa ve en fazla 13 ay çekilmesine izin verir. |
Error |
Hatanın ayrıntıları. |
Generate |
Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir. Bazı Hata yanıtları:
|
Generate |
Ayrıntılı maliyet raporunun tanımı. |
BlobInfo
Bu işlem tarafından oluşturulan blob bilgileri.
Name | Tür | Description |
---|---|---|
blobLink |
string |
Dosyayı indirmek için blob bağlantısı. |
byteCount |
integer |
Blobdaki bayt sayısı. |
CostDetailsDataFormat
Raporun veri biçimi
Name | Tür | Description |
---|---|---|
Csv |
string |
Csv veri biçimi. |
CostDetailsMetricType
Ayrıntılı raporun türü. Varsayılan olarak ActualCost sağlanır
Name | Tür | Description |
---|---|---|
ActualCost |
string |
Gerçek maliyet verileri. |
AmortizedCost |
string |
Amorti edilmiş maliyet verileri. |
CostDetailsOperationResults
Maliyet ayrıntıları Api'sinde uzun süre çalışan işlemin sonucu.
Name | Tür | Description |
---|---|---|
error |
Hatanın ayrıntıları. |
|
id |
string |
Uzun süre çalışan işlemin kimliği. |
manifest.blobCount |
integer |
Toplam blob sayısı. |
manifest.blobs |
Blob |
Bu işlem tarafından oluşturulan blob bilgilerinin listesi. |
manifest.byteCount |
integer |
Tüm bloblardaki toplam bayt sayısı. |
manifest.compressData |
boolean |
Veriler sıkıştırılmış biçimdedir. |
manifest.dataFormat |
Raporun veri biçimi |
|
manifest.manifestVersion |
string |
Bildirim sürümü. |
manifest.requestContext.requestBody |
Maliyet Ayrıntıları çağrısında sağlanan istek yükü gövdesi |
|
manifest.requestContext.requestScope |
string |
İsteğin istek kapsamı. |
name |
string |
Uzun süre çalışan işlemin adı. |
status |
Maliyet ayrıntıları işleminin durumu |
|
type |
string |
Uzun süre çalışan işlemin türü. |
validTill |
string |
Rapor URL'sinin geçersiz hale geldiği/UTC'de sona erdiği saat(ör. 2020-12-08T05:55:59.4394737Z). |
CostDetailsStatusType
Maliyet ayrıntıları işleminin durumu
Name | Tür | Description |
---|---|---|
Completed |
string |
İşlem Tamamlandı. |
Failed |
string |
İşlem Başarısız Oldu. |
NoDataFound |
string |
İşlem Tamamlandı ve maliyet verisi bulunamadı. |
CostDetailsTimePeriod
Maliyetle ilgili ayrıntılı rapor için veri çekme işleminin başlangıç ve bitiş tarihi. API, verilerin yalnızca 1 ay veya daha kısa ve en fazla 13 ay çekilmesine izin verir.
Name | Tür | Description |
---|---|---|
end |
string |
Verileri çekecek bitiş tarihi. örnek biçim 2020-03-15 |
start |
string |
Veri çekilenin başlangıç tarihi. örnek biçim 2020-03-15 |
ErrorDetails
Hatanın ayrıntıları.
Name | Tür | Description |
---|---|---|
code |
string |
Hata kodu. |
message |
string |
İşlemin neden başarısız olduğunu belirten hata iletisi. |
GenerateCostDetailsReportErrorResponse
Hata yanıtı, hizmetin gelen isteği işleyemediğini gösterir. Nedeni hata iletisinde verilmiştir.
Bazı Hata yanıtları:
400 Hatalı İstek - Geçersiz İstek Yükü. Sağlanan istek yükü json biçiminde değil veya istek yükünde geçersiz bir üye kabul edilemedi.
400 Hatalı İstek - Geçersiz istek yükü: yalnızca timePeriod, invoiceId veya billingPeriod olabilir. API yalnızca timePeriod, invoiceId veya billingPeriod için verilerin çekilmesine izin verir. Müşteri bu parametrelerden yalnızca birini sağlamalıdır.
400 Hatalı İstek - Başlangıç tarihi tarihinden sonra olmalıdır. API, verilerin bundan en fazla 13 ay sonra çekilmesine izin verir.
400 Hatalı İstek - İzin verilen en fazla tarih aralığı 1 aydır. API, verilerin yalnızca 1 ay veya daha kısa süreyle çekilmesine izin verir.
429 TooManyRequests - İstek kısıtlandı. "retry-after" üst bilgisinde belirtilen süreyi bekledikten sonra yeniden deneyin.
503 ServiceUnavailable - Hizmet geçici olarak kullanılamıyor. "Retry-After" üst bilgisinde belirtilen süre bekledikten sonra yeniden deneyin.
Name | Tür | Description |
---|---|---|
error |
Hatanın ayrıntıları. |
GenerateCostDetailsReportRequestDefinition
Ayrıntılı maliyet raporunun tanımı.
Name | Tür | Description |
---|---|---|
billingPeriod |
string |
Bu parametre yalnızca Kurumsal Anlaşma müşteriler tarafından kullanılabilir. YearMonth (örneğin 202008) biçimini kullanın. Bu parametre invoiceId veya timePeriod parametreleriyle birlikte kullanılamaz. İstek gövdesinde timePeriod, invoiceId veya billingPeriod parametresi sağlanmazsa API geçerli ayın maliyetini döndürür. |
invoiceId |
string |
Bu parametre yalnızca Microsoft Müşteri Sözleşmesi müşteriler tarafından kullanılabilir. Ayrıca, yalnızca Faturalama Profili veya Müşteri kapsamında kullanılabilir. Bu parametre billingPeriod veya timePeriod parametreleriyle birlikte kullanılamaz. İstek gövdesinde timePeriod, invoiceId veya billingPeriod parametresi sağlanmazsa API geçerli ayın maliyetini döndürür. |
metric |
Ayrıntılı raporun türü. Varsayılan olarak ActualCost sağlanır |
|
timePeriod |
Rapor için istenen maliyet ayrıntılarının belirli bir tarih aralığı. Bu parametre invoiceId veya billingPeriod parametreleriyle birlikte kullanılamaz. İstek gövdesinde timePeriod, invoiceId veya billingPeriod parametresi sağlanmazsa API geçerli ayın maliyetini döndürür. API, verilerin yalnızca 1 ay veya daha kısa ve en fazla 13 ay çekilmesine izin verir. TimePeriod, billingPeriod veya invoiceId sağlanmazsa API varsayılan olarak açık ay zaman aralığına ayarlanır |