@pnp/cli-microsoft365 6.7.0-beta.54db310 → 6.7.0-beta.7321771

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/.devcontainer/Dockerfile +1 -1
  2. package/README.md +10 -10
  3. package/dist/Auth.js +75 -4
  4. package/dist/AuthServer.js +2 -1
  5. package/dist/Command.js +56 -7
  6. package/dist/m365/aad/commands/user/user-set.js +145 -30
  7. package/dist/m365/base/AzmgmtCommand.js +11 -0
  8. package/dist/m365/base/PowerAppsCommand.js +11 -0
  9. package/dist/m365/base/PowerPlatformCommand.js +11 -0
  10. package/dist/m365/commands/login.js +17 -1
  11. package/dist/m365/commands/status.js +4 -2
  12. package/dist/m365/flow/commands/run/run-get.js +31 -1
  13. package/dist/m365/spo/commands/file/file-list.js +108 -32
  14. package/dist/m365/spo/commands/folder/folder-list.js +73 -16
  15. package/dist/m365/spo/commands/listitem/listitem-list.js +113 -55
  16. package/dist/m365/spo/commands/site/site-recyclebinitem-clear.js +115 -0
  17. package/dist/m365/spo/commands.js +1 -0
  18. package/dist/request.js +7 -0
  19. package/dist/utils/misc.js +11 -0
  20. package/docs/docs/cmd/aad/user/user-set.md +53 -8
  21. package/docs/docs/cmd/flow/run/run-get.md +110 -9
  22. package/docs/docs/cmd/login.md +5 -2
  23. package/docs/docs/cmd/planner/task/task-add.md +3 -1
  24. package/docs/docs/cmd/planner/task/task-set.md +6 -4
  25. package/docs/docs/cmd/spo/file/file-list.md +87 -2
  26. package/docs/docs/cmd/spo/folder/folder-list.md +36 -1
  27. package/docs/docs/cmd/spo/listitem/listitem-list.md +22 -8
  28. package/docs/docs/cmd/spo/site/site-recyclebinitem-clear.md +45 -0
  29. package/docs/docs/cmd/spo/spo-get.md +12 -0
  30. package/docs/docs/cmd/spo/spo-search.md +16 -3
  31. package/docs/docs/cmd/spo/user/user-ensure.md +1 -2
  32. package/docs/docs/cmd/spo/user/user-get.md +24 -0
  33. package/docs/docs/cmd/spo/user/user-list.md +27 -3
  34. package/docs/docs/cmd/spo/userprofile/userprofile-get.md +21 -0
  35. package/docs/docs/cmd/spo/web/web-add.md +24 -0
  36. package/docs/docs/cmd/spo/web/web-clientsidewebpart-list.md +16 -0
  37. package/docs/docs/cmd/spo/web/web-get.md +124 -0
  38. package/docs/docs/cmd/spo/web/web-installedlanguage-list.md +16 -0
  39. package/docs/docs/cmd/spo/web/web-list.md +16 -0
  40. package/docs/docs/cmd/spo/web/web-retentionlabel-list.md +29 -2
  41. package/docs/docs/cmd/tenant/id/id-get.md +6 -0
  42. package/docs/docs/cmd/tenant/report/report-activeusercounts.md +7 -0
  43. package/docs/docs/cmd/tenant/report/report-activeuserdetail.md +7 -0
  44. package/docs/docs/cmd/tenant/report/report-office365activationcounts.md +7 -0
  45. package/docs/docs/cmd/tenant/report/report-office365activationsusercounts.md +7 -0
  46. package/docs/docs/cmd/tenant/report/report-office365activationsuserdetail.md +7 -0
  47. package/docs/docs/cmd/tenant/report/report-servicesusercounts.md +7 -0
  48. package/docs/docs/cmd/tenant/security/security-alerts-list.md +23 -0
  49. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +32 -0
  50. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +32 -0
  51. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +26 -0
  52. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +26 -0
  53. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +22 -0
  54. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +22 -0
  55. package/package.json +3 -1
  56. package/dist/m365/spo/commands/file/FilePropertiesCollection.js +0 -3
  57. package/dist/m365/spo/commands/folder/FileFolderCollection.js +0 -3
@@ -37,6 +37,9 @@ m365 login [options]
37
37
  `--tenant [tenant]`
38
38
  : ID of the tenant from which accounts should be able to authenticate. Use `common` or `organization` if the app is multitenant. If not specified, use the tenant specified in the `CLIMICROSOFT365_TENANT` environment variable. If the environment variable is not defined, use `common` as the tenant identifier
39
39
 
