@pnp/cli-microsoft365 6.3.0-beta.e46ffee → 6.3.0-beta.fee5cdb

package/dist/utils/spo.js

@@ -18,6 +18,7 @@ const config_1 = require("../config");
 const base_permissions_1 = require("../m365/spo/base-permissions");
 const request_1 = require("../request");
 const formatting_1 = require("./formatting");
+const odata_1 = require("./odata");
 exports.spo = {
     getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -456,6 +457,94 @@ exports.spo = {
                 reject('Cannot proceed. Folder _ObjectIdentity_ not found'); // this is not suppose to happen
             }, (err) => { reject(err); });
         });
+    },
+    /**
+     * Retrieves the SiteId, VroomItemId and VroomDriveId from a specific file.
+     * @param webUrl Web url
+     * @param fileId GUID ID of the file
+     * @param fileUrl Decoded URL of the file
+     */
+    getVroomFileDetails(webUrl, fileId, fileUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let requestUrl = `${webUrl}/_api/web/`;
+            if (fileUrl) {
+                const fileServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(webUrl, fileUrl);
+                requestUrl += `GetFileByServerRelativePath(decodedUrl='${formatting_1.formatting.encodeQueryParameter(fileServerRelativeUrl)}')`;
+            }
+            else {
+                requestUrl += `GetFileById('${fileId}')`;
+            }
+            requestUrl += '?$select=SiteId,VroomItemId,VroomDriveId';
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const res = yield request_1.default.get(requestOptions);
+            return res;
+        });
+    },
+    /**
+     * Retrieves a list of Custom Actions from a SharePoint site.
+     * @param webUrl Web url
+     * @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
+     * @param filter An OData filter query to limit the results.
+     */
+    getCustomActions(webUrl, scope, filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
+                throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
+            }
+            const queryString = filter ? `?$filter=${filter}` : "";
+            if (scope && scope !== "All") {
+                return yield odata_1.odata.getAllItems(`${webUrl}/_api/${scope}/UserCustomActions${queryString}`);
+            }
+            const customActions = [
+                ...yield odata_1.odata.getAllItems(`${webUrl}/_api/Site/UserCustomActions${queryString}`),
+                ...yield odata_1.odata.getAllItems(`${webUrl}/_api/Web/UserCustomActions${queryString}`)
+            ];
+            return customActions;
+        });
+    },
+    /**
+     * Retrieves a Custom Actions from a SharePoint site by Id.
+     * @param webUrl Web url
+     * @param id The Id of the Custom Action
+     * @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
+     */
+    getCustomActionById(webUrl, id, scope) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
+                throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
+            }
+            function getById(webUrl, id, scope) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const requestOptions = {
+                        url: `${webUrl}/_api/${scope}/UserCustomActions(guid'${id}')`,
+                        headers: {
+                            accept: 'application/json;odata=nometadata'
+                        },
+                        responseType: 'json'
+                    };
+                    const result = yield request_1.default.get(requestOptions);
+                    if (result["odata.null"] === true) {
+                        return undefined;
+                    }
+                    return result;
+                });
+            }
+            if (scope && scope !== "All") {
+                return yield getById(webUrl, id, scope);
+            }
+            const customActionOnWeb = yield getById(webUrl, id, "Web");
+            if (customActionOnWeb) {
+                return customActionOnWeb;
+            }
+            const customActionOnSite = yield getById(webUrl, id, "Site");
+            return customActionOnSite;
+        });
     }
 };
 //# sourceMappingURL=spo.js.map

package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md

@@ -0,0 +1,42 @@
+# aad user recyclebinitem clear
+
+Removes all users from the tenant recycle bin
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem clear [options]
+```
+
+## Options
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
+
+!!! note
+    After running this command, it may take a minute before all deleted users are effectively removed from the tenant.
+
+## Examples
+
+Removes all users from the tenant recycle bin
+
+```sh
+m365 aad user recyclebinitem clear
+```
+
+Removes all users from the tenant recycle bin without confirmation prompt
+
+```sh
+m365 aad user recyclebinitem clear --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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/login.md

@@ -159,3 +159,29 @@ Log in to Microsoft 365 using a client secret.
 ```sh
 m365 login --authType secret --secret topSeCr3t@007
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
+    ```
+
+=== "Text"
+
+    ```text
+    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
+    ```
+
+=== "CSV"
+
+    ```csv
+    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
+    ```
+
+=== "Markdown"
+
+    ```md
+    To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
+    ```

