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

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

@@ -0,0 +1,123 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo commandset list
+
+Get a list of ListView Command Sets that are added to a site.
+
+## Usage
+
+```sh
+m365 spo commandset list [options]
+```
+
+## Options
+
+```md definition-list
+`-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`
+```
+
+<Global />
+
+## Examples
+
+Retrieves a list of ListView Command Sets.
+
+```sh
+m365 spo commandset list --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="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"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Name                                    Location                                           Scope  Id
+  --------------------------------------  -------------------------------------------------  -----  ------------------------------------
+  {e7000aef-f756-4997-9420-01cc84f9ac9c}  ClientSideExtension.ListViewCommandSet.CommandBar  2      e7000aef-f756-4997-9420-01cc84f9ac9c
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Name,Location,Scope,Id
+  {e7000aef-f756-4997-9420-01cc84f9ac9c},ClientSideExtension.ListViewCommandSet.CommandBar,2,e7000aef-f756-4997-9420-01cc84f9ac9c
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,59 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo commandset remove
+
+Remove a ListView Command Set that is added to a site.
+
+## Usage
+
+```sh
+m365 spo commandset remove [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,87 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo commandset set
+
+Updates a ListView Command Set on a site.
+
+## Usage
+
+```sh
+m365 spo commandset set [options]
+```
+
+## Options
+
+```md definition-list
+`-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`.
+
+`--newClientSideComponentId [newClientSideComponentId]`
+: The new Client Side Component Id (GUID) of the ListView Command Set.
+
+`--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`.
+```
+
+<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 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"}'`.
+
+:::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 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
+```
+
+Updates the Client Side Component Id of a ListView Command Set.
+
+```sh
+m365 spo commandset set --title "Some customizer" --newClientSideComponentId b2c5faf3-638f-44ae-bfde-1730d94283bf --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,77 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo contenttype add
+
+Adds a new list or site content type
+
+## Usage
+
+```sh
+m365 spo contenttype add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where the content type should be created
+
+`-l, --listTitle [listTitle]`
+: Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`-i, --id <id>`
+: The ID of the content type. Determines the parent content type
+
+`-n, --name <name>`
+: The name of the content type
+
+`-d, --description [description]`
+: The description of the content type
+
+`-g, --group [group]`
+: The group with which the content type should be associated
+```
+
+<Global />
+
+## Remarks
+
+If the specified content type already exists, you will get a _A duplicate content type "Your Content Type" was found._ error.
+
+The ID of the content type specifies the parent content type from which this content type inherits.
+
+## Examples
+
+Create a site content type that inherits from the List item content type
+
+```sh
+m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D --group 'PnP Content Types'
+```
+
+Create a list (retrieved by Title) content type that inherits from the List item content type
+
+```sh
+m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Alerts --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
+```
+
+Create a list (retrieved by ID) content type that inherits from the List item content type
+
+```sh
+m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
+```
+
+Create a list (retrieved by URL) content type that inherits from the List item content type
+
+```sh
+m365 spo contenttype add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --name 'PnP Alert' --id 0x01007926A45D687BA842B947286090B8F67D
+```
+
+## More information
+
+- Content Type IDs: [https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14)](https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/aa543822(v%3Doffice.14))

package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx

