Upgrade resources

  • Article

Applies to: Partner Center | Partner Center operated by 21Vianet | Partner Center for Microsoft Cloud for US Government

Describes the resources used to upgrade a user from a source subscription to a target subscription.

Note

This topic applies only to traditional license-based services and not to new commerce experiences. For more information about new commerce, see new commerce experiences overview.

Upgrade

Describes the behavior of an individual upgrade resource.

Property Type Description
TargetOffer Offer The offer of the target subscription.
UpgradeType string The type of upgrade: none, upgrade_only, or upgrade_with_license_transfer.
IsEligible boolean Identifies if the upgrade can be performed.
Quantity integer The quantity of the new offer to be purchased. Defaults to the source subscription quantity.
UpgradeErrors array of UpgradeErrors Reasons the upgrade can't be performed, if applicable.
Attributes ResourceAttributes The metadata attributes corresponding to the upgrade.

UpgradeError

Describes a reason why an upgrade can't be performed.

Property Type Description
Code string The error code associated with the issue: other, delegated_admin_permissions_disabled, subscription_status_not_active, conflicting_service_types, concurrency_conflicts, user_context_required, subscription_add_ons_present, subscription_does_not_have_any_upgrade_paths, subscription_target_offer_not_found, or subscription_not_provisioned.
Description string Friendly text describing the error.
AdditionalDetails string Details regarding the error.
Attributes ResourceAttributes The metadata attributes corresponding to the error.

UpgradeResult

Describes the result of the subscription upgrade process.

Property Type Description
SourceSubscriptionId string The identifier of the source subscription.
TargetSubscriptionID string The identifier of the target subscription.
UpgradeType string The type of upgrade: none, upgrade_only, or upgrade_with_license_transfer.
UpgradeErrors array of UpgradeErrors Errors encountered while attempting to perform the upgrade, if applicable.
LicenseErrors array of UserLicenseErrrors Errors encountered while attempted to migrate user licenses, if applicable.
Attributes ResourceAttributes The metadata attributes corresponding to the license.

UserLicenseError

Describes errors arising from failed user license transfer.

Property Type Description
UserObjectId string The unique identified of the user object.
Name string The name of the user.
Email string The email of the user.
Errors array of ServiceFaults A list of exceptions thrown when trying to perform user license transfer.
Attributes ResourceAttributes The metadata attributes corresponding to the license.