@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.1cd2525

package/docs/docs/cmd/spo/site/site-ensure.md

@@ -1,124 +0,0 @@
-# spo site ensure
-
-Ensures that the particular site collection exists and updates its properties if necessary.
-
-The command is a combination of `spo web get`, `spo site add` and `spo site set`.
-
-## Usage
-
-```sh
-m365 spo site ensure [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: URL of the site to ensure
-
-`--type [type]`
-: Expected type of the site. Allowed values `TeamSite,CommunicationSite,ClassicSite`. If not specified, will not check the type of the site if one exists at the specified URL.
-
-`-t, --title <title>`
-: Site title
-
-`-a, --alias [alias]`
-: Site alias, used in the URL and in the team site group e-mail (applies to type `TeamSite`)
-
-`-z, --timeZone [timeZone]`
-: Integer representing time zone to use for the site (applies to type `ClassicSite`)
-
-`-d, --description [description]`
-: Site description
-
-`-l, --lcid [lcid]`
-: Site language in the LCID format, eg. _1033_ for _en-US_. See [SharePoint documentation](https://support.microsoft.com/en-us/office/languages-supported-by-sharepoint-dfbf3652-2902-4809-be21-9080b6512fff) for the list of supported languages
-
-`--owners [owners]`
-: Comma-separated list of users to set as site owners (applies to type TeamSite, ClassicSite)
-
-`--isPublic`
-: Determines if the associated group is public or not (applies to type `TeamSite`)
-
-`-c, --classification [classification]`
-: Site classification (applies to type `TeamSite`, `CommunicationSite`)
-
-`--siteDesign [siteDesign]`
-: Type of communication site to create. Allowed values `Topic,Showcase,Blank`, default `Topic`. Used only for creating site when one doesn't exist.
-
-`--siteDesignId [siteDesignId]`
-: Id of the custom site design to use to create the site. When creating a communication site, specify either `siteDesign` or `siteDesignId` (applies to type `CommunicationSite`)
-
-`--shareByEmailEnabled`
-: Determines whether it's allowed to share file with guests (applies to type `CommunicationSite`)
-
-`-w, --webTemplate [webTemplate]`
-: Template to use for creating the site. Default `STS#0`  (applies to type `ClassicSite`)
-
-`--resourceQuota [resourceQuota]`
-: The quota for this site collection in Sandboxed Solutions units. Default `0`  (applies to type `ClassicSite`)
-
-`--resourceQuotaWarningLevel [resourceQuotaWarningLevel]`
-: The warning level for the resource quota. Default `0`  (applies to type `ClassicSite`)
-
-`--storageQuota [storageQuota]`
-: The storage quota for this site collection in megabytes. Default `100`  (applies to type `ClassicSite`)
-
-`--storageQuotaWarningLevel [storageQuotaWarningLevel]`
-: The warning level for the storage quota in megabytes. Default `100`  (applies to type `ClassicSite`)
-
-`--removeDeletedSite`
-: Set, to remove existing deleted site with the same URL from the Recycle Bin  (applies to type `ClassicSite`)
-
-`--wait`
-: Wait for the site to be provisioned before completing the command  (applies to type `ClassicSite`)
-
-`--disableFlows [disableFlows]`
-: Set to `true` to disable using Microsoft Flow in this site collection
-
-`--sharingCapability [sharingCapability]`
-: The sharing capability for the site. Allowed values:  `Disabled`, `ExternalUserSharingOnly`, `ExternalUserAndGuestSharing`, `ExistingExternalUserSharingOnly`.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-This command checks if a site collection exists at the specified URL.
-
-If no site is found, this command will create one using the specified options. For more information about creating site collections and things that you should into account, see the [`spo site add`](./site-add.md) command.
-
-If a site is found at the specified URL, this command will update its properties using the specified values. For more information about updating site collections and things that you should take into account see the [`spo site set`](./site-set.md) command.
-
-If another site exists at the specified URL and you haven't specified the `type` option, this command will proceed with updating its properties. If you specified the `type` and it doesn't match the type of the existing site, this command will return an error.
-
-If you set the type to `ClassicSite`, you should also set a value of the `webTemplate` option. If you don't, checking the type of existing site will be skipped. If no site exists at the specified URL, creating the site will fail.
-
-## Examples
-
-Ensure that a site exists at the specified URL. Create a modern team site if no site exists. If a site is found, don't check its type and update its title.
-
-```sh
-m365 spo site ensure --url https://contoso.sharepoint.com/sites/team1 --alias team1 --title "Team 1"
-```
-
-Ensure that a communication site exists at the specified URL. Create a communication site if no site exists. If a site of different type is found, return an error.
-
-```sh
-m365 spo site ensure --url https://contoso.sharepoint.com/sites/comms --title Comms --type CommunicationSite
-```
-
-Ensure that a classic site exists at the specified URL. Create a classic team site if no site exists. If a site of different type is found, return an error.
-
-```sh
-m365 spo site ensure --url https://contoso.sharepoint.com/sites/classic --title Classic --type ClassicSite
-```
-
-Ensure that a site exists at the specified URL. Create a modern team site if no site exists. If a site is found, don't check its type and update its title and properties.
-
-```sh
-m365 spo site ensure --url https://contoso.sharepoint.com/sites/team1 --alias team1 --title "Team 1" --isPublic --shareByEmailEnabled
-```
-
-## More information
-
-- [`spo site add`](./site-add.md)
-- [`spo site set`](./site-set.md)

package/docs/docs/cmd/spo/site/site-get.md