@@ -0,0 +1,73 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo contenttype field remove
+
+Removes a column from a site- or list content type
+
+## Usage
+
+```sh
+m365 spo contenttype field remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where the content type is located
+
+`-l, --listTitle [listTitle]`
+: Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`-i, --contentTypeId <contentTypeId>`
+: The ID of the content type to remove the column from
+
+`-f, --fieldLinkId <fieldLinkId>`
+: The ID of the column to remove
+
+`-c, --updateChildContentTypes`
+: Update child content types
+
+`--confirm`
+: Don't prompt for confirming removal of a column from content type
+```
+
+<Global />
+
+## Examples
+
+Remove column with a specific ID from a content type with a specific ID from a specific site.
+
+```sh
+m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --confirm
+```
+
+Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types
+
+```sh
+m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes
+```
+
+Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a spefici site.
+
+```sh
+m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents"
+```
+
+Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a spefici site.
+
+```sh
+m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c"
+```
+
+Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a spefici site.
+
+```sh
+m365 spo contenttype field remove  --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --fieldLinkId "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents"
+```

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

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo contenttype field set
+
+Adds or updates a site column reference in a site content type
+
+## Usage
+
+```sh
+m365 spo contenttype field set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where the content type is located
+
+`-c, --contentTypeId <contentTypeId>`
+: ID of the content type on which the field reference should be set
+
+`-f, --id <id>`
+: ID of the field to which the reference should be set
+
+`-r, --required [required]`
+: Set to `true`, if the field should be required or to `false` if it should be optional
+
+`--hidden [hidden]`
+: Set to `true`, if the field should be hidden or to `false` if it should be visible
+```
+
+<Global />
+
+## Remarks
+
+If the field reference already exists, the command will update its _required_ and _hidden_ properties as specified in the command.
+
+## Examples
+
+Add the specified site column to the specified content type as an optional and visible field
+
+```sh
+m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5
+```
+
+Add the specified site column to the specified content type as a required field
+
+```sh
+m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5 --required true
+```
+
+Update the existing site column reference in the specified content type to optional
+
+```sh
+m365 spo contenttype field set --webUrl https://contoso.sharepoint.com/sites/portal --contentTypeId 0x01007926A45D687BA842B947286090B8F67D --id ebe7e498-44ff-43da-a7e5-99b444f656a5 --required false
+```

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

@@ -0,0 +1,71 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo contenttype get
+
+Retrieves information about the specified list or site content type
+
+## Usage
+
+```sh
+m365 spo contenttype get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where the content type is located
+
+`-l, --listTitle [listTitle]`
+: Title of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: ID of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
+
+`-i, --id [id]`
+: The ID of the content type to retrieve. Specify either id or name but not both
+
+`-n, --name [name]`
+: The name of the content type to retrieve. Specify either id or name but not both
+```
+
+<Global />
+
+## Remarks
+
+If no content type with the specified is found in the site or the list, you will get the _Content type with ID 0x010012 not found_ error.
+
+## Examples
+
+Retrieve site content type by id
+
+```sh
+m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 0x0100558D85B7216F6A489A499DB361E1AE2F
+```
+
+Retrieve site content type by name
+
+```sh
+m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'Document'
+```
+
+Retrieve list (retrieved by Title) content type 
+
+```sh
+m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 0x0100558D85B7216F6A489A499DB361E1AE2F
+```
+
+Retrieve list (retrieved by ID) content type 
+
+```sh
+m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
+```
+
+Retrieve list (retrieved by URL) content type 
+
+```sh
+m365 spo contenttype get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/Shared Documents' --id 0x0100558D85B7216F6A489A499DB361E1AE2F
+```

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

@@ -0,0 +1,37 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo contenttype list
+
+Lists content types from specified site
+
+## Usage
+
+```sh
+m365 spo contenttype list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site for which to list content types
+
+`-c, --category [category]`
+: Category name of content types. When defined will return only content types from specified category
+```
+
+<Global />
+
+## Examples
+
+Retrieve site content types
+
+```PowerShell
+m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
+```
+
+Retrieve site content types from the 'List Content Types' category
+
+```PowerShell
+m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types"
+```

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

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo contenttype remove
+
+Deletes site content type
+
+## Usage
+
+```sh
+m365 spo contenttype remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where the content type is located
+
+`-i, --id [id]`
+: The ID of the content type to remove
+
+`-n, --name [name]`
+: The name of the content type to remove
+
+`--confirm`
+: Don't prompt for confirming removal of the content type
+```
+
+<Global />
+
+## Remarks
+
+If the specified content type is in use by a list and cannot be removed, you will be returned the error: _Another site or list is still using this content type._ SharePoint will not allow a content type to be removed unless any dependent objects are also emptied from the recycle bin including the second-stage recycle bin.
+
+The content type you wish to remove can be selected by the ID or Name of the content type. Either ID or Name parameter must be specified.
+
+## Examples
+
+Remove a site content type by ID
+
+```sh
+m365 spo contenttype remove --id "0x01007926A45D687BA842B947286090B8F67D" --webUrl https://contoso.sharepoint.com
+```
+
+Remove a site content type by Name
+
+```sh
+m365 spo contenttype remove --name "My Content Type" --webUrl https://contoso.sharepoint.com --confirm
+```
+
+Remove a site content type without prompting for confirmation
+
+```sh
+m365 spo contenttype remove --name "My Content Type" --webUrl https://contoso.sharepoint.com --confirm
+```