@pnp/cli-microsoft365 11.12.0-beta.8589b73 → 12.0.0-beta.8dff3ac

package/docs/docs/cmd/spo/list/list-view-set.mdx

@@ -48,6 +48,25 @@ When updating list view formatting for a view with the `--CustomFormatter` optio
 
 :::
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | SharePoint      | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions         |
+  |-----------------|---------------------|
+  | SharePoint      | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Update the title of the list view specified by its name

package/docs/docs/cmd/spo/list/list-webhook-add.mdx

@@ -39,6 +39,25 @@ m365 spo list webhook add [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Add a web hook to the list retrieved by Title located in a specific site with a specific notification url and the default expiration date

package/docs/docs/cmd/spo/list/list-webhook-get.mdx

@@ -37,6 +37,25 @@ m365 spo list webhook get [options]
 
 If the specified `id` doesn't refer to an existing webhook, you will get a `404 - "404 FILE NOT FOUND"` error.
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Return information about a specific webhook which belongs to a list retrieved by ID in a specific site

package/docs/docs/cmd/spo/list/list-webhook-list.mdx

@@ -30,6 +30,25 @@ m365 spo list webhook list [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions          |
+  |------------|----------------------|
+  | SharePoint | AllSites.FullControl |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions           |
+  |------------|-----------------------|
+  | SharePoint | Sites.FullControl.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 List all webhooks for a list with a specific ID in a specific site

package/docs/docs/cmd/spo/list/list-webhook-remove.mdx

@@ -1,4 +1,6 @@
 import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo list webhook remove
 
@@ -38,6 +40,25 @@ m365 spo list webhook remove [options]
 
 If the specified id doesn't refer to an existing webhook, you will get a `404 - "404 FILE NOT FOUND"` error.
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Remove webhook with a specific ID from a list retrieved by ID in a specific site

package/docs/docs/cmd/spo/list/list-webhook-set.mdx

@@ -1,4 +1,6 @@
 import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 
 # spo list webhook set
 
@@ -44,6 +46,25 @@ m365 spo list webhook set [options]
 
 If the specified `id` doesn't refer to an existing webhook, you will get a `404 - "404 FILE NOT FOUND"` error.
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Update the notification url of a webhook with a specific ID attached to a list with a specific ID in a specific site to a specific URL

package/docs/docs/cmd/spo/listitem/listitem-attachment-add.mdx

@@ -39,6 +39,25 @@ m365 spo listitem attachment add [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Add a new attachment to a list item from a local file by using list title

package/docs/docs/cmd/spo/listitem/listitem-attachment-get.mdx

@@ -36,6 +36,25 @@ m365 spo listitem attachment get [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions   |
+  |------------|---------------|
+  | SharePoint | AllSites.Read |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | Sites.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Get an attachment from a list item by using list title.

package/docs/docs/cmd/spo/listitem/listitem-attachment-list.mdx

@@ -33,6 +33,25 @@ m365 spo listitem attachment list [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions   |
+  |------------|---------------|
+  | SharePoint | AllSites.Read |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | Sites.Read.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Gets the attachments from list item with the specified listItemId in list with the specified title in the specified site.

package/docs/docs/cmd/spo/listitem/listitem-attachment-remove.mdx

@@ -39,6 +39,25 @@ m365 spo listitem attachment remove [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Remove an attachment from a list item using list tile.

package/docs/docs/cmd/spo/listitem/listitem-attachment-set.mdx

@@ -39,6 +39,25 @@ m365 spo listitem attachment set [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Update an attachment from a list item by using list title

package/docs/docs/cmd/spo/listitem/listitem-batch-remove.mdx

@@ -31,8 +31,8 @@ m365 spo listitem batch remove [options]
 `-i, --ids [ids]`
 : Comma separated list of list item IDs. Specify `filePath` or `ids`, but not both.
 
-`-r, --recycle`
-: Recycle the list items. Otherwise, they will be permanently deleted.
+`--permanent`
+: Permanently delete the list items instead of moving them to the recycle bin.
 
 `-f, --force`
 : Don't prompt for confirmation.
@@ -65,6 +65,12 @@ Remove a list of IDs from a list by specifying the IDs
 m365 spo listitem batch remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --ids "123,234,345"
 ```
 
+Permanently remove a list of IDs from a list.
+
+```sh
+m365 spo listitem batch remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --ids "123,234,345" --permanent
+```
+
 ## Response
 
 The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-get.mdx

@@ -33,8 +33,8 @@ m365 spo listitem get [options]
 `--listUrl [listUrl]`
 : Server- or site-relative URL of the list. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
 
-`-p, --properties [properties]`
-: Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested.
+`--fields [fields]`
+: Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested.
 
 `--withPermissions`
 : Set if you want to return associated roles and permissions.
@@ -44,7 +44,13 @@ m365 spo listitem get [options]
 
 ## Remarks
 
-If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
+:::note
+
+The `--properties` option has been renamed to `--fields`. If you use `--properties`, the command still works but shows a deprecation warning.
+
+:::
+
+If you want to specify a lookup type in the `fields` option, define which columns from the related list should be returned.
 
 ## Examples
 
@@ -63,19 +69,19 @@ m365 spo listitem get --listTitle "Demo List" --uniqueId "64dc28c4-3c43-45f6-ba6
 Get an item columns with the ID parameter from a given list in a given site.
 
 ```sh
-m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created"
+m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --fields "Title,Created"
 ```
 
 Get an item columns and lookup column with the ID parameter from a given list in a given site.
 
 ```sh
-m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
+m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --fields "Title,Created,Company/Title"
 ```
 
-Get an item with specific properties from a given list based on the server-relative URL in a specific site.
+Get an item with specific fields from a given list based on the server-relative URL in a specific site.
 
 ```sh
-m365 spo listitem get --listUrl /sites/project-x/documents --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
+m365 spo listitem get --listUrl /sites/project-x/documents --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --fields "Title,Created,Company/Title"
 ```
 
 Get an item with ID parameter from a given list based on the server-relative URL in a specific site with permissions.

package/docs/docs/cmd/spo/listitem/listitem-remove.mdx

@@ -28,8 +28,8 @@ m365 spo listitem remove [options]
 `--listUrl [listUrl]`
 : Server- or site-relative URL of the list. Specify either `listTitle`, `listId` or `listUrl`
 
-`--recycle`
-: Recycle the list item
+`--permanent`
+: Permanently delete the list item instead of moving it to the recycle bin.
 
 `-f, --force`
 : Don't prompt for confirming removing the list item
@@ -57,6 +57,12 @@ Remove the list item located in a given site based on the server-relative list u
 m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl /sites/project-x/lists/TestList --id 1
 ```
 
+Permanently remove a list item.
+
+```sh
+m365 spo listitem remove --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'List 1' --id 1 --permanent
+```
+
 ## Response
 
 The command won't return a response on success.

package/docs/docs/cmd/spo/page/page-header-set.mdx

@@ -22,7 +22,7 @@ m365 spo page header set [options]
 : URL of the site where the page to update is located.
 
 `-t, --type [type]`
-: Type of header, allowed values `None`, `Default`, `Custom`. Default `Default`.
+: Type of header, allowed values `None`, `Default`, `Custom`.
 
 `--imageUrl [imageUrl]`
 : Server-relative URL of the image to use in the header. Image must be stored in the same site collection as the page.
@@ -37,19 +37,19 @@ m365 spo page header set [options]
 : Y focal point of the header image.
 
 `--layout [layout]`
-: Layout to use in the header. Allowed values `FullWidthImage`, `NoImage`, `ColorBlock`, `CutInShape`. Default `FullWidthImage`.
+: Layout to use in the header. Allowed values `FullWidthImage`, `NoImage`, `ColorBlock`, `CutInShape`.
 
 `--textAlignment [textAlignment]`
-: How to align text in the header. Allowed values `Center`, `Left`. Default `Left`.
+: How to align text in the header. Allowed values `Center`, `Left`.
 
 `--showTopicHeader [showTopicHeader]`
-: Show the topic header. Valid values: `true`, `false`. Defaults to `false`.
+: Show the topic header. Valid values: `true`, `false`.
 
 `--showPublishDate [showPublishDate]`
-: Show the publishing date. Valid values: `true`, `false`. Defaults to `false`.
+: Show the publishing date. Valid values: `true`, `false`.
 
 `--showTimeToRead [showTimeToRead]`
-: Show the estimated time to read the page. Valid values: `true`, `false`. Defaults to `false`.
+: Show the estimated time to read the page. Valid values: `true`, `false`.
 
 `--topicHeader [topicHeader]`
 : Text to show in the topic header, when `showTopicHeader` is set.
@@ -81,16 +81,16 @@ m365 spo page header set [options]
 
 ## Examples
 
-Reset the page header to default
+Update the page header authors
 
 ```sh
-m365 spo page header set --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx
+m365 spo page header set --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --authors "steve@contoso.com, bob@contoso.com"
 ```
 
 Reset the page header to default and set authors
 
 ```sh
-m365 spo page header set --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --authors "steve@contoso.com, bob@contoso.com"
+m365 spo page header set --webUrl https://contoso.sharepoint.com/sites/team-a --pageName home.aspx --type Default --authors "steve@contoso.com, bob@contoso.com"
 ```
 
 Use the specified image focused on the given coordinates in the page header

package/docs/docs/cmd/spo/page/page-remove.mdx

@@ -19,8 +19,8 @@ m365 spo page remove [options]
 `-n, --name <name>`
 : Name of the page.
 
-`--recycle`
-: Send the page to the recycle bin instead of permanently deleting it.
+`--permanent`
+: Permanently delete the page instead of moving it to the recycle bin.
 
 `--bypassSharedLock`
 : Remove the page even if it is locked for shared use.
@@ -45,10 +45,10 @@ Remove a modern page without a confirmation prompt
 m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --force
 ```
 
-Send a page to the recycle bin
+Permanently remove a page
 
 ```sh
-m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --recycle
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --permanent
 ```
 
 Remove a page that is locked

package/docs/docs/cmd/spo/site/site-apppermission-add.mdx

@@ -34,14 +34,45 @@ m365 spo site apppermission add [options]
 
 To set permissions, specify at minimum either `appId` or `appDisplayName`. For best performance specify both values to avoid extra lookup.
 
-## Example
+## Permissions
 
-Grants the specified app the _read_ permission to site _https://contoso.sharepoint.com/sites/project-x_
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                                 |
+  |-----------------|---------------------------------------------|
+  | Microsoft Graph | Sites.FullControl.All, Application.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions                                 |
+  |-----------------|---------------------------------------------|
+  | Microsoft Graph | Sites.FullControl.All, Application.Read.All |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Grants the app with the specified display name the _read_ permission to a specific site
 
 ```sh
 m365 spo site apppermission add --siteUrl https://contoso.sharepoint.com/sites/project-x --permission read --appDisplayName Foo
 ```
 
+Grants the app with the specified ID the _write_ permission to a specific site
+
+```sh
+m365 spo site apppermission add --siteUrl https://contoso.sharepoint.com/sites/project-x --permission write --appId 5c89fbbf-670e-48e7-a0bc-fa8942c895a2
+```
+
+Grants the app with the specified ID and display name the _manage_ permission to a specific site
+
+```sh
+m365 spo site apppermission add --siteUrl https://contoso.sharepoint.com/sites/project-x --permission manage --appId 5c89fbbf-670e-48e7-a0bc-fa8942c895a2 --appDisplayName Foo
+```
+
 ## Response
 
 <Tabs>
@@ -49,27 +80,27 @@ m365 spo site apppermission add --siteUrl https://contoso.sharepoint.com/sites/p
 
   ```json
   {
-  "id": "aTowaS50fG1zLnNwLmV4dHw1Yzg5ZmJiZi02NzBlLTQ4ZTctYTBiYy1mYTg5NDJjODk1YTJAMWU4NTJiNDktYmY0Yi00YmE1LWJjZDQtYThjNDcwNmM4ZWQ0",
-  "roles": [
-    "read"
-  ],
-  "grantedToIdentitiesV2": [
-    {
-      "application": {
-        "displayName": "Foo",
-        "id": "5c89fbbf-670e-48e7-a0bc-fa8942c895a2"
+    "id": "aTowaS50fG1zLnNwLmV4dHw1Yzg5ZmJiZi02NzBlLTQ4ZTctYTBiYy1mYTg5NDJjODk1YTJAMWU4NTJiNDktYmY0Yi00YmE1LWJjZDQtYThjNDcwNmM4ZWQ0",
+    "roles": [
+      "read"
+    ],
+    "grantedToIdentitiesV2": [
+      {
+        "application": {
+          "displayName": "Foo",
+          "id": "5c89fbbf-670e-48e7-a0bc-fa8942c895a2"
+        }
       }
-    }
-  ],
-  "grantedToIdentities": [
-    {
-      "application": {
-        "displayName": "Foo",
-        "id": "5c89fbbf-670e-48e7-a0bc-fa8942c895a2"
+    ],
+    "grantedToIdentities": [
+      {
+        "application": {
+          "displayName": "Foo",
+          "id": "5c89fbbf-670e-48e7-a0bc-fa8942c895a2"
+        }
       }
-    }
-  ]
-}
+    ]
+  }
   ```
 
   </TabItem>

package/docs/docs/cmd/spo/site/site-list.mdx

@@ -16,7 +16,10 @@ m365 spo site list [options]
 
 ```md definition-list
 `-t, --type [type]`
-: convenience option for type of sites to list. Allowed values are `TeamSite,CommunicationSite`.
+: convenience option for type of sites to list. Allowed values are `TeamSite` and `CommunicationSite`.
+
+`--state [state]`
+: option to filter sites by their archived state. Allowed values are `active`, `fullyArchived`, `recentlyArchived` and `archived`.
 
 `--webTemplate [webTemplate]`
 : type of sites to list. To be used with values like `GROUP#0` and `SITEPAGEPUBLISHING#0`. Specify either `type` or `webTemplate`, but not both.  
@@ -31,6 +34,12 @@ m365 spo site list [options]
 <Global />
 
 ## Remarks
+When providing a value for option `state`, consider the following:
+
+- `active`: return sites that are not archived
+- `fullyArchived`: return sites that are fully archived (longer than 7 days)
+- `recentlyArchived`: return sites that are recently archived (within 7 days)
+- `archived`: return both recently archived and fully archived sites
 
 Using the `--filter` option you can specify which sites you want to retrieve. For example, to get sites with _project_ in their URL, use `Url -like 'project'` as the filter.
 
@@ -76,6 +85,18 @@ List all sites in the currently connected tenant including OneDrive sites.
 m365 spo site list --withOneDriveSites
 ```
 
+List all active (non-archived) sites in the currently connected tenant.
+
+```sh
+m365 spo site list --state active
+```
+
+List all archived sites in the currently connected tenant.
+
+```sh
+m365 spo site list --state archived
+```
+
 ## Response
 
 <Tabs>

package/docs/docs/cmd/spo/site/site-remove.mdx

@@ -16,8 +16,8 @@ m365 spo site remove [options]
 `-u, --url <url>`
 : URL of the site.
 
-`--skipRecycleBin`
-: Set to directly remove the site without moving it to the recycle bin.
+`--permanent`
+: Permanently remove the site without leaving it in the recycle bin.
 
 `--fromRecycleBin`
 : Set to remove the site from the recycle bin.
@@ -49,7 +49,7 @@ m365 spo site remove --url https://contoso.sharepoint.com/sites/demosite
 Remove the site without moving it to the recycle bin.
 
 ```sh
-m365 spo site remove --url https://contoso.sharepoint.com/sites/demosite --skipRecycleBin
+m365 spo site remove --url https://contoso.sharepoint.com/sites/demosite --permanent
 ```
 
 Remove the previously deleted site from the recycle bin.

package/docs/docs/cmd/spo/storageentity/storageentity-get.mdx

@@ -17,22 +17,31 @@ m365 spo storageentity get [options]
 ```md definition-list
 `-k, --key <key>`
 : Name of the tenant property to retrieve
+
+`-u, --appCatalogUrl [appCatalogUrl]`
+: URL of the app catalog site. If not specified, the tenant app catalog URL will be used.
 ```
 
 <Global />
 
 ## Remarks
 
-Tenant properties are stored in the app catalog site associated with the site to which you are currently connected. When retrieving the specified tenant property, SharePoint will automatically find the associated app catalog and try to retrieve the property from it.
+Tenant properties are stored in the app catalog site associated with the site to which you are currently connected. When retrieving the specified tenant property, SharePoint will use the specified app catalog URL or automatically resolve the tenant app catalog URL.
 
 ## Examples
 
-Show the value, description and comment of the _AnalyticsId_ tenant property
+Show the value, description and comment of the _AnalyticsId_ tenant property using the tenant app catalog
 
 ```sh
 m365 spo storageentity get -k AnalyticsId
 ```
 
+Show the value, description and comment of the _AnalyticsId_ tenant property from a specific app catalog site
+
+```sh
+m365 spo storageentity get -k AnalyticsId -u https://contoso.sharepoint.com/sites/appcatalog
+```
+
 ## Response
 
 <Tabs>