Annuler une place de marché commerciale ou un nouvel abonnement commercial à l’aide des API de l’Espace partenaires
S’applique à : Espace partenaires
Cet article explique comment utiliser l’API espace partenaires pour annuler une place de marché commerciale ou une nouvelle ressource d’abonnement commerce qui correspond au client et à l’ID d’abonnement.
Notes
Les nouvelles expériences commerciales pour les services basés sur des licences incluent de nombreuses nouvelles fonctionnalités et sont disponibles pour tous les Fournisseur de solutions Cloud (CSP). Pour plus d’informations, consultez la Vue d’ensemble des nouvelles expériences commerciales.
Les abonnements new-commerce peuvent être annulés dans un délai de 7 jours, sauf si la loi l’exige autrement, en cas d’achat ou de renouvellement. Une fois cette fenêtre passée, les abonnements ne peuvent plus être annulés et l’API génère une erreur.
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 des informations d’identification d’application autonome et d’application+utilisateur.
ID du client (
customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace partenaires de l’espace de travail Clients . Sélectionnez 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 le même que l’ID de client (customer-tenant-id).ID d’abonnement.
Méthode de l’Espace partenaires
Pour annuler un abonnement à la Place de marché commerciale dans l’Espace partenaires :
Sélectionnez l’abonnement que vous souhaitez annuler.
Choisissez l’option Annuler l’abonnement , puis sélectionnez Envoyer.
C#
Pour annuler l’abonnement d’un client :
Obtenez l’abonnement par ID.
Modifiez la propriété Status de l’abonnement. Pour plus d’informations sur les codes État, consultez Énumération SubscriptionStatus.
Une fois la modification apportée, utilisez votre
IAggregatePartner.Customerscollection et appelez la méthode ById().Appelez la propriété Subscriptions, suivie de la méthode ById().
Appelez la méthode Patch().
// IAggregatePartner partnerOperations;
// var selectedCustomerId as string;
// Subscription selectedSubscription;
selectedSubscription.Status = SubscriptionStatus.Deleted;
var updatedSubscription = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscription.Id).Patch(selectedSubscription);
Exemple d’application de test console
Exemple : application de test console. Projet : Classe PartnerSDK.FeatureSample : UpdateSubscription.cs
Demande REST
Syntaxe de la requête
| Méthode | URI de demande |
|---|---|
| PATCH | {baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id} HTTP/1.1 |
Paramètre d’URI
Ce tableau répertorie le paramètre de requête requis pour suspendre l’abonnement.
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
| customer-tenant-id | guid | O | GUID correspondant au client. |
| id d’abonnement | guid | O | GUID correspondant à l’abonnement. |
En-têtes de requête
Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.
Corps de demande
Une ressource Abonnement complète est requise dans le corps de la requête. Pour annuler votre abonnement, vérifiez que la propriété Status a été mise à jour avec la valeur de deleted.
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
| statut | string | O | État des abonnements. Les options peuvent être - active, suspended, deleted |
Exemple de requête
PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/subscriptions/<subscription-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
If-Match: <etag>
Content-Type: application/json
Content-Length: 1029
Expect: 100-continue
Connection: Keep-Alive
{
"id": "6e7aa601-629e-461b-8933-0898c3cc3c7c",
"offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
"offerName": "offer Name",
"friendlyName": "friendly Name",
"quantity": 1,
"unitType": "License(s)",
"hasPurchasableAddons": false,
"creationDate": "2019-01-04T01:00:12.6647304Z",
"effectiveStartDate": "2019-01-09T00:21:45.9263727+00:00",
"commitmentEndDate": "2019-02-08T00:21:45.9263727+00:00",
"status": "deleted",
"autoRenewEnabled": false,
"isTrial": false,
"billingType": "license",
"billingCycle": "monthly",
"termDuration": "P1M",
"refundOptions": [{
"type": "Full",
"expiresAt": "2019-01-10T00:21:45.9263727+00:00"
}],
"isMicrosoftProduct": false,
"partnerId": "",
"contractType": "subscription",
"publisherName": "publisher Name",
"orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
"attributes": {"objectType": "Subscription"},
}
Réponse REST
Si la demande réussit, cette méthode retourne les propriétés de ressource d’abonnement supprimées dans le corps de la réponse.
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.
Exemple de réponse
HTTP/1.1 200 OK
Content-Length: 1322
Content-Type: application/json; charset=utf-8
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
X-Locale: en-US
{
"id": "6e7aa601-629e-461b-8933-0898c3cc3c7c",
"offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
"offerName": "offer Name",
"friendlyName": "friendly Name",
"quantity": 1,
"unitType": "License(s)",
"hasPurchasableAddons": false,
"creationDate": "2019-01-04T01:00:12.6647304Z",
"effectiveStartDate": "2019-01-09T00:21:45.9263727+00:00",
"commitmentEndDate": "2019-02-08T00:21:45.9263727+00:00",
"status": "deleted",
"autoRenewEnabled": false,
"isTrial": false,
"billingType": "license",
"billingCycle": "monthly",
"termDuration": "P1M",
"refundOptions": [
{
"type": "Full",
"expiresAt": "2019-01-10T00:21:45.9263727+00:00"
}
],
"isMicrosoftProduct": false,
"partnerId": "",
"contractType": "subscription",
"links": {
"product": {
"uri": "/products/DZH318Z0BXWC?country=US",
"method": "GET",
"headers": []
},
"sku": {
"uri": "/products/DZH318Z0BXWC/skus/0001?country=US",
"method": "GET",
"headers": []
},
"availability": {
"uri": "/products/DZH318Z0BXWC/skus/0001/availabilities/DZH318Z0BMJX?country=US",
"method": "GET",
"headers": []
},
"self": {
"uri": "/customers/5921f00a-32c0-4457-aaa1-e8018c650895/subscriptions/6e7aa601-629e-461b-8933-0898c3cc3c7c",
"method": "GET",
"headers": []
}
},
"publisherName": "publisher Name",
"orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
"attributes": {
"etag": "",
"objectType": "Subscription"
}
}
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour