@pnp/cli-microsoft365 6.3.0-beta.4c3b2c9 → 6.3.0-beta.655c566

package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js

@@ -0,0 +1,90 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _PurviewRetentionEventTypeSetCommand_instances, _PurviewRetentionEventTypeSetCommand_initTelemetry, _PurviewRetentionEventTypeSetCommand_initOptions, _PurviewRetentionEventTypeSetCommand_initValidators;
+Object.defineProperty(exports, "__esModule", { value: true });
+const Auth_1 = require("../../../../Auth");
+const validation_1 = require("../../../../utils/validation");
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+const accessToken_1 = require("../../../../utils/accessToken");
+class PurviewRetentionEventTypeSetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.RETENTIONEVENTTYPE_SET;
+    }
+    get description() {
+        return 'Update a retention event type';
+    }
+    constructor() {
+        super();
+        _PurviewRetentionEventTypeSetCommand_instances.add(this);
+        __classPrivateFieldGet(this, _PurviewRetentionEventTypeSetCommand_instances, "m", _PurviewRetentionEventTypeSetCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _PurviewRetentionEventTypeSetCommand_instances, "m", _PurviewRetentionEventTypeSetCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _PurviewRetentionEventTypeSetCommand_instances, "m", _PurviewRetentionEventTypeSetCommand_initValidators).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (accessToken_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
+                this.handleError('This command does not support application permissions.');
+            }
+            if (this.verbose) {
+                logger.log(`Updating retention event type with id ${args.options.id}`);
+            }
+            try {
+                const requestBody = {
+                    description: args.options.description
+                };
+                const requestOptions = {
+                    url: `${this.resource}/beta/security/triggerTypes/retentionEventTypes/${args.options.id}`,
+                    headers: {
+                        accept: 'application/json'
+                    },
+                    responseType: 'json',
+                    data: requestBody
+                };
+                yield request_1.default.patch(requestOptions);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+}
+_PurviewRetentionEventTypeSetCommand_instances = new WeakSet(), _PurviewRetentionEventTypeSetCommand_initTelemetry = function _PurviewRetentionEventTypeSetCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            description: typeof args.options.description !== 'undefined'
+        });
+    });
+}, _PurviewRetentionEventTypeSetCommand_initOptions = function _PurviewRetentionEventTypeSetCommand_initOptions() {
+    this.options.unshift({
+        option: '-i, --id <id>'
+    }, {
+        option: '-d, --description [description]'
+    });
+}, _PurviewRetentionEventTypeSetCommand_initValidators = function _PurviewRetentionEventTypeSetCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (!validation_1.validation.isValidGuid(args.options.id)) {
+            return `'${args.options.id}' is not a valid GUID.`;
+        }
+        if (!args.options.description) {
+            return 'Specify at least one option to update.';
+        }
+        return true;
+    }));
+};
+module.exports = new PurviewRetentionEventTypeSetCommand();
+//# sourceMappingURL=retentioneventtype-set.js.map

package/dist/m365/purview/commands.js