40
+ `--cloud [cloud]`
41
+ : Cloud to connect to. Allowed values `Public`, `USGov`, `USGovHigh`, `USGovDoD` and `China`. Default `Public`
42
+
40
43
  --8<-- "docs/cmd/_global.md"
41
44
 
42
45
  ## Remarks
@@ -45,8 +48,6 @@ Using the `login` command you can log in to Microsoft 365.
45
48
 
46
49
  By default, the `login` command uses device code OAuth flow to log in to Microsoft 365. Alternatively, you can authenticate using a user name and password or certificate, which are convenient for CI/CD scenarios, but which come with their own [limitations](../user-guide/connecting-office-365.md).
47
50
 
48
- When logging in to Microsoft 365, the `login` command stores in memory the access token and the refresh token. Both tokens are cleared from memory after exiting the CLI or by calling the [logout](logout.md) command.
49
-
50
51
  When logging in to Microsoft 365 using the user name and password, next to the access and refresh token, the CLI for Microsoft 365 will store the user credentials so that it can automatically re-authenticate if necessary. Similarly to the tokens, the credentials are removed by re-authenticating using the device code or by calling the [logout](logout.md) command.
51
52
 
52
53
  When logging in to Microsoft 365 using a certificate, the CLI for Microsoft 365 will store the contents of the certificate so that it can automatically re-authenticate if necessary. The contents of the certificate are removed by re-authenticating using the device code or by calling the [logout](logout.md) command.
