@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.bb31388

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

@@ -0,0 +1,80 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign set
+
+Updates a site design with new values
+
+## Usage
+
+```sh
+m365 spo sitedesign set [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: The ID of the site design to update
+
+`-t, --title [title]`
+: The new display name of the updated site design
+
+`-w, --webTemplate [webTemplate]`
+: The new template to add the site design to. Allowed values `TeamSite,CommunicationSite`
+
+`-s, --siteScripts [siteScripts]`
+: Comma-separated list of new site script IDs. The scripts will run in the order listed
+
+`-d, --description [description]`
+: The new display description of updated site design
+
+`-m, --previewImageUrl [previewImageUrl]`
+: The new URL of a preview image. If none is specified SharePoint will use a generic image
+
+`-a, --previewImageAltText [previewImageAltText]`
+: The new alt text description of the image for accessibility
+
+`--thumbnailUrl [thumbnailUrl]`
+: The new URL of a thumbnail image. If none is specified SharePoint will use a generic image
+
+`-v, --version [version]`
+: The new version number for the site design
+
+`--isDefault [isDefault]`
+: Set to true if the site design is applied as the default site design
+```
+
+<Global />
+
+## Remarks
+
+If you had previously set the `isDefault` option to `true`, and wish for it to remain `true`, you must pass in this option again or it will be reset to `false`.
+
+When specifying IDs of site scripts to use with your site design, ensure that the IDs refer to existing site scripts or provisioning sites using the design will lead to unexpected results.
+
+## Examples
+
+Update the site design title and version
+
+```sh
+m365 spo sitedesign set --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --title "Contoso site design" --version 2
+```
+
+Update the site design to be the default design for provisioning modern communication sites
+
+```sh
+m365 spo sitedesign set --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webTemplate CommunicationSite  --isDefault true
+```
+
+
+Update the site design to be the default design for provisioning modern communication sites, with specific scripts
+
+```sh
+m365 spo sitedesign set --id 9b142c22-037f-4a7f-9017-e9d8c0e34b98 --webTemplate CommunicationSite  --isDefault true --siteScripts "19b0e1b2-e3d1-473f-9394-f08c198ef43e,b2307a39-e878-458b-bc90-03bc578531d6"
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)
+- Customize a default site design: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/customize-default-site-design)
+- Site design JSON schema: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-json-schema](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-json-schema)

package/docs/docs/cmd/spo/sitedesign/sitedesign-task-get.mdx

@@ -0,0 +1,32 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign task get
+
+Gets information about the specified site design scheduled for execution
+
+## Usage
+
+```sh
+m365 spo sitedesign task get [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: The ID of the site design task to get information for
+```
+
+<Global />
+
+## Examples
+
+Get information about the specified site design scheduled for execution
+
+```sh
+m365 spo sitedesign task get --id 6ec3ca5b-d04b-4381-b169-61378556d76e
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-task-list.mdx

@@ -0,0 +1,32 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign task list
+
+Lists site designs scheduled for execution on the specified site
+
+## Usage
+
+```sh
+m365 spo sitedesign task list [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --webUrl <webUrl>`
+: The URL of the site for which to list site designs scheduled for execution
+```
+
+<Global />
+
+## Examples
+
+List site designs scheduled for execution on the specified site
+
+```sh
+m365 spo sitedesign task list --webUrl https://contoso.sharepoint.com/sites/team-a
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitedesign/sitedesign-task-remove.mdx

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitedesign task remove
+
+Removes the specified site design scheduled for execution
+
+## Usage
+
+```sh
+m365 spo sitedesign task remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: The ID of the site design task to remove
+
+`--confirm`
+: Don't prompt for confirming removing the site design task
+```
+
+<Global />
+
+## Examples
+
+Removes the specified site design task with id _6ec3ca5b-d04b-4381-b169-61378556d76e_ scheduled for execution without prompting confirmation
+
+```sh
+m365 spo sitedesign task remove --id 6ec3ca5b-d04b-4381-b169-61378556d76e --confirm
+```
+
+Removes the specified site design task with id _6ec3ca5b-d04b-4381-b169-61378556d76e_ scheduled for execution with prompt for confirmation before removing
+
+```sh
+m365 spo sitedesign task remove --id 6ec3ca5b-d04b-4381-b169-61378556d76e
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

package/docs/docs/cmd/spo/sitescript/sitescript-add.mdx

@@ -0,0 +1,42 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitescript add
+
+Adds site script for use with site designs
+
+## Usage
+
+```sh
+m365 spo sitescript add [options]
+```
+
+## Options
+
+```md defintion-list
+`-t, --title <title>`
+: Site script title
+
+`-c, --content <content>`
+: JSON string containing the site script
+
+`-d, --description [description]`
+: Site script description
+```
+
+<Global />
+
+## Remarks
+
+Each time you execute the `spo sitescript add` command, it will create a new site script with a unique ID. Before creating a site script, be sure that another script with the same name doesn't already exist.
+
+## Examples
+
+Create new site script for use with site designs. Script contents are stored in the `$script` variable
+
+```sh
+m365 spo sitescript add --title "Contoso" --description "Contoso theme script" --content $script
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

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

@@ -0,0 +1,36 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitescript get
+
+Gets information about the specified site script
+
+## Usage
+
+```sh
+m365 spo sitescript get [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: Site script ID
+```
+
+<Global />
+
+## Remarks
+
+If the specified `id` doesn't refer to an existing site script, you will get a `File not found` error.
+
+## Examples
+
+Get information about the site script with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_
+
+```sh
+m365 spo sitescript get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

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

@@ -0,0 +1,27 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitescript list
+
+Lists site script available for use with site designs
+
+## Usage
+
+```sh
+m365 spo sitescript list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+List all site scripts available for use with site designs
+
+```sh
+m365 spo sitescript list
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

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

@@ -0,0 +1,45 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitescript remove
+
+Removes the specified site script
+
+## Usage
+
+```sh
+m365 spo sitescript remove [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: Site script ID
+
+`--confirm`
+: Don't prompt for confirming removing the site script
+```
+
+<Global />
+
+## Remarks
+
+If the specified `id` doesn't refer to an existing site script, you will get a `File not found` error.
+
+## Examples
+
+Remove site script with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_. Will prompt for confirmation before removing the script
+
+```sh
+m365 spo sitescript remove --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
+```
+
+Remove site script with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_ without prompting for confirmation
+
+```sh
+m365 spo sitescript remove --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --confirm
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

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

@@ -0,0 +1,48 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo sitescript set
+
+Updates existing site script
+
+## Usage
+
+```sh
+m365 spo sitescript set [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: Site script ID
+
+`-t, --title [title]`
+: Site script title
+
+`-d, --description [description]`
+: Site script description
+
+`-v, --version [version]`
+: Site script version
+
+`-c, --content [content]`
+: JSON string containing the site script
+```
+
+<Global />
+
+## Remarks
+
+If the specified `id` doesn't refer to an existing site script, you will get a `File not found` error.
+
+## Examples
+
+Update title of the existing site script with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_
+
+```sh
+m365 spo sitescript set --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --title "Contoso"
+```
+
+## More information
+
+- SharePoint site design and site script overview: [https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview](https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-overview)

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

@@ -0,0 +1,72 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo get
+
+Gets the context URL for the root SharePoint site collection and SharePoint tenant admin site
+
+## Usage
+
+```sh
+m365 spo get [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+CLI for Microsoft 365 automatically discovers the URL of the root SharePoint site collection/SharePoint tenant admin site (whichever is needed to run the particular command). Using this command you can see which URLs the CLI has discovered.
+
+## Examples
+
+Get the context URL for the root SharePoint site collection and SharePoint tenant admin site
+
+```sh
+m365 spo get --output json
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "SpoUrl": "https://contoso.sharepoint.com"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  SpoUrl: https://contoso.sharepoint.com
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  SpoUrl
+  https://contoso.sharepoint.com
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo get 
+
+  Date: 4/10/2023
+
+  Property | Value
+  ---------|-------
+  SpoUrl | https://contoso.sharepoint.com
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/spo/spo-search.mdx

@@ -0,0 +1,167 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo search
+
+Executes a search query
+
+## Usage
+
+```sh
+m365 spo search [options]
+```
+
+## Options
+
+```md defintion-list
+`-q, --queryText <queryText>`
+: Query to be executed in KQL format
+
+`-p, --selectProperties [selectProperties]`
+: Comma-separated list of properties to retrieve. Will retrieve all properties if not specified and json output is requested.
+
+`-u, --webUrl [webUrl]`
+: The web against which we want to execute the query. If the parameter is not defined, the query is executed against the web that's used when logging in to the SPO environment.
+
+`--allResults`
+: Set, to get all results of the search query, instead of the number specified by the `rowlimit` (default: 10)
+
+`--rowLimit [rowLimit]`
+: The number of rows to be returned. When the `allResults` option is used, the specified value will define the size of retrieved batches
+
+`--sourceId [sourceId]`
+: The identifier (GUID) of the result source to be used to run the query.
+
+`--trimDuplicates`
+: Set, to remove near duplicate items from the search results.
+
+`--enableStemming`
+: Set, to enable stemming.
+
+`--culture [culture]`
+: The locale for the query.
+
+`--refinementFilters [refinementFilters]`
+: The set of refinement filters used when issuing a refinement query.
+
+`--queryTemplate [queryTemplate]`
+: A string that contains the text that replaces the query text, as part of a query transformation.
+
+`--sortList [sortList]`
+: The list of properties by which the search results are ordered.
+
+`--rankingModelId [rankingModelId]`
+: The ID of the ranking model to use for the query.
+
+`--startRow [startRow]`
+: The first row that is included in the search results that are returned. You use this parameter when you want to implement paging for search results.
+
+`--properties [properties]`
+: Additional properties for the query.
+
+`--sourceName [sourceName]`
+: Specified the name of the result source to be used to run the query.
+
+`--refiners [refiners]`
+: The set of refiners to return in a search result.
+
+`--hiddenConstraints [hiddenConstraints]`
+: The additional query terms to append to the query.
+
+`--clientType [clientType]`
+: The type of the client that issued the query.
+
+`--enablePhonetic`
+: Set, to use the phonetic forms of the query terms to find matches. (Default = `false`).
+
+`--processBestBets`
+: Set, to return best bet results for the query.
+
+`--enableQueryRules`
+: Set, to enable query rules for the query.
+
+`--processPersonalFavorites`
+: Set, to return personal favorites with the search results.
+
+`--rawOutput`
+: Set, to return the unparsed, raw results of the REST call to the search API.
+```
+
+<Global />
+
+## Examples
+
+Execute search query to retrieve all Document Sets (ContentTypeId = _0x0120D520_) for the English locale
+
+```sh
+m365 spo search --queryText "ContentTypeId:0x0120D520" --culture 1033
+```
+
+Retrieve all documents. For each document, retrieve the _Path_, _Author_ and _FileType_.
+
+```sh
+m365 spo search --queryText "IsDocument:1" --selectProperties "Path,Author,FileType" --allResults
+```
+
+Return the top 50 items of which the title starts with _Marketing_ while trimming duplicates.
+
+```sh
+m365 spo search --queryText "Title:Marketing*" --rowLimit=50 --trimDuplicates
+```
+
+Return only items from a specific result source (using the source id).
+
+```sh
+m365 spo search --queryText "*" --sourceId "6e71030e-5e16-4406-9bff-9c1829843083"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Title": "Document",
+      "OriginalPath": "https://contoso.sharepoint.com/Shared Documents/Document.docx"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Title     OriginalPath
+  --------  -------------------------------------------------------------
+  Document  https://contoso.sharepoint.com/Shared Documents/Document.docx
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Title,OriginalPath
+  Document,https://contoso.sharepoint.com/Shared Documents/Document.docx
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo search --queryText "Title:Marketing*" --rowLimit "50" --trimDuplicates "true"
+
+  Date: 4/10/2023
+
+  ## Marketing lunch
+  Property | Value
+  ---------|-------
+  Title | Marketing lunch
+  OriginalPath | https://contoso.sharepoint.com/sites/contosoportal/SitePages/Marketing-Lunch.aspx
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,36 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo set
+
+Sets the URL of the root SharePoint site collection for use in SPO commands
+
+## Usage
+
+```sh
+m365 spo set [options]
+```
+
+## Options
+
+```md defintion-list
+`-u, --url <url>`
+: The URL of the root SharePoint site collection to use in SPO commands
+```
+
+<Global />
+
+## Remarks
+
+CLI for Microsoft 365 automatically discovers the URL of the root SharePoint site collection/SharePoint tenant admin site (whichever is needed to run the particular command). In specific cases, like when managing multi-geo Microsoft 365 tenants, it could be desirable to make the CLI manage the specific geography. For such cases, you can use this command to explicitly specify the SPO URL that should be used when executing SPO commands.
+
+## Examples
+
+Set SPO URL to the specified URL
+
+```sh
+m365 spo set --url https://contoso.sharepoint.com
+```
+
+## Response
+
+The command won't return a response on success.