@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.11542c0

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

@@ -0,0 +1,74 @@
+# spo eventreceiver remove
+
+Removes event receivers for the specified web, site, or list.
+
+## Usage
+
+```sh
+m365 spo eventreceiver remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the web.
+
+`--listTitle [listTitle]`
+: The title of the list, _if the event receiver should be removed from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: The id of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`-n, --name [name]`
+: The name. Specify either `name` or `id` but not both.
+
+`-i, --id [id]`
+: The id. Specify either `name` or `id` but not both.
+
+`-s, --scope [scope]`
+: The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    You can only remove an event receiver if it has been registered by an app with the same ID.
+
+## Examples
+
+Remove event receiver in a specific web by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
+```
+
+Remove event receiver in a specific site by id.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Remove event receiver in a specific list retrieved by title by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
+```
+
+Remove event receiver in a specific list retrieved by list id by id.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Remove event receiver in a specific list retrieved by list url by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
+```

package/docs/docs/cmd/spo/feature/feature-disable.md

@@ -10,10 +10,10 @@ m365 spo feature disable [options]
 
 ## Options
 
-`-u, --url <url>`
+`-u, --webUrl <webUrl>`
 : The URL of the site or web for which to disable the feature
 
-`-f, --featureId <id>`
+`-i, --id <id>`
 : The ID of the feature to disable
 
 `-s, --scope [scope]`
@@ -33,11 +33,11 @@ If the specified url doesn't refer to an existing site collection, you will get
 Disable site feature
 
 ```sh
-m365 spo feature disable --url https://contoso.sharepoint.com/sites/sales --featureId 915c240e-a6cc-49b8-8b2c-0bff8b553ed3 --scope Site
+m365 spo feature disable --webUrl https://contoso.sharepoint.com/sites/salis --id 915c240e-a6cc-49b8-8b2c-0bff8b553ed3 --scope Site
 ```
 
 Disable web feature (with force to ignore errors)
 
 ```sh
-m365 spo feature disable --url https://contoso.sharepoint.com/sites/sales --featureId 00bfea71-5932-4f9c-ad71-1557e5751100 --scope Web --force
+m365 spo feature disable --webUrl https://contoso.sharepoint.com/sites/salis --id 00bfea71-5932-4f9c-ad71-1557e5751100 --scope Web --force
 ```

package/docs/docs/cmd/spo/feature/feature-enable.md

@@ -10,10 +10,10 @@ m365 spo feature enable [options]
 
 ## Options
 
-`-u, --url <url>`
+`-u, --webUrl <webUrl>`
 : The URL of the site or web for which to enable the feature
 
-`-f, --featureId <id>`
+`-i, --id <id>`
 : The ID of the feature to enable
 
 `-s, --scope [scope]`

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

@@ -10,7 +10,7 @@ m365 spo feature list [options]
 
 ## Options
 
-`-u, --url <url>`
+`-u, --webUrl <webUrl>`
 : URL of the site (collection) to retrieve the activated Features from
 
 `-s, --scope [scope]`
@@ -23,11 +23,11 @@ m365 spo feature list [options]
 Return details about Features activated in the specified site collection
 
 ```sh
-m365 spo feature list --url https://contoso.sharepoint.com/sites/test --scope Site
+m365 spo feature list --webUrl https://contoso.sharepoint.com/sites/test --scope Site
 ```
 
 Return details about Features activated in the specified site
 
 ```sh
-m365 spo feature list --url https://contoso.sharepoint.com/sites/test --scope Web
+m365 spo feature list --webUrl https://contoso.sharepoint.com/sites/test --scope Web
 ```

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

@@ -14,7 +14,13 @@ m365 spo field add [options]
 : Absolute URL of the site where the field should be created
 
 `-l, --listTitle [listTitle]`
