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

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

@@ -0,0 +1,42 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site appcatalog remove
+
+Removes site collection app catalog from the specified site
+
+## Usage
+
+```sh
+m365 spo site appcatalog remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site collection containing the app catalog to disable
+```
+
+<Global />
+
+## 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.
+
+:::info
+
+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.mdx

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site apppermission add
+
+Adds a specific application permissions to the site
+
+## Usage
+
+```sh
+m365 spo site apppermission add [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,31 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site apppermission get
+
+Get a specific application permissions for the site
+
+## Usage
+
+```sh
+m365 spo site apppermission get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site collection where the permission to retrieve is located
+
+`-i, --id <id>`
+: ID of the permission to retrieve
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,44 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site apppermission list
+
+Lists application permissions for a site
+
+## Usage
+
+```sh
+m365 spo site apppermission list [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site apppermission remove
+
+Removes a specific application permission from a site
+
+## Usage
+
+```sh
+m365 spo site apppermission remove [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site apppermission set
+
+Updates a specific application permission for a site
+
+## Usage
+
+```sh
+m365 spo site apppermission set [options]
+```
+
+## Options
+
+```md definition-list
+`-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`)
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,64 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site chrome set
+
+Set the chrome header and footer for the specified site
+
+## Usage
+
+```sh
+m365 spo site chrome set [options]
+```
+
+## Options
+
+```md definition-list
+`-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`.
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,39 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site commsite enable
+
+Enables communication site features on the specified site
+
+## Usage
+
+```sh
+m365 spo site commsite enable [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+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
+```

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

@@ -0,0 +1,128 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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
+
+```md definition-list
+`-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`.
+```
+
+<Global />
+
+## 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.mdx) 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.mdx) 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.mdx)
+- [`spo site set`](./site-set.mdx)

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

@@ -0,0 +1,32 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site get
+
+Gets information about the specific site collection
+
+## Usage
+
+```sh
+m365 spo site get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: URL of the site collection to retrieve information for
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,78 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site groupify
+
+Connects site collection to an Microsoft 365 Group
+
+## Usage
+
+```sh
+m365 spo site groupify [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+This command is based on a SharePoint API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+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.mdx

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site hubsite connect
+
+Connects the specified site collection to the given hub site
+
+## Usage
+
+```sh
+m365 spo site hubsite connect [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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)