@pnp/cli-microsoft365 6.4.0-beta.b1f742c → 6.4.0-beta.f8f3553

package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md

@@ -21,13 +21,13 @@ m365 spo cdn origin remove [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## 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.
 
+!!! important
+    To use this command you have to have permissions to access the tenant admin site.
+    
 ## Examples
 
 Remove _*/CDN_ from the list of origins of the Public CDN

package/docs/docs/cmd/spo/cdn/cdn-policy-list.md

@@ -15,13 +15,13 @@ m365 spo cdn policy list [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
 Using the `-t, --cdnType` 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.
 
+!!! important
+    To use this command you have to have permissions to access the tenant admin site.
+
 ## Examples
 
 Show the list of policies configured for the Public CDN

package/docs/docs/cmd/spo/cdn/cdn-policy-set.md

@@ -21,13 +21,13 @@ m365 spo cdn policy set [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
 Using the `-t, --cdnType` 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.
 
+!!! important
+    To use this command you have to have permissions to access the tenant admin site.
+    
 ## Examples
 
 Set the list of extensions supported by the Public CDN

package/docs/docs/cmd/spo/cdn/cdn-set.md

@@ -21,9 +21,6 @@ m365 spo cdn set [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    To use this command you have to have permissions to access the tenant admin site.
-
 ## Remarks
 
 Using the `-t, --type` option you can choose whether you want to manage the settings of the Public (default), Private CDN or both. If you don't use the option, the command will use the Public CDN.
@@ -32,6 +29,9 @@ Using the `-e, --enabled` option you can specify whether the given CDN type shou
 
 Using the `--noDefaultOrigins` option you can specify to skip the creation of the default origins.
 
+!!! important
+    To use this command you have to have permissions to access the tenant admin site.
+
 ## Examples
 
 Enable the Microsoft 365 Public CDN on the current tenant

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

@@ -0,0 +1,159 @@
+# spo commandset add
+
+Add a ListView Command Set to a site.
+
+## Usage
+
+```sh
+m365 spo commandset add [options]
+```
+
+## Options
+
+`-t, --title <title>`
+: The title of the ListView Command Set
+
+`-u, --webUrl <webUrl>`
+: The site to add the ListView Command Set.
+
+`-l, --listType <listType>`
+: The list or library type to register the Command Set on. Allowed values `List`, `Library` or `SitePages`.
+
+`-i, --clientSideComponentId <clientSideComponentId>`
+: The Client Side Component Id (GUID) of the ListView Command Set.
+
+`--clientSideComponentProperties [clientSideComponentProperties]`
+: The Client Side Component properties of the ListView Command Set.
+
+`-s, --scope [scope]`
+: Scope of the ListView Command Set. Allowed values: `Site`, `Web`. Defaults to `Web`.
+
+`--location [location]`
+: The location of the ListView Command Set. Allowed values `ContextMenu`, `CommandBar` or `Both`. Defaults to `CommandBar`.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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 a ListView Command Set can be created from the Windows cmd.exe:
+
+```sh
+m365 spo commandset add --webUrl https://contoso.sharepoint.com/sites/test --title "CLI Commandset" --location "ContextMenu" --listType "List" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+!!! warning "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.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
+## Examples
+
+Adds a ListView Command Set to lists on the sales site.
+
+```sh
+m365 spo commandset add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --listType List --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Adds a ListView Command Set to lists on the sales site with some properties.
+
+```sh
+m365 spo commandset add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --listType List --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "ClientSideComponentId": "b206e130-1a5b-4ae7-86a7-4f91c9924d0a",
+      "ClientSideComponentProperties": "",
+      "CommandUIExtension": null,
+      "Description": null,
+      "Group": null,
+      "HostProperties": "",
+      "Id": "680ccc51-7ddf-4dda-8696-fc606480cc3f",
+      "ImageUrl": null,
+      "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
+      "Name": null,
+      "RegistrationId": "100",
+      "RegistrationType": 0,
+      "Rights": {
+        "High": "0",
+        "Low": "0"
+      },
+      "Scope": 2,
+      "ScriptBlock": null,
+      "ScriptSrc": null,
+      "Sequence": 0,
+      "Title": "CLI Commandset",
+      "Url": null,
+      "VersionOfUserCustomAction": "16.0.1.0"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    ClientSideComponentId        : b206e130-1a5b-4ae7-86a7-4f91c9924d0a
+    ClientSideComponentProperties:
+    CommandUIExtension           : null
+    Description                  : null
+    Group                        : null
+    HostProperties               :
+    Id                           : 680ccc51-7ddf-4dda-8696-fc606480cc3f
+    ImageUrl                     : null
+    Location                     : ClientSideExtension.ListViewCommandSet.CommandBar
+    Name                         : null
+    RegistrationId               : 100
+    RegistrationType             : 0
+    Rights                       : {"High":"0","Low":"0"}
+    Scope                        : 2
+    ScriptBlock                  : null
+    ScriptSrc                    : null
+    Sequence                     : 0
+    Title                        : CLI Commandset
+    Url                          : null
+    VersionOfUserCustomAction    : 16.0.1.0
+    ```
+
+=== "CSV"
+
+    ```csv
+    ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
+    b206e130-1a5b-4ae7-86a7-4f91c9924d0a,,,,,,680ccc51-7ddf-4dda-8696-fc606480cc3f,,ClientSideExtension.ListViewCommandSet.CommandBar,,100,0,"{""High"":""0"",""Low"":""0""}",2,,,0,CLI Commandset,,16.0.1.0
+    ```
+
+=== "Markdown"
+
+    ```md
+    # spo commandset add --title "CLI Commandset" --webUrl "https://contoso.sharepoint.com" --clientSideComponentId "b206e130-1a5b-4ae7-86a7-4f91c9924d0a" --listType "List" --scope "Site"
+
+    Date: 10/2/2023
+
+    ## CLI Commandset (680ccc51-7ddf-4dda-8696-fc606480cc3f)
+
+    Property | Value
+    ---------|-------
+    ClientSideComponentId | b206e130-1a5b-4ae7-86a7-4f91c9924d0a
+    ClientSideComponentProperties |
+    CommandUIExtension | null
+    Description | null
+    Group | null
+    HostProperties |
+    Id | 680ccc51-7ddf-4dda-8696-fc606480cc3f
+    ImageUrl | null
+    Location | ClientSideExtension.ListViewCommandSet.CommandBar
+    Name | null
+    RegistrationId | 100
+    RegistrationType | 0
+    Rights | {"High":"0","Low":"0"}
+    Scope | 2
+    ScriptBlock | null
+    ScriptSrc | null
+    Sequence | 0
+    Title | CLI Commandset
+    Url | null
+    VersionOfUserCustomAction | 16.0.1.0
+    ```
+

package/docs/docs/cmd/spo/commandset/commandset-get.md

@@ -0,0 +1,149 @@
+# spo commandset get
+
+Get a ListView Command Set that is added to a site.
+
+## Usage
+
+```sh
+m365 spo commandset get [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Url of the site.
+
+`-t, --title [title]`
+: The title of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-s, --scope [scope]`
+: Scope of the ListView Command Set. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the command finds multiple command sets with the specified title, it will prompt you to disambiguate which command set it should use, listing the discovered IDs.
+
+## Examples
+
+Retrieves a ListView Command Set by title.
+
+```sh
+m365 spo commandset get --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Retrieves a ListView Command Set by id with scope 'Web'.
+
+```sh
+m365 spo commandset get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales -scope Web
+```
+
+Retrieves a ListView Command Set by clientSideComponentId with scope 'Site'.
+
+```sh
+m365 spo commandset get --clientSideComponentId c1cbd896-5140-428d-8b0c-4873be19f5ac --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "ClientSideComponentId": "c1cbd896-5140-428d-8b0c-4873be19f5ac",
+      "ClientSideComponentProperties": "{\"sampleTextOne\":\"One item is selected in the list.\", \"sampleTextTwo\":\"This command is always visible.\"}",
+      "CommandUIExtension": null,
+      "Description": null,
+      "Group": null,
+      "HostProperties": "",
+      "Id": "9a0674de-2f3d-4a26-ba79-62b460ddd327",
+      "ImageUrl": null,
+      "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
+      "Name": "{9a0674de-2f3d-4a26-ba79-62b460ddd327}",
+      "RegistrationId": "100",
+      "RegistrationType": 1,
+      "Rights": {
+        "High": "0",
+        "Low": "0"
+      },
+      "Scope": 3,
+      "ScriptBlock": null,
+      "ScriptSrc": null,
+      "Sequence": 65536,
+      "Title": "Notification",
+      "Url": null,
+      "VersionOfUserCustomAction": "1.0.1.0"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    ClientSideComponentId        : c1cbd896-5140-428d-8b0c-4873be19f5ac
+    ClientSideComponentProperties: {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
+    CommandUIExtension           : null
+    Description                  : null
+    Group                        : null
+    HostProperties               :
+    Id                           : 9a0674de-2f3d-4a26-ba79-62b460ddd327
+    ImageUrl                     : null
+    Location                     : ClientSideExtension.ListViewCommandSet.CommandBar
+    Name                         : {9a0674de-2f3d-4a26-ba79-62b460ddd327}
+    RegistrationId               : 100
+    RegistrationType             : 1
+    Rights                       : {"High":"0","Low":"0"}
+    Scope                        : 3
+    ScriptBlock                  : null
+    ScriptSrc                    : null
+    Sequence                     : 65536
+    Title                        : Notification
+    Url                          : null
+    VersionOfUserCustomAction    : 1.0.1.0
+    ```
+
+=== "CSV"
+
+    ```csv
+    ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,HostProperties,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
+    c1cbd896-5140-428d-8b0c-4873be19f5ac,"{""sampleTextOne"":""One item is selected in the list."", ""sampleTextTwo"":""This command is always visible.""}",,,,,9a0674de-2f3d-4a26-ba79-62b460ddd327,,ClientSideExtension.ListViewCommandSet.CommandBar,{9a0674de-2f3d-4a26-ba79-62b460ddd327},100,1,"{""High"":""0"",""Low"":""0""}",3,,,65536,Notification,,1.0.1.0
+    ```
+
+=== "Markdown"
+
+    ```md
+    # spo commandset get --webUrl "https://contoso.sharepoint.com/sites/sales" --id "9a0674de-2f3d-4a26-ba79-62b460ddd327"
+
+    Date: 27/02/2023
+
+    ## Notification (9a0674de-2f3d-4a26-ba79-62b460ddd327)
+
+    Property | Value
+    ---------|-------
+    ClientSideComponentId | c1cbd896-5140-428d-8b0c-4873be19f5ac
+    ClientSideComponentProperties | {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
+    CommandUIExtension | null
+    Description | null
+    Group | null
+    HostProperties |
+    Id | 9a0674de-2f3d-4a26-ba79-62b460ddd327
+    ImageUrl | null
+    Location | ClientSideExtension.ListViewCommandSet.CommandBar
+    Name | {9a0674de-2f3d-4a26-ba79-62b460ddd327}
+    RegistrationId | 100
+    RegistrationType | 1
+    Rights | {"High":"0","Low":"0"}
+    Scope | 3
+    ScriptBlock | null
+    ScriptSrc | null
+    Sequence | 65536
+    Title | Notification
+    Url | null
+    VersionOfUserCustomAction | 1.0.1.0
+    ```

package/docs/docs/cmd/spo/commandset/commandset-list.md

@@ -0,0 +1,109 @@
+# spo commandset list
+
+Get a list of ListView Command Sets that are added to a site.
+
+## Usage
+
+```sh
+m365 spo commandset list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The url of the site.
+
+`-s, --scope [scope]`
+: Scope of the ListView Command Sets. Allowed values `Site`, `Web`, `All`. Default to `All`
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieves a list of ListView Command Sets.
+
+```sh
+m365 spo commandset list --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "ClientSideComponentId": "b206e130-1a5b-4ae7-86a7-4f91c9924d0a",
+        "ClientSideComponentProperties": "",
+        "CommandUIExtension": null,
+        "Description": null,
+        "Group": null,
+        "HostProperties": "",
+        "Id": "e7000aef-f756-4997-9420-01cc84f9ac9c",
+        "ImageUrl": null,
+        "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
+        "Name": "{e7000aef-f756-4997-9420-01cc84f9ac9c}",
+        "RegistrationId": "100",
+        "RegistrationType": 0,
+        "Rights": {
+          "High": 0,
+          "Low": 0
+        },
+        "Scope": 2,
+        "ScriptBlock": null,
+        "ScriptSrc": null,
+        "Sequence": 0,
+        "Title": "test",
+        "Url": null,
+        "VersionOfUserCustomAction": "16.0.1.0"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Name                                    Location                                           Scope  Id
+    --------------------------------------  -------------------------------------------------  -----  ------------------------------------
+    {e7000aef-f756-4997-9420-01cc84f9ac9c}  ClientSideExtension.ListViewCommandSet.CommandBar  2      e7000aef-f756-4997-9420-01cc84f9ac9c
+    ```
+
+=== "CSV"
+
+    ```csv
+    Name,Location,Scope,Id
+    {e7000aef-f756-4997-9420-01cc84f9ac9c},ClientSideExtension.ListViewCommandSet.CommandBar,2,e7000aef-f756-4997-9420-01cc84f9ac9c
+    ```
+
+=== "Markdown"
+
+    ```md
+    # spo commandset list --webUrl "https://ordidev.sharepoint.com"
+
+    Date: 20/2/2023
+
+    ## test (e7000aef-f756-4997-9420-01cc84f9ac9c)
+
+    Property | Value
+    ---------|-------
+    ClientSideComponentId | b206e130-1a5b-4ae7-86a7-4f91c9924d0a
+    ClientSideComponentProperties |
+    CommandUIExtension | null
+    Description | null
+    Group | null
+    HostProperties |
+    Id | e7000aef-f756-4997-9420-01cc84f9ac9c
+    ImageUrl | null
+    Location | ClientSideExtension.ListViewCommandSet.CommandBar
+    Name | {e7000aef-f756-4997-9420-01cc84f9ac9c}
+    RegistrationId | 100
+    RegistrationType | 0
+    Rights | {"High":0,"Low":0}
+    Scope | 2
+    ScriptBlock | null
+    ScriptSrc | null
+    Sequence | 0
+    Title | test
+    Url | null
+    VersionOfUserCustomAction | 16.0.1.0
+    ```

package/docs/docs/cmd/spo/commandset/commandset-remove.md

@@ -0,0 +1,55 @@
+# spo commandset remove
+
+Remove a ListView Command Set that is added to a site.
+
+## Usage
+
+```sh
+m365 spo commandset remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: Url of the site.
+
+`-t, --title [title]`
+: The title of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-c, --clientSideComponentId [clientSideComponentId]`
+: The id of the ListView Command Set. Specify either `title`, `id` or `clientSideComponentId`.
+
+`-s, --scope [scope]`
+: Scope of the ListView Command Set. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
+
+`--confirm`
+: Don't prompt for confirming removal of the ListView Command Set
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove a ListView Command Set by title.
+
+```sh
+m365 spo commandset remove --title "Some customizer" --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove a ListView Command Set by id.
+
+```sh
+m365 spo commandset remove --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Remove a ListView Command Set by clientSideComponentId.
+
+```sh
+m365 spo commandset remove --clientSideComponentId 7096cded-b83d-4eab-96f0-df477ed7c0bc --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/commandset/commandset-set.md

@@ -0,0 +1,71 @@
+# spo commandset set
+
+Updates a ListView Command Set on a site.
+
+## Usage
+
+```sh
+m365 spo commandset set [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The site to update the ListView Command Set on.
+
+`-t, --title [title]`
+: The title of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
+
+`-i, --id [id]`
+: The id of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
+
+`-c, --clientSideComponentId  [clientSideComponentId]`
+: The Client Side Component Id (GUID) of the ListView Command Set to update. Specify either `title`, `id`or `clientSideComponentId`.
+
+`--newTitle [newTitle]`
+: The new title of the ListView Command Set.
+
+`-l, --listType [listType]`
+: The list or library type to register the Command Set on. Allowed values `List`, `Library` or `SitePages`.
+
+`--clientSideComponentProperties  [clientSideComponentProperties]`
+: The Client Side Component properties of the ListView Command Set.
+
+`-s, --scope [scope]`
+: The scope where to lookup the ListView Command Set: at site level or web level. Allowed values: `Site`, `Web`, `All`. Defaults to `All`.
+
+`--location [location]`
+: The location of the ListView Command Set. Allowed values `ContextMenu`, `CommandBar` or `Both`.
+
+--8<-- "docs/cmd/_global.md"
+
+## 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 treat quotes differently. For example, this is how a ListView Command Set can be created from the Windows cmd.exe:
+
+```sh
+m365 spo commandset set --webUrl https://contoso.sharepoint.com/sites/test --title "CLI Commandset" --location "Both" --listType "List" --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+!!! warning "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.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
+## Examples
+
+Updates the title and location of a ListView Command Set on the sales site.
+
+```sh
+m365 spo commandset  set --clientSideComponentId  799883f5-7962-4384-a10a-105adaec6ffc --newTitle "Some new title" --location Both --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
+```
+
+Updates a ListView Command Set on the sales site with some properties.
+
+```sh
+m365 spo commandset set --title "Some customizer" --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales --scope Site
+```
+
+## Response
+
+The command won't return a response on success.