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

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

@@ -0,0 +1,86 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo homesite get
+
+Gets information about the Home Site
+
+## Usage
+
+```sh
+m365 spo homesite get [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+Get information about the Home Site.
+
+```sh
+m365 spo homesite get
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "SiteId": "af80c11f-0138-4d72-bb37-514542c3aabb",
+    "WebId": "6f90666d-b0e7-40c3-991f-4ab051d00a70",
+    "LogoUrl": "https://contoso.sharepoint.com/sites/intra/siteassets/work.png",
+    "Title": "Intranet",
+    "Url": "https://contoso.sharepoint.com/sites/intra"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  LogoUrl: https://contoso.sharepoint.com/sites/intra/siteassets/work.png
+  SiteId : af80c11f-0138-4d72-bb37-514542c3aabb
+  Title  : Intranet
+  Url    : https://contoso.sharepoint.com/sites/intra
+  WebId  : 6f90666d-b0e7-40c3-991f-4ab051d00a70
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  SiteId,WebId,LogoUrl,Title,Url
+  af80c11f-0138-4d72-bb37-514542c3aabb,6f90666d-b0e7-40c3-991f-4ab051d00a70,https://contoso.sharepoint.com/sites/intra/siteassets/work.png,Intranet,https://contoso.sharepoint.com/sites/intra
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo homesite get
+
+  Date: 2/20/2023
+
+  ## Intranet (https://contoso.sharepoint.com/sites/intra)
+
+  Property | Value
+  ---------|-------
+  IsInDraftMode | false
+  SiteId | af80c11f-0138-4d72-bb37-514542c3aabb
+  WebId |6f90666d-b0e7-40c3-991f-4ab051d00a70
+  LogoUrl | https://contoso.sharepoint.com/sites/intra/siteassets/work.png
+  Title | Intranet
+  Url | https://contoso.sharepoint.com/sites/intra
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- SharePoint home sites: a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)

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

@@ -0,0 +1,75 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo homesite remove
+
+Removes the current Home Site
+
+## Usage
+
+```sh
+m365 spo homesite remove [options]
+```
+
+## Options
+
+```md definition-list
+`--confirm`
+: Do not prompt for confirmation before removing the Home Site.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+
+## Examples
+
+Removes the current Home Site without confirmation.
+
+```sh
+m365 spo homesite remove --confirm
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  "https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details."
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- SharePoint home sites, a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)

package/docs/docs/cmd/spo/homesite/homesite-set.mdx

