Abrufen von Informationen zur Abonnementanalyse, die nach einer Suchabfrage gefiltert wurden
Gilt für: Partner Center | Partner Center-Betrieb durch 21Vianet | Partner Center für Microsoft Cloud for US Government
So erhalten Sie Abonnementanalyseinformationen für Ihre Kunden, die nach einer Suchabfrage gefiltert werden.
Voraussetzungen
- Anmeldeinformationen, wie unter Partner Center-Authentifizierung beschrieben. Dieses Szenario unterstützt nur die Authentifizierung mit Benutzeranmeldeinformationen.
REST-Anforderung
Anforderungssyntax
| Methode | Anforderungs-URI |
|---|---|
| GET | {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string} |
URI-Parameter
Verwenden Sie den folgenden erforderlichen Pfadparameter, um Ihre Organisation zu identifizieren und die Suche zu filtern.
| Name | Type | Erforderlich | Beschreibung |
|---|---|---|---|
| filter_string | Zeichenfolge | Ja | Der Filter, der auf die Abonnementanalyse angewendet werden soll. Informationen zur Verwendung in diesem Parameter finden Sie in den Abschnitten "Filtersyntax" und "Filterfelder". |
Filtersyntax
Der Filterparameter muss als Eine Reihe von Feld-, Wert- und Operatorkombinationen zusammengesetzt werden. Mehrere Kombinationen können mithilfe oder or Operatoren and kombiniert werden.
Ein nicht codiertes Beispiel sieht wie folgt aus:
- Zeichenfolge:
?filter=Field operator 'Value' - Boolesch:
?filter=Field operator Value - Enthält
?filter=contains(field,'value')
Filter (Felder)
Der Filterparameter der Anforderung enthält eine oder mehrere Anweisungen, die die Zeilen in der Antwort filtern. Jede Anweisung enthält ein Feld und einen Wert, die den eq Operatoren zugeordnet ne sind. Einige Felder unterstützen auch die containsOperatoren , gt, , ltgeund le . Anweisungen können mithilfe and oder or Operatoren kombiniert werden.
Im Folgenden sind Beispiele für Filterzeichenfolgen aufgeführt:
autoRenewEnabled eq true
autoRenewEnabled eq true and customerMarket eq 'US'
Die folgende Tabelle enthält eine Liste der unterstützten Felder und Supportoperatoren für den Filterparameter. Zeichenfolgenwerte müssen von einfachen Anführungszeichen umgeben sein.
| Parameter | Unterstützte Operatoren | Beschreibung |
|---|---|---|
| autoRenewEnabled | eq, ne |
Ein Wert, der angibt, ob das Abonnement automatisch verlängert wird. |
| commitmentEndDate | eq, , negt, lt, , gele |
Das Datum, an dem das Abonnement endet. |
| creationDate | eq, , negt, lt, , gele |
Das Datum, an dem das Abonnement erstellt wurde. |
| currentStateEndDate | eq, , negt, lt, , gele |
Das Datum, an dem sich der aktuelle Status des Abonnements ändert. |
| customerMarket | eq, ne |
Das Land/die Region, in dem der Kunde geschäftet. |
| customerName | contains |
Der Name des Kunden. |
| customerTenantId | eq, ne |
Eine GUID-formatierte Zeichenfolge, die den Kundenmandanten identifiziert. |
| deprovisionedDate | eq, , negt, lt, , gele |
Das Datum, an dem das Abonnement aufgehoben wurde. Der Standardwert ist "null". |
| effectiveStartDate | eq, , negt, lt, , gele |
Das Datum, an dem das Abonnement beginnt. |
| friendlyName | contains |
Der Name des Abonnements. |
| id | eq, ne |
Eine GUID-formatierte Zeichenfolge, die das Abonnement identifiziert. |
| lastRenewalDate | eq, , negt, lt, , gele |
Das Datum, an dem das Abonnement zuletzt verlängert wurde. Der Standardwert ist "null". |
| lastUsageDate | eq, , negt, lt, , gele |
Das Datum, an dem das Abonnement zuletzt verwendet wurde. Der Standardwert ist "null". |
| partnerId | eq, ne |
Die PartnerID. Bei einem direkten Wiederverkäufer ist dieser Wert die PartnerID des Partners. Bei einem indirekten Wiederverkäufer ist dieser Wert die PartnerID des indirekten Wiederverkäufers. |
| partnerName | Zeichenfolge | Name des Partners, für den das Abonnement erworben wurde |
| productName | contains, eqne |
Der Name des Produkts. |
| Providername | Zeichenfolge | Wenn die Abonnementtransaktion für den indirekten Wiederverkäufer gilt, ist der Anbietername der indirekte Anbieter, der das Abonnement erworben hat. |
| status | eq, ne |
Der Abonnementstatus. Unterstützte Werte sind: ACTIVE, SUSPENDED oder DEPROVISIONED. |
| subscriptionType | eq, ne |
Der Abonnementtyp. Hinweis: Bei diesem Feld wird die Groß-/Kleinschreibung beachtet. Unterstützte Werte sind: Office, Azure, Microsoft365, Dynamics, EMS. |
| trialStartDate | eq, , negt, lt, , gele |
Das Datum, an dem der Testzeitraum für das Abonnement gestartet wurde. Der Standardwert ist "null". |
| trialToPaidConversionDate | eq, , negt, lt, , gele |
Das Datum, an dem das Abonnement von der Testversion in die Bezahlung konvertiert wird. Der Standardwert ist "null". |
Anforderungsheader
Weitere Informationen finden Sie unter Partner Center-REST-Header.
Anforderungstext
Keine.
Beispiel für eine Anfrage
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-Antwort
Bei erfolgreicher Ausführung enthält der Antworttext eine Sammlung von Abonnementressourcen , die den Filterkriterien entsprechen.
Erfolgs- und Fehlercodes der Antwort
Jede Antwort enthält einen HTTP-Statuscode, der Erfolg oder Fehler und Debugginginformationen angibt. Verwenden Sie ein Netzwerkablaufverfolgungstool, um diesen Code, fehlertyp und andere Parameter zu lesen. Die vollständige Liste findest du unter Partner-API: REST-Fehlercodes.
Beispielantwort
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": "735920EB-A564-4C72-9FE5-52632562712C",
"customerName": "SURFACE TEST2",
"customerMarket": "US",
"id": "B76412DA-D382-4688-A6A4-711A207C1C2E",
"status": "ACTIVE",
"productName": "UNKNOWN",
"subscriptionType": "Azure",
"autoRenewEnabled": true,
"partnerId": "3B33E682-00C3-41EE-9DD2-A548ADF56438",
"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
}