npm - @pnp/cli-microsoft365 - Versions diffs - 11.9.0-beta.7b34e40 → 11.9.0-beta.87e70e2 - Mend

@pnp/cli-microsoft365 11.9.0-beta.7b34e40 → 11.9.0-beta.87e70e2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (478) hide show

package/docs/docs/cmd/spo/customaction/customaction-clear.mdx CHANGED Viewed

@@ -1,4 +1,6 @@
 import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 # spo customaction clear
@@ -25,6 +27,25 @@ m365 spo customaction clear [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
 Clears all user custom actions for both site and site collection. Skips the confirmation prompt message.

package/docs/docs/cmd/spo/customaction/customaction-get.mdx CHANGED Viewed

@@ -37,6 +37,25 @@ m365 spo customaction get [options]
 If the command finds multiple user custom actions with the specified `title` or `clientSideComponentId`, it will prompt you to disambiguate which user custom action it should get, listing the discovered IDs.
+## Permissions
+<Tabs>
+  <TabItem value="Delegated">
+  | Resource   | Permissions   |
+  |------------|---------------|
+  | SharePoint | AllSites.Read |
+  </TabItem>
+  <TabItem value="Application">
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | Sites.Read.All |
+  </TabItem>
+</Tabs>
 ## Examples
 Return details about the user custom action based on the id and a given url.

package/docs/docs/cmd/spo/customaction/customaction-list.mdx CHANGED Viewed

@@ -28,6 +28,25 @@ m365 spo customaction list [options]
 When using the text output type (default), the command lists only the values of the `Name`, `Location`, `Scope` and `Id` properties of the custom action. When setting the output type to JSON, all available properties are included in the command output.
+## Permissions
+<Tabs>
+  <TabItem value="Delegated">
+  | Resource   | Permissions   |
+  |------------|---------------|
+  | SharePoint | AllSites.Read |
+  </TabItem>
+  <TabItem value="Application">
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | Sites.Read.All |
+  </TabItem>
+</Tabs>
 ## Examples
 Return details about all user custom actions located in the specified site or site collection.

package/docs/docs/cmd/spo/customaction/customaction-remove.mdx CHANGED Viewed

@@ -1,4 +1,6 @@
 import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 # spo customaction remove
@@ -35,6 +37,25 @@ m365 spo customaction remove [options]
 If the command finds multiple user custom actions with the specified title, it will prompt you to disambiguate which user custom action it should use, listing the discovered IDs.
+## Permissions
+<Tabs>
+  <TabItem value="Delegated">
+  | Resource   | Permissions          |
+  |------------|----------------------|
+  | SharePoint | AllSites.FullControl |
+  </TabItem>
+  <TabItem value="Application">
+  | Resource   | Permissions           |
+  |------------|-----------------------|
+  | SharePoint | Sites.FullControl.All |
+  </TabItem>
+</Tabs>
 ## Examples
 Removes user custom action with given ID located in the specified site or site collection.

package/docs/docs/cmd/spo/customaction/customaction-set.mdx CHANGED Viewed

@@ -1,4 +1,6 @@
 import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
 # spo customaction set
@@ -91,6 +93,25 @@ When using the `--clientSideComponentProperties` option it's possible to enter a
 :::
+## Permissions
+<Tabs>
+  <TabItem value="Delegated">
+  | Resource   | Permissions     |
+  |------------|-----------------|
+  | SharePoint | AllSites.Manage |
+  </TabItem>
+  <TabItem value="Application">
+  | Resource   | Permissions      |
+  |------------|------------------|
+  | SharePoint | Sites.Manage.All |
+  </TabItem>
+</Tabs>
 ## Examples
 Updates a tenant-wide SharePoint Framework Application Customizer extension properties in the specified site.

package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo file retentionlabel ensure
-Apply a retention label to a file
+Applies a retention label to a file
 ## Usage

package/docs/docs/cmd/spo/file/file-unarchive.mdx ADDED Viewed

@@ -0,0 +1,68 @@
+import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+# spo file unarchive
+Unarchives a file
+## Usage
+```sh
+m365 spo file unarchive [options]
+```
+## Options
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+`--url [url]`
+: The server- or site-relative decoded URL of the file to unarchive. Specify either `url` or `id`, but not both.
+`-i, --id [id]`
+: The UniqueId (GUID) of the file to unarchive. Specify either `url` or `id`, but not both.
+`-f, --force`
+: Don't prompt for confirmation.
+```
+<Global />
+## Permissions
+<Tabs>
+  <TabItem value="Delegated">
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+  </TabItem>
+  <TabItem value="Application">
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+  </TabItem>
+</Tabs>
+## Examples
+Unarchive a file by id without prompting for confirmation
+```sh
+m365 spo file unarchive --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7a8c9207-7745-4cda-b0e2-be2618ee3030 --force
+```
+Unarchive a file by URL with prompting for confirmation
+```sh
+m365 spo file unarchive --webUrl https://contoso.sharepoint.com/sites/Marketing --url '/sites/Marketing/shared documents/document.docx'
+```
+## Response
+The command won't return a response on success.

package/docs/docs/cmd/spo/file/file-version-keep.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo file version keep
-Ensure that a specific file version will never expire
+Ensures that a specific file version will never expire
 ## Usage

package/docs/docs/cmd/spo/folder/folder-archive.mdx ADDED Viewed

@@ -0,0 +1,73 @@
+import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+# spo folder archive
+Archives a folder
+## Usage
+```sh
+m365 spo folder archive [options]
+```
+## Options
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder is located.
+`--url [url]`
+: The server- or site-relative decoded URL of the folder to archive. Specify either `url` or `id`, but not both.
+`-i, --id [id]`
+: The UniqueId (GUID) of the folder to archive. Specify either `url` or `id`, but not both.
+`-f, --force`
+: Don't prompt for confirmation.
+```
+<Global />
+## Remarks
+Folder archival can take some time to complete, as the status might not be reflected immediately.
+## Permissions
+<Tabs>
+  <TabItem value="Delegated">
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+  </TabItem>
+  <TabItem value="Application">
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+  </TabItem>
+</Tabs>
+## Examples
+Archive a folder by id without prompting for confirmation
+```sh
+m365 spo folder archive --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7a8c9207-7745-4cda-b0e2-be2618ee3030 --force
+```
+Archive a folder by URL with prompting for confirmation
+```sh
+m365 spo folder archive --webUrl https://contoso.sharepoint.com/sites/Marketing --url '/sites/Marketing/shared documents/folder'
+```
+## Response
+The command won't return a response on success.

package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo folder retentionlabel ensure
-Apply a retention label to a folder
+Applies a retention label to a folder
 ## Usage

package/docs/docs/cmd/spo/group/group-member-add.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo group member add
-Add members to a SharePoint Group
+Adds members to a SharePoint Group
 ## Usage

package/docs/docs/cmd/spo/group/group-member-list.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo group member list
-List the members of a SharePoint Group
+Lists the members of a SharePoint Group
 ## Usage

package/docs/docs/cmd/spo/hubsite/hubsite-connect.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo hubsite connect
-Connect a hub site to a parent hub site
+Connects a hub site to a parent hub site
 ## Usage

package/docs/docs/cmd/spo/hubsite/hubsite-data-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo hubsite data get
-Get hub site data for the specified site
+Gets hub site data for the specified site
 ## Usage

package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo hubsite disconnect
-Disconnect a hub site from its parent hub site
+Disconnects a hub site from its parent hub site
 ## Usage

package/docs/docs/cmd/spo/list/list-sensitivitylabel-remove.mdx ADDED Viewed

@@ -0,0 +1,77 @@
+import Global from '../../_global.mdx';
+import TabItem from '@theme/TabItem';
+import Tabs from '@theme/Tabs';
+# spo list sensitivitylabel remove
+Clears a default sensitivity label from a document library
+## Usage
+```sh
+m365 spo list sensitivitylabel remove [options]
+```
+## Options
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the list is located.
+`-t, --listTitle [listTitle]`
+: The title of the library on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+`-l, --listId [listId]`
+: The ID of the library on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the library on which to remove the label. Specify either `listTitle`, `listId`, or `listUrl` but not multiple.
+`-f, --force`
+: Don't prompt for confirmation.
+```
+<Global />
+## Permissions
+<Tabs>
+  <TabItem value="Delegated">
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | AllSites.Write |
+  </TabItem>
+  <TabItem value="Application">
+  | Resource   | Permissions         |
+  |------------|---------------------|
+  | SharePoint | Sites.ReadWrite.All |
+  </TabItem>
+</Tabs>
+## Examples
+Removes a sensitivity label from a document library based on the list title.
+```sh
+m365 spo list sensitivitylabel remove --webUrl 'https://contoso.sharepoint.com' --listTitle 'Shared Documents'
+```
+Removes a sensitivity label from a document library based on the list url.
+```sh
+m365 spo list sensitivitylabel remove --webUrl 'https://contoso.sharepoint.com' --listUrl '/Shared Documents'
+```
+Removes a sensitivity label from a document library based on the list id without prompting for confirmation.
+```sh
+m365 spo list sensitivitylabel remove --webUrl 'https://contoso.sharepoint.com' --listId 'b4cfa0d9-b3d7-49ae-a0f0-f14ffdd005f7' --force
+```
+## Response
+The command won't return a response on success.

package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo listitem retentionlabel ensure
-Apply a retention label to a list item
+Applies a retention label to a list item
 ## Usage

package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo listitem roleinheritance break
-Break inheritance of list item.
+Breaks inheritance of list item.
 ## Usage

package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo navigation node get
-Gets information about a specific navigation node.
+Gets information about a specific navigation node
 ## Usage

package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo orgassetslibrary list
-List all libraries that are assigned as asset library
+Lists all libraries that are assigned as asset library
 ## Usage

package/docs/docs/cmd/spo/page/page-column-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo page column get
-Get information about a specific column of a modern page
+Gets information about a specific column of a modern page
 ## Usage

package/docs/docs/cmd/spo/page/page-section-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo page section get
-Get information about the specified modern page section
+Gets information about the specified modern page section
 ## Usage

package/docs/docs/cmd/spo/page/page-section-list.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo page section list
-List sections in the specific modern page
+Lists sections in the specific modern page
 ## Usage

package/docs/docs/cmd/spo/report/report-siteusagefilecounts.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo report siteusagefilecounts
-Get the total number of files across all sites and the number of active files
+Gets the total number of files across all sites and the number of active files
 ## Usage

package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-set.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo serviceprincipal set
-Enable or disable the service principal
+Enables or disables the service principal
 ## Usage

package/docs/docs/cmd/spo/site/site-accessrequest-setting-set.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo site accessrequest setting set
-Update access requests for a specific site
+Updates access requests for a specific site
 ## Usage

package/docs/docs/cmd/spo/site/site-appcatalog-list.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo site appcatalog list
-List all site collection app catalogs within the tenant
+Lists all site collection app catalogs within the tenant
 ## Usage

package/docs/docs/cmd/spo/site/site-apppermission-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo site apppermission get
-Get a specific application permissions for the site
+Gets a specific application permissions for the site
 ## Usage

package/docs/docs/cmd/spo/site/site-chrome-set.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo site chrome set
-Set the chrome header and footer for the specified site
+Sets the chrome header and footer for the specified site
 ## Usage

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

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo storageentity get
-Get details for the specified tenant property
+Gets details for the specified tenant property
 ## Usage

package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo tenant applicationcustomizer add
-Add an Application Customizer as a tenant-wide extension
+Adds an Application Customizer as a tenant-wide extension
 ## Usage

package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo tenant applicationcustomizer get
-Get an application customizer that is installed tenant-wide
+Gets an application customizer that is installed tenant-wide
 ## Usage

package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo tenant commandset add
-Add a ListView Command Set as a tenant-wide extension
+Adds a ListView Command Set as a tenant-wide extension
 ## Usage

package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo tenant commandset get
-Get a ListView Command Set that is installed tenant-wide
+Gets a ListView Command Set that is installed tenant-wide
 ## Usage

package/docs/docs/cmd/spo/theme/theme-set.mdx CHANGED Viewed

@@ -2,7 +2,7 @@ import Global from '../../_global.mdx';
 # spo theme set
-Add or update a theme
+Adds or updates a theme
 ## Usage

package/docs/docs/cmd/spo/userprofile/userprofile-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo userprofile get
-Get SharePoint user profile properties for the specified user
+Gets SharePoint user profile properties for the specified user
 ## Usage

package/docs/docs/cmd/spo/web/web-add.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo web add
-Create new subsite
+Creates new subsite
 ## Usage

package/docs/docs/cmd/spo/web/web-get.mdx CHANGED Viewed

@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # spo web get
-Retrieve information about the specified site
+Retrieves information about the specified site
 ## Usage