Obtenir des dates de fin de période personnalisées

Article
02/19/2024

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

Les partenaires peuvent afficher les dates de fin de terme personnalisées autorisées pour les abonnements basés sur des licences NCE qu’ils achètent pour leurs clients. Les partenaires peuvent afficher les dates de fin qui s’alignent sur la fin du mois calendrier ou avec les abonnements clients existants.

Les API prennent uniquement en charge le calcul des dates de fin de terme personnalisées pour l’achat de nouveaux abonnements et non pour le renouvellement des abonnements existants.

Prérequis

Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario prend en charge l’authentification avec les informations d’identification d’application et d’application+utilisateur autonomes.
A CustomerTenantId. Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace de partenaires en sélectionnant l’espace de travail Clients, puis le client dans la liste des clients, puis compte. Dans la page Compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client. L’ID Microsoft est identique à l’ID client.

Demande REST

Syntaxe de la requête

Méthode	URI de demande
GET	{baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates

Chaînes de requête

Ce tableau répertorie les chaînes de requête nécessaires pour filtrer et récupérer des dates de fin de terme personnalisées.

Name:	Obligatoire :	Description :
term_duration	Oui	Représentation ISO 8601 de la durée du terme. Les valeurs prises en charge actuelles sont P1M (1 mois), P1Y (1 an) et P3Y (3 ans).
term_start_date	Non	Date prévue de l’achat. Cela ne peut pas être dans le passé.
target_coterm_subscription_id	Non	Chaîne au format GUID qui identifie l’abonnement à cotermer.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires. La réponse de l’API retourne un maximum de 300 enregistrements de page. Si plus de 300 enregistrements sont retournés dans une requête entrée, un jeton de continuation est fourni dans l’en-tête de réponse. Le jeton de continuation peut être entré dans l’en-tête d’une requête suivante pour retourner des enregistrements de page supplémentaires interrogés.

Corps de la demande

Aucune.

Réponse REST

Si elle réussit, cette méthode retourne les détails des abonnements qui ont été migrés (objet de migration) dans le corps de la réponse. Cela inclut l’ID de migration.

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

Chaque réponse est accompagnée d’un code d’état HTTP qui indique la réussite ou l’échec ainsi que des informations de débogage supplémentaires. Utilisez un outil de trace réseau pour lire ce code, le type d’erreur et des paramètres supplémentaires. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemples d’URL de requête

baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M

Exemples de réponse

 {
    "totalCount": 2,
    "items": [
        {
            "allowedCustomTermEndDateType": "calendarMonthAligned",
            "allowedCustomTermEndDate": "2023-07-31T00:00:00"
        },
        {
            "allowedCustomTermEndDateType": "subscriptionAligned",
            "cotermSubscriptionIds": [
               "5fcf618b-1daa-4604-da99-cc3e1c9ee422",
               "d30a9ff9-713e-4546-c97e-f06b9dcf6ef6"
            ],
            "allowedCustomTermEndDate": "2023-08-01T00:00:00"
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
 }

Partager via