ISubscription Interface

Package:

com.microsoft.store.partnercenter.subscriptions

Maven Artifact:

com.microsoft.store:partnercenter:1.15.3

Implements

IPartnerComponent<Tuple<java.lang.String,java.lang.String>> IEntityGetOperations<Subscription> IEntityPatchOperations<Subscription>

public interface ISubscription extends IPartnerComponent<Tuple<String,String>>, IEntityGetOperations<Subscription>, IEntityPatchOperations<Subscription>

This interface defines the operations available on a customer's subscription.

Method Summary

Modifier and Type	Method and Description
abstract SubscriptionActivationResult	activate() Activates a third-party subscription.
abstract Subscription	get() Retrieves the subscription.
abstract ISubscriptionActivationLinks	getActivationLinks() Gets the current subscription's activation links.
abstract ISubscriptionAddOnCollection	getAddOns() Gets the current subscription's add-ons operations.
abstract ResourceCollection<AzureEntitlement>	getAzurePlanSubscriptionEntitlements() Gets an Azure Plan's subscription entitlements.
abstract ISubscriptionConversionCollection	getConversions() Gets the current subscription's conversion operations.
abstract ISubscriptionProvisioningStatus	getProvisioningStatus() Gets the current subscription's provisioning status operations.
abstract ISubscriptionRegistration	getRegistration() Gets the current subscription's registration operations.
abstract ISubscriptionRegistrationStatus	getRegistrationStatus() Gets the current subscription's registration status operations.
abstract ISubscriptionSupportContact	getSupportContact() Gets the current subscription's support contact operations.
abstract ISubscriptionUpgradeCollection	getUpgrades() Gets the current subscription's upgrade operations.
abstract ISubscriptionUsageRecordCollection	getUsageRecords() Gets the current subscription's resource usage records operations.
abstract ISubscriptionUsageSummary	getUsageSummary() Gets the current subscription's usage summary operations.
abstract IUtilizationCollection	getUtilization() Gets the current subscription's utilization operations.
abstract Subscription	patch(Subscription subscription) Patches the subscription.

Method Details

activate

public abstract SubscriptionActivationResult activate()

Activates a third-party subscription.

Returns:

The result from the subscription activation.

get

public abstract Subscription get()

Retrieves the subscription.

Returns:

The subscription.

getActivationLinks

public abstract ISubscriptionActivationLinks getActivationLinks()

Gets the current subscription's activation links.

Returns:

The current subscription's activation links.

getAddOns

public abstract ISubscriptionAddOnCollection getAddOns()

Gets the current subscription's add-ons operations.

Returns:

The current subscription's add-ons operations.

getAzurePlanSubscriptionEntitlements

public abstract ResourceCollection getAzurePlanSubscriptionEntitlements()

Gets an Azure Plan's subscription entitlements.

Returns:

A resource collection of Azure entitlements.

getConversions

public abstract ISubscriptionConversionCollection getConversions()

Gets the current subscription's conversion operations. These operations will only apply to trial subscriptions.

Returns:

The current subscription's conversion operations.

getProvisioningStatus

public abstract ISubscriptionProvisioningStatus getProvisioningStatus()

Gets the current subscription's provisioning status operations.

Returns:

The current subscription's provisioning status operations.

getRegistration

public abstract ISubscriptionRegistration getRegistration()

Gets the current subscription's registration operations.

Returns:

The current subscription's registration operations.

getRegistrationStatus

public abstract ISubscriptionRegistrationStatus getRegistrationStatus()

Gets the current subscription's registration status operations.

Returns:

The current subscription's registration status operations.

getSupportContact

public abstract ISubscriptionSupportContact getSupportContact()

Gets the current subscription's support contact operations.

Returns:

The current subscription's support contact operations.

getUpgrades

public abstract ISubscriptionUpgradeCollection getUpgrades()

Gets the current subscription's upgrade operations.

Returns:

The current subscription's upgrade operations.

getUsageRecords

public abstract ISubscriptionUsageRecordCollection getUsageRecords()

Gets the current subscription's resource usage records operations.

Returns:

The current subscription's resource usage records operations.

getUsageSummary

public abstract ISubscriptionUsageSummary getUsageSummary()

Gets the current subscription's usage summary operations.

Returns:

The current subscription's usage summary operations.

getUtilization

public abstract IUtilizationCollection getUtilization()

Gets the current subscription's utilization operations.

Returns:

The current subscription's utilization operations.

patch

public abstract Subscription patch(Subscription subscription)

Patches the subscription.

Parameters:

subscription - A subscription that has the properties to be patched set.

Returns:

The updated subscription.