-: Title of the list where the field should be created (if it should be created as a list column)
+: Title of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
+
+`--listId [listId]`
+: ID of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list where the field should be created (if it should be created as a list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `-x, --xml <xml>`
 : CAML field definition
@@ -36,7 +42,7 @@ Create a date time site column
 m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
 ```
 
-Create a URL list column
+Create a URL list column to a list retrieved by Title
 
 ```sh
 m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
@@ -48,6 +54,18 @@ Create a URL list column and add it to all content types
 m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`' --options AddToAllContentTypes
 ```
 
+Create a URL list column to a list retrieved by ID
+
+```sh
+m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId e785fe80-2ca1-409e-b9d1-19055a85cd38 --xml '`<Field Type="URL" DisplayName="More information link" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="Hyperlink" Group="PnP Columns" ID="{6085e32a-339b-4da7-ab6d-c1e013e5ab27}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertMoreInformation" Name="PnPAlertMoreInformation"></Field>`'
+```
+
+Create a date time list column to a list retrieved by URL
+
+```sh
+m365 spo field add --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl /sites/contoso-sales/lists/Events --xml '`<Field Type="DateTime" DisplayName="Start date-time" Required="FALSE" EnforceUniqueValues="FALSE" Indexed="FALSE" Format="DateTime" Group="PnP Columns" FriendlyDisplayFormat="Disabled" ID="{5ee2dd25-d941-455a-9bdb-7f2c54aed11b}" SourceID="{4f118c69-66e0-497c-96ff-d7855ce0713d}" StaticName="PnPAlertStartDateTime" Name="PnPAlertStartDateTime"><Default>[today]</Default></Field>`'
+```
+
 ## More information
 
 - AddFieldOptions enumeration: [https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx](https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.addfieldoptions.aspx)

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

@@ -23,10 +23,10 @@ m365 spo field get [options]
 : Server- or web-relative URL of the list where the field is located. Specify only one of listTitle, listId or listUrl
 
 `-i, --id [id]`
-: The ID of the field to retrieve. Specify id or fieldTitle but not both
+: The ID of the field to retrieve. Specify id or title but not both
 
-`--fieldTitle [fieldTitle]`
-: The display name (case-sensitive) of the field to retrieve. Specify id or fieldTitle but not both
+`-t, --title [title]`
+: The display name (case-sensitive) of the field to remove. Specify id or title, or group but not both
 
 --8<-- "docs/cmd/_global.md"
 
@@ -47,5 +47,5 @@ m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales -
 Retrieves list column by display name located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its url
 
 ```sh
-m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl 'Lists/Events' --fieldTitle 'Title'
+m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
 ```

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

@@ -23,13 +23,13 @@ m365 spo field remove [options]
 : Server- or web-relative URL of the list where the field is located. Specify only one of `listTitle`, `listId` or `listUrl`
 
 `-i, --id [id]`
-: The ID of the field to remove. Specify id, fieldTitle, or group
+: The ID of the field to remove. Specify id, title, or group
 
-`-t, --fieldTitle [fieldTitle]`
-: The display name (case-sensitive) of the field to remove. Specify id, fieldTitle, or group
+`-t, --title [title]`
+: The display name (case-sensitive) of the field to remove. Specify id, title, or group
 
 `-g, --group [group]`
-: Delete all fields from this group (case-sensitive). Specify id, fieldTitle, or group
+: Delete all fields from this group (case-sensitive). Specify id, title, or group
 
 `--confirm`
 : Don't prompt for confirming removing the field
@@ -53,11 +53,11 @@ m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sale
 Remove the list column with the specified display name, located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its url
 
 ```sh
-m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl 'Lists/Events' --fieldTitle 'Title'
+m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl "Lists/Events" --title "Title"
 ```
 
 Remove all site columns from group _MyGroup_
 
 ```sh
-m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --group 'MyGroup'
+m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --group "MyGroup"
 ```

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

@@ -14,10 +14,13 @@ m365 spo field set [options]
 : Absolute URL of the site where the field is located
 
 `--listId [listId]`
-: ID of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
+: ID of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `--listTitle [listTitle]`
-: Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
+: Title of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or site-relative URL of the list where the field is located (if list column). Specify either `listTitle`, `listId` or `listUrl`
 
 `-i, --id [id]`
 : ID of the field to update. Specify `id` or `title` but not both
@@ -25,9 +28,6 @@ m365 spo field set [options]
 `-t, --title [title]`
 : Title or internal name of the field to update. Specify `id` or `title` but not both
 
-`-n, --name [name]`
-: (deprecated. Use `title` instead) Title or internal name of the field to update. Specify `id` or `name` but not both
-
 `--updateExistingLists`
 : Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only
 
@@ -37,6 +37,9 @@ m365 spo field set [options]
 
 Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
 
+!!! warning "Escaping JSON in PowerShell"
+    When updating column formatting for a field with the `--CustomFormatter` 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
 
 Update the title of the site column specified by its internal name and push changes to existing lists
@@ -51,8 +54,14 @@ Update the title of the list column specified by its ID
 m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Title 'My column'
 ```
 
+Update the description of a column specified by the ID on a list retrieved by the URL
+
+```sh
+m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl '/sites/project-x/Lists/My List' --id 330f29c5-5c4c-465f-9f4b-7903020ae1ce --Description 'My column Description'
+```
+
 Update column formatting of the specified list column
 
 ```sh
-m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
+m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}'
 ```

package/docs/docs/cmd/spo/file/file-checkin.md

@@ -13,11 +13,11 @@ m365 spo file checkin [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the file is located
 
-`-f, --fileUrl [fileUrl]`
-: The server-relative URL of the file to retrieve. Specify either `fileUrl` or `id` but not both
+`-f, --url [url]`
+: The server-relative URL of the file to retrieve. Specify either `url` or `id` but not both
 
 `-i, --id [id]`
-: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `id` but not both
+: The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both
 
 `-t, --type [type]`
 : Type of the check in. Available values `Minor,Major,Overwrite`. Default is Major
@@ -38,17 +38,17 @@ m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --
 Checks in file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx'
+m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
 ```
 
 Checks in minor version of file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx' --type Minor