@@ -1,28 +0,0 @@
-# spo site get
-
-Gets information about the specific site collection
-
-## Usage
-
-```sh
-m365 spo site get [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: URL of the site collection to retrieve information for
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-This command can retrieve information for both classic and modern sites.
-
-## Examples
-
-Return information about the _https://contoso.sharepoint.com/sites/project-x_ site collection.
-
-```sh
-m365 spo site get -u https://contoso.sharepoint.com/sites/project-x
-```

package/docs/docs/cmd/spo/site/site-groupify.md

@@ -1,71 +0,0 @@
-# spo site groupify
-
-Connects site collection to an Microsoft 365 Group
-
-!!! 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.
-
-## Usage
-
-```sh
-m365 spo site groupify [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: URL of the site collection being connected to new Microsoft 365 Group
-
-`-a, --alias <alias>`
-: The email alias for the new Microsoft 365 Group that will be created
-
-`-n, --displayName <displayName>`
-: The name of the new Microsoft 365 Group that will be created
-
-`-d, --description [description]`
-: The group’s description
-
-`-c, --classification [classification]`
-: The classification value, if classifications are set for the organization. If no value is provided, the default classification will be set, if one is configured
-
-`--isPublic`
-: Determines the Microsoft 365 Group’s privacy setting. If set, the group will be public, otherwise it will be private
-
-`--keepOldHomepage`
-: For sites that already have a modern page set as homepage, set this option, to keep it as the homepage
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-When connecting site collection to an Microsoft 365 Group, SharePoint will create a new group using the specified information. If a group with the same name already exists, you will get a `The group alias already exists.` error.
-
-## Examples
-
-Connect site collection to an Microsoft 365 Group
-
-```sh
-m365 spo site groupify --url https://contoso.sharepoin.com/sites/team-a --alias team-a --displayName 'Team A'
-```
-
-Connect site collection to an Microsoft 365 Group and make the group public
-
-```sh
-m365 spo site groupify --url https://contoso.sharepoin.com/sites/team-a --alias team-a --displayName 'Team A' --isPublic
-```
-
-Connect site collection to an Microsoft 365 Group and set the group classification
-
-```sh
-m365 spo site groupify --url https://contoso.sharepoin.com/sites/team-a --alias team-a --displayName 'Team A' --classification HBI
-```
-
-Connect site collection to an Microsoft 365 Group and keep the old home page
-
-```sh
-m365 spo site groupify --url https://contoso.sharepoin.com/sites/team-a --alias team-a --displayName 'Team A' --keepOldHomepage
-```
-
-## More information
-
-- Overview of the "Log in to new Microsoft 365 group" feature: [https://docs.microsoft.com/en-us/sharepoint/dev/features/groupify/groupify-overview](https://docs.microsoft.com/en-us/sharepoint/dev/features/groupify/groupify-overview)

package/docs/docs/cmd/spo/site/site-hubsite-connect.md

@@ -1,37 +0,0 @@
-# spo site hubsite connect
-
-Connects the specified site collection to the given hub site
-
-## Usage
-
-```sh
-m365 spo site hubsite connect [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: The URL of the site collection to connect to the hub site
-
-`-i, --id <id>`
-: The ID of the hub site to which to connect the site collection
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-If the specified site collection is already connected to a hub site, it will be disconnected and connected to the newly specified hub site.
-
-If the specified `id` doesn't point to a valid hub site, you will get a `ResourceNotFoundException` error.
-
-## Examples
-
-Connect a specific site collection to a hub site
-
-```sh
-m365 spo site hubsite connect --siteUrl https://contoso.sharepoint.com/sites/contoso-sales --id 255a50b2-527f-4413-8485-57f4c17a24d1
-```
-
-## 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-disconnect.md

@@ -1,37 +0,0 @@
-# spo site hubsite disconnect
-
-Disconnects the specified site collection from its hub site
-
-## Usage
-
-```sh
-m365 spo site hubsite disconnect [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection to disconnect from its hub site
-
-`--confirm`
-: Don't prompt for confirmation
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,28 +0,0 @@
-# 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
-
-`-u, --webUrl <webUrl>`
-: URL of the site to apply theme updates from the hub site to.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,33 +0,0 @@
-# spo site inplacerecordsmanagement set
-
-Activates or deactivates in-place records management for a site collection
-
-## Usage
-
-```sh
-m365 spo site inplacerecordsmanagement set [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,75 +0,0 @@
-# spo site list
-
-Lists modern sites of the given type
-
-## Usage
-
-```sh
-m365 spo site list [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! important
-    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.md

@@ -1,45 +0,0 @@
-# spo site recyclebinitem clear
-
-Permanently removes all items in a site recycle bin
-
-## Usage
-
-```sh
-m365 spo site recyclebinitem clear [options]
-```
-
-## Options
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! warning
-    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.md

@@ -1,40 +0,0 @@
-# spo site recyclebinitem list
-
-Lists items from recycle bin
-
-## Usage
-
-```sh
-m365 spo site recyclebinitem list [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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-restore.md

@@ -1,27 +0,0 @@
-# spo site recyclebinitem restore
-
-Restores given items from the site recycle bin
-
-## Usage
-
-```sh
-m365 spo site recyclebinitem restore [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,65 +0,0 @@
-# spo site remove
-
-Removes the specified site
-
-## Usage
-
-```sh
-m365 spo site remove [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! important
-    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.md

@@ -1,58 +0,0 @@
-# spo site rename
-
-Renames the URL and title of a site collection
-
-## Usage
-
-```sh
-m365 spo site rename [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.
-
-!!! important
-    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
-```