@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.1da0a1d

package/docs/docs/cmd/spo/web/web-reindex.md

@@ -10,7 +10,7 @@ m365 spo web reindex [options]
 
 ## Options
 
-`-u, --webUrl <webUrl>`
+`-u, --url <url>`
 : URL of the subsite to reindex
 
 --8<-- "docs/cmd/_global.md"
@@ -24,5 +24,9 @@ If the subsite to be reindexed is a no-script site, the command will request rei
 Request reindexing the subsite _https://contoso.sharepoint.com/subsite_
 
 ```sh
-m365 spo web reindex --webUrl https://contoso.sharepoint.com/subsite
+m365 spo web reindex --url https://contoso.sharepoint.com/subsite
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/web/web-remove.md

@@ -10,7 +10,7 @@ m365 spo web remove [options]
 
 ## Options
 
-`-u, --webUrl <webUrl>`
+`-u, --url <url>`
 : URL of the subsite to remove
 
 `--confirm`
@@ -23,5 +23,9 @@ m365 spo web remove [options]
 Delete subsite without prompting for confirmation
 
 ```sh
-m365 spo web remove --webUrl https://contoso.sharepoint.com/subsite --confirm
+m365 spo web remove --url https://contoso.sharepoint.com/subsite --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/web/web-roleassignment-add.md

@@ -0,0 +1,61 @@
+# spo web roleassignment add
+
+Adds a role assignment to web permissions.
+
+## Usage
+
+```sh
+m365 spo web roleassignment add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--upn [upn]`
+: upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--groupName [groupName]`
+: enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--roleDefinitionId [roleDefinitionId]`
+: ID of role definition. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
+
+`--roleDefinitionName [roleDefinitionName]`
+: enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either `roleDefinitionId` or `roleDefinitionName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition id _1073741829_
+
+```sh
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionId 1073741829
+```
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for upn _someaccount@tenant.onmicrosoft.com_ and role definition id _1073741829_
+
+```sh
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --upn "someaccount@tenant.onmicrosoft.com" --roleDefinitionId 1073741829
+```
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for group _someGroup_ and role definition id _1073741829_
+
+```sh
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --groupName "someGroup" --roleDefinitionId 1073741829
+```
+
+add role assignment to site _https://contoso.sharepoint.com/sites/project-x_for principal id _11_ and role definition name _Full Control_
+
+```sh
+m365 spo web roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --principalId 11 --roleDefinitionName "Full Control"
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/web/web-roleassignment-remove.md

@@ -0,0 +1,58 @@
+# spo web roleassignment remove
+
+Removes a role assignment from web permissions.
+
+## Usage
+
+```sh
+m365 spo web roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`--principalId [principalId]`
+: SharePoint ID of principal it may be either user id or group id we want to add permissions to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--upn [upn]`
+: Upn/email of user to assign role to. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--groupName [groupName]`
+: Enter group name of Azure AD or SharePoint group. Specify either `principalId`, `upn`, or `groupName` but not multiple.
+
+`--confirm [confirm]`
+: Don't prompt for confirming removing the roleassignment.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove roleassignment from web based on group name
+
+```sh
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --groupName "saleGroup"
+```
+
+Remove roleassignment from web based on principal Id
+
+```sh
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2
+```
+
+Remove roleassignment from web based on upn
+
+```sh
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --upn "someaccount@tenant.onmicrosoft.com"
+```
+
+Remove roleassignment from web based on principal Id without prompting for confirmation
+
+```sh
+m365 spo web roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"  --principalId 2 --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/web/web-roleinheritance-break.md

