@pnp/cli-microsoft365 5.5.0-beta.5a6c547 → 5.5.0-beta.6fb46e0

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/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/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/listitem/listitem-get.md

@@ -27,6 +27,10 @@ m365 spo listitem get [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
+
 ## Examples
 
 Get an item with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
@@ -35,9 +39,14 @@ Get an item with ID _147_ from list with title _Demo List_ in site _https://cont
 m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-
-Get an items Title and Created column and with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+Get an items _Title_ and _Created_ column with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
 m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created"
 ```
+
+Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
+```

package/docs/docs/cmd/spo/listitem/listitem-list.md

@@ -46,6 +46,8 @@ m365 spo listitem list [options]
 
 `pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
 
+If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
+
 ## Examples
 
 Get all items from a list named Demo List
@@ -72,6 +74,12 @@ Get all items from list named _Demo List_. For each item, retrieve the value of
 m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
 ```
 
+Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_, _Modified_ fields, and the value of lookup field _Company_
+
+```sh
+m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"
+```
+
 From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
 
 ```sh

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/package.json

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