@@ -2,8 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const prefix = 'purview';
 exports.default = {
-    RETENTIONEVENTTYPE_GET: `${prefix} retentioneventtype get`,
     AUDITLOG_LIST: `${prefix} auditlog list`,
+    RETENTIONEVENT_GET: `${prefix} retentionevent get`,
+    RETENTIONEVENT_LIST: `${prefix} retentionevent list`,
+    RETENTIONEVENTTYPE_ADD: `${prefix} retentioneventtype add`,
+    RETENTIONEVENTTYPE_GET: `${prefix} retentioneventtype get`,
+    RETENTIONEVENTTYPE_LIST: `${prefix} retentioneventtype list`,
+    RETENTIONEVENTTYPE_REMOVE: `${prefix} retentioneventtype remove`,
+    RETENTIONEVENTTYPE_SET: `${prefix} retentioneventtype set`,
     RETENTIONLABEL_ADD: `${prefix} retentionlabel add`,
     RETENTIONLABEL_GET: `${prefix} retentionlabel get`,
     RETENTIONLABEL_LIST: `${prefix} retentionlabel list`,

package/dist/m365/spo/commands/listitem/listitem-add.js

@@ -176,7 +176,8 @@ class SpoListItemAddCommand extends SpoCommand_1.default {
             'folder',
             'debug',
             'verbose',
-            'output'
+            'output',
+            '_'
         ];
         Object.keys(options).forEach(key => {
             if (excludeOptions.indexOf(key) === -1) {

package/dist/m365/spo/commands/navigation/navigation-node-get.js

@@ -0,0 +1,73 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoNavigationNodeGetCommand_instances, _SpoNavigationNodeGetCommand_initOptions, _SpoNavigationNodeGetCommand_initValidators;
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoNavigationNodeGetCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.NAVIGATION_NODE_GET;
+    }
+    get description() {
+        return 'Retrieve information about a specific navigation node';
+    }
+    constructor() {
+        super();
+        _SpoNavigationNodeGetCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoNavigationNodeGetCommand_instances, "m", _SpoNavigationNodeGetCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoNavigationNodeGetCommand_instances, "m", _SpoNavigationNodeGetCommand_initValidators).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving information about navigation node with id ${args.options.id}`);
+            }
+            const requestOptions = {
+                url: `${args.options.webUrl}/_api/web/navigation/GetNodeById(${args.options.id})`,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            try {
+                const listInstance = yield request_1.default.get(requestOptions);
+                logger.log(listInstance);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+}
+_SpoNavigationNodeGetCommand_instances = new WeakSet(), _SpoNavigationNodeGetCommand_initOptions = function _SpoNavigationNodeGetCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '--id <id>'
+    });
+}, _SpoNavigationNodeGetCommand_initValidators = function _SpoNavigationNodeGetCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const id = parseInt(args.options.id);
+        if (isNaN(id)) {
+            return `${args.options.id} is not a valid number`;
+        }
+        return validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+    }));
+};
+module.exports = new SpoNavigationNodeGetCommand();
+//# sourceMappingURL=navigation-node-get.js.map

package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js

@@ -0,0 +1,179 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoTenantApplicationCustomizerAddCommand_instances, _SpoTenantApplicationCustomizerAddCommand_initTelemetry, _SpoTenantApplicationCustomizerAddCommand_initOptions, _SpoTenantApplicationCustomizerAddCommand_initValidators;
+Object.defineProperty(exports, "__esModule", { value: true });
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+const Cli_1 = require("../../../../cli/Cli");
+const spoTenantAppCatalogUrlGetCommand = require("../tenant/tenant-appcatalogurl-get");
+const spoListItemAddCommand = require("../listitem/listitem-add");
+const spoListItemListCommand = require("../listitem/listitem-list");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+class SpoTenantApplicationCustomizerAddCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.TENANT_APPLICATIONCUSTOMIZER_ADD;
+    }
+    get description() {
+        return 'Add an application customizer as a tenant wide extension.';
+    }
+    constructor() {
+        super();
+        _SpoTenantApplicationCustomizerAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerAddCommand_instances, "m", _SpoTenantApplicationCustomizerAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerAddCommand_instances, "m", _SpoTenantApplicationCustomizerAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoTenantApplicationCustomizerAddCommand_instances, "m", _SpoTenantApplicationCustomizerAddCommand_initValidators).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const appCatalogUrl = yield this.getAppCatalogUrl(logger);
+                const componentManifest = yield this.getComponentManifest(appCatalogUrl, args.options.clientSideComponentId, logger);
+                const clientComponentManifest = JSON.parse(componentManifest.ClientComponentManifest);
+                if (clientComponentManifest.extensionType !== "ApplicationCustomizer") {
+                    throw `The extension type of this component is not of type 'ApplicationCustomizer' but of type '${clientComponentManifest.extensionType}'`;
+                }
+                const solution = yield this.getSolutionFromAppCatalog(appCatalogUrl, componentManifest.SolutionId, logger);
+                if (!solution.ContainsTenantWideExtension) {
+                    throw `The solution does not contain an extension that can be deployed to all sites. Make sure that you've entered the correct component Id.`;
+                }
+                else if (!solution.SkipFeatureDeployment) {
+                    throw 'The solution has not been deployed to all sites. Make sure to deploy this solution to all sites.';
+                }
+                yield this.addTenantWideExtension(appCatalogUrl, args.options, logger);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+    getAppCatalogUrl(logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const spoTenantAppCatalogUrlGetCommandOutput = yield Cli_1.Cli.executeCommandWithOutput(spoTenantAppCatalogUrlGetCommand, { options: { output: 'text', _: [] } });
+            if (this.verbose) {
+                logger.logToStderr(spoTenantAppCatalogUrlGetCommandOutput.stderr);
+            }
+            const appCatalogUrl = spoTenantAppCatalogUrlGetCommandOutput.stdout;
+            if (!appCatalogUrl) {
+                throw 'Cannot add tenant-wide application customizer as app catalog cannot be found';
+            }
+            if (this.verbose) {
+                logger.logToStderr(`Got tenant app catalog url: ${appCatalogUrl}`);
+            }
+            return appCatalogUrl;
+        });
+    }
+    getComponentManifest(appCatalogUrl, clientSideComponentId, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr('Retrieving component manifest item from the ComponentManifests list on the app catalog site so that we get the solution id');
+            }
+            const camlQuery = `<View><ViewFields><FieldRef Name='ClientComponentId'></FieldRef><FieldRef Name='SolutionId'></FieldRef><FieldRef Name='ClientComponentManifest'></FieldRef></ViewFields><Query><Where><Eq><FieldRef Name='ClientComponentId' /><Value Type='Guid'>${clientSideComponentId}</Value></Eq></Where></Query></View>`;
+            const commandOptions = {
+                webUrl: appCatalogUrl,
+                listUrl: `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(appCatalogUrl)}/Lists/ComponentManifests`,
+                camlQuery: camlQuery,
+                verbose: this.verbose,
+                debug: this.debug,
+                output: 'json'
+            };
+            const output = yield Cli_1.Cli.executeCommandWithOutput(spoListItemListCommand, { options: Object.assign(Object.assign({}, commandOptions), { _: [] }) });
+            if (this.verbose) {
+                logger.logToStderr(output.stderr);
+            }
+            const outputParsed = JSON.parse(output.stdout);
+            if (outputParsed.length === 0) {
+                throw 'No component found with the specified clientSideComponentId found in the component manifest list. Make sure that the application is added to the application catalog';
+            }
+            return outputParsed[0];
+        });
+    }
+    getSolutionFromAppCatalog(appCatalogUrl, solutionId, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving solution with id ${solutionId} from the application catalog`);
+            }
+            const camlQuery = `<View><ViewFields><FieldRef Name='SkipFeatureDeployment'></FieldRef><FieldRef Name='ContainsTenantWideExtension'></FieldRef></ViewFields><Query><Where><Eq><FieldRef Name='AppProductID' /><Value Type='Guid'>${solutionId}</Value></Eq></Where></Query></View>`;
+            const commandOptions = {
+                webUrl: appCatalogUrl,
+                listUrl: `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(appCatalogUrl)}/AppCatalog`,
+                camlQuery: camlQuery,
+                verbose: this.verbose,
+                debug: this.debug,
+                output: 'json'
+            };
+            const output = yield Cli_1.Cli.executeCommandWithOutput(spoListItemListCommand, { options: Object.assign(Object.assign({}, commandOptions), { _: [] }) });
+            if (this.verbose) {
+                logger.logToStderr(output.stderr);
+            }
+            const outputParsed = JSON.parse(output.stdout);
+            if (outputParsed.length === 0) {
+                throw `No component found with the solution id ${solutionId}. Make sure that the solution is available in the app catalog`;
+            }
+            return outputParsed[0];
+        });
+    }
+    addTenantWideExtension(appCatalogUrl, options, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr('Pre-checks finished. Adding tenant wide extension to the TenantWideExtensions list');
+            }
+            const commandOptions = {
+                webUrl: appCatalogUrl,
+                listUrl: `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(appCatalogUrl)}/Lists/TenantWideExtensions`,
+                Title: options.title,
+                TenantWideExtensionComponentId: options.clientSideComponentId,
+                TenantWideExtensionLocation: 'ClientSideExtension.ApplicationCustomizer',
+                TenantWideExtensionSequence: 0,
+                TenantWideExtensionListTemplate: 0,
+                TenantWideExtensionComponentProperties: options.clientSideComponentProperties || '',
+                TenantWideExtensionWebTemplate: options.webTemplate || '',
+                TenantWideExtensionDisabled: false,
+                verbose: this.verbose,
+                debug: this.debug,
+                output: options.output
+            };
+            yield Cli_1.Cli.executeCommand(spoListItemAddCommand, { options: Object.assign(Object.assign({}, commandOptions), { _: [] }) });
+        });
+    }
+}
+_SpoTenantApplicationCustomizerAddCommand_instances = new WeakSet(), _SpoTenantApplicationCustomizerAddCommand_initTelemetry = function _SpoTenantApplicationCustomizerAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            clientSideComponentProperties: typeof args.options.clientSideComponentProperties !== 'undefined',
+            webTemplate: typeof args.options.webTemplate !== 'undefined'
+        });
+    });
+}, _SpoTenantApplicationCustomizerAddCommand_initOptions = function _SpoTenantApplicationCustomizerAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-t, --title <title>'
+    }, {
+        option: '-i, --clientSideComponentId <clientSideComponentId>'
+    }, {
+        option: '-p, --clientSideComponentProperties [clientSideComponentProperties]'
+    }, {
+        option: '-w, --webTemplate [webTemplate]'
+    });
+}, _SpoTenantApplicationCustomizerAddCommand_initValidators = function _SpoTenantApplicationCustomizerAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (!validation_1.validation.isValidGuid(args.options.clientSideComponentId)) {
+            return `${args.options.clientSideComponentId} is not a valid GUID`;
+        }
+        return true;
+    }));
+};
+module.exports = new SpoTenantApplicationCustomizerAddCommand();
+//# sourceMappingURL=tenant-applicationcustomizer-add.js.map

package/dist/m365/spo/commands.js

@@ -168,6 +168,7 @@ exports.default = {
     LISTITEM_SET: `${prefix} listitem set`,
     MAIL_SEND: `${prefix} mail send`,
     NAVIGATION_NODE_ADD: `${prefix} navigation node add`,
+    NAVIGATION_NODE_GET: `${prefix} navigation node get`,
     NAVIGATION_NODE_LIST: `${prefix} navigation node list`,
     NAVIGATION_NODE_REMOVE: `${prefix} navigation node remove`,
     NAVIGATION_NODE_SET: `${prefix} navigation node set`,
@@ -277,6 +278,7 @@ exports.default = {
     STORAGEENTITY_REMOVE: `${prefix} storageentity remove`,
     TENANT_APPCATALOG_ADD: `${prefix} tenant appcatalog add`,
     TENANT_APPCATALOGURL_GET: `${prefix} tenant appcatalogurl get`,
+    TENANT_APPLICATIONCUSTOMIZER_ADD: `${prefix} tenant applicationcustomizer add`,
     TENANT_RECYCLEBINITEM_LIST: `${prefix} tenant recyclebinitem list`,
     TENANT_RECYCLEBINITEM_REMOVE: `${prefix} tenant recyclebinitem remove`,
     TENANT_RECYCLEBINITEM_RESTORE: `${prefix} tenant recyclebinitem restore`,

package/docs/docs/cmd/context/option/option-list.md

@@ -0,0 +1,63 @@
+# context option list
+
+List all options added to the context
+
+## Usage
+
+```sh
+m365 context option list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all options added to the context
+
+```sh
+m365 context option list
+```
+
+## Response
+
+The responses below are an example. The output may differ based on the contents of the context file
+
+=== "JSON"
+
+    ```json
+    {
+      "url": "https://contoso.sharepoint.com",
+      "list": "list name"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    list: list name
+    url : https://contoso.sharepoint.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    url,list
+    https://contoso.sharepoint.com,list name
+    ```
+
+=== "Markdown"
+
+    ```md
+    # context option list
+
+    Date: 7/2/2023
+
+    ## https://contoso.sharepoint.com
+
+    Property | Value
+    ---------|-------
+    url | https://contoso.sharepoint.com
+    list | list name
+    ```

