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

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

@@ -1,179 +0,0 @@
-# spo site add
-
-Creates new SharePoint Online site
-
-## Usage
-
-```sh
-m365 spo site add [options]
-```
-
-## Options
-
-`--type [type]`
-: Type of sites to add. Allowed values `TeamSite,CommunicationSite,ClassicSite`, default `TeamSite`
-
-`-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)
-
-`-u, --url [url]`
-: Site URL  (applies to type CommunicationSite, ClassicSite)
-
-`-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`. When creating a communication site, specify either `siteDesign` or `siteDesignId` (applies to type CommunicationSite)
-
-`--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)
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks for classic sites
-
-Using the `-z, --timeZone` option you have to specify the time zone of the site. For more information about the valid values see [https://msdn.microsoft.com/library/microsoft.sharepoint.spregionalsettings.timezones.aspx](https://msdn.microsoft.com/library/microsoft.sharepoint.spregionalsettings.timezones.aspx).
-
-The value of the `--resourceQuota` option must not exceed the company's aggregate available Sandboxed Solutions quota. For more information, see Resource Usage Limits on Sandboxed Solutions in SharePoint 2010: [http://msdn.microsoft.com/en-us/library/gg615462.aspx](http://msdn.microsoft.com/en-us/library/gg615462.aspx).
-
-The value of the `--resourceQuotaWarningLevel` option must not exceed the value of the `--resourceQuota` option.
-
-The value of the `--storageQuota` option must not exceed the company's available quota.
-
-The value of the `--storageQuotaWarningLevel` option must not exceed the the value of the `--storageQuota` option.
-
-If you try to create a site with the same URL as a site that has been previously moved to the recycle bin, you will get an error. To avoid this error, you can use the `--removeDeletedSite` option. Prior to creating the site, the spo site add command will check if the site with the specified URL has been previously moved to the recycle bin and if so, will remove it. Because removing sites from the recycle bin might take a moment, it should be used in conjunction with the `--wait` option so that the new site is not created before the old site is fully removed.
-
-Deleting and creating classic site collections is by default asynchronous and depending on the current state of Office 365, might take up to few minutes. If you're building a script with steps that require the site to be fully provisioned, you should use the `--wait` flag. When using this flag, the spo site add command will keep running until it received confirmation from Office 365 that the site has been fully provisioned.
-
-## Remarks for modern sites
-
-The `--owners` option is mandatory for creating `CommunicationSite` sites with app-only permissions.
-
-When trying to create a team site using app-only permissions, you will get an _Insufficient privileges to complete the operation._ error. As a workaround, you can use the [`aad o365group add`](../../aad/o365group/o365group-add.md) command, followed by [`spo site set`](./site-set.md) to further configure the Team site.
-
-## Examples
-
-Create modern team site with private group
-
-```sh
-m365 spo site add --alias team1 --title "Team 1"
-```
-
-Create modern team site with description and classification
-
-```sh
-m365 spo site add --type TeamSite --alias team1 --title "Team 1" --description "Site of team 1" --classification LBI
-```
-
-Create modern team site with public group
-
-```sh
-m365 spo site add --type TeamSite --alias team1 --title "Team 1" --isPublic
-```
-
-Create modern team site using the Dutch language
-
-```sh
-m365 spo site add --alias team1 --title "Team 1" --lcid 1043
-```
-
-Create modern team site with the specified users as owners
-
-```sh
-m365 spo site add --alias team1 --title "Team 1" --owners "steve@contoso.com, bob@contoso.com"
-```
-
-Create communication site using the Topic design
-
-```sh
-m365 spo site add --type CommunicationSite --url https://contoso.sharepoint.com/sites/marketing --title Marketing
-```
-
-Create communication site using app-only permissions
-
-```sh
-m365 spo site add --type CommunicationSite --url https://contoso.sharepoint.com/sites/marketing --title Marketing --owners "john.smith@contoso.com"
-```
-
-Create communication site using the Showcase design
-
-```sh
-m365 spo site add --type CommunicationSite --url https://contoso.sharepoint.com/sites/marketing --title Marketing --siteDesign Showcase
-```
-
-Create communication site using a custom site design
-
-```sh
-m365 spo site add --type CommunicationSite --url https://contoso.sharepoint.com/sites/marketing --title Marketing --siteDesignId 99f410fe-dd79-4b9d-8531-f2270c9c621c
-```
-
-Create communication site using the Blank design with description and classification
-
-```sh
-m365 spo site add --type CommunicationSite --url https://contoso.sharepoint.com/sites/marketing --title Marketing --description Site of the marketing department --classification MBI --siteDesign Blank
-```
-
-Create new classic site collection using the Team site template. Set time zone to `UTC+01:00`. Don't wait for the site provisioning to complete
-
-```sh
-m365 spo site add --type ClassicSite --url https://contoso.sharepoint.com/sites/team --title Team --owners admin@contoso.onmicrosoft.com --timeZone 4
-```
-
-Create new classic site collection using the Team site template. Set time zone to `UTC+01:00`. Wait for the site provisioning to complete
-
-```sh
-m365 spo site add --type ClassicSite --url https://contoso.sharepoint.com/sites/team --title Team --owners admin@contoso.onmicrosoft.com --timeZone 4 --webTemplate STS#0 --wait
-```
-
-Create new classic site collection using the Team site template. Set time zone to `UTC+01:00`. If a site with the same URL is in the recycle bin, delete it. Wait for the site provisioning to complete
-
-```sh
-m365 spo site add --type ClassicSite --url https://contoso.sharepoint.com/sites/team --title Team --owners admin@contoso.onmicrosoft.com --timeZone 4 --webTemplate STS#0 --removeDeletedSite --wait
-```
-
-## More information
-
-- Creating SharePoint Communication Site using REST: [https://docs.microsoft.com/en-us/sharepoint/dev/apis/communication-site-creation-rest](https://docs.microsoft.com/en-us/sharepoint/dev/apis/communication-site-creation-rest)

package/docs/docs/cmd/spo/site/site-appcatalog-add.md

@@ -1,33 +0,0 @@
-# spo site appcatalog add
-
-Creates a site collection app catalog in the specified site
-
-## Usage
-
-```sh
-m365 spo site appcatalog add [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection where the app catalog should be added
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-Add a site collection app catalog to the specified site
-
-```sh
-m365 spo site appcatalog add --siteUrl https://contoso.sharepoint/sites/site
-```
-
-## More information
-
-- Use the site collection app catalog: [https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog)

package/docs/docs/cmd/spo/site/site-appcatalog-list.md

@@ -1,55 +0,0 @@
-# spo site appcatalog list
-
-List all site collection app catalogs within the tenant
-
-## Usage
-
-```sh
-m365 spo site appcatalog list [options]
-```
-
-## Options
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you need to have at least read permissions on the SharePoint root site.
-
-## Examples
-
-List all site collection app catalogs within the tenant
-
-```sh
-m365 spo site appcatalog list
-```
-
-## Response
-
-=== "JSON"
-
-    ```json
-    [
-      {
-        "AbsoluteUrl": "https://contoso.sharepoint.com/sites/site1",
-        "ErrorMessage": "Success",
-        "SiteID": "9798e615-b586-455e-8486-84913f492c49"
-      }
-    ]
-    ```
-
-=== "Text"
-
-    ```text
-    AbsoluteUrl                                          SiteID
-    ---------------------------------------------------  ------------------------------------
-    https://contoso.sharepoint.com/sites/site1           9798e615-b586-455e-8486-84913f492c49
-    ```
-
-=== "CSV"
-
-    ```csv
-    AbsoluteUrl,SiteID
-    https://contoso.sharepoint.com/sites/site1,9798e615-b586-455e-8486-84913f492c49
-    ```

package/docs/docs/cmd/spo/site/site-appcatalog-remove.md

@@ -1,35 +0,0 @@
-# spo site appcatalog remove
-
-Removes site collection app catalog from the specified site
-
-## Usage
-
-```sh
-m365 spo site appcatalog remove [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection containing the app catalog to disable
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-While the command uses the term *'remove'*, like its equivalent PowerShell cmdlet, it does not remove the special library **Apps for SharePoint** from the site collection. Instead, it disables the site collection app catalog in that site. Packages deployed to the app catalog are not available within the site collection.
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-    
-## Examples
-
-Remove the site collection app catalog from specified site
-
-```sh
-m365 spo site appcatalog remove --siteUrl https://contoso.sharepoint/sites/site
-```
-
-## More information
-
-- Use the site collection app catalog: [https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog](https://docs.microsoft.com/en-us/sharepoint/dev/general-development/site-collection-app-catalog)

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

@@ -1,37 +0,0 @@
-# spo site apppermission add
-
-Adds a specific application permissions to the site
-
-## Usage
-
-```sh
-m365 spo site apppermission add [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection to add the permission
-
-`-p, --permission <permission>`
-: Permission to site (`read`, `write`, `manage` or `fullcontrol`)
-
-`-i, --appId [appId]`
-: Client ID of the Azure AD app for which to grant permissions
-
-`-n, --appDisplayName [appDisplayName]`
-: Display name of the Azure AD app for which to grant permissions
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-To set permissions, specify at minimum either `appId` or `addDisplayName`. For best performance specify both values to avoid extra lookup.
-
-## Example
-
-Grants the specified app the _read_ permission to site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo site apppermission add --siteUrl https://contoso.sharepoint.com/sites/project-x --permission read --appDisplayName Foo
-```

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

@@ -1,27 +0,0 @@
-# spo site apppermission get
-
-Get a specific application permissions for the site
-
-## Usage
-
-```sh
-m365 spo site apppermission get [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection where the permission to retrieve is located
-
-`-i, --id <id>`
-: ID of the permission to retrieve
-
---8<-- "docs/cmd/_global.md"
-
-## Example
-
-Return a specific application permissions for the _https://contoso.sharepoint.com/sites/project-x_ site collection with permission id _aTowaS50fG1zLnNwLmV4dHw4OWVhNWM5NC03NzM2LTRlMjUtOTVhZC0zZmE5NWY2MmI2NmVAZGUzNDhiYzctMWFlYi00NDA2LThjYjMtOTdkYjAyMWNhZGI0_
-
-```sh
-m365 spo site apppermission get --siteUrl https://contoso.sharepoint.com/sites/project-x --id aTowaS50fG1zLnNwLmV4dHw4OWVhNWM5NC03NzM2LTRlMjUtOTVhZC0zZmE5NWY2MmI2NmVAZGUzNDhiYzctMWFlYi00NDA2LThjYjMtOTdkYjAyMWNhZGI0
-```

package/docs/docs/cmd/spo/site/site-apppermission-list.md

@@ -1,40 +0,0 @@
-# spo site apppermission list
-
-Lists application permissions for a site
-
-## Usage
-
-```sh
-m365 spo site apppermission list [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection to retrieve information for
-
-`-i, --appId [appId]`
-: Id of the application to filter by
-
-`-n, --appDisplayName [appDisplayName]`
-: Display name of the application to filter by
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-To filter by an app, pass in either `appId` or `appDisplayName` not both
-
-## Examples
-
-Return list of application permissions for the _https://contoso.sharepoint.com/sites/project-x_ site collection.
-
-```sh
-m365 spo site apppermission list --siteUrl https://contoso.sharepoint.com/sites/project-x
-```
-
-Return list of application permissions for the _https://contoso.sharepoint.com/sites/project-x_ site collection and filter by an application called Foo
-
-```sh
-m365 spo site apppermission list --siteUrl https://contoso.sharepoint.com/sites/project-x --appDisplayName Foo
-```

package/docs/docs/cmd/spo/site/site-apppermission-remove.md

@@ -1,48 +0,0 @@
-# spo site apppermission remove
-
-Removes a specific application permission from a site
-
-## Usage
-
-```sh
-m365 spo site apppermission remove [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection where the permission to remove is located
-
-`--appId [appId]`
-: App Id
-
-`-n, --appDisplayName [appDisplayName]`
-: App display name
-
-`-i, --id [id]`
-: ID of the permission to remove
-
-`--confirm`
-: Don't prompt for confirmation
-
---8<-- "docs/cmd/_global.md"
-
-## Example
-
-Removes all application permissions for application with id _89ea5c94-7736-4e25-95ad-3fa95f62b66e_ on site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo site apppermission remove --siteUrl https://contoso.sharepoint.com/sites/project-x --appId 89ea5c94-7736-4e25-95ad-3fa95f62b66e
-```
-
-Removes all application permissions for application named _Foo_ on site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo site apppermission remove --siteUrl https://contoso.sharepoint.com/sites/project-x --appDisplayName Foo
-```
-
-Removes the application permission with the specified ID on site _https://contoso.sharepoint.com/sites/project-x_
-
-```sh
-m365 spo site apppermission remove --siteUrl https://contoso.sharepoint.com/sites/project-x --id aTowaS50fG1zLnNwLmV4dHw4OWVhNWM5NC03NzM2LTRlMjUtOTVhZC0zZmE5NWY2MmI2NmVAZGUzNDhiYzctMWFlYi00NDA2LThjYjMtOTdkYjAyMWNhZGI0
-```

package/docs/docs/cmd/spo/site/site-apppermission-set.md

@@ -1,48 +0,0 @@
-# spo site apppermission set
-
-Updates a specific application permission for a site
-
-## Usage
-
-```sh
-m365 spo site apppermission set [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection where the permission to retrieve is located
-
-`-i, --id [id]`
-: ID of the permission to update. Specify `id`, `appId` or `appDisplayName`
-
-`--appId [appId]`
-: Client ID of the Azure AD app for which to update permissions. Specify `id`, `appId` or `appDisplayName`
-
-`-n, --appDisplayName [appDisplayName]`
-: Display name of the Azure AD app for which to update permissions. Specify `id`, `appId` or `appDisplayName`
-
-`-p, --permission <permission>`
-: Permission to site (`read`, `write`, `manage` or `fullcontrol`)
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Updates a specific application permission to _read_ for the _https://contoso.sharepoint.com/sites/project-x_ site collection with permission id _aTowaS50fG1zLnNwLmV4dHw4OWVhNWM5NC03NzM2LTRlMjUtOTVhZC0zZmE5NWY2MmI2NmVAZGUzNDhiYzctMWFlYi00NDA2LThjYjMtOTdkYjAyMWNhZGI0_
-
-```sh
-m365 spo site apppermission set --siteUrl https://contoso.sharepoint.com/sites/project-x --id aTowaS50fG1zLnNwLmV4dHw4OWVhNWM5NC03NzM2LTRlMjUtOTVhZC0zZmE5NWY2MmI2NmVAZGUzNDhiYzctMWFlYi00NDA2LThjYjMtOTdkYjAyMWNhZGI0 --permission read
-```
-
-Updates a specific application permission to _read_ for the _https://contoso.sharepoint.com/sites/project-x_ site collection with an application called _Foo_
-
-```sh
-m365 spo site apppermission set --siteUrl https://contoso.sharepoint.com/sites/project-x --appDisplayName Foo --permission read
-```
-
-Updates a specific application permission to _read_ for the _https://contoso.sharepoint.com/sites/project-x_ site collection with an application id _89ea5c94-7736-4e25-95ad-3fa95f62b66e_
-
-```sh
-m365 spo site apppermission set --siteUrl https://contoso.sharepoint.com/sites/project-x --appId 89ea5c94-7736-4e25-95ad-3fa95f62b66e --permission read
-```

package/docs/docs/cmd/spo/site/site-chrome-set.md

@@ -1,58 +0,0 @@
-# spo site chrome set
-
-Set the chrome header and footer for the specified site
-
-## Usage
-
-```sh
-m365 spo site chrome set [options]
-```
-
-## Options
-
-`-u, --siteUrl <siteUrl>`
-: URL of the site collection to which you want to change the chrome header/footer
-
-`--headerLayout [headerLayout]`
-: Header layout to set on the site. Options: `Standard|Compact|Minimal|Extended`.
-
-`--headerEmphasis [headerEmphasis]`
-: Header background to set on the site. Options: `Lightest|Light|Dark|Darkest`.
-
-`--logoAlignment [logoAlignment]`
-: Logo position when header layout set to `Extended`. Ignored otherwise. Options: `Left|Center|Right`.
-
-`--footerLayout [footerLayout]`
-: Footer layout to set on the site. Options: `Simple|Extended`.
-
-`--footerEmphasis [footerEmphasis]`
-: Footer background color to set. Options: `Lightest|Light|Dark|Darkest`.
-
-`--disableMegaMenu [disableMegaMenu]`
-: Set to `true` to disable the mega menu and to `false` to enable it. Disabling mega menu results in using the cascading navigation (classic experience). Options: `true|false`.
-
-`--hideTitleInHeader [hideTitleInHeader]`
-: Set to `true` to hide the site title in the header and to `false` to show it. Options: `true|false`.
-
-`--disableFooter [disableFooter]`
-: Set to `true` to disable the footer on the site and to `false` to enable it. Options: `true|false`.
-
-## Examples
-
-Show site header in compact mode
-
-```sh
-m365 spo site chrome set --siteUrl https://contoso.sharepoint.com/sites/project-x --headerLayout Compact
-```
-
-Show site header in extended mode and display the logo on the right
-
-```sh
-m365 spo site chrome set --siteUrl https://contoso.sharepoint.com/sites/project-x  --headerLayout Extended --logoAlignment Right
-```
-
-Disable the footer on the site
-
-```sh
-m365 spo site chrome set --siteUrl https://contoso.sharepoint.com/sites/project-x --disableFooter true
-```

package/docs/docs/cmd/spo/site/site-commsite-enable.md

@@ -1,32 +0,0 @@
-# spo site commsite enable
-
-Enables communication site features on the specified site
-
-## Usage
-
-```sh
-m365 spo site commsite enable [options]
-```
-
-## Options
-
-`-u, --url <url>`
-: The URL of the site to enable communication site features on
-
-`-i, --designPackageId [designPackageId]`
-: The ID of the site design to apply when enabling communication site features
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
-## Examples
-
-Enable communication site features on an existing site
-
-```sh
-m365 spo site commsite enable --url https://contoso.sharepoint.com
-```