@pnp/cli-microsoft365 5.4.0-beta.fb9344d → 5.5.0-beta.10c7ae2

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

@@ -17,16 +17,19 @@ m365 planner task list [options]
 : Name of the bucket to list the tasks of. To retrieve tasks from a bucket, specify `bucketId` or `bucketName`, but not both.
 
 `--planId [planId]`
-: ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
+: ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
+
+`--planTitle [planTitle]`
+: Title of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
 
 `--planName [planName]`
-: Name of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planName` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
+: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
 
 `--ownerGroupId [ownerGroupId]`
-: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
 
 `--ownerGroupName [ownerGroupName]`
-: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -52,7 +55,7 @@ m365 planner task list --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"`
 List the Microsoft Planner tasks in the plan _My Plan_ in group _My Group_
 
 ```sh
-m365 planner task list --planName "My Plan" --ownerGroupName "My Group"
+m365 planner task list --planTitle "My Plan" --ownerGroupName "My Group"
 ```
 
 List the Microsoft Planner tasks in the bucket _FtzysDykv0-9s9toWiZhdskAD67z_
@@ -70,5 +73,5 @@ m365 planner task list --bucketName "My Bucket" --planId "iVPMIgdku0uFlou-KLNg6M
 List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My Plan_ in group _My Group_
 
 ```sh
-m365 planner task list --bucketName "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
+m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
 ```

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

@@ -23,16 +23,19 @@ m365 planner task set [options]
 : Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` when using `title`.
 
 `--planId [planId]`
-: ID of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
+: ID of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
+
+`--planTitle [planTitle]`
+: Title of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
 
 `--planName [planName]`
-: Name of the plan to which the bucket belongs to. Specify either `planId` or `planName` when using `bucketName`.
+: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
 
 `--ownerGroupId [ownerGroupId]`
-: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
 
 `--ownerGroupName [ownerGroupName]`
-: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
 
 `--startDateTime [startDateTime]`
 : The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
@@ -91,10 +94,10 @@ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the
 m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
 ```
 
-Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
+Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_
 
 ```sh
-m365 planner task set  --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
+m365 planner task set  --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
 ```
 
 Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.

package/docs/docs/cmd/planner/tenant/tenant-settings-set.md

@@ -0,0 +1,56 @@
+# planner tenant settings set
+
+Sets Microsoft Planner configuration of the tenant
+
+## Usage
+
+```sh
+m365 planner tenant settings set [options]
+```
+
+## Options
+
+`--isPlannerAllowed [isPlannerAllowed]`
+: Configure whether Planner should be enabled on the tenant.
+
+`--allowCalendarSharing [allowCalendarSharing]`
+: Configure whether Outlook calendar sync is enabled.
+
+`--allowTenantMoveWithDataLoss [allowTenantMoveWithDataLoss]`
+: Configure whether a tenant move into a new region is authorized.
+
+`--allowTenantMoveWithDataMigration [allowTenantMoveWithDataMigration]`
+: Configure whether a tenant move with data migration is authorized.
+
+`--allowRosterCreation [allowRosterCreation]`
+: Configure whether Planner roster creation is allowed.
+
+`--allowPlannerMobilePushNotifications [allowPlannerMobilePushNotifications]`
+: Configure whether push notifications are enabled in the mobile app.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a global administrator.
+
+## Examples
+
+Disable Microsoft Planner in the tenant
+
+```sh
+m365 planner tenant settings set --isPlannerAllowed false
+```
+
+Disable Outlook calendar sync and mobile push notifications
+
+```sh
+m365 planner tenant settings set --allowCalendarSharing false --allowPlannerMobilePushNotifications false
+```
+
+Enable Microsoft Planner but disallow roster plans to be created
+
+```sh
+m365 planner tenant settings set --isPlannerAllowed true --allowRosterCreation false
+```

package/docs/docs/cmd/search/externalconnection/externalconnection-get.md