@@ -0,0 +1,127 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo homesite set
+
+Sets the specified site as the Home Site
+
+## Usage
+
+```sh
+m365 spo homesite set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: The URL of the site to set as Home site.
+
+`--vivaConnectionsDefaultStart [vivaConnectionsDefaultStart]`
+: When set to `true`, the Viva Connections landing experience is set to the SharePoint home site. If set to `false`, the Viva Connections home experience will be used.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global or SharePoint administrator.
+
+:::
+
+## Examples
+
+Set the specified site as the Home Site.
+
+```sh
+m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms
+```
+
+Sets the Home site to the provided site collection url and sets the Viva Connections landing experience to the SharePoint home site
+
+```sh
+m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms --vivaConnectionsDefaultStart true
+```
+
+Sets the Home site to the provided site collection url and sets the Viva Connections landing experience to the default experience
+
+```sh
+m365 spo homesite set --siteUrl https://contoso.sharepoint.com/sites/comms --vivaConnectionsDefaultStart false
+```
+
+## Response
+
+### Standard response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  "The Home site has been set to https://contoso.sharepoint.com. It may take some time for the change to apply. Check aka.ms/homesites for details."
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  The Home site has been set to https://contoso.sharepoint.com. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  The Home site has been set to https://contoso.sharepoint.com. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  The Home site has been set to https://contoso.sharepoint.com. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+</Tabs>
+
+### `vivaConnectionsDefaultStart` response
+
+When we make use of the option `vivaConnectionsDefaultStart` the response will differ. 
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  "The Home site has been set to https://contoso.sharepoint.com and the Viva Connections default experience to True. It may take some time for the change to apply. Check aka.ms/homesites for details."
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  The Home site has been set to https://contoso.sharepoint.com and the Viva Connections default experience to True. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  The Home site has been set to https://contoso.sharepoint.com and the Viva Connections default experience to True. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  The Home site has been set to https://contoso.sharepoint.com and the Viva Connections default experience to True. It may take some time for the change to apply. Check aka.ms/homesites for details.
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- SharePoint home sites: a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)

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

@@ -0,0 +1,69 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo hubsite connect
+
+Connect a hub site to a parent hub site
+
+## Usage
+
+```sh
+m365 spo hubsite connect [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: ID of the hub site. Specify either `id`, `title`, or `url` but not multiple.
+
+`-t, --title [title]`
+: Title of the hub site. Specify either `id`, `title`, or `url` but not multiple.
+
+`-u, --url [url]`
+: Absolute or server-relative URL of the hub site. Specify either `id`, `title`, or `url` but not multiple.
+
+`--parentId [parentId]`
+: ID of the parent hub site. Specify either `parentId`, `parentTitle`, or `parentUrl` but not multiple.
+
+`--parentTitle [parentTitle]`
+: Title of the parent hub site. Specify either `parentId`, `parentTitle`, or `parentUrl` but not multiple.
+
+`--parentUrl [parentUrl]`
+: Absolute or server-relative URL of the parent hub site. Specify either `parentId`, `parentTitle`, or `parentUrl` but not multiple.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global or SharePoint administrator.
+
+:::
+
+To connect a regular site to a hub site, use command [spo site hubsite connect](../site/site-hubsite-connect.mdx).
+
+## Examples
+
+Connect a specific hub site to specific parent hub site by ID.
+
+```sh
+m365 spo hubsite connect --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --parentId 637ed2ea-b65b-4a4b-a3d7-ad86953224a4
+```
+
+Connect a specific hub site to specific parent hub site by URL.
+
+```sh
+m365 spo hubsite connect --url https://contoso.sharepoint.com/sites/project-x --parentUrl https://contoso.sharepoint.com/sites/projects
+```
+
+Connect a specific hub site with title to a parent hub site with ID.
+
+```sh
+m365 spo hubsite connect --title "My hub site" --parentId 637ed2ea-b65b-4a4b-a3d7-ad86953224a4
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,137 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo hubsite data get
+
+Get hub site data for the specified site
+
+## Usage
+
+```sh
+m365 spo hubsite data get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve hub site data.
+
+`-f, --forceRefresh`
+: Set, to refresh the server cache with the latest updates.
+```
+
+<Global />
+
+## Remarks
+
+By default, the hub site data is returned from the server's cache. To refresh the data with the latest updates, use the `-f, --forceRefresh` option. Use this option, if you just made changes and need to see them right away.
+
+If the specified site is not connected to a hub site site and is not a hub site itself, no data will be retrieved.
+
+## Examples
+
+Get information about the hub site data for a specific site with URL.
+
+```sh
+m365 spo hubsite data get --webUrl https://contoso.sharepoint.com/sites/project-x
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "headerEmphasis": "None",
+    "themeKey": "7EDE94FF",
+    "name": "Intranet",
+    "url": "https://contoso.sharepoint.com/sites/intra",
+    "logoUrl": "https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png",
+    "logoFileHash": 637696294610000000,
+    "usesMetadataNavigation": false,
+    "megaMenuEnabled": true,
+    "navigation": [],
+    "isNavAudienceTargeted": false,
+    "siteDesignId": "184644fb-90ed-4841-a7ad-6930cf819060",
+    "requiresJoinApproval": false,
+    "hideNameInNavigation": false,
+    "parentHubSiteId": "1e1232eb-1a78-4726-8bb9-56af3640228d",
+    "relatedHubSiteIds": [
+      "af80c11f-0138-4d72-bb37-514542c3aabb"
+    ],
+    "tenantInstanceId": "4d128b52-7228-46b5-8765-5b338476054d",
+    "isSameTenantInstance": true
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  headerEmphasis        : None
+  hideNameInNavigation  : false
+  isNavAudienceTargeted : false
+  isSameTenantInstance  : true
+  logoFileHash          : 637696294610000000
+  logoUrl               : https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png
+  megaMenuEnabled       : true
+  name                  : Intranet
+  navigation            : []
+  parentHubSiteId       : 1e1232eb-1a78-4726-8bb9-56af3640228d
+  relatedHubSiteIds     : ["af80c11f-0138-4d72-bb37-514542c3aabb"]
+  requiresJoinApproval  : false
+  siteDesignId          : 184644fb-90ed-4841-a7ad-6930cf819060
+  tenantInstanceId      : 4d128b52-7228-46b5-8765-5b338476054d
+  themeKey              : 7EDE94FF
+  url                   : https://contoso.sharepoint.com/sites/intra
+  usesMetadataNavigation: false
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  headerEmphasis,themeKey,name,url,logoUrl,logoFileHash,usesMetadataNavigation,megaMenuEnabled,navigation,isNavAudienceTargeted,siteDesignId,requiresJoinApproval,hideNameInNavigation,parentHubSiteId,relatedHubSiteIds,tenantInstanceId,isSameTenantInstance
+  None,7EDE94FF,Intranet,https://contoso.sharepoint.com/sites/intra,https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png,637696294610000000,false,1,[],false,184644fb-90ed-4841-a7ad-6930cf819060,,,1e1232eb-1a78-4726-8bb9-56af3640228d,"[""af80c11f-0138-4d72-bb37-514542c3aabb""]",4d128b52-7228-46b5-8765-5b338476054d,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo hubsite data get --webUrl "https://contoso.sharepoint.com/sites/intra"
+
+  Date: 2/20/2023
+
+  ## Intranet (https://contoso.sharepoint.com/sites/intra)
+
+  Property | Value
+  ---------|-------
+  headerEmphasis | None
+  themeKey | 7EDE94FF
+  name | Intranet
+  url | https://contoso.sharepoint.com/sites/intra
+  logoUrl | https://contoso.sharepoint.com/sites/intra/SiteAssets/work.png
+  logoFileHash | 637696294610000000
+  usesMetadataNavigation | false
+  megaMenuEnabled | true
+  navigation | []
+  isNavAudienceTargeted | false
+  siteDesignId | 184644fb-90ed-4841-a7ad-6930cf819060
+  requiresJoinApproval | false
+  hideNameInNavigation | false
+  parentHubSiteId | 1e1232eb-1a78-4726-8bb9-56af3640228d
+  relatedHubSiteIds | ["af80c11f-0138-4d72-bb37-514542c3aabb"]
+  tenantInstanceId | 4d128b52-7228-46b5-8765-5b338476054d
+  isSameTenantInstance | true
+  ```
+
+  </TabItem>
+</Tabs>
+
+## 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/hubsite/hubsite-disconnect.mdx

@@ -0,0 +1,65 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo hubsite disconnect
+
+Disconnect a hub site from its parent hub site
+
+## Usage
+
+```sh
+m365 spo hubsite disconnect [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: ID of the hub site. Specify either `id`, `title`, or `url` but not multiple.
+
+`-t, --title [title]`
+: Title of the hub site. Specify either `id`, `title`, or `url` but not multiple.
+
+`-u, --url [url]`
+: Absolute or server-relative URL of the hub site. Specify either `id`, `title`, or `url` but not multiple.
+
+`--confirm`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be a Global or SharePoint administrator.
+
+:::
+
+To disconnect a regular site from a hub site, use command [spo site hubsite disconnect](../site/site-hubsite-disconnect.mdx).
+
+If the specified id doesn't point to a valid hub site, you will get a ResourceNotFoundException error.
+
+## Examples
+
+Disconnect a specific hub site with id from its parent hub site.
+
+```sh
+m365 spo hubsite disconnect --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+```
+
+Disconnect a specific hub site with url from its parent hub site.
+
+```sh
+m365 spo hubsite disconnect --url https://contoso.sharepoint.com/sites/project-x
+```
+
+Disconnect a specific hub site with title from its parent hub site.
+
+```sh
+m365 spo hubsite disconnect --title "My hub site"
+```
+
+## Response
+
+The command won't return a response on success.