package/docs/docs/cmd/logout.md

@@ -29,3 +29,7 @@ Log out from Microsoft 365 in debug mode including detailed debug information in
 ```sh
 m365 logout --debug
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pa/app/app-get.md

@@ -222,3 +222,27 @@ m365 pa app get --displayName App
     name,displayName,description,appVersion,owner
     37ea6004-f07b-46ca-8ef3-a256b67b4dbb,PowerApps Application,App Description,2022-10-25T21:28:12Z,user@tenant.onmicrosoft.com
     ```
+    
+=== "Markdown"
+
+    ```md
+    # pa app get --displayName "PowerApps Application"
+
+    Date: 9/1/2023
+
+    ## PowerApps Application (/providers/Microsoft.PowerApps/apps/fe36f75e-c103-410b-a18a-2bf6df06ac3a)
+
+    Property | Value
+    ---------|-------
+    name | fe36f75e-c103-410b-a18a-2bf6df06ac3a
+    id | /providers/Microsoft.PowerApps/apps/fe36f75e-c103-410b-a18a-2bf6df06ac3a
+    type | Microsoft.PowerApps/apps
+    tags | {"primaryDeviceWidth":"1366","primaryDeviceHeight":"768","supportsPortrait":"true","supportsLandscape":"true","primaryFormFactor":"Tablet","publisherVersion":"3.22102.32","minimumRequiredApiVersion":"2.2.0","hasComponent":"false","hasUnlockedComponent":"false","isUnifiedRootApp":"false","sienaVersion":"20221025T212812Z-3.22102.32.0"}
+    properties | {"appVersion":"2022-10-25T21:28:12Z","lastDraftVersion":"2022-10-25T21:28:12Z","lifeCycleId":"Published","status":"Ready","createdByClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"minClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"owner":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"createdBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastModifiedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastPublishedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"backgroundColor":"RGBA(0,176,240,1)","backgroundImageUri":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/logoSmallFile?sv=2018-03-28&sr=c&sig=cOkbwChyhCO%2BEJpqMDRxrXaxRoPD1TbTy%2B%2BFkdJEOjI%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsColorIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamscoloricon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsOutlineIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamsoutlineicon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","displayName":"Test application","description":"","commitMessage":"","appUris":{"documentUri":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"imageUris":[],"additionalUris":[]},"createdTime":"2022-10-25T21:28:12.7171469Z","lastModifiedTime":"2022-10-25T21:28:12.7456297Z","lastPublishTime":"2022-10-25T21:28:12Z","sharedGroupsCount":0,"sharedUsersCount":0,"appOpenProtocolUri":"ms-apps:///providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb","appOpenUri":"https://apps.powerapps.com/play/e/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc","appPlayUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d","appPlayEmbeddedUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu","appPlayTeamsUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&source=teamstab&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu&locale={locale}&channelId={channelId}&channelType={channelType}&chatId={chatId}&groupId={groupId}&hostClientType={hostClientType}&isFullScreen={isFullScreen}&entityId={entityId}&subEntityId={subEntityId}&teamId={teamId}&teamType={teamType}&theme={theme}&userTeamRole={userTeamRole}","userAppMetadata":{"favorite":"NotSpecified","includeInAppsList":true},"isFeaturedApp":false,"bypassConsent":false,"isHeroApp":false,"environment":{"id":"/providers/Microsoft.PowerApps/environments/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d","name":"default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d"},"appPackageDetails":{"playerPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"webPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"unauthenticatedWebPackage":{"value":"https://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"documentServerVersion":{"major":3,"minor":22102,"build":33,"revision":0,"majorRevision":0,"minorRevision":0},"appPackageResourcesKind":"Split","packagePropertiesJson":"{\"cdnUrl\":\"https://content.powerapps.com/resource/app\",\"preLoadIdx\":\"https://content.powerapps.com/resource/app/kdfj31mdao7t9/preloadindex.web.html\",\"id\":\"638023301009567627\",\"v\":2.1}","id":"20221025t000000zac5237a2672a4782ad5a7d71040c032bhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"almMode":"Environment","performanceOptimizationEnabled":true,"unauthenticatedWebPackageHint":"296b0ef7-b4d0-4124-b835-f9c220a1f4bc","canConsumeAppPass":true,"enableModernRuntimeMode":false,"executionRestrictions":{"isTeamsOnly":false,"dataLossPreventionEvaluationResult":{"status":"Compliant","lastEvaluationDate":"2022-10-25T21:28:30.2281817Z","violations":[],"violationsByPolicy":[],"violationErrorMessage":"De app gebruikt de volgende connectors:."}},"appPlanClassification":"Standard","usesPremiumApi":false,"usesOnlyGrandfatheredPremiumApis":true,"usesCustomApi":false,"usesOnPremiseGateway":false,"usesPcfExternalServiceUsage":false,"isCustomizable":true}
+    appLocation | europe
+    appType | ClassicCanvasApp
+    displayName | PowerApps Application
+    description | App Description
+    appVersion | 2022-10-25T21:28:12Z
+    owner | user@tenant.onmicrosoft.com
+    ```

