Partager via

Obtenir des informations analytiques d’abonnement filtrées par une requête de recherche

  • Article

S’applique à : Espace partenaires | Espace partenaires géré par 21Vianet | Espace partenaires de Microsoft Cloud for US Government

Comment obtenir des informations d’analyse d’abonnement pour vos clients filtrées par une requête de recherche.

Prérequis

Demande REST

Syntaxe de la requête

Méthode URI de demande
GET {baseURL}/partner/v1/analytics/subscriptions ?filter={filter_string}

Paramètres d’URI

Utilisez le paramètre de chemin d’accès requis suivant pour identifier votre organisation et filtrer la recherche.

Nom Type Requise Description
filter_string string Oui Filtre à appliquer à l’analytique de l’abonnement. Consultez les sections Filtrer la syntaxe et les champs Filtre pour connaître la syntaxe, les champs et les opérateurs à utiliser dans ce paramètre.

Syntaxe du filtre

Le paramètre de filtre doit être composé sous la forme d’une série de combinaisons de champs, de valeurs et d’opérateurs. Plusieurs combinaisons peuvent être combinées à l’aide and ou or aux opérateurs.

Un exemple non codé ressemble à ceci :

  • Chaîne : ?filter=Field operator 'Value'
  • Booléen : ?filter=Field operator Value
  • Contient ?filter=contains(field,'value')

Champs Filtrer

Le paramètre de filtre de la requête contient une ou plusieurs instructions qui filtrent les lignes dans la réponse. Chaque instruction contient un champ et une valeur associés aux opérateurs ou ne aux eq opérateurs. Certains champs prennent également en charge les containsopérateurs , , gtltet gele les opérateurs. Les instructions peuvent être combinées à l’aide and ou or aux opérateurs.

Voici des exemples de chaînes de filtre :

autoRenewEnabled eq true

autoRenewEnabled eq true and customerMarket eq 'US'

Le tableau suivant présente la liste des champs pris en charge et des opérateurs de prise en charge pour le paramètre de filtre. Les valeurs de chaîne doivent être entourées de guillemets simples.

Paramètre Opérateurs pris en charge Description
autoRenewEnabled eq, ne Valeur indiquant si l’abonnement est renouvelé automatiquement.
commitmentEndDate eq, , ne, ltgt, , gele Date de fin de l’abonnement.
creationDate eq, , ne, ltgt, , gele Date de création de l’abonnement.
currentStateEndDate eq, , ne, ltgt, , gele Date à laquelle l’état actuel de l’abonnement change.
customerMarket eq, ne Pays/région dans lequel le client s’occupe.
customerName contains Nom du client.
customerTenantId eq, ne Chaîne au format GUID qui identifie le client.
deprovisionedDate eq, , ne, ltgt, , gele Date à laquelle l’abonnement a été déprovisionné. La valeur par défaut est null.
effectiveStartDate eq, , ne, ltgt, , gele Date de début de l’abonnement.
friendlyName contains Nom de l'abonnement.
id eq, ne Chaîne au format GUID qui identifie l’abonnement.
lastRenewalDate eq, , ne, ltgt, , gele Date à laquelle l’abonnement a été renouvelé pour la dernière fois. La valeur par défaut est null.
lastUsageDate eq, , ne, ltgt, , gele Date à laquelle l’abonnement a été utilisé pour la dernière fois. La valeur par défaut est null.
partnerId eq, ne The PartnerID. Pour un revendeur direct, cette valeur est l’ID partenaire du partenaire. Pour un revendeur indirect, cette valeur est l’ID partenaire du revendeur indirect.
partnerName string Nom du partenaire pour lequel l’abonnement a été acheté
productName contains, , eqne Nom du produit.
Providername string Lorsque la transaction d’abonnement concerne le revendeur indirect, le nom du fournisseur est le fournisseur indirect qui a acheté l’abonnement.
statut eq, ne État de l’abonnement. Les valeurs prises en charge sont les suivantes : ACTIVE, SUSPENDED ou DEPROVISIONED.
subscriptionType eq, ne Type d’abonnement. Remarque : ce champ respecte la casse. Les valeurs prises en charge sont les suivantes : Bureau, Azure, Microsoft365, Dynamics, EMS.
trialStartDate eq, , ne, ltgt, , gele Date à laquelle la période d’évaluation de l’abonnement a démarré. La valeur par défaut est null.
trialToPaidConversionDate eq, , ne, ltgt, , gele Date à laquelle l’abonnement passe de la version d’évaluation au paiement. La valeur par défaut est null.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

Aucune

Exemple de requête

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

Réponse REST

Si elle réussit, le corps de la réponse contient une collection de ressources d’abonnement qui répondent aux critères de filtre.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et les informations de débogage. Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres. Pour obtenir la liste complète, consultez Codes d’erreur.

Exemple de réponse

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
}

Voir aussi