Ressources d’abonnement
S’applique à : Espace partenaires | Espace partenaires géré par 21Vianet | Espace partenaires de Microsoft Cloud for US Government
Un abonnement permet à un client d’utiliser un service pendant une certaine période. Tous les champs ne s’appliquent pas à tous les abonnements. De nombreux champs s’appliquent uniquement à certains points du cycle de vie, par exemple si un abonnement est suspendu ou annulé.
Abonnement
Remarque
La ressource d’abonnement a une limite de 500 requêtes par minute par identificateur de locataire.
La ressource Abonnement représente le cycle de vie d’un abonnement et inclut les propriétés qui définissent les états tout au long du cycle de vie de l’abonnement.
| Propriété | Type | Description |
|---|---|---|
| id | string | Identificateur de l’abonnement. |
| offerId | string | Identificateur de l’offre. |
| entitlementId | string | Identificateur de droit (ID d’abonnement Azure). |
| offerName | string | Nom de l’offre. |
| friendlyName | string | Nom convivial de l’abonnement défini par le partenaire pour aider à désambiguer. |
| quantité | number | La quantité. Cette propriété est définie sur le nombre de licences pour la facturation basée sur la licence. |
| unitType | string | Unités définissant la quantité pour l’abonnement : « Licences », « Basée sur l’utilisation » ou « Avantage ». |
| parentSubscriptionId | string | Obtient ou définit l’identificateur d’abonnement parent. |
| creationDate | string | Obtient ou définit la date de création, au format date-heure. |
| effectiveStartDate | Chaîne au format date/heure UTC | Obtient ou définit la date de début effective de cet abonnement, au format date-heure. Cette propriété est utilisée pour dater un abonnement migré ou l’aligner avec un autre. |
| commitmentEndDate | Chaîne au format date/heure UTC | Date de fin de l’engagement pour cet abonnement, au format date-heure. Pour les abonnements qui ne sont pas automatiquement accessibles, cette propriété représente une date éloignée à l’avenir. Les nouvelles dates de fin de commerce sont inclusives, ce qui signifie que la fin du terme est à la fin de la journée complète. Les dates de fin héritées ne sont pas inclusives. |
| commitmentEndDateTime | Chaîne au format date/heure UTC | Date et heure de fin de l’engagement pour cet abonnement, au format date-heure. Pour les abonnements qui ne sont pas automatiquement accessibles, cette propriété représente une date éloignée à l’avenir. |
| statut | string | État de l’abonnement : « aucun », « actif », « en attente », « suspendu », « expiré », « désactivé » ou « supprimé ». |
| autoRenewEnabled | booléen | Obtient une valeur indiquant si l’abonnement est renouvelé automatiquement. |
| billingType | string | Spécifie la façon dont l’abonnement est facturé : « none », « usage », « license » ou « benefit ». |
| billingCycle | string | Indique la fréquence avec laquelle le partenaire est facturé pour cette commande. Les valeurs prises en charge sont les noms des membres trouvés dans BillingCycleType. |
| hasPurchasableAddons | booléen | Obtient ou définit une valeur indiquant si l’abonnement a des modules complémentaires pouvant être purchassables. |
| isTrial | booléen | Valeur indiquant si l’abonnement est un essai. |
| isMicrosoftProduct | booléen | Valeur indiquant si l’abonnement est un produit Microsoft. |
| publisherName | string | Nom de l’éditeur. |
| actions | tableau de chaînes | Obtient ou définit les actions autorisées. Valeurs possibles : « edit », « cancel » |
| partnerId | string | PartnerID du revendeur d’enregistrement, utilisé dans le modèle partenaire indirect. |
| suspensionReasons | tableau de chaînes | Lecture seule. Si l’abonnement a été suspendu, indique pourquoi. |
| Contracttype | string | Lecture seule. Type de contrat : « subscription », « productKey » ou « redemptionCode ». |
| refundOptions | tableau de ressources RefundOption | Lecture seule. Ensemble d’options de remboursement disponibles pour cet abonnement. |
| scheduledNextTermInstructions | scheduledNextTermInstructions | Obtient ou définit les instructions planifiées exécutées au démarrage du terme suivant. |
| nextChargeInstructions | nextChargeInstructions | Obtient des détails pour les instructions de facturation à terme suivantes pour les modifications de cycle de facturation en attente à la fin de la période actuelle. |
| liens | SubscriptionLinks | Obtient ou définit les liens d’abonnement. |
| orderId | string | ID de la commande qui a été passée pour commencer l’abonnement. |
| termDuration | string | 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). |
| attributs | ResourceAttributes | Attributs de métadonnées correspondant à l’abonnement. |
| renewalTermDuration | string | Représentation ISO 8601 de la durée du terme. Les valeurs prises en charge actuelles sont P1M (1 mois) et P1Y (1 an). |
| ProductType | Type d'élément | Lecture seule. Le type de produit pour lequel l’abonnement est utilisé. |
| consumptionType | tableau de ressources de dépassement | Obtient ou définit un dépassement pour un client donné. |
| promotionId | string | Identificateur de promotion s’il est appliqué à l’abonnement. Exemple de format : « 39NFJQT1PJQB :0001 :39NFJQT1Q5KN » |
| CancellationAllowedUntilDate | Date/Heure | Date de la dernière annulation. |
| BillingCycleEndDate | Date/Heure | Obtient ou définit la date de fin cycle de facturation de cet abonnement, au format date-heure. |
| BillingCycleEndDateTime | Date/Heure | Obtient cycle de facturation date de fin pour cet abonnement, au format date-heure. |
| productOrderId | string | Identificateur d’un achat de produit spécifique (par exemple, réservations ou plan d’épargne Azure). |
| lineItems | SubscriptionLineItem | Un élément de ligne contient les détails de l’achat d’un abonnement particulier. |
SubscriptionLinks
La ressource SubscriptionLinks décrit la collection de liens attachés à une ressource d’abonnement.
| Propriété | Type | Description |
|---|---|---|
| offer | Lien | Obtient ou définit l’offre. |
| parentSubscription | Lien | Obtient ou définit l’abonnement parent. |
| product | Lien | Obtient le produit associé à l’abonnement. |
| sku | Lien | Obtient la référence SKU du produit associée à l’abonnement. |
| availability | Lien | Obtient la disponibilité de la référence SKU du produit associée à l’abonnement. |
| activationLinks | Lien | Obtient la liste des liens d’activation associés à l’abonnement. |
| self | Lien | AUTO-URI. |
| suivant | Lien | Page suivante des éléments. |
| previous | Lien | Page précédente des éléments. |
SubscriptionProvisioningStatus
La ressource SubscriptionProvisioningStatus fournit des informations sur l’état d’approvisionnement d’un abonnement.
| Propriété | Type | Description |
|---|---|---|
| skuId | string | Chaîne qui identifie la référence SKU du produit. |
| statut | string | Indique l’état d’approvisionnement : « réussite », « en attente » ou « échec ». |
| quantité | number | Fournit la quantité d’abonnement après l’approvisionnement. |
| endDate | Chaîne au format date/heure UTC | Date de fin de l’abonnement. |
| attributs | ResourceAttributes | Attributs de métadonnées. |
scheduledNextTermInstructions
La ressource scheduledNextTermInstructions définit les instructions à appliquer au début du terme suivant de l’abonnement. Présente uniquement si les modifications planifiées sont définies ou pour tous les abonnements d’évaluation.
| Propriété | Type | Description |
|---|---|---|
| product | product | Chaîne au format GUID qui identifie la référence SKU du produit. |
| quantité | number | Fournit la quantité d’abonnement après l’approvisionnement. |
| customTermEndDate | Chaîne au format date/heure UTC | Date de fin personnalisée de l’abonnement lorsqu’elle est alignée sur la date de fin d’un autre abonnement |
Produit
La ressource scheduledNextTermInstructions.product et les attributs d’une modification planifiée s’appliquent au prochain terme.
| Propriété | Type | Description |
|---|---|---|
| productId | Chaîne | ID d’un produit. |
| skuId | Chaîne | Fournit la quantité d’abonnement après l’approvisionnement. |
| availabilityId | Chaîne | ID de cette disponibilité. Cet ID est unique uniquement dans le contexte de son produit parent et de sa référence SKU. Notez que les ID de disponibilité peuvent changer au fil du temps. Les partenaires ne doivent compter que sur cette valeur dans un court intervalle de temps après sa récupération. |
| billingCycle | Chaîne | Indique la fréquence avec laquelle le partenaire est facturé pour cette commande. Les valeurs prises en charge sont les noms des membres trouvés dans BillingCycleType. |
| termDuration | Chaîne | Représentation ISO 8601 de la durée du terme. Les valeurs prises en charge actuelles sont P1M (1 mois) et P1Y (1 an). |
| promotionId | Chaîne | Identificateur de promotion à appliquer pour le terme planifié suivant. Exemple de format : « 39NFJQT1PJQB :0001 :39NFJQT1Q5KN ». |
nextChargeInstructions
La ressource nextChargeInstructions définit les instructions cycle de facturation appliquées au début du terme suivant de l’abonnement. Présente uniquement lorsque des modifications cycle de facturation en attente sont en attente.
| Propriété | Type | Description |
|---|---|---|
| product | product | Chaîne au format GUID qui identifie la référence SKU du produit. |
| quantité | number | Fournit la quantité d’abonnement après l’approvisionnement. |
SubscriptionRegistrationStatus
La ressource SubscriptionRegistrationStatus décrit la collection de liens attachés à une ressource d’abonnement.
| Propriété | Type | Description |
|---|---|---|
| subscriptionId | string | Identificateur de l’abonnement. |
| statut | string | Indique l’état d’inscription : « inscrit », « inscription » ou « notregistered ». |
SupportContact
La ressource SupportContact représente un contact de support pour l’abonnement d’un client.
| Propriété | Type | Description |
|---|---|---|
| supportTenantId | string | Chaîne au format GUID qui indique l’identificateur de locataire du contact de support. |
| supportMpnId | string | Identificateur du partenaire du contact. |
| name | chaîne | Nom du contact de support. |
| liens | ResourceLinks | Liens associés au contact du support technique. |
| attributs | ResourceAttributes | Attributs de métadonnées. Contient « objectType » : « SupportContact ». |
Dépassement
La ressource de dépassement représente le dépassement de l’abonnement de consommation peut être affecté, qu’il soit affecté et au revendeur affecté.
| Propriété | Type | Description |
|---|---|---|
| azureEntitlementId | string | Chaîne au format GUID qui indique l’identificateur d’abonnement consommation. |
| partnerId | string | Identificateur partenaire du revendeur associé à l’abonnement. |
| type | string | Le type de dépassement peut être « Téléphone Services » |
| Excédent | booléen | Valeur indiquant si le dépassement est activé. |
| liens | ResourceLinks | Liens connexes de dépassement. |
| attributs | ResourceAttributes | Attributs de métadonnées. Contient « objectType » : « Overage ». |
RegisterSubscription
La ressource RegisterSubscription retourne un lien qui peut être utilisé pour interroger l’état d’inscription d’un abonnement. L’état d’inscription est retourné dans le corps de la réponse d’une demande acceptée avec succès pour inscrire un abonnement Azure.
| Propriété | Type | Description |
|---|---|---|
| httpResponseMessage | object | Renvoie le code d’état HTTP 202 « Accepté », avec un en-tête Location contenant un lien pour interroger l’état de l’inscription. Par exemple, "/customers/{customer-id}/subscriptions/{subscription-id}/registrationstatus" |
RefundOption
La ressource RefundOption représente une option de remboursement possible pour l’abonnement.
| Propriété | Type | Description |
|---|---|---|
| type | string | Type de remboursement. Les valeurs prises en charge sont « Partial » et « Full » |
| expiresAfter | Chaîne au format date/heure UTC | Horodatage à l’expiration de cette option. Si la valeur est Null, l’opération de remboursement n’a pas d’expiration. |
AzureEntitlement
La ressource AzureEntitlement représente les droits Azure de l’abonnement.
| Propriété | Type | Description |
|---|---|---|
| id | string | Identificateur du droit d’utilisation |
| friendlyName | string | Nom convivial du droit d’utilisation. |
| statut | string | État du droit. |
| subscriptionId | string | Identificateur d’abonnement auquel appartient le droit. |
SubscriptionLineItem
Un élément de ligne contient les détails de l’achat d’un abonnement particulier.
| Propriété | Type | Description |
|---|---|---|
| id | string | Identificateur de l’élément de ligne d’abonnement. |
| friendlyName | string | Nom convivial de l’élément de ligne d’abonnement défini par le partenaire pour aider à lever l’ambiguïté. |
| scope | Portée | L’étendue indique l’endroit où les avantages s’appliquent. |
| autoRenewEnabled | Boolean | Obtient une valeur indiquant si l’abonnement est renouvelé automatiquement. |
| statut | string | État de l’abonnement : « aucun », « actif », « en attente », « suspendu », « expiré », « désactivé » ou « supprimé ». |
| purchaseCommitment | Engagement d’achat | Montant fixe validé sur les services de calcul. |
Étendue
L’étendue indique l’endroit où les avantages s’appliquent.
| Propriété | Type | Description |
|---|---|---|
| type | string | Type d’étendue pour un achat : « Unique », « Partagé », « Groupe de ressources » ou « Groupe d’administration ». |
| subscriptionId | string | ID du plan Azure qui serait utilisé pour un achat. Obligatoire pour l’étendue partagée. |
| entitlementId | string | ID de l’abonnement Azure qui serait utilisé pour un achat. Obligatoire pour l’étendue unique. |
| managementGroupId | string | ID du groupe d’administration qui serait utilisé pour un achat. Cette étendue ne peut être sélectionnée que par Portail Azure aujourd’hui, mais les mises à jour reflètent dans pc. |
| resourceGroupId | string | ID du groupe de ressources qui serait utilisé pour un achat. Cette étendue ne peut être sélectionnée que par Portail Azure aujourd’hui, mais les mises à jour reflètent dans pc. |
Engagement d’achat
Montant fixe validé sur les services de calcul.
| Propriété | Type | Description |
|---|---|---|
| montant | string | Engagement de montant fixe. |
| Grain | string | Période de l’engagement. |
| currency | chaîne | Devise de l’engagement. |