pnp/cli-microsoft365

Clarify or extend "aad license list"

Open

#5,336 opened on Jul 21, 2023

View on GitHub
 (14 comments) (1 reaction) (0 assignees)TypeScript (399 forks)auto 404
docsenhancementhelp wanted

Repository metrics

Stars
 (1,390 stars)
PR merge metrics
 (PR metrics pending)

Description

Regarding the aad license list command, the Graph API endpoint subscribedSku currently doesn't provide the license name in its output. This lack of essential information can be quite frustrating for developers, like myself, who was working on a script that utilized this command. 😅 Unfortunately, integrating this feature into the CLI is challenging, given that the API doesn't include the license name in its response.

In relation to this endpoint, the Graph docs offers a link to download a CSV containing all license names. We can utilize this CSV data to create custom logic that associates each license name appropriately, but this isn't clear from our docs perspective.

After conducting some research, I discovered several approaches to address this issue and improve clarity for our end users.

1. The straightforward solution: Adding a remark.

One simple approach to address this is by including a remark in our documentation, directing users to the Graph docs for additional information. This remark would contain a link that helps users understand how to utilize the related license CSV to complement the results from aad license list. Additionally, we can provide a new script sample demonstrating how to effectively read the license CSV and associate it with the command's output.

2. The user-friendly, albeit slightly cumbersome option.

For enhanced user-friendliness, we can include the license CSV directly in our codebase and incorporate the license names into the output. However, this method requires us to diligently monitor the CSV for any updates to ensure the information remains accurate and up-to-date.

Contributor guide