@@ -0,0 +1,44 @@
+# spo web roleinheritance break
+
+Break role inheritance of subsite
+
+## Usage
+
+```sh
+m365 spo web roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`-c, --clearExistingPermissions`
+: Clears all existing permissions from the web.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+By default, when breaking permissions inheritance, the web will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
+
+## Examples
+
+Break role inheritance of a web and keep the existing permissions
+
+```sh
+m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+Break role inheritance of a web and clear the existing permissions
+
+```sh
+m365 spo web roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --clearExistingPermissions
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/web/web-roleinheritance-reset.md

@@ -0,0 +1,37 @@
+# spo web roleinheritance reset
+
+Restores role inheritance of subsite.
+
+## Usage
+
+```sh
+m365 spo web roleinheritance reset [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site
+
+`--confirm`
+: Do not prompt for confirmation before resetting role inheritance.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Restore role inheritance of subsite _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo web roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+Restore role inheritance of subsite _https://contoso.sharepoint.com/sites/project-x_ without prompting for confirmation
+
+```sh
+m365 spo web roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/web/web-set.md

@@ -10,7 +10,7 @@ m365 spo web set [options]
 
 ## Options
 
-`-u, --webUrl <webUrl>`
+`-u, --url <url>`
 : URL of the subsite to update
 
 `-t, --title [title]`
@@ -54,51 +54,55 @@ Next to updating web properties corresponding to the options of this command, yo
 Update subsite title
 
 ```sh
-m365 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --title Team-a
+m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --title Team-a
 ```
 
 Hide quick launch on the subsite
 
 ```sh
-m365 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --quickLaunchEnabled false
+m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --quickLaunchEnabled false
 ```
 
 Set site header layout to compact
 
 ```sh
-m365 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --headerLayout compact
+m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --headerLayout compact
 ```
 
 Set site header color to primary theme background color
 
 ```sh
-m365 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --headerEmphasis 0
+m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --headerEmphasis 0
 ```
 
 Enable megamenu in the site
 
 ```sh
-m365 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --megaMenuEnabled true
+m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --megaMenuEnabled true
 ```
 
 Hide footer in the site
 
 ```sh
-m365 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --footerEnabled false
+m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --footerEnabled false
 ```
 
 Set search scope to tenant scope
 
 ```sh
-m365 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --searchScope tenant
+m365 spo web set --url https://contoso.sharepoint.com/sites/team-a --searchScope tenant
 ```
 
 Set welcome page for the web
 
 ```sh
-m365 spo web set  --webUrl https://contoso.sharepoint.com/sites/team-a --welcomePage "SitePages/new-home.aspx"
+m365 spo web set  --url https://contoso.sharepoint.com/sites/team-a --welcomePage "SitePages/new-home.aspx"
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
 - Web properties: [https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee545886(v=office.15)](https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee545886(v=office.15))

package/docs/docs/cmd/teams/app/app-install.md

@@ -10,7 +10,7 @@ m365 teams app install [options]
 
 ## Options
 
-`--appId <appId>`
+`--id <id>`
 : The ID of the app to install
 
 `--teamId [teamId]`
@@ -26,24 +26,28 @@ m365 teams app install [options]
 
 ## Remarks
 
-The `appId` has to be the ID of the app from the Microsoft Teams App Catalog. Do not use the ID from the manifest of the zip app package. Use the [teams app list](./app-list.md) command to get this ID instead.
+The `id` has to be the ID of the app from the Microsoft Teams App Catalog. Do not use the ID from the manifest of the zip app package. Use the [teams app list](./app-list.md) command to get this ID instead.
 
 ## Examples
 
 Install an app from the catalog in a Microsoft Teams team
 
 ```sh
-m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
+m365 teams app install --id 4440558e-8c73-4597-abc7-3644a64c4bce --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
 ```
 
 Install a personal app for the user specified using their user name
 
 ```sh
-m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --userName steve@contoso.com
+m365 teams app install --id 4440558e-8c73-4597-abc7-3644a64c4bce --userName steve@contoso.com
 ```
 
 Install a personal app for the user specified using their ID
 
 ```sh
-m365 teams app install --appId 4440558e-8c73-4597-abc7-3644a64c4bce --userId 2609af39-7775-4f94-a3dc-0dd67657e900
+m365 teams app install --id 4440558e-8c73-4597-abc7-3644a64c4bce --userId 2609af39-7775-4f94-a3dc-0dd67657e900
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -1,6 +1,6 @@
 # teams app list
 
-Lists apps from the Microsoft Teams app catalog or apps installed in the specified team
+Lists apps from the Microsoft Teams app catalog
 
 ## Usage
 
@@ -10,43 +10,51 @@ m365 teams app list [options]
 
 ## Options
 
-`-a, --all`
-: Specify, to get apps from your organization only
-
-`-i, --teamId [teamId]`
-: The ID of the team for which to list installed apps. Specify either `teamId` or `teamName` but not both
-
-`-t, --teamName [teamName]`
-: The display name of the team for which to list installed apps. Specify either `teamId` or `teamName` but not both
+`--distributionMethod [distributionMethod]`
+: The distribution method. Allowed values `store`, `organization`, `sideloaded`.
 
 --8<-- "docs/cmd/_global.md"
 
-## Remarks
-
-To list apps installed in the specified Microsoft Teams team, specify that team's ID using the `teamId` option. If the `teamId` option is not specified, the command will list apps available in the Teams app catalog.
-
 ## Examples
 
-List all Microsoft Teams apps from your organization's app catalog only
+List all apps from the Microsoft Teams app catalog
 
 ```sh
 m365 teams app list
 ```
 
-List all apps from the Microsoft Teams app catalog and the Microsoft Teams store
+List all apps from the Microsoft Teams app catalog according to a given distribution method
 
 ```sh
-m365 teams app list --all
+m365 teams app list --distributionMethod 'store'
 ```
 
-List your organization's apps installed in the specified Microsoft Teams team with id _6f6fd3f7-9ba5-4488-bbe6-a789004d0d55_
+## Response
 
-```sh
-m365 teams app list --teamId 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
-```
+=== "JSON"
 
-List your organization's apps installed in the specified Microsoft Teams team with name _Team Name_
+    ```json
+    [
+      {
+        "id": "ffdb7239-3b58-46ba-b108-7f90a6d8799b",
+        "externalId": null,
+        "displayName": "Contoso App",
+        "distributionMethod": "store"
+      }
+    ]
+    ```
 
-```sh
-m365 teams app list --teamName "Team Name"
-```
+=== "Text"
+
+    ```text
+    id                                                        displayName                       distributionMethod
+    --------------------------------------------------------  --------------------------------  ------------------
+    ffdb7239-3b58-46ba-b108-7f90a6d8799b                      Contoso App                       store
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,distributionMethod
+    ffdb7239-3b58-46ba-b108-7f90a6d8799b,Contoso App,store
+    ```

package/docs/docs/cmd/teams/app/app-publish.md

@@ -17,7 +17,8 @@ m365 teams app publish [options]
 
 ## Remarks
 
-You can only publish a Teams app as a global administrator.
+!!! important
+    To use this command you must be a Global administrator.
 
 ## Examples
 
@@ -26,3 +27,32 @@ Add the _teams-manifest.zip_ file to the organization's app catalog
 ```sh
 m365 teams app publish --filePath ./teams-manifest.zip
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+        "id": "e3e29acb-8c79-412b-b746-e6c39ff4cd22",
+        "externalId": "b5561ec9-8cab-4aa3-8aa2-d8d7172e4311",
+        "displayName": "Test App",
+        "distributionMethod": "organization"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    displayName       : Test App
+    distributionMethod: organization
+    externalId        : b5561ec9-8cab-4aa3-8aa2-d8d7172e4311
+    id                : e3e29acb-8c79-412b-b746-e6c39ff4cd22
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,externalId,displayName,distributionMethod
+    e3e29acb-8c79-412b-b746-e6c39ff4cd22,b5561ec9-8cab-4aa3-8aa2-d8d7172e4311,Test App,organization
+    ```

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

@@ -35,3 +35,7 @@ Remove the Teams app with ID _83cece1e-938d-44a1-8b86-918cf6151957_ from the org
 ```sh
 m365 teams app remove --id 83cece1e-938d-44a1-8b86-918cf6151957 --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/app/app-uninstall.md

@@ -10,7 +10,7 @@ m365 teams app uninstall [options]
 
 ## Options
 
-`--appId <appId>`
+`--id <id>`
 : The unique id of the app instance installed in the Microsoft Teams team
 
 `--teamId <teamId>`
@@ -23,7 +23,7 @@ m365 teams app uninstall [options]
 
 ## Remarks
 
-The `appId` has to be the id the app instance installed in the Microsoft Teams team.
+The `id` has to be the id the app instance installed in the Microsoft Teams team.
 Do not use the ID from the manifest of the zip app package or the id from the Microsoft Teams App Catalog.
 
 ## Examples
@@ -31,5 +31,9 @@ Do not use the ID from the manifest of the zip app package or the id from the Mi
 Uninstall an app from a Microsoft Teams team
 
 ```sh
-m365 teams app uninstall --appId YzUyN2E0NzAtYTg4Mi00ODFjLTk4MWMtZWU2ZWZhYmE4NWM3IyM0ZDFlYTA0Ny1mMTk2LTQ1MGQtYjJlOS0wZDI4NTViYTA1YTY= --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
+m365 teams app uninstall --id YzUyN2E0NzAtYTg4Mi00ODFjLTk4MWMtZWU2ZWZhYmE4NWM3IyM0ZDFlYTA0Ny1mMTk2LTQ1MGQtYjJlOS0wZDI4NTViYTA1YTY= --teamId 2609af39-7775-4f94-a3dc-0dd67657e900
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/teams/app/app-update.md

@@ -38,3 +38,7 @@ Update the Teams app with name _Test app_ from file _teams-manifest.zip_
 ```sh
 m365 teams app update --name "Test app" --filePath ./teams-manifest.zip
 ```
+
+## Response
+
+The command won't return a response on success.

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

@@ -41,6 +41,10 @@ Removes the Microsoft Teams client cache
 m365 teams cache remove
 ```
 
+## Response
+
+The command won't return a response on success.
+
 ## More information
 
-- [Clear the Teams client cache guidance](https://docs.microsoft.com/microsoftteams/troubleshoot/teams-administration/clear-teams-cache)
+- [Clear the Teams client cache guidance](https://docs.microsoft.com/microsoftteams/troubleshoot/teams-administration/clear-teams-cache)

package/docs/docs/cmd/teams/channel/channel-add.md

@@ -23,10 +23,10 @@ m365 teams channel add [options]
 : The description of the channel to add
 
 `--type [type]`
-: Type of channel to create: `standard,private`. Default `standard`.
+: Type of channel to create: `standard`, `private`, `shared`. Default `standard`.
 
 `--owner [owner]`
-: User with this ID or UPN will be added as owner of the private channel. This option is required when type is `private`.
+: User with this ID or UPN will be added as owner of the channel. This option is required when type is `private` or `shared`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -54,8 +54,45 @@ Add private channel to the specified Microsoft Teams team with owner UPN
 m365 teams channel add --teamName "Team Name" --name climicrosoft365 --type private --owner john.doe@contoso.com
 ```
 
-Add private channel to the specified Microsoft Teams team with owner ID
+Add shared channel to the specified Microsoft Teams team with owner ID
 
 ```sh
-m365 teams channel add --teamId 6703ac8a-c49b-4fd4-8223-28f0ac3a6402 --name climicrosoft365 --type private --owner cc693a7d-4833-4911-a89a-f0fe6e49bf69
-```
+m365 teams channel add --teamId 6703ac8a-c49b-4fd4-8223-28f0ac3a6402 --name climicrosoft365 --type shared --owner cc693a7d-4833-4911-a89a-f0fe6e49bf69
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "19:591922f67c4341eeb15e49c791822bfe@thread.tacv2",
+      "createdDateTime": "2022-11-05T10:02:44.3930065Z",
+      "displayName": "climicrosoft365",
+      "description": null,
+      "isFavoriteByDefault": false,
+      "email": "",
+      "webUrl": "https://teams.microsoft.com/l/channel/19%3a591922f67c4341eeb15e49c791822bfe%40thread.tacv2/climicrosoft365?groupId=6703ac8a-c49b-4fd4-8223-28f0ac3a6402&tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b",
+      "membershipType": "standard"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdDateTime    : 2022-11-05T10:05:31.3998293Z
+    description        : null
+    displayName        : climicrosoft365
+    email              :
+    id                 : 19:591922f67c4341eeb15e49c791822bfe@thread.tacv2
+    isFavoriteByDefault: false
+    membershipType     : standard
+    webUrl             : https://teams.microsoft.com/l/channel/19%3a591922f67c4341eeb15e49c791822bfe%40thread.tacv2/climicrosoft365?groupId=6703ac8a-c49b-4fd4-8223-28f0ac3a6402&tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,createdDateTime,displayName,description,isFavoriteByDefault,email,webUrl,membershipType
+    19:591922f67c4341eeb15e49c791822bfe@thread.tacv2,2022-11-05T12:34:59.6583728Z,climicrosoft365,,,,https://teams.microsoft.com/l/channel/19%3a591922f67c4341eeb15e49c791822bfe%40thread.tacv2/climicrosoft365?groupId=6703ac8a-c49b-4fd4-8223-28f0ac3a6402&tenantId=446355e4-e7e3-43d5-82f8-d7ad8272d55b,standard
+    ```