@@ -0,0 +1,33 @@
+# search externalconnection get
+
+Allow the administrator to get a specific external connection for use in Microsoft Search.
+
+## Usage
+
+```sh
+m365 search externalconnection get [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the External Connection to get. Specify either `id` or `name`
+
+`-n, --name [name]`
+: Name of the External Connection to get. Specify either `id` or `name`
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get the External Connection by its id
+
+```sh
+m365 search externalconnection get --id "MyApp"
+```
+
+Get the External Connection by its name
+
+```sh
+m365 search externalconnection get --name "Test"
+```

package/docs/docs/cmd/spfx/project/project-upgrade.md

@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
 
 ## Remarks
 
-The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.14.0). If you specify the `preview` option without a specific version, the command will upgrade your project to the latest preview version v1.15.0-rc.0.
+The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.15.0).
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
 

package/docs/docs/cmd/spo/hubsite/hubsite-get.md

@@ -10,17 +10,16 @@ m365 spo hubsite get [options]
 
 ## Options
 
-`-i, --id <id>`
-: Hub site ID
+`-i, --id [id]`
+: ID of the hubsite. Specify either `id`, `title` or `url` but not multiple.
 
---8<-- "docs/cmd/_global.md"
-
-## Remarks
+`-t, --title [title]`
+: Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
 
-!!! attention
-    This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+`-u, --url [url]`
+: URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
 
-If the specified `id` doesn't refer to an existing hub site, you will get a `ResourceNotFoundException` error.
+--8<-- "docs/cmd/_global.md"
 
 ## Examples
 
@@ -30,6 +29,18 @@ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
 m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
 ```
 
+Get information about the hub site with Title _My Hub Site_
+
+```sh
+m365 spo hubsite get --title 'My Hub Site'
+```
+
+Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
+
+```sh
+m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
+```
+
 ## More information
 
 - SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)

package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md

