Yeni ticaret günlük derecelendirmeli kullanım v2 API'si (beta)
Şunlar için geçerlidir: İş Ortağı Merkezi | 21Vianet tarafından işletilen İş Ortağı Merkezi | ABD Kamu için Microsoft Bulut İş Ortağı Merkezi
Yeni ticaret faturalandırılan ve faturalandırılmayan günlük kullanım verilerini zaman uyumsuz olarak almak için bu API'leri kullanın.
Not
Bu API kullanım dışı bırakılacak. Bunun yerine GA sürümünü kullanın. Daha fazla bilgi için aşağıdaki ayrıntılara bakın.
Bu API'yi yalnızca 30 Eylül 2024'e kadar faturalanmış günlük kullanım için kullanabilirsiniz. Doğru API sürümünü seçmek ve önceden planlamak için ayrıntılara bakın.
- Mümkün olan en kısa sürede v2 GA'ya geçin. O zamana kadar, Eylül 2022'den itibaren faturalama dönemlerine ait yeni ticaret faturalarının günlük derecelendirilmiş kullanım satırı öğelerini almak için bu API'yi kullanın.
- Eylül 2022'den itibaren faturalama dönemlerine ait yeni ticaret faturalarının günlük derecelendirilmiş kullanım satırı öğelerini almak için 1 Ekim 2024'ten itibaren yalnızca API v2 GA kullanın.
Bu API'yi yalnızca 30 Eylül 2024'e kadar faturalanmamış günlük derecelendirmeli kullanım için kullanabilirsiniz. Doğru API sürümünü seçmek ve önceden planlamak için ayrıntılara bakın.
- Mümkün olan en kısa sürede v2 GA'ya geçin. O zamana kadar bu API'yi kullanarak geçerli ve önceki faturalama dönemleri için yeni ticari faturalanmamış günlük derecelendirilmiş kullanım satırı öğeleri alın.
- Geçerli ve önceki faturalama dönemlerine ait yeni ticari faturalanmamış günlük derecelendirilmiş kullanım satırı öğelerini almak için 1 Ekim 2024'ten itibaren yalnızca API v2 GA kullanın.
Yeni v2 GA API'lerine erişmek için şu bağlantıya bakın:
Faturalandırılmış ve faturalanmamış günlük derecelendirilmiş kullanım mutabakatı API'si v2 (GA)
Not
Günlük faturalanmamış kullanım satırı öğelerinizi API veya İş Ortağı Merkezi portalı aracılığıyla alabilirsiniz. Verilerin kullanılabilir duruma gelmesi 24 saate kadar sürebilir. Ancak, konumunuza ve ölçümler kullanımı bildirdiğinde daha fazla gecikme olabilir.
Bazen, önceki aya ilişkin faturalanan kullanım verileri teslim edilene kadar en son faturalanmamış kullanım verilerini göremeyebilirsiniz. Bu, faturalanan kullanım verilerinin kararlaştırılan süre içinde teslim edilmesini sağlamak için yapılır. Faturalanan kullanım verilerini aldıktan sonra, ayın başından itibaren güncelleştirilmiş tüm faturalanmamış kullanım verilerini alabilmeniz gerekir.
Önemli
Günlük derecelendirilmiş kullanım verileri, bu ürünlerin ücretlerini içermez:
- Azure rezervasyonu
- Azure tasarruf planı
- Office
- Dynamics
- Microsoft Power Apps
- Kalıcı yazılım
- Yazılım aboneliği
- Microsoft dışı SaaS ürünü
API’ye genel bakış
Zaman uyumsuz API, yönetilebilir öbeklerde faturalama ve mutabakat verilerine hızlı bir şekilde erişmek için yeni bir yöntemdir. Saatlerce açık bir bağlantı sürdürme gereksinimini ortadan kaldırır ve milyonlarca işlemde yinelemeli olarak döngü oluşturur.
Sonuçları zaman uyumsuz olarak sunmak üzere faturalama ve mutabakat API'lerimizi iyileştirmek için vale anahtarı ve zaman uyumsuz istek-yanıt desenlerini kullandık. API yanıtları, tüm özniteliklerle veya bir alt kümeyle mutabakat verilerine erişmek için bir belirteç sağlar.
Üç yeni adımı (API uç noktaları) kullanarak kullanım verilerini zaman uyumsuz olarak indirebilirsiniz. Daha fazla bilgi edinmek için aşağıdakileri okuyun:
Kullanım satır öğesi uç noktası
Faturalanmış veya faturalanmamış tüketim satırı öğelerine erişmek için bu API'yi kullanın. 202 HTTP durumunu ve URL'yi içeren bir konum üst bilgisi döndürür. Bildirim URL'si ile bir başarı durumu elde edene kadar düzenli aralıklarla yoklamanız gerekir.
İşlem durumu uç noktası
Başarı durumunu alıncaya kadar bu API'yi düzenli aralıklarla yoklamayı sürdürebilirsiniz. İstenen veriler kullanılamıyorsa, API yanıtı başka bir istek göndermeden önce ne kadar beklemeniz gerektiğini belirten bir Yeniden Deneme-Sonra üst bilgisi içerir.
Bildirim uç noktası
Bu uç nokta, gerçek faturalama verilerinin indirilebileceği bir depolama klasörü sağlar. Yanıt, aktarım hızını ve G/Ç paralelliğini iyileştirmek için dosyaları böler veya bölümlere ayırır.
Sıralı diyagram
Aşağıdaki diyagramda mutabakat verilerini indirmek için gereken adımlar gösterilmiştir.
Kullanıcı eylem dizisi
Mutabakat verilerini almak için aşağıdaki adımları izleyin.
1. Adım: İstek gönderme
API uç noktasına bir POST isteği gönderin.
Faturalanmamış kullanım satırı öğelerini alma
Geçerli veya son takvim ayı için faturalanmamış kullanım satırı öğelerini alın.
API isteği
POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/unbilledusage?fragment={fragment}&period={period}?currencyCode={currencyCode}
İstek parametreleri
| Ad | In | Required | Tür | Açıklama |
|---|---|---|---|---|
| parça | Sorgu | False | String | Tam yanıt için "tam" veya özniteliklerin bir alt kümesi için "temel" seçeneğini belirleyin. Varsayılan değer "tam"dır. Bu makaledeki özniteliklerin listesine bakın. |
| Dönem | Sorgu | Doğru | String | Geçerli veya son takvim ayının kullanımını almak için "geçerli" veya "son" kullanın. "last" değeri, mevcut V1 API'lerindeki "önceki" değerle aynıdır. |
| currencyCode | Sorgu | Doğru | String | İş ortağı faturalama para birimi kodu. |
Kullanım dışı istek parametreleri
Daha yeni API sürümü için aşağıdaki URI parametreleri gerekmez:
| Ad | Açıklama |
|---|---|
| Provider | Yok. (Tüm Azure planı kullanımını döndürür ve mevcut V1 API'lerinin "onetime" değeriyle eşdeğerdir.) |
| hasPartnerEarnedCredit | Yok. (PEC'e bakılmaksızın tüm verileri döndürür.) |
| Size | Yok. |
| Atlanacak sayı | Yok. |
| seekOperation | Yok. |
İstek üst bilgisi
Bu makaledeki API için istek üst bilgileri listesine bakın.
Request body
Yok.
API yanıtı
HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/811bb8f0-8aca-4807-897c-c15ce50820d6
API, HTTP durumu 202'i döndürür. API, isteğe bağlı olarak diğer standart durumu döndürebilir.
| Ad | Açıklama |
|---|---|
| 202 Kabul Edildi | İstek kabul edilir. İstek durumu için işlem konumu üst bilgisi URL'sini sorgula. |
Faturalanan kullanım satırı öğelerini alma
Kapatılan faturalama dönemi için faturalanmış kullanım satırı öğelerini alın.
API isteği
POST https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billedusage/invoices/{invoiceId}?fragment={fragment}
İstek parametreleri
| Ad | In | Required | Tür | Açıklama |
|---|---|---|---|---|
| invoiceId | Yol | Doğru | String | İş Ortağı Merkezi fatura numarası. |
| Parça | Sorgu | False | String | Tam yanıt için "tam" veya özniteliklerin bir alt kümesi için "temel" seçeneğini belirleyin. Varsayılan değer "tam"dır. Bu makaledeki özniteliklerin listesine bakın. |
Kullanım dışı istek parametreleri
Daha yeni API sürümü için aşağıdaki URI parametreleri gerekmez:
| Ad | Açıklama |
|---|---|
| Provider | Yok. (Tüm Azure planı kullanımını döndürür ve mevcut V1 API'lerinin "onetime" değeriyle eşdeğerdir.) |
| hasPartnerEarnedCredit | Yok. (PEC'e bakılmaksızın tüm verileri döndürür.) |
| Size | Yok. |
| Atlanacak sayı | Yok. |
| seekOperation | Yok. |
İstek üst bilgisi
Bu makaledeki API için istek üst bilgileri listesine bakın.
Request body
Yok.
API yanıtı
HTTP/1.1 202 Accepted Operation-Location: https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e83ab1d4640
API "HTTP 202 Kabul Edildi" değerini döndürür. İstek API'si temelinde diğer standart durumu döndürebilir.
| Ad | Açıklama |
|---|---|
| 202 Kabul Edildi | İstek kabul edilir. İşlem konumu üst bilgisi URL'sini yoklayarak istek durumunu denetleyin. |
2. Adım: İstek durumunu denetleme
Terminal durumu başarılı veya başarısız olan bir HTTP 200 bekleyin. Bildirim URL'si başarı durumunda "resourceLocation" olur.
İşlem durumunu alma
Mutabakat veri isteğinin durumunu alır.
API isteği
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4448-83b4-1e63ab1d3640
İstek parametreleri
| Ad | In | Required | Tür | Açıklama |
|---|---|---|---|---|
| operationId | Yol | Doğru | String | İşlem kimliği. |
İstek üst bilgisi
Bu makaledeki API için istek üst bilgileri listesine bakın.
Request body
Yok.
Yanıt durumu
Bu makaledeki standart HTTP durumuna ek olarak, API aşağıdaki HTTP durumunu döndürebilir:
| Ad | Açıklama |
|---|---|
| 410 Gitti | Her işlem bağlantısı, sunucu tarafından denetlenen belirli bir süre boyunca etkindir. Süre dolduktan sonra istemcinin yeni bir istek göndermesi gerekir. |
Yanıt yükü
API yanıt yükü aşağıdaki öznitelikleri döndürür:
| Veri Akışı Adı | İsteğe bağlı | Açıklama |
|---|---|---|
| createdDateTime | yanlış | İstek süresi. |
| lastActionDateTime | yanlış | Durum değiştirme süresi. |
| resourceLocation | true | Bildirim yükü URI'si. |
| durum | yanlış | Olası değerler ve eylemler. |
| Değer | İstemci eylemi |
|---|---|
| başlamadı | "Yeniden Dene-Sonra" üst bilgisinde belirtilen süreyi bekledikten sonra durumu denetlemek için başka bir çağrı yapın. |
| çalışıyor | "Yeniden Dene-Sonra" üst bilgisinde belirtilen süreyi bekledikten sonra durumu denetlemek için başka bir çağrı yapın. |
| Başarılı | Verilerin hazır olduğunu gösteren işlemin son durumu. resourceLocation içinde belirtilen URI'yi kullanarak bildirim yükünü alın. |
| başarısız | Kalıcı hata olduğunu gösteren terminal durumu. İşlemi yeniden başlatın. |
Hata özniteliği için:
| Veri Akışı Adı | İsteğe bağlı | Açıklama |
|---|---|---|
| error | true | İşlemin durumu başarısız olursa json biçiminde sağlanan hata ayrıntıları. |
| Veri Akışı Adı | İsteğe bağlı | Açıklama |
|---|---|---|
| ileti | yanlış | Hatayı ayrıntılı olarak açıklar |
| kod | yanlış | Oluşan hata türünü gösterir |
API isteği
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640
API yanıtı
Yanıt, verileri işlerken yeniden denemeden önce 10 saniye beklemenizi önerir.
HTTP/1.1 200 OK
Retry-After: 10
{
"createdDateTime": "2022-06-1T10-01-03.4Z",
"lastActionDateTime":" 2022-06-1T10-01-05Z",
"status": "running"
}
API isteği
(Önceki istekte 10 saniye sonra)
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingoperations/06d01983-07bf-4447-83b4-1e83ab1d3640
API yanıtı
API, "başarılı" durumunu ve "resourceLocation" URI'sini döndürür.
HTTP/1.1 200 OK
Content-Type: application/json
{
"createdDateTime": "2022-06-1T10-01-03.4Z",
"lastActionDateTime": "2022-06-1T10-01-13Z",
"status": "succeeded",
"resourceLocation": "https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingmanifests/e03e1882-ff59-4c09-882f-74e60b4d7743"
}
3. Adım: Bildirim yükünü alma
Arayan, mutabakat verilerinin Azure bloblarında nerede depolandığı hakkında daha fazla bilgi edinmek için bildirim URL'sine bir GET isteğinde bulunur.
Bildirimi alma
Mutabakat verilerinin Azure depolama konumu hakkında bilgi bulunan bildirimi alır.
API isteği
GET https://ep-billingreconservice-prod-d5bfczcnfvbqbdhx.z01.azurefd.net/v1/billingmanifests/{manifestId}
İstek parametreleri
| Ad | In | Required | Tür | Açıklama |
|---|---|---|---|---|
| manifestId | Yol | Doğru | String | Bildirim kimliği. |
İstek üst bilgisi
Bu makaledeki [API için istek üst bilgileri listesi] bölümüne bakın.
Request body
Yok.
Yanıt durumu
Standart HTTP durumuna ek olarak, API aşağıdaki HTTP durumunu döndürebilir:
| Ad | Açıklama |
|---|---|
| 410 Gitti | Her bildirim bağlantısı, sunucu tarafından denetlenen belirli bir süre boyunca etkindir. Süre dolduktan sonra istemcinin yeni bir istek göndermesi gerekir. |
Yanıt yükü
API yanıtı aşağıdaki öznitelikleri döndürür:
| Ad | Açıklama |
|---|---|
| Sürüm | Bildirim şeması sürümü. |
| Dataformat | Faturalama veri dosyası biçimi. Olası değerler compressedJSONLines: Her blob sıkıştırılmış bir dosyadır ve dosyadaki veriler JSON satırları biçimindedir. Verilere erişmek için dosyanın sıkıştırmasını kaldırın. |
| utcCreatedDateTime | Bildirim dosyası oluşturma zamanı. |
| Etag | Bildirim verileri sürümü. Faturalama bilgilerinde yapılan bir değişiklik yeni bir eTag değeri oluşturur. |
| partnerTenantId | İş ortağı kiracı kimliği. |
| Rootfolder | Dosyanın kök dizini. |
| rootFolderSAS | Dosyaya erişmek için SAS belirteci. |
| partitionType | Bu özellik verileri böler. Belirli bir bölüm desteklenen sayıdan daha fazlasına sahipse, veriler "partitionValue" öğesine karşılık gelen birden çok dosyaya bölünür. Veriler, varsayılan olarak dosyadaki satır öğelerinin sayısına göre bölümlenmiştir. Bunlar değişebileceğinden kodunuzda sabit sayıda satır öğesi veya dosya boyutu ayarlamayın. |
| blobCount | Bu iş ortağı kiracı kimliği için toplam dosya sayısı. |
| sizeInBytes | Tüm dosyalardaki toplam bayt sayısı. |
| bloblar | İş ortağı kiracı kimliği için tüm dosyaların ayrıntılarını içeren "blob" nesnelerinin JSON dizisi. |
| Blob nesnesi | |
| Veri Akışı Adı | Blob'un adı. |
| sizeInBytes | Bayt cinsinden blob boyutu. |
| partitionValue | Dosyayı içeren bölüm. Büyük bir bölüm, her birinde aynı "partitionValue" olan birden çok dosyaya bölünür. |
Örnek bildirim yükü
{
"version": "1",
"dataFormat": "compressedJSONLines",
"utcCretedDateTime": "2022-04-29T22:40:57.1853571Z",
"eTag": "0x5B168C7B6E589D2",
"partnerTenantId": "14f593ad-1edc-474d-aaa0-83abbf9638da",
"rootFolder": "https://{billing.blob.core.windows.net}/{folder_path}",
"rootFolderSAS": "\*\*\*",
"partitionType": "ItemCount",
"blobCount": 3,
"sizeInBytes": 2000,
"blobs": [
{
"name": "{blobName1.json.gz}",
"sizeinBytes": 500,
"partitionValue": "1"
},
{
"name": "{blobName2.json.gz}",
"sizeinBytes": 1000,
"partitionValue": "2"
},
{
"name": "{blobName3.json.gz}",
"sizeinBytes": 500,
"partitionValue": "3"
}
]
}
4. Adım: Kullanım mutabakatı verilerini depolama konumundan indirme
Bildirim yükü API'sinin yanıtını "rootFolderSAS" ve "rootFolder" özelliklerinden SAS belirtecini ve blob depolama konumunu alın. Blob dosyasını indirip açmak için Azure Depolama SDK'sını/aracını kullanın. JSON çizgileri biçimindedir.
Standart API isteği üst bilgileri
Tüm API'ler aşağıdaki üst bilgileri kabul eder:
| Ad | Required | Tür | Açıklama |
|---|---|---|---|
| Yetkilendirme | Doğru | String | Yetkilendirme Taşıyıcı Belirteci. |
| ms-correlationid | False | String | bir iç istek izleyicisi. Her istek yeni bir izleyici (GUID) oluşturur. |
| ms-cv | False | String | bir iç istek izleyicisi. |
| ms-requestid | False | String | İstek eşzamanlılık kimliği. |
Standart API yanıt durumları
API yanıtından alınan HTTP durumları şunlardır:
| Ad | Açıklama |
|---|---|
| 400 Hatalı İstek | Eksik veya yanlış veriler vardı. Hata ayrıntıları yanıt gövdesine eklenir. |
| 401 Yetkisiz | Arayan kimliği doğrulanmamıştır ve ilk çağrıyı yapmadan önce iş ortağı API hizmetiyle kimlik doğrulaması yapmalıdır. |
| 403 Yasak | Arayan, isteği yapma yetkisine sahip değil. |
| 500 İç Sunucu Hatası | API veya bağımlılıklarından biri isteği karşılayamıyor. Lütfen daha sonra yeniden deneyin. |
| 404 Bulunamadı | Kaynak giriş parametreleriyle kullanılamaz. |
| 410 Gitti | Bildirim bağlantısı zaman aşımına uğradı veya geçti. Yeni bir istek gönderin. |
Kullanım verileri öznitelikleri
"Tam" veya "temel" istek parametresiyle faturalanan veya faturalanmamış kullanım API'sinin yanıtı aşağıdaki öznitelikleri döndürür:
| Öznitelik | "tam" | "temel" |
|---|---|---|
| İş Ortağı Kimliği | evet | evet |
| PartnerName | evet | evet |
| CustomerId | evet | evet |
| CustomerName | evet | Yes |
| CustomerDomainName | evet | hayır |
| CustomerCountry | evet | hayır |
| MpnId | evet | hayır |
| Tier2MpnId | evet | hayır |
| InvoiceNumber | evet | evet |
| Ürün Kimliği | evet | evet |
| SkuId | evet | evet |
| AvailabilityId | evet | hayır |
| SkuName | evet | evet |
| ProductName | evet | hayır |
| PublisherName | evet | evet |
| PublisherId | evet | hayır |
| SubscriptionDescription | evet | hayır |
| SubscriptionId | evet | evet |
| ChargeStartDate | evet | evet |
| ChargeEndDate | evet | evet |
| UsageDate | evet | evet |
| MeterType | evet | hayır |
| MeterCategory | evet | hayır |
| MeterId | evet | hayır |
| MeterSubCategory | evet | hayır |
| MeterName | evet | hayır |
| MeterRegion | evet | hayır |
| Birim | evet | evet |
| ResourceLocation | evet | hayır |
| ConsumedService | evet | hayır |
| ResourceGroup | evet | hayır |
| ResourceURI | evet | evet |
| ChargeType | evet | evet |
| UnitPrice | evet | evet |
| Miktar | evet | evet |
| Unittype | evet | hayır |
| BillingPreTaxTotal | evet | evet |
| BillingCurrency | evet | evet |
| PricingPreTaxTotal | evet | evet |
| PricingCurrency | evet | evet |
| ServiceInfo1 | evet | hayır |
| ServiceInfo2 | evet | hayır |
| Etiketler | evet | hayır |
| AdditionalInfo | evet | hayır |
| EffectiveUnitPrice | evet | evet |
| PCToBCExchangeRate | evet | evet |
| EntitlementId | evet | evet |
| EntitlementDescription | evet | hayır |
| PartnerEarnedCreditPercentage | evet | hayır |
| CreditPercentage | evet | evet |
| CreditType | evet | evet |
| BenefitOrderID | evet | evet |
| Avantaj Kimliği | evet | hayır |
| BenefitType | evet | evet |
Geri Bildirim
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz. https://aka.ms/ContentUserFeedback.
Gönderin ve geri bildirimi görüntüleyin