Table of Contents

Codeunit "Azure AD Licensing"

ID 458
Namespace: System.Azure.Identity

Access information about the subscribed SKUs and the corresponding service plans. You can retrieve information such as the SKU Object ID, SKU ID, number of licenses assigned, the license state (enabled, suspended, or warning), and the SKU part number. For the corresponding service plans, you can retrieve the ID, the capability status, or the name.

Properties

Name Value
Access Public
InherentEntitlements X
InherentPermissions X

Methods

ResetSubscribedSKU

Sets the enumerator for the subscribed SKUs to its initial position, which is before the first subscribed SKU in the collection.

[NonDebuggable]
procedure ResetSubscribedSKU(): Boolean

Returns

Type Description
Boolean

True if the enumerator was successfully reset and otherwise false.

NextSubscribedSKU

Advances the enumerator to the next subscribed SKU in the collection. If only known service plans should be included, it advances to the next SKU known in Business Central.

[NonDebuggable]
procedure NextSubscribedSKU(): Boolean

Returns

Type Description
Boolean

True if the enumerator was successfully advanced to the next SKU; false if the enumerator has passed the end of the collection.

SubscribedSKUCapabilityStatus

Gets the capability status of the subscribed SKU that the enumerator is currently pointing to in the collection.

[NonDebuggable]
procedure SubscribedSKUCapabilityStatus(): Text

Returns

Type Description
Text

The capability status of the subscribed SKU, or an empty string if the subscribed SKUs enumerator was not initialized.

SubscribedSKUConsumedUnits

Gets the number of licenses assigned to the subscribed SKU that the enumerator is currently pointing to in the collection.

[NonDebuggable]
procedure SubscribedSKUConsumedUnits(): Integer

Returns

Type Description
Integer

The number of licenses that are assigned to the subscribed SKU, or 0 if the subscribed SKUs enumerator was not initialized.

SubscribedSKUObjectId

Gets the object ID of the subscribed SKU that the enumerator is currently pointing to in the collection.

[NonDebuggable]
procedure SubscribedSKUObjectId(): Text

Returns

Type Description
Text

The object ID of the current SKU. If the subscribed SKUs enumerator was not initialized, it will return an empty string.

SubscribedSKUPrepaidUnitsInEnabledState

Gets the number of prepaid licenses that are enabled for the subscribed SKU that the enumerator is currently pointing to in the collection.

[NonDebuggable]
procedure SubscribedSKUPrepaidUnitsInEnabledState(): Integer

Returns

Type Description
Integer

The number of prepaid licenses that are enabled for the subscribed SKU. If the subscribed SKUs enumerator was not initialized it will return 0.

SubscribedSKUPrepaidUnitsInSuspendedState

Gets the number of prepaid licenses that are suspended for the subscribed SKU that the enumerator is currently pointing to in the collection.

[NonDebuggable]
procedure SubscribedSKUPrepaidUnitsInSuspendedState(): Integer

Returns

Type Description
Integer

The number of prepaid licenses that are suspended for the subscribed SKU. If the subscribed SKUs enumerator was not initialized it will return 0.

SubscribedSKUPrepaidUnitsInWarningState

Gets the number of prepaid licenses that are in warning status for the subscribed SKU that the enumerator is currently pointing to in the collection.

[NonDebuggable]
procedure SubscribedSKUPrepaidUnitsInWarningState(): Integer

Returns

Type Description
Integer

The number of prepaid licenses that are in warning status for the subscribed SKU. If the subscribed SKUs enumerator was not initialized it will return 0.

SubscribedSKUId

Gets the unique identifier (GUID) for the subscribed SKU that the enumerator is currently pointing to in the collection.

[NonDebuggable]
procedure SubscribedSKUId(): Text

Returns

Type Description
Text

The unique identifier (GUID) of the subscribed SKU; empty string if the subscribed SKUs enumerator was not initialized.

SubscribedSKUPartNumber

Gets the part number of the subscribed SKU that the enumerator is currently pointing to in the collection. For example, "AAD_PREMIUM" OR "RMSBASIC."

[NonDebuggable]
procedure SubscribedSKUPartNumber(): Text

Returns

Type Description
Text

The part number of the subscribed SKU or an empty string if the subscribed SKUs enumerator was not initialized.

ResetServicePlans

Sets the enumerator for service plans to its initial position, which is before the first service plan in the collection.

[NonDebuggable]
procedure ResetServicePlans()

NextServicePlan

Advances the enumerator to the next service plan in the collection.

[NonDebuggable]
procedure NextServicePlan(): Boolean

Returns

Type Description
Boolean

True if the enumerator was successfully advanced to the next service plan; false if the enumerator has passed the end of the collection or it was not initialized.

ServicePlanCapabilityStatus

Gets the service plan capability status.

[NonDebuggable]
procedure ServicePlanCapabilityStatus(): Text

Returns

Type Description
Text

The capability status of the service plan, or an empty string if the service plan enumerator was not initialized.

ServicePlanId

Gets the service plan ID.

[NonDebuggable]
procedure ServicePlanId(): Text

Returns

Type Description
Text

The ID of the service plan, or an empty string if the service plan enumerator was not initialized.

ServicePlanName

Gets the service plan name.

[NonDebuggable]
procedure ServicePlanName(): Text

Returns

Type Description
Text

The name of the service plan, or an empty string if the service plan enumerator was not initialized.

IncludeUnknownPlans

Checks whether to include unknown plans when moving to the next subscribed SKU in the subscribed SKUs collection.

[NonDebuggable]
procedure IncludeUnknownPlans(): Boolean

Returns

Type Description
Boolean

True if the unknown service plans should be included. Otherwise, false.

SetIncludeUnknownPlans

Sets whether to include unknown plans when moving to the next subscribed SKU in subscribed SKUs collection.

[NonDebuggable]
procedure SetIncludeUnknownPlans(NewIncludeUnknownPlans: Boolean)

Parameters

Name Type Description
NewIncludeUnknownPlans Boolean

The value to be set to the flag.

See also