Ottenere l'analisi delle sottoscrizioni raggruppate per date o termini

Articolo
06/19/2023

Si applica a: Centro per i partner | Centro per i partner gestito da 21Vianet | Centro per i partner per Microsoft Cloud for US Government

Come ottenere informazioni sull'analisi delle sottoscrizioni per i clienti raggruppati in base a date o termini.

Prerequisiti

Credenziali descritte in Autenticazione del Centro per i partner. Questo scenario supporta l'autenticazione solo con le credenziali utente.

Richiesta REST

Sintassi della richiesta

Metodo	URI richiesta
GET	{baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

Parametri URI

Usare i parametri di percorso necessari seguenti per identificare l'organizzazione e raggruppare i risultati.

Nome	Tipo	Obbligatoria	Descrizione
groupby_queries	coppie di stringhe e dateTime	Sì	Termini e date per filtrare il risultato.

Sintassi GroupBy

Il gruppo per parametro deve essere composto come una serie di valori delimitati da virgole, campi.

Di seguito è riportato un esempio non codificato:

?groupby=termField1,dateField1,termField2

La tabella seguente mostra un elenco dei campi supportati per il gruppo.

Campo	Tipo	Descrizione
customerTenantId	string	Stringa formattata GUID che identifica il tenant del cliente.
customerName	string	Nome del cliente.
customerMarket	string	Paese/area geografica in cui il cliente fa attività.
id	string	Stringa in formato GUID che identifica la sottoscrizione.
status	string	Stato della sottoscrizione. I valori supportati sono: "ACTIVE", "SUSPENDED" o "DEPROVISIONED".
productName	string	Nome del prodotto.
subscriptionType	string	Tipo di sottoscrizione. Nota: questo campo è distinzione tra maiuscole e minuscole. I valori supportati sono: "Office", "Azure", "Microsoft365", "Dynamics", "EMS".
autoRenewEnabled	Boolean	Valore che indica se la sottoscrizione viene rinnovata automaticamente.
partnerId	string	The PartnerID. Per un rivenditore diretto, questo parametro sarà partnerID del partner. Per un rivenditore indiretto, questo parametro sarà il PartnerID del rivenditore indiretto.
friendlyName	string	Nome della sottoscrizione.
partnerName	string	Nome del partner per il quale è stata acquistata la sottoscrizione
providerName	string	Quando la transazione di sottoscrizione è per il rivenditore indiretto, il nome del provider è il provider indiretto che ha acquistato la sottoscrizione.
creationDate	stringa in formato data e ora UTC	Data di creazione della sottoscrizione.
effectiveStartDate	stringa in formato data e ora UTC	Data di inizio della sottoscrizione.
commitmentEndDate	stringa in formato data e ora UTC	Data di fine della sottoscrizione.
currentStateEndDate	stringa in formato data e ora UTC	Data di modifica dello stato corrente della sottoscrizione.
trialToPaidConversionDate	stringa in formato data e ora UTC	Data di conversione della sottoscrizione dalla versione di valutazione a pagamento. Il valore predefinito è null.
trialStartDate	stringa in formato data e ora UTC	Data di inizio del periodo di valutazione per la sottoscrizione. Il valore predefinito è null.
lastUsageDate	stringa in formato data e ora UTC	Data dell'ultimo utilizzo della sottoscrizione. Il valore predefinito è null.
deprovisionedDate	stringa in formato data e ora UTC	Data di deprovisioning della sottoscrizione. Il valore predefinito è null.
lastRenewalDate	stringa in formato data e ora UTC	Data dell'ultimo rinnovo della sottoscrizione. Il valore predefinito è null.

Campi di filtro

La tabella seguente elenca i campi di filtro facoltativi e le relative descrizioni:

Campo	Tipo	Descrizione
top	INT	Numero di righe di dati da restituire nella richiesta. Se il valore non viene specificato, il valore massimo e il valore predefinito sono 10000. Se nella query sono presenti più righe, il corpo della risposta include un link successivo che puoi usare per richiedere la pagina successiva dei dati.
skip	INT	Numero di righe da ignorare nella query. Usa questo parametro per scorrere set di dati di grandi dimensioni. Ad esempio, top=10000 e skip=0 recupera le prime 10000 righe di dati, top=10000 e skip=10000 recupera le 10000 righe di dati successive.
filter	string	Una o più istruzioni per filtrare le righe nella risposta. Ogni istruzione di filtro contiene un nome di campo dal corpo della risposta e un valore associato `eq`a , `ne`o per determinati campi, l'operatore `contains` . Le istruzioni possono essere combinate usando `and` o `or`. I valori stringa devono essere racchiusi tra virgolette singole nel parametro filter. Vedere la sezione seguente per un elenco di campi che possono essere filtrati e gli operatori supportati con tali campi.
aggregationLevel	string	Specifica l'intervallo di tempo per cui recuperare dati aggregati. Può essere una delle stringhe seguenti: day, week o month. Se il valore non viene specificato, il valore predefinito è dateRange. Nota: questo parametro si applica solo quando un campo data viene passato come parte del parametro groupBy.
Groupby	string	Istruzione che applica l'aggregazione dei dati solo ai campi specificati.

Intestazioni della richiesta

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

Testo della richiesta

Nessuno.

Esempio di richiesta

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
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 della sottoscrizione raggruppate in base ai termini e alle date specificati.

Codici di errore e di esito della risposta

Ogni risposta viene fornita con un codice di stato HTTP che ne indica l'esito e con informazioni di debug aggiuntive. Usa uno strumento di traccia di rete per leggere il codice, il tipo di errore e parametri aggiuntivi. Per l'elenco completo, vedi Codici di errore.

Esempio di risposta

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
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

Vedi anche

Analisi del Centro per i partner - Risorse

Condividi tramite