+m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --type Minor
 ```
 
 Checks in file _/sites/project-x/documents/Test1.docx_ with comment located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx' --comment 'approved'
+m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx' --comment 'approved'
 ```

package/docs/docs/cmd/spo/file/file-checkout.md

@@ -13,11 +13,11 @@ m365 spo file checkout [options]
 `-u, --webUrl <webUrl>`
 : The URL of the site where the file is located
 
-`-f, --fileUrl [fileUrl]`
-: The server-relative URL of the file to retrieve. Specify either `fileUrl` or `id` but not both
+`-f, --url [url]`
+: The server-relative URL of the file to retrieve. Specify either `url` or `id` but not both
 
 `-i, --id [id]`
-: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `id` but not both
+: The UniqueId (GUID) of the file to retrieve. Specify either `url` or `id` but not both
 
 --8<-- "docs/cmd/_global.md"
 
@@ -32,5 +32,5 @@ m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x -
 Checks out file with server-relative url _/sites/project-x/documents/Test1.docx_ located in site _https://contoso.sharepoint.com/sites/project-x_
 
 ```sh
-m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --fileUrl '/sites/project-x/documents/Test1.docx'
+m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --url '/sites/project-x/documents/Test1.docx'
 ```

package/docs/docs/cmd/spo/file/file-copy.md

@@ -11,50 +11,60 @@ m365 spo file copy [options]
 ## Options
 
 `-u, --webUrl <webUrl>`
-: The URL of the site where the file is located
+: The URL of the site where the file is located.
 
 `-s, --sourceUrl <sourceUrl>`
-: Site-relative URL of the file to copy
+: Server-relative or absolute URL of the file.
 
 `-t, --targetUrl <targetUrl>`
-: Server-relative URL where to copy the file
+: Server-relative or absolute URL of the location.
 
-`--deleteIfAlreadyExists`
-: If a file already exists at the targetUrl, it will be moved to the recycle bin. If omitted, the copy operation will be canceled if the file already exists at the targetUrl location
+`--newName [newName]`
+: New name of the destination file.
 
-`--allowSchemaMismatch`
-: Ignores any missing fields in the target document library and copies the file anyway
+`--nameConflictBehavior [nameConflictBehavior]`
+: Behavior when a document with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. Default is `fail`.
+
+`--bypassSharedLock`
+: This indicates whether a file with a share lock can still be copied. Use this option to copy a file that is locked.
 
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
-When you copy a file using the `spo file copy` command, only the latest version of the file is copied.
+!!! important
+    The required URLs `webUrl`, `sourceUrl` and `targetUrl` cannot be encoded. When you do so, you will get a `File Not Found` error.
+
+When you specify a value for `nameConflictBehavior`, consider the following:
+
+- `fail` will throw an error when the destination file already exists.
+- `replace` will replace the destination file if it already exists.
+- `rename` will add a suffix (e.g. Document1.pdf) when the destination file already exists.
 
 ## Examples
 
-Copy file to a document library in another site collection
+Copy a file to a document library in another site collection with server relative URLs
 
 ```sh
-m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/
+m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
 ```
 
-Copy file to a document library in the same site collection
+Copy a file to a document library in another site collection with absolute URLs
 
 ```sh
-m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test1/HRDocuments/
+m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "https://contoso.sharepoint.com/sites/project/Shared Documents/Document.pdf" --targetUrl "https://contoso.sharepoint.com/sites/IT/Shared Documents"
 ```
 
-Copy file to a document library in another site collection. If a file with the same name already exists in the target document library, move it to the recycle bin
+Copy file to a document library in another site collection with a new name
 
 ```sh
-m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/ --deleteIfAlreadyExists
+m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf"
 ```
 
-Copy file to a document library in another site collection. Will ignore any missing fields in the target destination and copy anyway
+Copy file to a document library in another site collection with a new name, rename the file if it already exists
 
 ```sh
-m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/test1 --sourceUrl /Shared%20Documents/sp1.pdf --targetUrl /sites/test2/Shared%20Documents/ --allowSchemaMismatch
+m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --newName "Report.pdf" --nameConflictBehavior rename
 ```
 
 ## More information