@@ -0,0 +1,27 @@
+# spo roledefinition get
+
+Gets specified role definition from web by id
+
+## Usage
+
+```sh
+m365 spo roledefinition get [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve the role definition
+
+`-i, --id <id>`
+: The Id of the role definition to retrieve.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with id _1_
+
+```sh
+m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
+```

package/docs/docs/cmd/teams/cache/cache-remove.md

@@ -0,0 +1,46 @@
+# teams cache remove
+
+Removes the Microsoft Teams client cache
+
+## Usage
+
+```sh
+m365 teams cache remove [options]
+```
+
+## Options
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+This command will execute the following steps.
+
+- Stop the Microsoft Teams client. This will kill all the running `Teams.exe` tasks.
+
+- Clear the Microsoft Teams cached files. For Windows it will delete all files and folders in the %appdata%\Microsoft\Teams directory. For macOS it will delete all files and folders in the  ~/Library/Application Support/Microsoft/Teams directory.
+
+!!! important
+    - You won't lose any user data by clearing the cache.
+    - Restarting Teams after you clear the cache might take longer than usual because the Teams cache files have to be rebuilt.
+
+If you run the command in the CLI Docker container, you will get the following error message:
+
+> Because you're running CLI for Microsoft 365 in a Docker container, we can't clear the cache on your host. Instead run this command on your host using 'npx ...'.
+
+The command works only on Windows and macOS. If you run it on a different operating system, you will get the `'abc' platform is unsupported for this command` error.
+
+## Examples
+
+Removes the Microsoft Teams client cache
+
+```sh
+m365 teams cache remove
+```
+
+## More information
+
+- [Clear the Teams client cache guidance](https://docs.microsoft.com/microsoftteams/troubleshoot/teams-administration/clear-teams-cache)

package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md

@@ -16,7 +16,7 @@ m365 tenant serviceannouncement health get [options]
 `-i, --issues`
 : Return the collection of issues that happened on the service, with detailed information for each issue. Is only returned in JSON output mode.
 
---8<-- "docs/cmd/\_global.md"
+--8<-- "docs/cmd/_global.md"
 
 ## Examples
 

package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md

@@ -13,7 +13,7 @@ m365 tenant serviceannouncement healthissue list [options]
 `-s, --service [service]`
 : Retrieve service health issues for the particular service. If not provided, retrieves health issues for all services
 
---8<-- "docs/cmd/\_global.md"
+--8<-- "docs/cmd/_global.md"
 
 ## Examples
 

package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md

@@ -13,7 +13,7 @@ m365 tenant serviceannouncement message list [options]
 `-s, --service [service]`
 : Retrieve service update messages for the particular service. If not provided, retrieves messages for all services
 
---8<-- "docs/cmd/\_global.md"
+--8<-- "docs/cmd/_global.md"
 
 ## Examples
 

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "5.4.0",
+  "version": "5.5.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@pnp/cli-microsoft365",
-      "version": "5.4.0",
+      "version": "5.5.0",
       "license": "MIT",
       "dependencies": {
         "@azure/msal-node": "^1.9.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "5.4.0-beta.fb9344d",
+  "version": "5.5.0-beta.10c7ae2",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",

package/dist/m365/planner/commands/plan/plan-details-get.js

@@ -1,116 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../../../../utils");
-const Auth_1 = require("../../../../Auth");
-const request_1 = require("../../../../request");
-const planner_1 = require("../../../../utils/planner");
-const GraphCommand_1 = require("../../../base/GraphCommand");
-const commands_1 = require("../../commands");
-const aadGroup_1 = require("../../../../utils/aadGroup");
-class PlannerPlanDetailsGetCommand extends GraphCommand_1.default {
-    constructor() {
-        super(...arguments);
-        this.groupId = '';
-    }
-    get name() {
-        return commands_1.default.PLAN_DETAILS_GET;
-    }
-    get description() {
-        return 'Get details of a Microsoft Planner plan';
-    }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.planId = typeof args.options.planId !== 'undefined';
-        telemetryProps.planTitle = typeof args.options.planTitle !== 'undefined';
-        telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
-        telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
-        return telemetryProps;
-    }
-    commandAction(logger, args, cb) {
-        if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
-            this.handleError('This command does not support application permissions.', logger, cb);
-            return;
-        }
-        this
-            .getGroupId(args)
-            .then((groupId) => {
-            this.groupId = groupId;
-            return this.getPlanId(args);
-        })
-            .then((planId) => {
-            args.options.planId = planId;
-            return this.getPlanDetails(args);
-        })
-            .then((res) => {
-            logger.log(res);
-            cb();
-        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
-    }
-    getGroupId(args) {
-        if (args.options.planId) {
-            return Promise.resolve('');
-        }
-        if (args.options.ownerGroupId) {
-            return Promise.resolve(args.options.ownerGroupId);
-        }
-        return aadGroup_1.aadGroup
-            .getGroupByDisplayName(args.options.ownerGroupName)
-            .then(group => group.id);
-    }
-    getPlanId(args) {
-        if (args.options.planId) {
-            return Promise.resolve(args.options.planId);
-        }
-        return planner_1.planner
-            .getPlanByName(args.options.planTitle, this.groupId)
-            .then(plan => plan.id);
-    }
-    getPlanDetails(args) {
-        const requestOptions = {
-            url: `${this.resource}/v1.0/planner/plans/${args.options.planId}/details`,
-            headers: {
-                'accept': 'application/json;odata.metadata=none'
-            },
-            responseType: 'json'
-        };
-        return request_1.default.get(requestOptions);
-    }
-    options() {
-        const options = [
-            {
-                option: '-i, --planId [planId]'
-            },
-            {
-                option: '-t, --planTitle [planTitle]'
-            },
-            {
-                option: '--ownerGroupId [ownerGroupId]'
-            },
-            {
-                option: '--ownerGroupName [ownerGroupName]'
-            }
-        ];
-        const parentOptions = super.options();
-        return options.concat(parentOptions);
-    }
-    validate(args) {
-        if (!args.options.planId && !args.options.planTitle) {
-            return 'Specify either planId or planTitle';
-        }
-        if (args.options.planId && args.options.planTitle) {
-            return 'Specify either planId or planTitle';
-        }
-        if (args.options.planTitle && !args.options.ownerGroupId && !args.options.ownerGroupName) {
-            return 'Specify either ownerGroupId or ownerGroupName';
-        }
-        if (args.options.planTitle && args.options.ownerGroupId && args.options.ownerGroupName) {
-            return 'Specify either ownerGroupId or ownerGroupName but not both';
-        }
-        if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
-            return `${args.options.ownerGroupId} is not a valid GUID`;
-        }
-        return true;
-    }
-}
-module.exports = new PlannerPlanDetailsGetCommand();
-//# sourceMappingURL=plan-details-get.js.map

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

@@ -1,45 +0,0 @@
-# planner plan details get
-
-Retrieve the planner details about the specified plan.
-
-## Usage
-
-```sh
-m365 planner plan details get [options]
-```
-
-## Options
-
-`-i, --planId [planId]`
-: ID of the plan. Specify either `planId` or `planTitle` but not both.
-
-`-t, --planTitle [planTitle]`
-: Title of the plan. Specify either `planId` or `planTitle` but not both.
-
-`--ownerGroupId [ownerGroupId]`
-: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
-
-`--ownerGroupName [ownerGroupName]`
-: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Returns the Microsoft Planner plan details with id _gndWOTSK60GfPQfiDDj43JgACDCb_
-
-```sh
-m365 planner plan details get --planId "gndWOTSK60GfPQfiDDj43JgACDCb"
-```
-
-Returns the Microsoft Planner plan details with title _MyPlan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
-
-```sh
-m365 planner plan details get --planTitle "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
-```
-
-Returns the Microsoft Planner plan details with title _MyPlan_ for Group _My Planner Group_
-
-```sh
-m365 planner plan details get --planTitle "MyPlan" --ownerGroupName "My Planner Group"
-```