Skip to content

usageright.md

Latest commit

 

History

History
70 lines (54 loc) · 2.53 KB

usageright.md

File metadata and controls

70 lines (54 loc) · 2.53 KB
title usageRight resource type
description Contains information about a usageRight a user/device has assigned
author jeeshnair
ms.localizationpriority medium
ms.subservice entra-directory-management
doc_type resourcePageType
ms.date 05/23/2024

usageRight resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

A usage right represents a license that a user or device has for either third party software built on Power Apps or for device-based subscriptions (device only).

Methods

Method Return type Description
List user usage rights usageRight collection Get the list of usage rights for a user.
List device usage rights usageRight collection Get the list of usage rights for a device.

Properties

Property Type Description
catalogId String Product id corresponding to the usage right.
id String The id of the usage right.
serviceIdentifier String Identifier of the service corresponding to the usage right.
state usageRightState The state of the usage right. The possible values are: active, inactive, warning, suspended.

usageRightState values

Member Description
active Indicates that the usage right is active and can be used for provisioning benefits.
inactive Indicates that the usage right isn't active and can't be used for provisioning benefits.
warning Indicates that the usage right is in grace likely due to payment violation. This state can be used to either remind of pending payment or offer a degraded experience.
suspended Indicates that the usage right is suspended likely due to Payment violation
unknownFutureValue Sentinel value to indicate future values.

Note: Only the active and warning states represent a usable benefit. All other states should be treated as not resulting in a usable benefit.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.usageRight",
  "id": "String (identifier)",
  "catalogId": "String",
  "serviceIdentifier": "String",
  "state": "String"
}