Bir arama sorgusuyla filtrelenmiş abonelik analizi bilgilerini alma
Şunlar için geçerlidir: İş Ortağı Merkezi | 21Vianet tarafından işletilen İş Ortağı Merkezi | ABD Kamu için Microsoft Bulut İş Ortağı Merkezi
Müşterileriniz için arama sorgusuna göre filtrelenmiş abonelik analizi bilgilerini alma.
Önkoşullar
- İş Ortağı Merkezi kimlik doğrulamasında açıklandığı gibi kimlik bilgileri. Bu senaryo yalnızca Kullanıcı kimlik bilgileriyle kimlik doğrulamayı destekler.
REST isteği
İstek söz dizimi
Metot | İstek URI'si |
---|---|
GET | {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string} |
URI parametreleri
Kuruluşunuzu tanımlamak ve aramayı filtrelemek için aşağıdaki gerekli yol parametresini kullanın.
Veri Akışı Adı | Tür | Zorunlu | Açıklama |
---|---|---|---|
filter_string | Dize | Evet | Abonelik analizine uygulanacak filtre. Bu parametrede kullanılacak söz dizimi, alanlar ve işleçler için Söz dizimini filtreleme ve Alanları filtreleme bölümlerine bakın. |
Filtre söz dizimi
Filtre parametresi bir dizi alan, değer ve işleç birleşimi olarak oluşturulmalıdır. Veya or
işleçleri kullanılarak and
birden çok birleşim birleştirilebilir.
Kodlanmamış bir örnek şöyle görünür:
- Dize:
?filter=Field operator 'Value'
- Boolean:
?filter=Field operator Value
- Içerir
?filter=contains(field,'value')
Filtre alanları
İsteğin filter parametresi, yanıttaki satırları filtreleyen bir veya daha fazla deyim içerir. Her deyim, veya ne
işleçleriyle eq
ilişkili bir alan ve değer içerir. Bazı alanlar , , gt
, ge
lt
ve le
işleçlerini de desteklercontains
. Deyimler veya or
işleçleri kullanılarak and
birleştirilebilir.
Filtre dizelerine örnekler aşağıda verilmiştir:
autoRenewEnabled eq true
autoRenewEnabled eq true and customerMarket eq 'US'
Aşağıdaki tabloda, filtre parametresi için desteklenen alanların ve destek işleçlerinin listesi gösterilmektedir. Dize değerleri tek tırnak içine alınmalıdır.
Parametre | Desteklenen işleçler | Açıklama |
---|---|---|
autoRenewEnabled | eq , ne |
Aboneliğin otomatik olarak yenilenip yenilenmediğini gösteren değer. |
commitmentEndDate | eq , ne , gt , , lt , ge , le |
Aboneliğin bitiş tarihi. |
Creationdate | eq , ne , gt , , lt , ge , le |
Aboneliğin oluşturulduğu tarih. |
currentStateEndDate | eq , ne , gt , , lt , ge , le |
Aboneliğin geçerli durumunun değiştirileceği tarih. |
customerMarket | eq , ne |
Müşterinin iş yaptığı ülke/bölge. |
Müşteriadı | contains |
Müşterinin adı. |
customerTenantId | eq , ne |
Müşteri kiracısını tanımlayan GUID biçimli bir dize. |
deprovisionedDate | eq , ne , gt , , lt , ge , le |
Aboneliğin sağlamasını kaldırıldığı tarih. Varsayılan değer boştur. |
effectiveStartDate | eq , ne , gt , , lt , ge , le |
Aboneliğin başladığı tarih. |
Friendlyname | contains |
Aboneliğin adı. |
kimlik | eq , ne |
Aboneliği tanımlayan GUID biçimli bir dize. |
lastRenewalDate | eq , ne , gt , , lt , ge , le |
Aboneliğin son yenilendiği tarih. Varsayılan değer boştur. |
lastUsageDate | eq , ne , gt , , lt , ge , le |
Aboneliğin son kullanıldığı tarih. Varsayılan değer boştur. |
partnerId | eq , ne |
İş Ortağı Kimliği. Doğrudan kurumsal bayi için bu değer, iş ortağının İş Ortağı Kimliği'dir. Dolaylı bir kurumsal bayi için bu değer, dolaylı kurumsal bayinin İş Ortağı Kimliği'dir. |
partnerName | Dize | Aboneliğin satın alındığı iş ortağının adı |
Productname | contains , eq , ne |
Ürünün adı. |
providerName | Dize | Abonelik işlemi dolaylı kurumsal bayi için olduğunda, sağlayıcı adı aboneliği satın alan dolaylı sağlayıcıdır. |
durum | eq , ne |
Abonelik durumu. Desteklenen değerler şunlardır: ETKİn, ASKIYA ALINDI veya DEPROVISIONED. |
Subscriptiontype | eq , ne |
Abonelik türü. Not: Bu alan büyük/küçük harfe duyarlıdır. Desteklenen değerler şunlardır: Office, Azure, Microsoft365, Dynamics, EMS. |
trialStartDate | eq , ne , gt , , lt , ge , le |
Abonelik için deneme süresinin başladığı tarih. Varsayılan değer boştur. |
trialToPaidConversionDate | eq , ne , gt , , lt , ge , le |
Aboneliğin deneme sürümünden ücretliye dönüştürüldüğü tarih. Varsayılan değer boştur. |
İstek üst bilgileri
Daha fazla bilgi için bkz . İş Ortağı Merkezi REST üst bilgileri.
Request body
Yok.
İstek örneği
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?filter=autoRenewEnabled eq true
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Content-Type: application/json
Content-Length: 0
REST yanıtı
Başarılı olursa, yanıt gövdesi filtre ölçütlerini karşılayan bir Abonelik kaynakları koleksiyonu içerir.
Yanıt başarısı ve hata kodları
Her yanıt, başarılı veya başarısız olduğunu ve hata ayıklama bilgilerini gösteren bir HTTP durum koduyla birlikte gelir. Bu kodu, hata türünü ve diğer parametreleri okumak için bir ağ izleme aracı kullanın. Tam liste için bkz . Hata Kodları.
Yanıt örneği
HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: aaaa0000-bb11-2222-33cc-444444dddddd
{
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"customerName": "SURFACE TEST2",
"customerMarket": "US",
"id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
"status": "ACTIVE",
"productName": "UNKNOWN",
"subscriptionType": "Azure",
"autoRenewEnabled": true,
"partnerId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
"friendlyName": "MICROSOFT AZURE",
"creationDate": "2017-06-02T23:11:58.747",
"effectiveStartDate": "2017-06-02T00:00:00",
"commitmentEndDate": null,
"currentStateEndDate": null,
"trialToPaidConversionDate": null,
"trialStartDate": null,
"trialEndDate": null,
"lastUsageDate": null,
"deprovisionedDate": null,
"lastRenewalDate": null,
"licenseCount": 0
}