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

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

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo field get
+
+Retrieves information about the specified list- or site column
+
+## Usage
+
+```sh
+m365 spo field get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where the field is located
+
+`-l, --listTitle [listTitle]`
+: Title of the list where the field is located. Specify only one of listTitle, listId or listUrl
+
+`--listId [listId]`
+: ID of the list where the field is located. Specify only one of listTitle, listId or listUrl
+
+`--listUrl [listUrl]`
+: 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 title 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
+```
+
+<Global />
+
+## Examples
+
+Retrieves site column by id located in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
+```
+
+Retrieves list column by id located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its title
+
+```sh
+m365 spo field get --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
+```
+
+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" --title "Title"
+```

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

@@ -0,0 +1,55 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo field list
+
+Retrieves columns for the specified list or site
+
+## Usage
+
+```sh
+m365 spo field list [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where fields are located
+
+`-t, --listTitle [listTitle]`
+: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`-i --listId [listId]`
+: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
+```
+
+<Global />
+
+## Examples
+
+Retrieves site columns for site _https://contoso.sharepoint.com/sites/contoso-sales_.
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
+```
+
+Retrieves list columns for list _Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
+```
+
+Retrieves list columns for list _202b8199-b9de-43fd-9737-7f213f51c991_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
+```
+
+Retrieves list columns for list _/sites/contoso-sales/lists/Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
+```

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

