@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.148279d

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

@@ -0,0 +1,66 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo applicationcustomizer add
+
+Add an application customizer to a site.
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer add [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --title <title>`
+: The title of the application customizer.
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`-i, --clientSideComponentId <clientSideComponentId>`
+: Client-side component ID of the application customizer (GUID).
+
+`--clientSideComponentProperties [clientSideComponentProperties]`
+: JSON string with application customizer properties
+
+`-s, --scope [scope]`
+: Scope of the application customizer. Allowed values: `Site`, `Web`. Defaults to `Site`.
+```
+
+<Global />
+
+## Remarks
+
+Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treats quotes differently. For example, this is how an application customizer can be created from the Windows cmd.exe:
+
+```sh
+m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+:::caution Escaping JSON in PowerShell
+
+When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+## Examples
+
+Adds an application customizer to the sales site.
+
+```sh
+m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Adds an application customizer to the sales site with some properties.
+
+```sh
+m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales --scope 'Site'
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,159 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo applicationcustomizer get
+
+Get an application customizer that is added to a site.
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`-t, --title [title]`
+: The title of the Application Customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the Application Customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`-c, --clientSideComponentId  [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id`, or `clientSideComponentId`.
+
+`-s, --scope [scope]`
+: Scope of the application customizer. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
+```
+
+<Global />
+
+## Examples
+
+Retrieves an application customizer by title.
+
+```sh
+m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Retrieves an application customizer by id.
+
+```sh
+m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Retrieves an application customizer by clientSideComponentId.
+
+```sh
+m365 spo applicationcustomizer get --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Retrieves an application customizer by title available at the site scope.
+
+```sh
+m365 spo applicationcustomizer get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales --scope site
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "ClientSideComponentId": "7096cded-b83d-4eab-96f0-df477ed7c0bc",
+    "ClientSideComponentProperties": "",
+    "CommandUIExtension": null,
+    "Description": null,
+    "Group": null,
+    "Id": "14125658-a9bc-4ddf-9c75-1b5767c9a337",
+    "ImageUrl": null,
+    "Location": "ClientSideExtension.ApplicationCustomizer",
+    "Name": "Some customizer",
+    "RegistrationId": null,
+    "RegistrationType": 0,
+    "Rights": "{\"High\":0,\"Low\":0}",
+    "Scope": "Web",
+    "ScriptBlock": null,
+    "ScriptSrc": null,
+    "Sequence": 0,
+    "Title": "Some customizer",
+    "Url": null,
+    "VersionOfUserCustomAction": "16.0.1.0"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ClientSideComponentId        : 7096cded-b83d-4eab-96f0-df477ed7c0bc
+  ClientSideComponentProperties:
+  CommandUIExtension           : null
+  Description                  : null
+  Group                        : null
+  Id                           : 14125658-a9bc-4ddf-9c75-1b5767c9a337
+  ImageUrl                     : null
+  Location                     : ClientSideExtension.ApplicationCustomizer
+  Name                         : Some customizer
+  RegistrationId               : null
+  RegistrationType             : 0
+  Rights                       : {"High":0,"Low":0}
+  Scope                        : Web
+  ScriptBlock                  : null
+  ScriptSrc                    : null
+  Sequence                     : 0
+  Title                        : Some customizer
+  Url                          : null
+  VersionOfUserCustomAction    : 16.0.1.0
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
+  7096cded-b83d-4eab-96f0-df477ed7c0bc,,,,,14125658-a9bc-4ddf-9c75-1b5767c9a337,,ClientSideExtension.ApplicationCustomizer,Some customizer,,0,"{""High"":0,""Low"":0}",Web,,,0,Some customizer,,16.0.1.0
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo applicationcustomizer get --title "Some customizer" --webUrl "https://nachan365.sharepoint.com/sites/spdemo" --scope "Web"
+
+  Date: 3/6/2023
+
+  ## Some customizer (14125658-a9bc-4ddf-9c75-1b5767c9a337)
+
+  Property | Value
+  ---------|-------
+  ClientSideComponentId | 7096cded-b83d-4eab-96f0-df477ed7c0bc
+  ClientSideComponentProperties |
+  CommandUIExtension | null
+  Description | null
+  Group | null
+  Id | 14125658-a9bc-4ddf-9c75-1b5767c9a337
+  ImageUrl | null
+  Location | ClientSideExtension.ApplicationCustomizer
+  Name | Some customizer
+  RegistrationId | null
+  RegistrationType | 0
+  Rights | {"High":0,"Low":0}
+  Scope | Web
+  ScriptBlock | null
+  ScriptSrc | null
+  Sequence | 0
+  Title | Some customizer
+  Url | null
+  VersionOfUserCustomAction | 16.0.1.0
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,123 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo applicationcustomizer list
+
+Get a list of application customizers that are added to a site.
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The url of the site.
+
+`-s, --scope [scope]`
+: Scope of the application customizers. Allowed values `Site`, `Web`, `All`. Defaults to `All`
+```
+
+<Global />
+
+## Examples
+
+Retrieves a list of application customizers.
+
+```sh
+m365 spo applicationcustomizer list --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "ClientSideComponentId": "4358e70e-ec3c-4713-beb6-39c88f7621d1",
+      "ClientSideComponentProperties": "{\"listTitle\":\"News\",\"listViewTitle\":\"Published News\"}",
+      "CommandUIExtension": null,
+      "Description": null,
+      "Group": null,
+      "HostProperties": "",
+      "Id": "f405303c-6048-4636-9660-1b7b2cadaef9",
+      "ImageUrl": null,
+      "Location": "ClientSideExtension.ApplicationCustomizer",
+      "Name": "{f405303c-6048-4636-9660-1b7b2cadaef9}",
+      "RegistrationId": null,
+      "RegistrationType": 0,
+      "Rights": {
+        "High": 0,
+        "Low": 0
+      },
+      "Scope": 3,
+      "ScriptBlock": null,
+      "ScriptSrc": null,
+      "Sequence": 65536,
+      "Title": "NewsTicker",
+      "Url": null,
+      "VersionOfUserCustomAction": "1.0.1.0"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Name                                    Location                                   Scope  Id
+  --------------------------------------  -----------------------------------------  -----  ------------------------------------
+  {f405303c-6048-4636-9660-1b7b2cadaef9}  ClientSideExtension.ApplicationCustomizer  3      f405303c-6048-4636-9660-1b7b2cadaef9
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Name,Location,Scope,Id
+  {f405303c-6048-4636-9660-1b7b2cadaef9},ClientSideExtension.ApplicationCustomizer,3,f405303c-6048-4636-9660-1b7b2cadaef9
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo applicationcustomizer list --webUrl "https://contoso.sharepoint.com"
+
+  Date: 28/2/2023
+
+  ## NewsTicker (f405303c-6048-4636-9660-1b7b2cadaef9)
+
+  Property | Value
+  ---------|-------
+  ClientSideComponentId | 4358e70e-ec3c-4713-beb6-39c88f7621d1
+  ClientSideComponentProperties | {"listTitle":"News","listViewTitle":"Published News"}
+  CommandUIExtension | null
+  Description | null
+  Group | null
+  HostProperties |
+  Id | f405303c-6048-4636-9660-1b7b2cadaef9
+  ImageUrl | null
+  Location | ClientSideExtension.ApplicationCustomizer
+  Name | {f405303c-6048-4636-9660-1b7b2cadaef9}
+  RegistrationId | null
+  RegistrationType | 0
+  Rights | {"High":0,"Low":0}
+  Scope | 3
+  ScriptBlock | null
+  ScriptSrc | null
+  Sequence | 65536
+  Title | NewsTicker
+  Url | null
+  VersionOfUserCustomAction | 1.0.1.0
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,81 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo applicationcustomizer remove
+
+Removes an application customizer that is added to a site
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The url of the site.
+
+`-t, --title [title]`
+: The title of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the Application Customizer. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the application customizer. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-s, --scope [scope]`
+: Scope of the application customizer. Allowed values: `Site`, `Web`, and `All`. Defaults to `All`.
+
+`--confirm`
+: Don't prompt for confirming removal of the application customizer.
+```
+
+<Global />
+
+## Remarks
+
+If the command finds multiple application customizers with the specified title or clientSideComponentId, it will prompt you to disambiguate which customizer it should remove, listing the discovered IDs.
+
+## Examples
+
+Remove an application customizer by id
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove an application customizer by title
+
+```sh
+m365 spo applicationcustomizer remove --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove an application customizer by clientSideComponentId
+
+```sh
+m365 spo applicationcustomizer remove --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove an application customizer by its id without prompting for confirmation
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm
+```
+
+Remove an application customizer from a site collection by its id without prompting for confirmation
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm --scope Site
+```
+
+Remove an application customizer from a site by its id without prompting for confirmation
+
+```sh
+m365 spo applicationcustomizer remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales --confirm --scope Web
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,72 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo applicationcustomizer set
+
+Updates an existing Application Customizer on a site
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The site to update the Application Customizer on.
+
+`-t, --title [title]`
+: The title of the Application Customizer to update. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the Application Customizer to update. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the Application Customizer to update. Specify either `title`, `id` or `clientSideComponentId`.
+
+`--newTitle [newTitle]`
+: The new title of the Application Customizer.
+
+`-p, --clientSideComponentProperties  [clientSideComponentProperties]`
+: The Client Side Component properties of the Application Customizer.
+
+`-s, --scope [scope]`
+: The scope where to lookup the Application Customizer. Allowed values: `Site`, `Web`, and `All`. Defaults to `All`.
+```
+
+<Global />
+
+## Remarks
+
+Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for clientSideComponentProperties option that has JSON value because the command shell treats quotes differently. For example, this is how Application Customizer can be updated from the Windows cmd.exe:
+
+```sh
+m365 spo applicationcustomizer set --webUrl https://contoso.sharepoint.com/sites/sales --id b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --newTitle "Some customizer" --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option (--clientSideComponentProperties) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+:::caution Escaping JSON in PowerShell
+
+When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
+
+:::
+
+## Examples
+
+Updates the title of an application customizer on the sales site
+
+```sh
+m365 spo applicationcustomizer set --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --newTitle "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Updates the properties of an application customizer on the sales site
+
+```sh
+m365 spo applicationcustomizer set --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --clientSideComponentProperties '{ "testMessage": "Test message" }' --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo apppage add
+
+Creates a single-part app page
+
+## Usage
+
+```sh
+m365 spo apppage add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the page should be created
+
+`-t, --title <title>`
+: The title of the page to be created
+
+`-d, --webPartData <webPartData>`
+: JSON string of the web part to put on the page
+
+`--addToQuickLaunch`
+: Set, to add the page to the quick launch
+```
+
+<Global />
+
+## Remarks
+
+If you want to add the single-part app page to quick launch, use the addToQuickLaunch flag.
+
+## Examples
+
+Create a single-part app page in a site with url https://contoso.sharepoint.com, webpart data is stored in the `$webPartData` variable
+
+```sh
+m365 spo apppage add --title "Contoso" --webUrl "https://contoso.sharepoint.com" --webPartData $webPartData --addToQuickLaunch
+```

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

@@ -0,0 +1,34 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo apppage set
+
+Updates the single-part app page
+
+## Usage
+
+```sh
+m365 spo apppage set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the page to update is located
+
+`-n, --name <name>`
+: The name of the page to be updated, eg. page.aspx
+
+`-d, --webPartData <webPartData>`
+: JSON string of the web part to update on the page
+```
+
+<Global />
+
+## Examples
+
+Updates the single-part app page located in a site with url https://contoso.sharepoint.com. Web part data is stored in the `$webPartData` variable
+
+```sh
+m365 spo apppage set --webUrl "https://contoso.sharepoint.com" --name "Contoso.aspx" --webPartData $webPartData
+```

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

@@ -0,0 +1,48 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo cdn get
+
+View current status of the specified Microsoft 365 CDN
+
+## Usage
+
+```sh
+m365 spo cdn get [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --type [type]`
+: Type of CDN to manage. Allowed values `Public`, `Private`. Default `Public`.
+```
+
+<Global />
+
+## Remarks
+
+Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+
+## Examples
+
+Show if the Public CDN is currently enabled or not.
+
+```sh
+m365 spo cdn get
+```
+
+Show if the Private CDN is currently enabled or not.
+
+```sh
+m365 spo cdn get --type Private
+```
+
+## More information
+
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)

package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx

@@ -0,0 +1,45 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo cdn origin add
+
+Adds CDN origin to the current SharePoint Online tenant
+
+## Usage
+
+```sh
+m365 spo cdn origin add [options]
+```
+
+## Options
+
+```md definition-list
+`-t, --type [type]`
+: Type of CDN to manage. `Public,Private`. Default `Public`
+
+`-r, --origin <origin>`
+: Origin to add to the current CDN configuration
+```
+
+<Global />
+
+## Remarks
+
+Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default) or Private CDN. If you don't use the option, the command will use the Public CDN.
+
+:::info
+
+To use this command you have to have permissions to access the tenant admin site.
+
+:::
+    
+## Examples
+
+Add _*/CDN_ to the list of origins of the Public CDN
+
+```sh
+m365 spo cdn origin add --type Public --origin */CDN
+```
+
+## More information
+
+- Use Microsoft 365 CDN with SharePoint Online: [https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide](https://learn.microsoft.com/microsoft-365/enterprise/use-microsoft-365-cdn-with-spo?view=o365-worldwide)