Pobieranie informacji analitycznych dotyczących subskrypcji filtrowanych wg zapytania wyszukiwania
Dotyczy: Centrum partnerskie | Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA
Jak uzyskać informacje dotyczące analizy subskrypcji dla klientów filtrowanych według zapytania wyszukiwania.
Wymagania wstępne
- Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje uwierzytelnianie tylko przy użyciu poświadczeń użytkownika.
Żądanie REST
Składnia żądania
| Metoda | Identyfikator URI żądania |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string} |
Parametry identyfikatora URI
Użyj następującego wymaganego parametru ścieżki, aby zidentyfikować organizację i filtrować wyszukiwanie.
| Nazwisko | Type | Wymagania | opis |
|---|---|---|---|
| filter_string | string | Tak | Filtr do zastosowania do analizy subskrypcji. Zobacz sekcje Składnia filtru i Filtruj pola składni, pól i operatorów do użycia w tym parametrze. |
Składnia filtru
Parametr filtru musi składać się z serii kombinacji pól, wartości i operatorów. Wiele kombinacji można łączyć za pomocą and operatorów lub or .
Przykład niekodowany wygląda następująco:
- Ciąg:
?filter=Field operator 'Value' - Boolean:
?filter=Field operator Value - Zawiera
?filter=contains(field,'value')
Pola filtrowania
Parametr filtru żądania zawiera co najmniej jedną instrukcję, która filtruje wiersze w odpowiedzi. Każda instrukcja zawiera pole i wartość, które są skojarzone z operatorami eq or ne . Niektóre pola obsługują również operatory contains, , gtlt, gei le . Instrukcje można łączyć przy użyciu and operatorów lub .or
Poniżej przedstawiono przykłady ciągów filtru:
autoRenewEnabled eq true
autoRenewEnabled eq true and customerMarket eq 'US'
W poniższej tabeli przedstawiono listę obsługiwanych pól i operatorów obsługi dla parametru filtru. Wartości ciągu muszą być otoczone pojedynczymi cudzysłowami.
| Parametr | Obsługiwane operatory | opis |
|---|---|---|
| autoRenewEnabled | eq, ne |
Wartość wskazująca, czy subskrypcja jest odnawiana automatycznie. |
| commitmentEndDate | eq, , ne, gt, lt, , gele |
Data zakończenia subskrypcji. |
| Creationdate | eq, , ne, gt, lt, , gele |
Data utworzenia subskrypcji. |
| currentStateEndDate | eq, , ne, gt, lt, , gele |
Data zmiany bieżącego stanu subskrypcji. |
| customerMarket | eq, ne |
Kraj/region, w którym klient prowadzi działalność. |
| Customername | contains |
Nazwa klienta. |
| customerTenantId | eq, ne |
Ciąg sformatowany za pomocą identyfikatora GUID, który identyfikuje dzierżawę klienta. |
| anulowanie aprowizacjiDate | eq, , ne, gt, lt, , gele |
Data anulowania aprowizacji subskrypcji. Wartością domyślną jest wartość null. |
| effectiveStartDate | eq, , ne, gt, lt, , gele |
Data rozpoczęcia subskrypcji. |
| Friendlyname | contains |
Nazwa subskrypcji. |
| identyfikator | eq, ne |
Ciąg sformatowany przez identyfikator GUID, który identyfikuje subskrypcję. |
| lastRenewalDate | eq, , ne, gt, lt, , gele |
Data ostatniego odnowienia subskrypcji. Wartością domyślną jest wartość null. |
| lastUsageDate | eq, , ne, gt, lt, , gele |
Data ostatniego użycia subskrypcji. Wartością domyślną jest wartość null. |
| partnerId | eq, ne |
Identyfikator partnera. W przypadku odsprzedawcy bezpośredniego ta wartość to PartnerID partnera. W przypadku odsprzedawcy pośredniego ta wartość to PartnerID odsprzedawcy pośredniego. |
| partnerName | string | Nazwa partnera, dla którego zakupiono subskrypcję |
| productName | contains, , eqne |
Nazwa produktu. |
| Providername | string | Gdy transakcja subskrypcji dotyczy odsprzedawcy pośredniego, nazwa dostawcy jest dostawcą pośrednim, który kupił subskrypcję. |
| status | eq, ne |
Stan subskrypcji. Obsługiwane wartości to: ACTIVE, SUSPENDED lub DEPROVISIONED. |
| Subscriptiontype | eq, ne |
Typ subskrypcji. Uwaga: w tym polu jest uwzględniana wielkość liter. Obsługiwane wartości to: Office, Azure, Microsoft365, Dynamics, EMS. |
| trialStartDate | eq, , ne, gt, lt, , gele |
Data rozpoczęcia okresu próbnego subskrypcji. Wartością domyślną jest wartość null. |
| trialToPaidConversionDate | eq, , ne, gt, lt, , gele |
Data konwersji subskrypcji z wersji próbnej na płatną. Wartością domyślną jest wartość null. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
Brak.
Przykład żądania
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
Odpowiedź REST
W przypadku powodzenia treść odpowiedzi zawiera kolekcję zasobów subskrypcji spełniających kryteria filtrowania.
Kody powodzenia i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i informacje o debugowaniu. Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów.
Przykład odpowiedzi
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
}