@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.6a23aba

package/docs/docs/cmd/spo/site/site-hubsite-disconnect.mdx

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site hubsite disconnect
+
+Disconnects the specified site collection from its hub site
+
+## Usage
+
+```sh
+m365 spo site hubsite disconnect [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site collection to disconnect from its hub site
+
+`--confirm`
+: Don't prompt for confirmation
+```
+
+<Global />
+
+## Examples
+
+Disconnect a specific site collection from its hub site. Will prompt for confirmation before disconnecting from the hub site.
+
+```sh
+m365 spo site hubsite disconnect --siteUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Disconnect a specific site collection from its hub site without prompting for confirmation.
+
+```sh
+m365 spo site hubsite disconnect --siteUrl https://contoso.sharepoint.com/sites/sales --confirm
+```
+
+## 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/site/site-hubsite-theme-sync.mdx

@@ -0,0 +1,32 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site hubsite theme sync
+
+Applies any theme updates from the hub site the site is connected to.
+
+## Usage
+
+```sh
+m365 spo site hubsite theme sync [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site to apply theme updates from the hub site to.
+```
+
+<Global />
+
+## Examples
+
+Applies any theme updates from the hub site to a specific site
+
+```sh
+m365 spo site hubsite theme sync --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+## 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/site/site-inplacerecordsmanagement-set.mdx

@@ -0,0 +1,37 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site inplacerecordsmanagement set
+
+Activates or deactivates in-place records management for a site collection
+
+## Usage
+
+```sh
+m365 spo site inplacerecordsmanagement set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: The URL of the site on which to activate or deactivate in-place records management
+
+`--enabled <enabled>`
+: Set to `true` to activate in-place records management and to `false` to deactivate it
+```
+
+<Global />
+
+## Examples
+
+Activates in-place records management for site _https://contoso.sharepoint.com/sites/team-a_
+
+```sh
+m365 spo site inplacerecordsmanagement set --siteUrl https://contoso.sharepoint.com/sites/team-a --enabled true
+```
+
+Deactivates in-place records management for site _https://contoso.sharepoint.com/sites/team-a_
+
+```sh
+m365 spo site inplacerecordsmanagement set --siteUrl https://contoso.sharepoint.com/sites/team-a --enabled false
+```

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

@@ -0,0 +1,82 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site list
+
+Lists modern sites of the given type
+
+## Usage
+
+```sh
+m365 spo site list [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --type [type]`
+: convenience option for type of sites to list. Allowed values are `TeamSite,CommunicationSite`.
+
+`--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.  
+
+`-f, --filter [filter]`
+: filter to apply when retrieving sites
+
+`--includeOneDriveSites`
+: use this switch to include OneDrive sites in the result when retrieving sites. Do not specify the `type` or `webTemplate` options when using this.
+
+`--deleted`
+: use this switch to only return deleted sites
+```
+
+<Global />
+
+## Remarks
+
+Using the `-f, --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.
+
+When using the text output type, the command lists only the values of the `Title`, and `Url` properties of the site. When setting the output type to JSON, all available properties are included in the command output.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+    
+## Examples
+
+List all sites in the currently connected tenant
+
+```sh
+m365 spo site list
+```
+
+List all group connected team sites in the currently connected tenant
+
+```sh
+m365 spo site list --type TeamSite
+```
+
+List all communication sites in the currently connected tenant
+
+```sh
+m365 spo site list --type CommunicationSite
+```
+
+List all group connected team sites that contain _project_ in the URL
+
+```sh
+m365 spo site list --type TeamSite --filter "Url -like 'project'"
+```
+
+List all sites in the currently connected tenant including OneDrive sites
+
+```sh
+m365 spo site list --includeOneDriveSites
+```
+
+List all deleted sites in the tenant you're logged in to
+
+```sh
+m365 spo site list --deleted
+```

package/docs/docs/cmd/spo/site/site-recyclebinitem-clear.mdx

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site recyclebinitem clear
+
+Permanently removes all items in a site recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem clear [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site where the recycle bin is located.
+
+`--secondary`
+: Remove all items from the second-stage recycle bin. When not specified, items from the first-stage recycle bin will be cleared.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+Items in the recycle bin will be permanently removed without the ability to restore them.
+
+:::
+
+## Examples
+
+Clear all items from the first-stage recycle bin
+
+```sh
+m365 spo site recyclebinitem clear --siteUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Clear all items from the second-stage recycle bin
+
+```sh
+m365 spo site recyclebinitem clear --siteUrl https://contoso.sharepoint.com/sites/sales --secondary
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,44 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site recyclebinitem list
+
+Lists items from recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site for which to retrieve the recycle bin items
+
+`--type [type]`
+: Type of items which should be retrieved (listItems, folders, files)
+
+`--secondary`
+: Use this switch to retrieve items from secondary recycle bin
+```
+
+<Global />
+
+## Remarks
+
+When type is not specified then the command will return all items in the recycle bin
+
+## Examples
+
+Lists all files, items and folders from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site
+```
+
+Lists only files from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site --type files
+```

package/docs/docs/cmd/spo/site/site-recyclebinitem-move.mdx

@@ -0,0 +1,47 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site recyclebinitem move
+
+Moves items from the first-stage recycle bin to the second-stage recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem move [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site where the recycle bin is located.
+
+`-i, --ids [ids]`
+: Comma separated list of item IDs. Specify either `ids` or `all` but not both.
+
+`--all`
+: Move all first-stage recycle bin items to the second-stage recycle bin. Specify either `ids` or `all` but not both.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Examples
+
+Move 2 specific items from the first-stage recycle bin to the second-stage
+
+```sh
+m365 spo site recyclebinitem move --siteUrl https://contoso.sharepoint.com/sites/sales --ids "06ca4fe4-3048-4b76-bd41-296fed4c9881,d679c17b-d7b8-429a-9307-34e1d9e631e7"
+```
+
+Move all first-stage recycle bin items to the second-stage
+
+```sh
+m365 spo site recyclebinitem move --siteUrl https://contoso.sharepoint.com/sites/sales --all
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site recyclebinitem remove
+
+Permanently deletes specific items from the site recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site where the recycle bin is located.
+
+`-i, --ids <ids>`
+: Comma separated list of item IDs.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+Items in the recycle bin will be permanently removed without the ability to restore them.
+
+:::
+
+## Examples
+
+Permanently remove 2 specific items from the recycle bin
+
+```sh
+m365 spo site recyclebinitem remove --siteUrl https://contoso.sharepoint.com/sites/sales --ids "06ca4fe4-3048-4b76-bd41-296fed4c9881,d679c17b-d7b8-429a-9307-34e1d9e631e7"
+```
+
+Permanently remove 2 specific items from the recycle bin and skip the confirmation prompt
+
+```sh
+m365 spo site recyclebinitem remove --siteUrl https://contoso.sharepoint.com/sites/sales --ids "06ca4fe4-3048-4b76-bd41-296fed4c9881,d679c17b-d7b8-429a-9307-34e1d9e631e7" --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/site/site-recyclebinitem-restore.mdx

@@ -0,0 +1,31 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site recyclebinitem restore
+
+Restores given items from the site recycle bin
+
+## Usage
+
+```sh
+m365 spo site recyclebinitem restore [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site for which to restore the recycle bin items
+
+`-i, --ids <ids>`
+: List of ids of items which will be restored from the site recycle bin
+```
+
+<Global />
+
+## Examples
+
+Restore specific items by given ids from recycle bin for site _https://contoso.sharepoint.com/site_
+
+```sh
+m365 spo site recyclebinitem restore --siteUrl https://contoso.sharepoint.com/site --ids "ae6f97a7-280e-48d6-b481-0ea986c323da,aadbf916-1f71-42ee-abf2-8ee4802ae291"
+```

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

@@ -0,0 +1,72 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site remove
+
+Removes the specified site
+
+## Usage
+
+```sh
+m365 spo site remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: URL of the site to remove
+
+`--skipRecycleBin`
+: Set to directly remove the site without moving it to the Recycle Bin
+
+`--fromRecycleBin`
+: Set to remove the site from the Recycle Bin
+
+`--wait`
+: Wait for the site to be removed before completing the command
+
+`--confirm`
+: Don't prompt for confirming removing the site
+```
+
+<Global />
+
+## Remarks
+
+Deleting a site collection is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully deleted, you should use the `--wait` flag. When using this flag, the `spo site remove` command will keep running until it received confirmation from Microsoft 365 that the site has been fully deleted.
+
+If the site which you have selected to remove is groupified (Modern Team Site) and group exists, flags `--skipRecycleBin` and `--wait` will not be applicable. If the linked group still exists in the deleted groups, the site won't be removed. If the linked group is permanently deleted, the site will be removed like any classic site (except that flag `--wait` only will still not be applicable).
+
+If the argument `--fromRecycleBin` is passed, the selected site will be permanently removed even if it's a groupified one.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+
+## Examples
+
+Remove the specified site and place it in the Recycle Bin
+
+```sh
+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
+```
+
+Remove the previously deleted site from the Recycle Bin
+
+```sh
+m365 spo site remove --url https://contoso.sharepoint.com/sites/demosite --fromRecycleBin
+```
+
+Remove the site without moving it to the Recycle Bin and wait for completion
+
+```sh
+m365 spo site remove --url https://contoso.sharepoint.com/sites/demosite --wait --skipRecycleBin
+```

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

@@ -0,0 +1,65 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site rename
+
+Renames the URL and title of a site collection
+
+## Usage
+
+```sh
+m365 spo site rename [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: The URL of the site to rename
+
+`--newUrl <newUrl>`
+: New URL for the site collection
+
+`--newTitle [newTitle]`
+: New title for the site
+
+`--suppressMarketplaceAppCheck`
+: Suppress marketplace app check
+
+`--suppressWorkflow2013Check`
+: Suppress 2013 workflow check
+
+`--wait`
+: Wait for the job to complete
+```
+
+<Global />
+
+## Remarks
+
+Renaming site collections is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the operation to complete fully, you should use the `--wait` flag. When using this flag, the `spo site rename` command  will keep running until it receives confirmation from Microsoft 365 that the site rename operation has completed.
+
+:::info
+
+To use this command you must have permissions to access the tenant admin site.
+
+:::
+    
+## Examples
+
+Starts the rename of the site collection with name "samplesite" to "renamed" without modifying the title
+
+```sh
+m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed
+```
+
+Starts the rename of the site collection with name "samplesite" to "renamed" modifying the title of the site to "New Title"
+
+```sh
+m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed --newTitle "New Title"
+```
+
+Renames the specified site collection and waits for the operation to complete
+
+```sh
+m365 spo site rename --url http://contoso.sharepoint.com/samplesite --newUrl http://contoso.sharepoint.com/renamed --newTitle "New Title" --wait
+```