subscribedSku resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents information about a service SKU that a company is subscribed to. Use the values of skuId and servicePlans > servicePlanId to assign licenses to unassigned users and groups through the user: assignLicense and group: assignLicense APIs respectively.

For more information about subscriptions and licenses, see Subscriptions, licenses, accounts, and tenants for Microsoft's cloud offerings.

Inherits from directoryObject.

Methods

Method Return Type Description
Get subscribedSku Get a specific commercial subscription that an organization has acquired.
List subscribedSku collection Get the list of commercial subscriptions that an organization has acquired.

Properties

Property Type Description
accountId String The unique ID of the account this SKU belongs to.
accountName String The name of the account this SKU belongs to.
appliesTo String The target class for this SKU. Only SKUs with target class User are assignable. Possible values are: User, Company.
capabilityStatus String Enabled indicates that the prepaidUnits property has at least one unit that is enabled. LockedOut indicates that the customer canceled their subscription. Possible values are: Enabled, Warning, Suspended, Deleted, LockedOut.
consumedUnits Int32 The number of licenses that have been assigned.
id String The unique identifier for the subscribed SKU object. Key, not nullable.
prepaidUnits licenseUnitsDetail Information about the number and status of prepaid licenses.
servicePlans servicePlanInfo collection Information about the service plans that are available with the SKU. Not nullable
skuId String The unique identifier (GUID) for the service SKU.
skuPartNumber String The SKU part number; for example, AAD_PREMIUM or RMSBASIC. To get a list of commercial subscriptions that an organization has acquired, see List subscribedSkus.
subscriptionIds String collection A list of all subscription IDs associated with this SKU.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "accountId": "String",
  "accountName": "String",
  "appliesTo": "String",
  "capabilityStatus": "String",
  "consumedUnits": "Int32",
  "id": "String (identifier)",
  "prepaidUnits": { "@odata.type": "microsoft.graph.licenseUnitsDetail" },
  "servicePlans": [{ "@odata.type": "microsoft.graph.servicePlanInfo" }],
  "skuId": "String",
  "skuPartNumber": "String",
  "subscriptionIds": ["String"]
}