@@ -55,6 +56,8 @@ To log in to Microsoft 365 using a certificate or secret, you will typically [cr
55
56
 
56
57
  Managed identity in Azure Cloud Shell is the identity of the user. It is neither system- nor user-assigned and it can't be configured. To log in to Microsoft 365 using managed identity in Azure Cloud Shell, set `authType` to `identity` and don't specify the `userName` option.
57
58
 
59
+ When connecting to clouds other than `Public`, you'll need to use an Azure AD application registered in a directory provisioned in that cloud. If you try to login using the default Azure AD application, login will fail.
60
+
58
61
  ## Examples
59
62
 
60
63
  Log in to Microsoft 365 using the device code
@@ -50,7 +50,7 @@ m365 planner task add [options]
50
50
  : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
51
51
 
52
52
  `--description [description]`
53
- : Description of the task
53
+ : Description of the task.
54
54
 
55
55
  `--appliedCategories [appliedCategories]`
56
56
  : Comma-separated categories that should be added to the task. The possible options are: `category1`, `category2`, `category3`, `category4`, `category5` and/or `category6`. Additional info defined [here](https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0).
@@ -81,6 +81,8 @@ When you specify an integer value for `priority`, consider the following:
81
81
  - values 5, 6 and 7 are interpreted as _Medium_
82
82
  - values 8, 9 and 10 are interpreted as _Low_
83
83
 
84
+ When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
85
+
84
86
  ## Examples
85
87
 
86
88
  Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
@@ -50,16 +50,16 @@ m365 planner task set [options]
50
50
  : Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
51
51
 
52
52
  `--description [description]`
53
- : Description of the task
53
+ : Description of the task.
54
54
 
55
55
  `--orderHint [orderHint]`
56
- : Hint used to order items of this type in a list view
56
+ : Hint used to order items of this type in a list view.
57
57
 
58
58
  `--assigneePriority [assigneePriority]`
59
- : Hint used to order items of this type in a list view
59
+ : Hint used to order items of this type in a list view.
60
60
 
61
61
  `--appliedCategories [appliedCategories]`
62
- : Comma-separated categories that should be added to the task
62
+ : Comma-separated categories that should be added to the task.
63
63
 
64
64
  `--priority [priority]`
65
65
  : Priority of the task: Urgent, Important, Medium, Low. Or an integer between 0 and 10 (check remarks section for more info).
@@ -83,6 +83,8 @@ When you specify an integer value for `priority`, consider the following:
83
83
 
84
84
  You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
85
85
 
86
+ When using `description` with a multiple lines value, use the new line character of the shell you are using to indicate line breaks. For PowerShell this is `` `n ``. For Zsh or Bash use `\n` with a `$` in front. E.g. `$"Line 1\nLine 2"`.
87
+
86
88
  ## Examples
87
89
 
88
90
  Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
@@ -16,21 +16,106 @@ m365 spo file list [options]
16
16
  `-f, --folder <folder>`
17
17
  : The server- or site-relative URL of the folder from which to retrieve files
18
18
 
19
+ `--fields [fields]`
20
+ : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified.
21
+
22
+ `--filter [filter]`
23
+ : OData filter to use to query the list of items with
24
+
19
25
  `-r, --recursive`
20
26
  : Set to retrieve files from subfolders
21
27
 
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
30
+ ## Remarks
31
+
32
+ When the `fields` option includes values with a `/`, for example: `ListItemAllFields/Id`, an additional `$expand` query parameter will be included on `ListItemAllFields`.
33
+
24
34
  ## Examples
25
35
 
26
- Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
36
+ Return all files from a folder
27
37
 
28
38
  ```sh
29
39
  m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
30
40
  ```
31
41
 
32
- Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
42
+ Return all files from a folder and all the sub-folders
33
43
 
34
44
  ```sh
35
45
  m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
36
46
  ```
47
+
48
+ Return the files from a folder with specific fields which will be expanded
49
+
50
+ ```sh
51
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --fields "Title,Length"
52
+ ```
53
+
54
+ Return the files from a folder that meet the criteria of the filter with specific fields which will be expanded
55
+
56
+ ```sh
57
+ m365 spo file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --fields ListItemAllFields/Id --filter "Name eq 'document.docx'"
58
+ ```
59
+
60
+ ## Response
61
+
62
+ === "JSON"
63
+
64
+ ```json
65
+ [
66
+ {
67
+ "CheckInComment": "",
68
+ "CheckOutType": 2,
69
+ "ContentTag": "{F09C4EFE-B8C0-4E89-A166-03418661B89B},9,12",
70
+ "CustomizedPageStatus": 0,
71
+ "ETag": "\"{F09C4EFE-B8C0-4E89-A166-03418661B89B},9\"",
72
+ "Exists": true,
73
+ "IrmEnabled": false,
74
+ "Length": 331673,
75
+ "Level": 1,
76
+ "LinkingUri": "https://contoso.sharepoint.com/sites/project-x/Shared Documents/Document.docx?d=wf09c4efeb8c04e89a16603418661b89b",
77
+ "LinkingUrl": "https://contoso.sharepoint.com/sites/project-x/Shared Documents/Document.docx?d=wf09c4efeb8c04e89a16603418661b89b",
78
+ "MajorVersion": 3,
79
+ "MinorVersion": 0,
80
+ "Name": "Document.docx",
81
+ "ServerRelativeUrl": "/sites/project-x/Shared Documents/Document.docx",
82
+ "TimeCreated": "2018-02-05T08:42:36Z",
83
+ "TimeLastModified": "2018-02-05T08:44:03Z",
84
+ "Title": "",
85
+ "UIVersion": 1536,
86
+ "UIVersionLabel": "3.0",
87
+ "UniqueId": "f09c4efe-b8c0-4e89-a166-03418661b89b"
88
+ }
89
+ ]
90
+ ```
91
+
92
+ === "Text"
93
+
94
+ ```text
95
+ Name ServerRelativeUrl UniqueId
96
+ --------------------------------- ----------------------------------------------- ------------------------------------
97
+ Document.docx /sites/project-x/Shared Documents/Document.docx 5eb97525-2167-4d26-94b8-092a97d65716
98
+ ```
99
+
100
+ === "CSV"
101
+
102
+ ```csv
103
+ Name,ServerRelativeUrl,UniqueId
104
+ Document.docx,/sites/project-x/Shared Documents/Document.docx,5eb97525-2167-4d26-94b8-092a97d65716
105
+ ```
106
+
107
+ === "Markdown"
108
+
109
+ ```md
110
+ # spo file list --webUrl "https://contoso.sharepoint.com" --folder "Shared Documents"
111
+
112
+ Date: 23/3/2023
113
+
114
+ ## Document.docx (5eb97525-2167-4d26-94b8-092a97d65716)
115
+
116
+ Property | Value
117
+ ---------|-------
118
+ Name | Document.docx
119
+ ServerRelativeUrl | /sites/project-x/Shared Documents/Document.docx
120
+ UniqueId | 5eb97525-2167-4d26-94b8-092a97d65716
121
+ ```
@@ -16,6 +16,12 @@ m365 spo folder list [options]
16
16
  `-p, --parentFolderUrl <parentFolderUrl>`
17
17
  : Site-relative URL of the parent folder
18
18
 
19
+ `-f, --fields [fields]`
20
+ : Comma-separated list of fields to retrieve. Will retrieve all fields if not specified and json output is requested.
21
+
22
+ `--filter [filter]`
23
+ : OData filter to use to query the list of folders with.
24
+
19
25
  `-r, --recursive`
20
26
  : Set to retrieve nested folders
21
27
 
@@ -23,7 +29,7 @@ m365 spo folder list [options]
23
29
 
24
30
  ## Examples
25
31
 
26
- Gets list of folders under a parent folder with site-relative url _/Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
32
+ Gets list of folders under a parent folder
27
33
 
28
34
  ```sh
29
35
  m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents'
@@ -35,6 +41,12 @@ Gets recursive list of folders under a specific folder on a specific site
35
41
  m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --recursive
36
42
  ```
37
43
 
44
+ Return a filtered list of folders and only return the list item ID
45
+
46
+ ```sh
47
+ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --parentFolderUrl '/Shared Documents' --fields ListItemAllFields/Id --filter "startswith(Name,'Folder')"
48
+ ```
49
+
38
50
  ## Response
39
51
 
40
52
  === "JSON"
@@ -70,3 +82,26 @@ m365 spo folder list --webUrl https://contoso.sharepoint.com/sites/project-x --p
70
82
  Name,ServerRelativeUrl
71
83
  Folder A,/Shared Documents/Folder A
72
84
  ```
85
+
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo folder list --webUrl "https://contoso.sharepoint.com" --parentFolderUrl "/Shared Documents"
90
+
91
+ Date: 29/3/2023
92
+
93
+ ## Folder A (20523746-971b-4488-aa6d-b45d645f61c5)
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ Exists | true
98
+ IsWOPIEnabled | false
99
+ ItemCount | 9
100
+ Name | Folder A
101
+ ProgID | null
102
+ ServerRelativeUrl | /Shared Documents/Folder A
103
+ TimeCreated | 2022-04-26T12:30:56Z
104
+ TimeLastModified | 2022-04-26T12:50:14Z
105
+ UniqueId | 20523746-971b-4488-aa6d-b45d645f61c5
106
+ WelcomePage |
107
+ ```
@@ -32,7 +32,7 @@ m365 spo listitem list [options]
32
32
  : OData filter to use to query the list of items with. Specify `camlQuery` or `filter` but not both.
33
33
 
34
34
  `-p, --pageSize [pageSize]`
35
- : Number of list items to return. Specify `camlQuery` or `pageSize` but not both.
35
+ : Number of list items to return. Specify `camlQuery` or `pageSize` but not both. The default value is 5000.
36
36
 
37
37
  `-n, --pageNumber [pageNumber]`
38
38
  : Page number to return if `pageSize` is specified (first page is indexed as value of 0).
@@ -41,6 +41,8 @@ m365 spo listitem list [options]
41
41
 
42
42
  ## Remarks
43
43
 
44
+ This command retrieves all items in the list, even if there are more than 5000. Use the `pageSize` and `pageNumber` options if you only want a specific amount of items. When using a CAML query, include a `RowLimit`-node to get all items. If you run into list view threshold exceptions, remove any Query-conditions or filters and also include a `RowLimit`-node.
45
+
44
46
  `pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
45
47
 
46
48
  If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
@@ -53,12 +55,6 @@ Get all items from a list named Demo List
53
55
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x
54
56
  ```
55
57
 
56
- From a list named _Demo List_ get all items with title _Demo list item_ using a CAML query
57
-
58
- ```sh
59
- m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query></View>"
60
- ```
61
-
62
58
  Get all items from a list with ID _935c13a0-cc53-4103-8b48-c1d0828eaa7f_
63
59
 
64
60
  ```sh
@@ -83,10 +79,16 @@ From a list named _Demo List_ get all items with title _Demo list item_ using an
83
79
  m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --filter "Title eq 'Demo list item'"
84
80
  ```
85
81
 
82
+ From a list named _Demo List_ get the first 100 items
83
+
84
+ ```sh
85
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 100 --pageNumber 0
86
+ ```
87
+
86
88
  From a list named _Demo List_ get the second batch of 10 items
87
89
 
88
90
  ```sh
89
- m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 2
91
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --pageSize 10 --pageNumber 1
90
92
  ```
91
93
 
92
94
  Get all items from a list by server-relative URL
@@ -95,6 +97,18 @@ Get all items from a list by server-relative URL
95
97
  m365 spo listitem list --listUrl /sites/project-x/documents --webUrl https://contoso.sharepoint.com/sites/project-x
96
98
  ```
97
99
 
100
+ From a list named _Demo List_ get all items with title _Demo list item_ using a CAML query
101
+
102
+ ```sh
103
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View><Query><Where><Eq><FieldRef Name='Title' /><Value Type='Text'>Demo list item</Value></Eq></Where></Query><RowLimit Paged='TRUE'>5000</RowLimit></View>"
104
+ ```
105
+
106
+ From a library named _Demo Library_ with 5000+ files and folders, get all items recursively without running into a list view threshold exception, using a CAML query
107
+
108
+ ```sh
109
+ m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --camlQuery "<View Scope='RecursiveAll'><Query></Query><ViewFields><FieldRef Name='Title'/></ViewFields><RowLimit Paged='TRUE'>5000</RowLimit></View>"
110
+ ```
111
+
98
112
  ## Response
99
113
 
100
114
  === "JSON"
@@ -0,0 +1,45 @@
1
+ # spo site recyclebinitem clear
2
+
3
+ Permanently removes all items in a site recycle bin
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo site recyclebinitem clear [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --siteUrl <siteUrl>`
14
+ : URL of the site where the recycle bin is located.
15
+
16
+ `--secondary`
17
+ : Remove all items from the second-stage recycle bin. When not specified, items from the first-stage recycle bin will be cleared.
18
+
19
+ `--confirm`
20
+ : Don't prompt for confirmation.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! warning
27
+ Items in the recycle bin will be permanently removed without the ability to restore them.
28
+
29
+ ## Examples
30
+
31
+ Clear all items from the first-stage recycle bin
32
+
33
+ ```sh
34
+ m365 spo site recyclebinitem clear --siteUrl https://contoso.sharepoint.com/sites/sales
35
+ ```
36
+
37
+ Clear all items from the second-stage recycle bin
38
+
39
+ ```sh
40
+ m365 spo site recyclebinitem clear --siteUrl https://contoso.sharepoint.com/sites/sales --secondary
41
+ ```
42
+
43
+ ## Response
44
+
45
+ The command won't return a response on success.
@@ -46,3 +46,15 @@ m365 spo get --output json
46
46
  SpoUrl
47
47
  https://contoso.sharepoint.com
48
48
  ```
49
+
50
+ === "Markdown"
51
+
52
+ ```md
53
+ # spo get
54
+
55
+ Date: 4/10/2023
56
+
57
+ Property | Value
58
+ ---------|-------
59
+ SpoUrl | https://contoso.sharepoint.com
60
+ ```
@@ -126,9 +126,9 @@ m365 spo search --queryText "*" --sourceId "6e71030e-5e16-4406-9bff-9c1829843083
126
126
  === "Text"
127
127
 
128
128
  ```text
129
- Title OriginalPath
130
- ----------------------- --------------------------------------------------------------------------------------------------------
131
- Document https://contoso.sharepoint.com/Shared Documents/Document.docx
129
+ Title OriginalPath
130
+ -------- -------------------------------------------------------------
131
+ Document https://contoso.sharepoint.com/Shared Documents/Document.docx
132
132
  ```
133
133
 
134
134
  === "CSV"
@@ -138,3 +138,16 @@ m365 spo search --queryText "*" --sourceId "6e71030e-5e16-4406-9bff-9c1829843083
138
138
  Document,https://contoso.sharepoint.com/Shared Documents/Document.docx
139
139
  ```
140
140
 
141
+ === "Markdown"
142
+
143
+ ```md
144
+ # spo search --queryText "Title:Marketing*" --rowLimit "50" --trimDuplicates "true"
145
+
146
+ Date: 4/10/2023
147
+
148
+ ## Marketing lunch
149
+ Property | Value
150
+ ---------|-------
151
+ Title | Marketing lunch
152
+ OriginalPath | https://contoso.sharepoint.com/sites/contosoportal/SitePages/Marketing-Lunch.aspx
153
+ ```
@@ -86,7 +86,7 @@ m365 spo user ensure --webUrl https://contoso.sharepoint.com/sites/project --use
86
86
  === "Markdown"
87
87
 
88
88
  ```md
89
- # spo user ensure --webUrl "https://mathijsdev2.sharepoint.com" --userName "john@contoso.com"
89
+ # spo user ensure --webUrl "https://contoso.sharepoint.com" --userName "john@contoso.com"
90
90
 
91
91
  Date: 18/02/2023
92
92
 
@@ -104,6 +104,5 @@ m365 spo user ensure --webUrl https://contoso.sharepoint.com/sites/project --use
104
104
  IsEmailAuthenticationGuestUser | false
105
105
  IsShareByEmailGuestUser | false
106
106
  IsSiteAdmin | false
107
- UserId | {"NameId":"100320009d80e5de","NameIdIssuer":"urn:federation:microsoftonline"}
108
107
  UserPrincipalName | john@contoso.com
109
108
  ```
@@ -91,3 +91,27 @@ m365 spo user get --webUrl https://contoso.sharepoint.com/sites/project-x --logi
91
91
  Id,IsHiddenInUI,LoginName,Title,PrincipalType,Email,Expiration,IsEmailAuthenticationGuestUser,IsShareByEmailGuestUser,IsSiteAdmin,UserId,UserPrincipalName
92
92
  10,,i:0#.f|membership|johndoe@contoso.onmicrosoft.com,John Doe,1,johndoe@contoso.onmicrosoft.com,,,,,"{""NameId"":""100320022ec308a7"",""NameIdIssuer"":""urn:federation:microsoftonline""}",johndoe@contoso.onmicrosoft.com
93
93
  ```
94
+
95
+ === "Markdown"
96
+
97
+ ```md
98
+ # spo user get --webUrl "https://contoso.sharepoint.com" --loginName "i:0#.f|membership|john.doe@contoso.onmicrosoft.com"
99
+
100
+ Date: 4/10/2023
101
+
102
+ ## John Doe (9)
103
+
104
+ Property | Value
105
+ ---------|-------
106
+ Id | 10
107
+ IsHiddenInUI | false
108
+ LoginName | i:0#.f\|membership\|john.doe@contoso.onmicrosoft.com
109
+ Title | Reshmee Auckloo
110
+ PrincipalType | 1
111
+ Email | john.doe@contoso.onmicrosoft.com
112
+ Expiration |
113
+ IsEmailAuthenticationGuestUser | false
114
+ IsShareByEmailGuestUser | false
115
+ IsSiteAdmin | false
116
+ UserPrincipalName | john.doe@contoso.onmicrosoft.com
117
+ ```
@@ -52,9 +52,9 @@ m365 spo user list --webUrl https://contoso.sharepoint.com/sites/project-x
52
52
  === "Text"
53
53
 
54
54
  ```text
55
- Id Title LoginName
56
- ---------- ------------------------------ --------------------------------------------------------------------------
57
- 10 John Doe i:0#.f|membership|johndoe@contoso.onmicrosoft.com
55
+ Id Title LoginName
56
+ --- -------- -------------------------------------------------
57
+ 10 John Doe i:0#.f|membership|johndoe@contoso.onmicrosoft.com
58
58
  ```
59
59
 
60
60
  === "CSV"
@@ -63,3 +63,27 @@ m365 spo user list --webUrl https://contoso.sharepoint.com/sites/project-x
63
63
  Id,Title,LoginName
64
64
  10,John Doe,i:0#.f|membership|johndoe@contoso.onmicrosoft.com
65
65
  ```
66
+
67
+ === "Markdown"
68
+
69
+ ```md
70
+ # spo user list --webUrl "https://contoso.sharepoint.com/sites/project-x"
71
+
72
+ Date: 4/10/2023
73
+
74
+ ## John Doe (10)
75
+
76
+ Property | Value
77
+ ---------|-------
78
+ Id | 7
79
+ IsHiddenInUI | false
80
+ LoginName | c:0o.c\|membership\|johndoe@contoso.onmicrosoft.com
81
+ Title | John Doe
82
+ PrincipalType | 1
83
+ Email | johndoe@contoso.onmicrosoft.com
84
+ Expiration |
85
+ IsEmailAuthenticationGuestUser | false
86
+ IsShareByEmailGuestUser | false
87
+ IsSiteAdmin | false
88
+ UserPrincipalName | johndoe@contoso.onmicrosoft.com
89
+ ```
@@ -611,4 +611,25 @@ m365 spo userprofile get --userName 'john.doe@mytenant.onmicrosoft.com'
611
611
  i:0#.f|membership|johndoe@contoso.onmicrosoft.com,[],John Doe,johndoe@contoso.onmicrosoft.com,[],"[""i:0#.f|membership|johndoe@contoso.onmicrosoft.com""]",,,[],https://contoso-my.sharepoint.com:443/,https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/,,,"[{""Key"":""UserProfile_GUID"",""Value"":""0b4f6da0-97db-456e-993d-80e035057600"",""ValueType"":""Edm.String""},{""Key"":""SID"",""Value"":""i:0h.f|membership|100320022ec308a7@live.com"",""ValueType"":""Edm.String""},{""Key"":""ADGuid"",""Value"":""System.Byte[]"",""ValueType"":""Edm.String""},{""Key"":""AccountName"",""Value"":""i:0#.f|membership|johndoe@contoso.onmicrosoft.com"",""ValueType"":""Edm.String""},{""Key"":""FirstName"",""Value"":""John"",""ValueType"":""Edm.String""},{""Key"":""SPS-PhoneticFirstName"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""LastName"",""Value"":""Doe"",""ValueType"":""Edm.String""},{""Key"":""SPS-PhoneticLastName"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""PreferredName"",""Value"":""John Doe"",""ValueType"":""Edm.String""},{""Key"":""SPS-PhoneticDisplayName"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""WorkPhone"",""Value"":""494594133"",""ValueType"":""Edm.String""},{""Key"":""Department"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""Title"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Department"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""Manager"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""AboutMe"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""PersonalSpace"",""Value"":""/personal/john_contoso_onmicrosoft_com/"",""ValueType"":""Edm.String""},{""Key"":""PictureURL"",""Value"":""https://contoso-my.sharepoint.com:443/User%20Photos/Profile%20Pictures/78ccf530-bbf0-47e4-aae6-da5f8c6fb142_MThumb.jpg"",""ValueType"":""Edm.String""},{""Key"":""UserName"",""Value"":""johndoe@contoso.onmicrosoft.com"",""ValueType"":""Edm.String""},{""Key"":""QuickLinks"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""WebSite"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""PublicSiteRedirect"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-JobTitle"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-DataSource"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-MemberOf"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Dotted-line"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Peers"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Responsibility"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-SipAddress"",""Value"":""johndoe@contoso.onmicrosoft.com"",""ValueType"":""Edm.String""},{""Key"":""SPS-MySiteUpgrade"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-DontSuggestList"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-ProxyAddresses"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-HireDate"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-DisplayOrder"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-ClaimID"",""Value"":""johndoe@contoso.onmicrosoft.com"",""ValueType"":""Edm.String""},{""Key"":""SPS-ClaimProviderID"",""Value"":""membership"",""ValueType"":""Edm.String""},{""Key"":""SPS-LastColleagueAdded"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-OWAUrl"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-ResourceSID"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-ResourceAccountName"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-MasterAccountName"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-UserPrincipalName"",""Value"":""johndoe@contoso.onmicrosoft.com"",""ValueType"":""Edm.String""},{""Key"":""SPS-O15FirstRunExperience"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-PersonalSiteInstantiationState"",""Value"":""2"",""ValueType"":""Edm.String""},{""Key"":""SPS-DistinguishedName"",""Value"":""CN=78ccf530-bbf0-47e4-aae6-da5f8c6fb142,OU=0cac6cda-2e04-4a3d-9c16-9c91470d7022,OU=Tenants,OU=MSOnline,DC=SPODS188311,DC=msft,DC=net"",""ValueType"":""Edm.String""},{""Key"":""SPS-SourceObjectDN"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-LastKeywordAdded"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-ClaimProviderType"",""Value"":""Forms"",""ValueType"":""Edm.String""},{""Key"":""SPS-SavedAccountName"",""Value"":""i:0#.f|membership|johndoe@contoso.onmicrosoft.com"",""ValueType"":""Edm.String""},{""Key"":""SPS-SavedSID"",""Value"":""System.Byte[]"",""ValueType"":""Edm.String""},{""Key"":""SPS-ObjectExists"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-PersonalSiteCapabilities"",""Value"":""36"",""ValueType"":""Edm.String""},{""Key"":""SPS-PersonalSiteFirstCreationTime"",""Value"":""9/12/2022 6:19:29 PM"",""ValueType"":""Edm.String""},{""Key"":""SPS-PersonalSiteLastCreationTime"",""Value"":""9/12/2022 6:19:29 PM"",""ValueType"":""Edm.String""},{""Key"":""SPS-PersonalSiteNumberOfRetries"",""Value"":""1"",""ValueType"":""Edm.String""},{""Key"":""SPS-PersonalSiteFirstCreationError"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-FeedIdentifier"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""WorkEmail"",""Value"":""johndoe@contoso.onmicrosoft.com"",""ValueType"":""Edm.String""},{""Key"":""CellPhone"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""Fax"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""HomePhone"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""Office"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Location"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""Assistant"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-PastProjects"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Skills"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-School"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Birthday"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-StatusNotes"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Interests"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-HashTags"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-EmailOptin"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-PrivacyPeople"",""Value"":""True"",""ValueType"":""Edm.String""},{""Key"":""SPS-PrivacyActivity"",""Value"":""4095"",""ValueType"":""Edm.String""},{""Key"":""SPS-PictureTimestamp"",""Value"":""63799442436"",""ValueType"":""Edm.String""},{""Key"":""SPS-PicturePlaceholderState"",""Value"":""1"",""ValueType"":""Edm.String""},{""Key"":""SPS-PictureExchangeSyncState"",""Value"":""1"",""ValueType"":""Edm.String""},{""Key"":""SPS-MUILanguages"",""Value"":""en-US"",""ValueType"":""Edm.String""},{""Key"":""SPS-ContentLanguages"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-TimeZone"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-RegionalSettings-FollowWeb"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Locale"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-CalendarType"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-AltCalendarType"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-AdjustHijriDays"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-ShowWeeks"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-WorkDays"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-WorkDayStartHour"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-WorkDayEndHour"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-Time24"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-FirstDayOfWeek"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-FirstWeekOfYear"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-RegionalSettings-Initialized"",""Value"":""True"",""ValueType"":""Edm.String""},{""Key"":""OfficeGraphEnabled"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-UserType"",""Value"":""0"",""ValueType"":""Edm.String""},{""Key"":""SPS-HideFromAddressLists"",""Value"":""False"",""ValueType"":""Edm.String""},{""Key"":""SPS-RecipientTypeDetails"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""DelveFlags"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""PulseMRUPeople"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""msOnline-ObjectId"",""Value"":""78ccf530-bbf0-47e4-aae6-da5f8c6fb142"",""ValueType"":""Edm.String""},{""Key"":""SPS-PointPublishingUrl"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-TenantInstanceId"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-SharePointHomeExperienceState"",""Value"":""17301504"",""ValueType"":""Edm.String""},{""Key"":""SPS-RefreshToken"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""SPS-MultiGeoFlags"",""Value"":"""",""ValueType"":""Edm.String""},{""Key"":""PreferredDataLocation"",""Value"":"""",""ValueType"":""Edm.String""}]",https://contoso-my.sharepoint.com:443/Person.aspx?accountname=i%3A0%23%2Ef%7Cmembership%7Cjohn%40contoso%2Eonmicrosoft%2Ecom
612
612
  ```
613
613
 
614
+ === "Markdown"
614
615
 
616
+ ```md
617
+ # spo userprofile get --userName "johndoe@mytenant.onmicrosoft.com"
618
+
619
+ Date: 4/10/2023
620
+
621
+ ## John Doe
622
+
623
+ Property | Value
624
+ ---------|-------
625
+ AccountName | i:0#.f\|membership\|johndoe@mytenant.onmicrosoft.com
626
+ DisplayName | John Doe
627
+ Email | johndoe@mytenant.onmicrosoft.com
628
+ IsFollowed | false
629
+ LatestPost | null
630
+ PersonalSiteHostUrl | https://johndoe-my.sharepoint.com:443/
631
+ PersonalUrl | https://johndoe-my.sharepoint.com/personal/johndoe\_johndoe\_onmicrosoft\_com/
632
+ PictureUrl | null
633
+ Title | null
634
+ UserUrl | https://johndoe-my.sharepoint.com:443/Person.aspx?accountname=i%3A0%23%2Ef%7Cmembership%7Cjohndoe%40johndoe%2Eonmicrosoft%2Ecom
635
+ ```
@@ -98,3 +98,27 @@ m365 spo web add --title Subsite --url subsite --webTemplate STS#0 --parentWebUr
98
98
  Configuration,Created,Description,Id,Language,LastItemModifiedDate,LastItemUserModifiedDate,ServerRelativeUrl,Title,WebTemplate,WebTemplateId
99
99
  0,2022-11-05T14:09:11,Subsite,0cbf2896-bac2-4244-b871-68b413ee7b2f,1033,2022-11-05T14:09:22Z,2022-11-05T14:09:22Z,/subsite,Subsite,STS,0
100
100
  ```
101
+
102
+ === "Markdown"
103
+
104
+ ```md
105
+ # spo web add --title "Subsite" --url "subsite" --webTemplate "STS#0" --parentWebUrl "https://contoso.sharepoint.com" --inheritNavigation "true"
106
+
107
+ Date: 4/10/2023
108
+
109
+ ## Subsite (261ab6d3-0064-47d8-9189-82e5745d7a7f)
110
+
111
+ Property | Value
112
+ ---------|-------
113
+ Configuration | 0
114
+ Created | 2023-04-10T06:38:24
115
+ Description |
116
+ Id | 261ab6d3-0064-47d8-9189-82e5745d7a7f
117
+ Language | 1033
118
+ LastItemModifiedDate | 2023-04-10T06:38:32Z
119
+ LastItemUserModifiedDate | 2023-04-10T06:38:32Z
120
+ ServerRelativeUrl | /subsite
121
+ Title | Subsite
122
+ WebTemplate | STS
123
+ WebTemplateId | 0
124
+ ```
@@ -51,3 +51,19 @@ m365 spo web clientsidewebpart list --webUrl https://contoso.sharepoint.com
51
51
  Id,Name,Title
52
52
  9cc0f495-db64-4d74-b06b-a3de16231fe1,9cc0f495-db64-4d74-b06b-a3de16231fe1,Dashboard for Viva Connections
53
53
  ```
54
+
55
+ === "Markdown"
56
+
57
+ ```md
58
+ # spo web clientsidewebpart list --webUrl "https://contoso.sharepoint.com"
59
+
60
+ Date: 4/10/2023
61
+
62
+ ## Dashboard for Viva Connections (9cc0f495-db64-4d74-b06b-a3de16231fe1)
63
+
64
+ Property | Value
65
+ ---------|-------
66
+ Id | 9cc0f495-db64-4d74-b06b-a3de16231fe1
67
+ Name | 9cc0f495-db64-4d74-b06b-a3de16231fe1
68
+ Title | Dashboard for Viva Connections
69
+ ```