package/docs/docs/cmd/pa/app/app-list.md

@@ -221,3 +221,24 @@ m365 pa app list --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --as
     name,displayName
     37ea6004-f07b-46ca-8ef3-a256b67b4dbb,"PowerApps Application"
     ```
+
+=== "Markdown"
+
+    ```md
+    # pa app list
+
+    Date: 9/1/2023
+
+    ## PowerApps Application (/providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb)
+
+    Property | Value
+    ---------|-------
+    name | 37ea6004-f07b-46ca-8ef3-a256b67b4dbb
+    id | /providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb
+    type | Microsoft.PowerApps/apps
+    tags | {"primaryDeviceWidth":"1366","primaryDeviceHeight":"768","supportsPortrait":"true","supportsLandscape":"true","primaryFormFactor":"Tablet","publisherVersion":"3.22102.32","minimumRequiredApiVersion":"2.2.0","hasComponent":"false","hasUnlockedComponent":"false","isUnifiedRootApp":"false","sienaVersion":"20221025T212812Z-3.22102.32.0"}
+    properties | {"appVersion":"2022-10-25T21:28:12Z","lastDraftVersion":"2022-10-25T21:28:12Z","lifeCycleId":"Published","status":"Ready","createdByClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"minClientVersion":{"major":3,"minor":22102,"build":32,"revision":0,"majorRevision":0,"minorRevision":0},"owner":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"createdBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastModifiedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"lastPublishedBy":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"contoso","email":"user@contoso.onmicrosoft.com","type":"User","tenantId":"e1dd4023-a656-480a-8a0e-c1b1eec51e1d","userPrincipalName":"user@contoso.onmicrosoft.com"},"backgroundColor":"RGBA(0,176,240,1)","backgroundImageUri":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/logoSmallFile?sv=2018-03-28&sr=c&sig=cOkbwChyhCO%2BEJpqMDRxrXaxRoPD1TbTy%2B%2BFkdJEOjI%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsColorIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamscoloricon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","teamsOutlineIconUrl":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000ze297221f3dc643ed9686b72b22d9a414/teamsoutlineicon.png?sv=2018-03-28&sr=c&sig=Fhk8E0LO4Lw0mHvNawCF5Ld7GHzPHo9l7RxvZbeZY48%3D&se=2022-12-24T10%3A06%3A27Z&sp=rl","displayName":"Test application","description":"","commitMessage":"","appUris":{"documentUri":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zddd642012aba4021a4886c8e21a3e1cb/document.msapp?sv=2018-03-28&sr=c&sig=laSGdpZL03POyAABXvdsyxv8YDDB8JPZIBccztIe39Q%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"imageUris":[],"additionalUris":[]},"createdTime":"2022-10-25T21:28:12.7171469Z","lastModifiedTime":"2022-10-25T21:28:12.7456297Z","lastPublishTime":"2022-10-25T21:28:12Z","sharedGroupsCount":0,"sharedUsersCount":0,"appOpenProtocolUri":"ms-apps:///providers/Microsoft.PowerApps/apps/37ea6004-f07b-46ca-8ef3-a256b67b4dbb","appOpenUri":"https://apps.powerapps.com/play/e/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc","appPlayUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d","appPlayEmbeddedUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu","appPlayTeamsUri":"https://apps.powerapps.com/play/e/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d/a/37ea6004-f07b-46ca-8ef3-a256b67b4dbb?tenantId=e1dd4023-a656-480a-8a0e-c1b1eec51e1d&source=teamstab&hint=296b0ef7-b4d0-4124-b835-f9c220a1f4bc&telemetryLocation=eu&locale={locale}&channelId={channelId}&channelType={channelType}&chatId={chatId}&groupId={groupId}&hostClientType={hostClientType}&isFullScreen={isFullScreen}&entityId={entityId}&subEntityId={subEntityId}&teamId={teamId}&teamType={teamType}&theme={theme}&userTeamRole={userTeamRole}","userAppMetadata":{"favorite":"NotSpecified","includeInAppsList":true},"isFeaturedApp":false,"bypassConsent":false,"isHeroApp":false,"environment":{"id":"/providers/Microsoft.PowerApps/environments/default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d","name":"default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d"},"appPackageDetails":{"playerPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"webPackage":{"value":"https://pafeblobprodam.blob.core.windows.net:443/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl","readonlyValue":"https://pafeblobprodam-secondary.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rl"},"unauthenticatedWebPackage":{"value":"https://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"documentServerVersion":{"major":3,"minor":22102,"build":33,"revision":0,"majorRevision":0,"minorRevision":0},"appPackageResourcesKind":"Split","packagePropertiesJson":"{\"cdnUrl\":\"https://content.powerapps.com/resource/app\",\"preLoadIdx\":\"https://content.powerapps.com/resource/app/kdfj31mdao7t9/preloadindex.web.html\",\"id\":\"638023301009567627\",\"v\":2.1}","id":"20221025t000000zac5237a2672a4782ad5a7d71040c032bhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/web/index.web.html?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/20221025t000000zac5237a2672a4782ad5a7d71040c032b/5b38cd68-a930-4a14-be71-c622de887d1a/player.msappk?sv=2018-03-28&sr=c&sig=eztEkTd1pFaFEITA%2Bqqj2XCpxwgeujMC7FahMmEkujA%3D&se=2022-11-04T12%3A00%3A00Z&sp=rlhttps://pafeblobprodam.blob.core.windows.net/alt20221025t000000z529d41282a634bf6b94383dde5a8d52c/20221025T212824Z/index.web.html"},"almMode":"Environment","performanceOptimizationEnabled":true,"unauthenticatedWebPackageHint":"296b0ef7-b4d0-4124-b835-f9c220a1f4bc","canConsumeAppPass":true,"enableModernRuntimeMode":false,"executionRestrictions":{"isTeamsOnly":false,"dataLossPreventionEvaluationResult":{"status":"Compliant","lastEvaluationDate":"2022-10-25T21:28:30.2281817Z","violations":[],"violationsByPolicy":[],"violationErrorMessage":"De app gebruikt de volgende connectors: ."}},"appPlanClassification":"Standard","usesPremiumApi":false,"usesOnlyGrandfatheredPremiumApis":true,"usesCustomApi":false,"usesOnPremiseGateway":false,"usesPcfExternalServiceUsage":false,"isCustomizable":true}
+    appLocation | europe
+    appType | ClassicCanvasApp
+    displayName | PowerApps Application
+    ```

package/docs/docs/cmd/pa/connector/connector-list.md

@@ -122,3 +122,20 @@ m365 pa connector list --environmentName Default-d87a7535-dd31-4437-bfe1-95340ac
     name,displayName
     shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012,My connector
     ```
+
+=== "Markdown"
+
+    ```md
+    # pa connector list --environmentName "Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6"
+
+    Date: 9/1/2023
+
+    ## My connector (/providers/Microsoft.PowerApps/apis/shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012)
+
+    Property | Value
+    ---------|-------
+    name | shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012
+    id | /providers/Microsoft.PowerApps/apis/shared_my-20connector-5f0027f520b23e81c1-5f9888a90360086012
+    type | Microsoft.PowerApps/apis
+    properties | {"displayName":"My connector","iconUri":"https://az787822.vo.msecnd.net/defaulticons/api-dedicated.png","iconBrandColor":"#007ee5","contact":{},"license":{},"apiEnvironment":"Shared","isCustomApi":true,"connectionParameters":{},"runtimeUrls":["https://europe-002.azure-apim.net/apim/my-20connector-5f0027f520b23e81c1-5f9888a90360086012"],"primaryRuntimeUrl":"https://europe-002.azure-apim.net/apim/my-20connector-5f0027f520b23e81c1-5f9888a90360086012","metadata":{"source":"powerapps-user-defined","brandColor":"#007ee5","contact":{},"license":{},"publisherUrl":null,"serviceUrl":null,"documentationUrl":null,"environmentName":"Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6","xrmConnectorId":null,"almMode":"Environment","createdBy":"{\"id\":\"03043611-d01e-4e58-9fbe-1a18ecb861d8\",\"displayName\":\"MOD Administrator\",\"email\":\"admin@contoso.OnMicrosoft.com\",\"type\":\"User\",\"tenantId\":\"0d645e38-ec52-4a4f-ac58-65f2ac4015f6\",\"userPrincipalName\":\"admin@contoso.onmicrosoft.com\"}","modifiedBy":"{\"id\":\"03043611-d01e-4e58-9fbe-1a18ecb861d8\",\"displayName\":\"MOD Administrator\",\"email\":\"admin@contoso.OnMicrosoft.com\",\"type\":\"User\",\"tenantId\":\"0d645e38-ec52-4a4f-ac58-65f2ac4015f6\",\"userPrincipalName\":\"admin@contoso.onmicrosoft.com\"}","allowSharing":false},"capabilities":[],"description":"","apiDefinitions":{"originalSwaggerUrl":"https://paeu2weu8.blob.core.windows.net/api-swagger-files/my-20connector-5f0027f520b23e81c1-5f9888a90360086012.json_original?sv=2018-03-28&sr=b&sig=cOkjAecgpr6sSznMpDqiZitUOpVvVDJRCOZfe3VmReU%3D&se=2019-12-05T19%3A53%3A49Z&sp=r","modifiedSwaggerUrl":"https://paeu2weu8.blob.core.windows.net/api-swagger-files/my-20connector-5f0027f520b23e81c1-5f9888a90360086012.json?sv=2018-03-28&sr=b&sig=rkpKHP8K%2F2yNBIUQcVN%2B0ZPjnP9sECrM%2FfoZMG%2BJZX0%3D&se=2019-12-05T19%3A53%3A49Z&sp=r"},"createdBy":{"id":"03043611-d01e-4e58-9fbe-1a18ecb861d8","displayName":"MOD Administrator","email":"admin@contoso.OnMicrosoft.com","type":"User","tenantId":"0d645e38-ec52-4a4f-ac58-65f2ac4015f6","userPrincipalName":"admin@contoso.onmicrosoft.com"},"modifiedBy":{"id":"03043611-d01e-4e58-9fbe-1a18ecb861d8","displayName":"MOD Administrator","email":"admin@contoso.OnMicrosoft.com","type":"User","tenantId":"0d645e38-ec52-4a4f-ac58-65f2ac4015f6","userPrincipalName":"admin@contoso.onmicrosoft.com"},"createdTime":"2019-12-05T18:45:03.4615313Z","changedTime":"2019-12-05T18:45:03.4615313Z","environment":{"id":"/providers/Microsoft.PowerApps/environments/Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6","name":"Default-0d645e38-ec52-4a4f-ac58-65f2ac4015f6"},"tier":"Standard","publisher":"MOD Administrator","almMode":"Environment"}
+    ```

package/docs/docs/cmd/pa/environment/environment-get.md

@@ -10,8 +10,8 @@ m365 pa environment get [options]
 
 ## Options
 
-`-n, --name <name>`
-: The name of the environment to get information about
+`-n, --name [name]`
+: The name of the environment. When not specified, the default environment is retrieved.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -24,6 +24,12 @@ If the environment with the name you specified doesn't exist, you will get the `
 
 ## Examples
 
+Get information about the default Power Apps environment
+
+```sh
+m365 pa environment get
+```
+
 Get information about the Power Apps environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
 
 ```sh
@@ -141,4 +147,22 @@ m365 pa environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
     name,id,location,displayName,provisioningState,environmentSku,azureRegionHint,isDefault
     Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,/providers/Microsoft.PowerApps/environments/Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,europe,environmentName (default),Succeeded,Default,westeurope,1
     ```
+    
+=== "Markdown"
 
+    ```md
+    # pa environment get --name "Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d"
+
+    Date: 9/1/2023
+
+    ## environmentName (default) (org6633050c) (/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
+
+    Property | Value
+    ---------|-------
+    id | /providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
+    name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
+    location | europe
+    type | Microsoft.PowerApps/environments
+    properties | {"azureRegionHint":"westeurope","displayName":"contoso (default) (org6633049a)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"Production","isDefault":true,"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"Dynamics365Instance","resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","modifiedTime":"2022-10-29T14:04:14.0720726Z","hostNameSuffix":"crm4.dynamics.com","bapSolutionId":"00000001-0000-0000-0001-00000000009b","creationTemplates":["D365_CDS"],"webApiVersion":"v9.0","platformSku":"Standard"},"retentionPeriod":"P7D","lifecycleAuthority":"Environment","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"connectedGroups":[],"protectionStatus":{"keyManagedBy":"Microsoft"},"trialScenarioType":"None","cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
+    displayName | contoso (default) (org6633049a)
+    ```

package/docs/docs/cmd/pa/environment/environment-list.md

@@ -133,3 +133,22 @@ m365 pa environment list
     name,displayName
     Default-e1dd4030-a657-480a-8a0e-c1b1eec51e2e,environmentName (default) (org6633050c)
     ```
+
+=== "Markdown"
+
+    ```md
+    # pa environment list
+
+    Date: 9/1/2023
+
+    ## environmentName (default) (org6633050c) (/providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d)
+
+    Property | Value
+    ---------|-------
+    id | /providers/Microsoft.PowerApps/environments/Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
+    name | Default-e1dd4023-a656-480a-8a0e-c1b1eec51e1d
+    location | europe
+    type | Microsoft.PowerApps/environments
+    properties | {"azureRegionHint":"westeurope","displayName":"contoso (default) (org6633049a)","createdTime":"2020-03-12T13:39:17.9876946Z","createdBy":{"id":"SYSTEM","displayName":"SYSTEM","type":"NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"Production","isDefault":true,"runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://europe.api.bap.microsoft.com","microsoft.CommonDataModel":"https://europe.api.cds.microsoft.com","microsoft.PowerApps":"https://europe.api.powerapps.com","microsoft.PowerAppsAdvisor":"https://europe.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.eu-il109.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.EUROPE.azure-apihub.net","microsoft.Flow":"https://emea.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"Dynamics365Instance","resourceId":"5041ef46-5a1c-4a0f-a185-6bb49b5c6686","friendlyName":"contoso (default)","uniqueName":"unq5041ef465a1c4a0fa1856bb49b5c6","domainName":"org6633049a","version":"9.2.22101.00168","instanceUrl":"https://org6633049a.crm4.dynamics.com/","instanceApiUrl":"https://org6633049a.api.crm4.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2021-10-08T09:50:41.283Z","modifiedTime":"2022-10-29T14:04:14.0720726Z","hostNameSuffix":"crm4.dynamics.com","bapSolutionId":"00000001-0000-0000-0001-00000000009b","creationTemplates":["D365_CDS"],"webApiVersion":"v9.0","platformSku":"Standard"},"retentionPeriod":"P7D","lifecycleAuthority":"Environment","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"updateCadence":{"id":"Frequent"},"connectedGroups":[],"protectionStatus":{"keyManagedBy":"Microsoft"},"trialScenarioType":"None","cluster":{"category":"Prod","number":"109","uriSuffix":"eu-il109.gateway.prod.island","geoShortName":"EU","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
+    displayName | contoso (default) (org6633049a)
+    ```

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

@@ -11,39 +11,53 @@ m365 planner plan get [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 that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
 
 `--ownerGroupName [ownerGroupName]`
-: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title`.
+: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! 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
 
-Returns the Microsoft Planner plan with id _gndWOTSK60GfPQfiDDj43JgACDCb_
+Returns the Microsoft Planner plan by id
 
 ```sh
 m365 planner plan get --id "gndWOTSK60GfPQfiDDj43JgACDCb"
 ```
 
-Returns the Microsoft Planner plan with title _MyPlan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
+Returns the Microsoft Planner plan by title and owner group id 
 
 ```sh
 m365 planner plan get --title "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
 ```
 
-Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Group_
+Returns the Microsoft Planner plan by title and owner group name
 
 ```sh
 m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
 ```
 
+Returns the Microsoft Planner plan by roster id
+
+```sh
+m365 planner plan get --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
+```
+
 ## Response
 
 === "JSON"

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

@@ -11,13 +11,21 @@ m365 planner plan list [options]
 ## Options
 
 `--ownerGroupId [ownerGroupId]`
-: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
+: ID of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
 
 `--ownerGroupName [ownerGroupName]`
-: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
+: Name of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
+
+`--rosterId [rosterId]`
+: ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId`.
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! 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
 
 Returns a list of Microsoft Planner plans for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
@@ -32,6 +40,12 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
 m365 planner plan list --ownerGroupName "My Planner Group"
 ```
 
+Returns a list of Microsoft Planner plans for Roster _FeMZFDoK8k2oWmuGE-XFHZcAEwtn_
+
+```sh
+m365 planner plan list --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
+```
+
 ## Response
 
 === "JSON"

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.