package/docs/docs/cmd/planner/plan/plan-set.md

@@ -11,16 +11,19 @@ m365 planner plan set [options]
 ## Options
 
 `-i, --id [id]`
-: ID of the plan. Specify either `id` or `title` but not both.
+: ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
 
 `-t, --title [title]`
-: Title of the plan. Specify either `id` or `title` but not both.
+: Title of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
+
+`--rosterId [rosterId]`
+: ID of the Planner Roster. Specify either `id`, `title` or `rosterId` but not multiple.
 
 `--ownerGroupId [ownerGroupId]`
-: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
 
 `--ownerGroupName [ownerGroupName]`
-: Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+: Name of the Group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
 
 `--newTitle [newTitle]`
 : New title of the plan.
@@ -40,6 +43,9 @@ This command allows using unknown options.
 `--category1 [category1]`
 : New label for a category. Define the category key within your option to update the related label. Category 1 to 25 are available. E.g., `--category4`, `--category12`.
 
+!!! attention
+    When using `rosterId`, the command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
 ## Examples
 
 Updates a Microsoft Planner plan title to New Title

package/docs/docs/cmd/planner/roster/roster-get.md

@@ -0,0 +1,73 @@
+# planner roster get
+
+Gets information about the specific Microsoft Planner Roster.
+
+## Usage
+
+```sh
+m365 planner roster get [options]
+```
+
+## Options
+
+`--id <id>`
+: ID of the Planner Roster.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+## Examples
+
+Gets information about a specific Planner Roster.
+
+```sh
+m365 planner roster get --id tYqYlNd6eECmsNhN_fcq85cAGAnd
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "tYqYlNd6eECmsNhN_fcq85cAGAnd",
+      "assignedSensitivityLabel": null
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    assignedSensitivityLabel: null
+    id                      : tYqYlNd6eECmsNhN_fcq85cAGAnd
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,assignedSensitivityLabel
+    tYqYlNd6eECmsNhN_fcq85cAGAnd,
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner roster get --id "tYqYlNd6eECmsNhN_fcq85cAGAnd"
+
+    Date: 1/30/2023
+
+    ## undefined (tYqYlNd6eECmsNhN_fcq85cAGAnd)
+
+    Property | Value
+    ---------|-------
+    id | tYqYlNd6eECmsNhN_fcq85cAGAnd
+    assignedSensitivityLabel | null
+    ```
+
+## Additional information
+
+Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.