Condividi tramite

Ottenere informazioni sull'analisi delle sottoscrizioni filtrate in base a una query di ricerca

  • Articolo

Si applica a: Centro per i partner | Centro per i partner gestito da 21Vianet | Centro per i partner per Microsoft Cloud per il governo degli Stati Uniti

Come ottenere informazioni sull'analisi delle sottoscrizioni per i clienti filtrati in base a una query di ricerca.

Prerequisiti

Richiesta REST

Sintassi della richiesta

metodo URI della richiesta
GET {baseURL}/partner/v1/analytics/subscriptions?filter={filter_string}

Parametri URI

Usare il parametro di percorso obbligatorio seguente per identificare l'organizzazione e filtrare la ricerca.

Nome Digita Obbligatorio Descrizione
filter_string string Sì Filtro da applicare all'analisi delle sottoscrizioni. Vedere le sezioni Filtrare la sintassi e i campi filtro per la sintassi, i campi e gli operatori da usare in questo parametro.

Sintassi dei filtri

Il parametro di filtro deve essere composto come una serie di combinazioni di campi, valori e operatori. È possibile combinare più combinazioni usando and o or operatori.

Un esempio non codificato è simile al seguente:

  • Stringa: ?filter=Field operator 'Value'
  • Booleano: ?filter=Field operator Value
  • Contiene ?filter=contains(field,'value')

Campi filtro

Il parametro di filtro della richiesta contiene una o più istruzioni che filtrano le righe nella risposta. Ogni istruzione contiene un campo e un valore associati agli eq operatori o ne . Alcuni campi supportano anche gli containsoperatori , gtlt, ge, e le . Le istruzioni possono essere combinate tramite and operatori o or .

Di seguito sono riportati esempi di stringhe di filtro:

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

La tabella seguente mostra un elenco dei campi supportati e degli operatori di supporto per il parametro di filtro. I valori stringa devono essere racchiusi tra virgolette singole.

Parametro Operatori supportati Descrizione
autoRenewEnabled eq, ne Valore che indica se la sottoscrizione viene rinnovata automaticamente.
commitmentEndDate eq, ne, gt, lt, gele Data di fine della sottoscrizione.
creationDate eq, ne, gt, lt, gele Data di creazione della sottoscrizione.
currentStateEndDate eq, ne, gt, lt, gele Data di modifica dello stato corrente della sottoscrizione.
customerMarket eq, ne Paese/area geografica in cui il cliente fa affari.
customerName contains Il nome del cliente.
customerTenantId eq, ne Stringa in formato GUID che identifica il tenant del cliente.
deprovisionedDate eq, ne, gt, lt, gele Data di deprovisioning della sottoscrizione. Il valore predefinito è null.
effectiveStartDate eq, ne, gt, lt, gele Data di inizio della sottoscrizione.
friendlyName contains Nome della sottoscrizione.
ID eq, ne Stringa in formato GUID che identifica la sottoscrizione.
lastRenewalDate eq, ne, gt, lt, gele Data dell'ultimo rinnovo della sottoscrizione. Il valore predefinito è null.
lastUsageDate eq, ne, gt, lt, gele Data dell'ultima utilizzo della sottoscrizione. Il valore predefinito è null.
partnerId eq, ne Id partner. Per un rivenditore diretto, questo valore è l'ID partner del partner. Per un rivenditore indiretto, questo valore è l'ID partner del rivenditore indiretto.
partnerName string Nome del partner per il quale è stata acquistata la sottoscrizione
productName contains, eq, ne Nome del prodotto.
Providername string Quando la transazione di sottoscrizione è per il rivenditore indiretto, il nome del provider è il provider indiretto che ha acquistato la sottoscrizione.
stato eq, ne Stato della sottoscrizione. I valori supportati sono ACTIVE, SUSPENDED o DEPROVISIONED.
subscriptionType eq, ne Tipo di sottoscrizione. Nota: questo campo fa distinzione tra maiuscole e minuscole. I valori supportati sono: Office, Azure, Microsoft365, Dynamics, EMS.
trialStartDate eq, ne, gt, lt, gele Data di inizio del periodo di valutazione per la sottoscrizione. Il valore predefinito è null.
trialToPaidConversionDate eq, ne, gt, lt, gele Data in cui la sottoscrizione viene convertita da versione di valutazione a pagamento. Il valore predefinito è null.

Intestazioni delle richieste

Per altre informazioni, vedi Intestazioni REST del Centro per i partner.

Corpo della richiesta

Nessuno.

Esempio di richiesta

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

Risposta REST

In caso di esito positivo, il corpo della risposta contiene una raccolta di risorse di sottoscrizione che soddisfano i criteri di filtro.

Codici di errore e di esito della risposta

Ogni risposta viene fornita con un codice di stato HTTP che indica l'esito positivo o negativo e le informazioni di debug. Usare uno strumento di traccia di rete per leggere questo codice, il tipo di errore e altri parametri. Per l'elenco completo, vedi Codici di errore.

Risposta di esempio

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
}

Vedi anche