@@ -0,0 +1,67 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo field remove
+
+Removes the specified list- or site column
+
+## Usage
+
+```sh
+m365 spo field remove [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: Absolute URL of the site where the field to remove is located
+
+`-l, --listTitle [listTitle]`
+: Title of the list where the field is located. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`--listId [listId]`
+: ID of the list where the field is located. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: 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, title, 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, title, or group
+
+`--confirm`
+: Don't prompt for confirming removing the field
+```
+
+<Global />
+
+## Examples
+
+Remove the site column with the specified ID, located in site _https://contoso.sharepoint.com/sites/contoso-sales_
+
+```sh
+m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
+```
+
+Remove the list column with the specified ID, located in site _https://contoso.sharepoint.com/sites/contoso-sales_. Retrieves the list by its title
+
+```sh
+m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --id 5ee2dd25-d941-455a-9bdb-7f2c54aed11b
+```
+
+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" --title "Title"
+```
+
+Remove all site columns from group _MyGroup_
+
+```sh
+m365 spo field remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --group "MyGroup"
+```

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

@@ -0,0 +1,74 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo field set
+
+Updates existing list or site column
+
+## Usage
+
+```sh
+m365 spo field set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: 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 either `listTitle`, `listId` or `listUrl`
+
+`--listTitle [listTitle]`
+: 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
+
+`-t, --title [title]`
+: Title or internal name of the field to update. Specify `id` or `title` but not both
+
+`--updateExistingLists`
+: Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only
+```
+
+<Global />
+
+## Remarks
+
+Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
+
+:::caution 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.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
+
+Update the title of the site column specified by its internal name and push changes to existing lists
+
+```sh
+m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --title 'MyColumn' --updateExistingLists --Title 'My column'
+```
+
+Update the title of the list column specified by its ID
+
+```sh
+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"}'
+```

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

@@ -0,0 +1,160 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file add
+
+Uploads file to the specified folder
+
+## Usage
+
+```sh
+m365 spo file add [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file should be uploaded to
+
+`-f, --folder <folder>`
+: The server- or site-relative URL to the folder where the file should be uploaded
+
+`-p, --path <path>`
+: Local path to the file to upload
+
+`-c, --contentType [contentType]`
+: Content type name or ID to assign to the file
+
+`--checkOut [checkOut]`
+: If versioning is enabled, this will check out the file first if it exists, upload the file, then check it in again
+
+`--checkInComment [checkInComment]`
+: Comment to set when checking the file in
+
+`--approve [approve]`
+: Will automatically approve the uploaded file
+
+`--approveComment [approveComment]`
+: Comment to set when approving the file
+
+`--publish [publish]`
+: Will automatically publish the uploaded file
+
+`--publishComment [publishComment]`
+: Comment to set when publishing the file
+```
+
+<Global />
+
+## Remarks
+
+This command allows using unknown properties. Each property corresponds to the list item field that should be set when uploading the file.
+
+## Examples
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in sub folder _Shared Documents/Sub Folder 1_
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Sub Folder 1' --path 'C:\MS365.jpg'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ specifying server-relative folder url
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder '/sites/project-x/Shared Documents' --path 'C:\MS365.jpg'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ with specified content type
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --contentType 'Picture'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_, but checks out existing file before the upload
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --checkOut --checkInComment 'check in comment x'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and approves it (when list moderation is enabled)
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --approve --approveComment 'approve comment x'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and publishes it
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --publish --publishComment 'publish comment x'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes single text field value of the list item
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Title "New Title"
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes person/group field and DateTime field values
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Editor "[{'Key':'i:0#.f|membership|john.smith@contoso.com'}]" --Modified '6/23/2018 10:15 PM'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes hyperlink or picture field
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --URL 'https://contoso.com, Contoso'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes taxonomy field
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Topic "HR services|c17baaeb-67cd-4378-9389-9d97a945c701"
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes taxonomy multi-value field
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --Topic "HR services|c17baaeb-67cd-4378-9389-9d97a945c701;Inclusion ＆ Diversity|66a67671-ed89-44a7-9be4-e80c06b41f35"
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes choice field and multi-choice field
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --ChoiceField1 'Option3' --MultiChoiceField1 'Option2;#Option3'
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes person/group field that allows multi-user selection
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --AllowedUsers "[{'Key':'i:0#.f|membership|john.smith@contoso.com'},{'Key':'i:0#.f|membership|velin.georgiev@contoso.com'}]"
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes yes/no field
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --HasCar true
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes number field and currency field
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --NumberField 100 --CurrencyField 20
+```
+
+Adds file _MS365.jpg_ to site _https://contoso.sharepoint.com/sites/project-x_ in folder _Shared Documents_ and changes lookup field and multi-lookup field
+
+```sh
+m365 spo file add --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --path 'C:\MS365.jpg' --LookupField 1 --MultiLookupField "2;#;#3;#;#4;#"
+```
+
+## More information
+
+- Update file metadata with REST API using ValidateUpdateListItem method: [https://robertschouten.com/2018/04/30/update-file-metadata-with-rest-api-using-validateupdatelistitem-method/](https://robertschouten.com/2018/04/30/update-file-metadata-with-rest-api-using-validateupdatelistitem-method/)
+- List Items System Update options in SharePoint Online: [https://www.linkedin.com/pulse/list-items-system-update-options-sharepoint-online-andrew-koltyakov/](https://www.linkedin.com/pulse/list-items-system-update-options-sharepoint-online-andrew-koltyakov/)

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

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file checkin
+
+Checks in specified file
+
+## Usage
+
+```sh
+m365 spo file checkin [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-f, --url [url]`
+: The server- or site-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 `url` or `id` but not both
+
+`-t, --type [type]`
+: Type of the check in. Available values `Minor`, `Major`, `Overwrite`. Default is Major
+
+`--comment [comment]`
+: Comment to set when checking the file in. It\'s length must be less than 1024 letters. Default is empty string
+```
+
+<Global />
+
+## Examples
+
+Checks in file with UniqueId _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo file checkin --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+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 --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 --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 --url '/sites/project-x/documents/Test1.docx' --comment 'approved'
+```

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

@@ -0,0 +1,40 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file checkout
+
+Checks out specified file
+
+## Usage
+
+```sh
+m365 spo file checkout [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located
+
+`-f, --url [url]`
+: The server- or site-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 `url` or `id` but not both
+```
+
+<Global />
+
+## Examples
+
+Checks out file with UniqueId _b2307a39-e878-458b-bc90-03bc578531d6_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo file checkout --webUrl https://contoso.sharepoint.com/sites/project-x --id 'b2307a39-e878-458b-bc90-03bc578531d6'
+```
+
+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 --url '/sites/project-x/documents/Test1.docx'
+```

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

@@ -0,0 +1,79 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo file copy
+
+Copies a file to another location
+
+## Usage
+
+```sh
+m365 spo file copy [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`-s, --sourceUrl <sourceUrl>`
+: Site-relative, server-relative or absolute URL of the file.
+
+`-t, --targetUrl <targetUrl>`
+: Server-relative or absolute URL of the location.
+
+`--newName [newName]`
+: New name of the destination file.
+
+`--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.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+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 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/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
+```
+
+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/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 with a new name
+
+```sh
+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 with a new name, rename the file if it already exists
+
+```sh
+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
+
+- Copy items from a SharePoint document library: [https://support.office.com/en-us/article/move-or-copy-items-from-a-sharepoint-document-library-00e2f483-4df3-46be-a861-1f5f0c1a87bc](https://support.office.com/en-us/article/move-or-copy-items-from-a-sharepoint-document-library-00e2f483-4df3-46be-a861-1f5f0c1a87bc)