@pnp/cli-microsoft365 6.3.0-beta.a991329 → 6.3.0-beta.ad6d08e

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 (122) hide show
  1. package/.eslintrc.js +8 -0
  2. package/dist/Command.js +4 -4
  3. package/dist/cli/Cli.js +38 -0
  4. package/dist/m365/aad/commands/user/user-recyclebinitem-clear.js +103 -0
  5. package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
  6. package/dist/m365/aad/commands.js +2 -0
  7. package/dist/m365/base/O365MgmtCommand.js +10 -0
  8. package/dist/m365/context/commands/option/option-list.js +54 -0
  9. package/dist/m365/context/commands.js +1 -0
  10. package/dist/m365/pa/commands/environment/environment-get.js +13 -5
  11. package/dist/m365/planner/commands/plan/plan-get.js +40 -26
  12. package/dist/m365/planner/commands/plan/plan-list.js +24 -14
  13. package/dist/m365/planner/commands/plan/plan-set.js +21 -10
  14. package/dist/m365/planner/commands/roster/roster-get.js +61 -0
  15. package/dist/m365/planner/commands/roster/roster-member-add.js +113 -0
  16. package/dist/m365/planner/commands/roster/roster-member-list.js +54 -0
  17. package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
  18. package/dist/m365/planner/commands/task/task-add.js +3 -0
  19. package/dist/m365/planner/commands.js +4 -0
  20. package/dist/m365/pp/commands/environment/environment-get.js +18 -9
  21. package/dist/m365/purview/commands/auditlog/auditlog-list.js +205 -0
  22. package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +75 -0
  23. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +46 -0
  24. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
  25. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-add.js +77 -0
  26. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +13 -8
  27. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +43 -0
  28. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-remove.js +97 -0
  29. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-set.js +90 -0
  30. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
  31. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
  32. package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
  33. package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
  34. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
  35. package/dist/m365/purview/commands.js +8 -0
  36. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-add.js +95 -0
  37. package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
  38. package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
  39. package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
  40. package/dist/m365/spo/commands/file/GraphFileDetails.js +0 -1
  41. package/dist/m365/spo/commands/file/file-sharinglink-add.js +2 -22
  42. package/dist/m365/spo/commands/file/file-sharinglink-clear.js +137 -0
  43. package/dist/m365/spo/commands/file/file-sharinglink-get.js +2 -25
  44. package/dist/m365/spo/commands/file/file-sharinglink-list.js +7 -28
  45. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +2 -25
  46. package/dist/m365/spo/commands/file/file-sharinglink-set.js +104 -0
  47. package/dist/m365/spo/commands/listitem/listitem-add.js +2 -1
  48. package/dist/m365/spo/commands/navigation/navigation-node-get.js +73 -0
  49. package/dist/m365/spo/commands/sitedesign/sitedesign-add.js +6 -0
  50. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-add.js +179 -0
  51. package/dist/m365/spo/commands.js +5 -0
  52. package/dist/utils/aadUser.js +38 -0
  53. package/dist/utils/planner.js +13 -2
  54. package/dist/utils/spo.js +89 -0
  55. package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
  56. package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
  57. package/docs/docs/cmd/context/option/option-list.md +63 -0
  58. package/docs/docs/cmd/login.md +26 -0
  59. package/docs/docs/cmd/logout.md +4 -0
  60. package/docs/docs/cmd/pa/app/app-get.md +24 -0
  61. package/docs/docs/cmd/pa/app/app-list.md +21 -0
  62. package/docs/docs/cmd/pa/connector/connector-list.md +17 -0
  63. package/docs/docs/cmd/pa/environment/environment-get.md +26 -2
  64. package/docs/docs/cmd/pa/environment/environment-list.md +19 -0
  65. package/docs/docs/cmd/planner/plan/plan-get.md +21 -7
  66. package/docs/docs/cmd/planner/plan/plan-list.md +16 -2
  67. package/docs/docs/cmd/planner/plan/plan-set.md +10 -4
  68. package/docs/docs/cmd/planner/roster/roster-get.md +73 -0
  69. package/docs/docs/cmd/planner/roster/roster-member-add.md +87 -0
  70. package/docs/docs/cmd/planner/roster/roster-member-list.md +76 -0
  71. package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
  72. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +43 -0
  73. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +43 -0
  74. package/docs/docs/cmd/pp/card/card-clone.md +12 -0
  75. package/docs/docs/cmd/pp/card/card-get.md +49 -0
  76. package/docs/docs/cmd/pp/card/card-list.md +49 -0
  77. package/docs/docs/cmd/pp/chatbot/chatbot-get.md +55 -0
  78. package/docs/docs/cmd/pp/chatbot/chatbot-list.md +36 -0
  79. package/docs/docs/cmd/pp/dataverse/dataverse-table-get.md +30 -0
  80. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +30 -0
  81. package/docs/docs/cmd/pp/dataverse/dataverse-table-row-list.md +30 -0
  82. package/docs/docs/cmd/pp/environment/environment-get.md +19 -0
  83. package/docs/docs/cmd/pp/environment/environment-list.md +19 -0
  84. package/docs/docs/cmd/pp/gateway/gateway-get.md +19 -0
  85. package/docs/docs/cmd/pp/gateway/gateway-list.md +19 -0
  86. package/docs/docs/cmd/pp/managementapp/managementapp-add.md +12 -0
  87. package/docs/docs/cmd/pp/managementapp/managementapp-list.md +12 -0
  88. package/docs/docs/cmd/pp/solution/solution-get.md +14 -0
  89. package/docs/docs/cmd/pp/solution/solution-list.md +14 -0
  90. package/docs/docs/cmd/pp/solution/solution-publisher-get.md +20 -1
  91. package/docs/docs/cmd/pp/solution/solution-publisher-list.md +18 -0
  92. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +21 -0
  93. package/docs/docs/cmd/purview/auditlog/auditlog-list.md +123 -0
  94. package/docs/docs/cmd/purview/retentionevent/retentionevent-get.md +132 -0
  95. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +107 -0
  96. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
  97. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-add.md +106 -0
  98. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +3 -0
  99. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +97 -0
  100. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-remove.md +43 -0
  101. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-set.md +43 -0
  102. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
  103. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
  104. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
  105. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
  106. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
  107. package/docs/docs/cmd/request.md +74 -0
  108. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md +56 -0
  109. package/docs/docs/cmd/spo/file/file-sharinglink-clear.md +46 -0
  110. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +1 -1
  111. package/docs/docs/cmd/spo/file/file-sharinglink-set.md +104 -0
  112. package/docs/docs/cmd/spo/list/list-contenttype-add.md +1 -1
  113. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +1 -1
  114. package/docs/docs/cmd/spo/list/list-contenttype-list.md +1 -1
  115. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +1 -1
  116. package/docs/docs/cmd/spo/navigation/navigation-node-get.md +91 -0
  117. package/docs/docs/cmd/spo/sitedesign/sitedesign-add.md +3 -0
  118. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.md +59 -0
  119. package/docs/docs/cmd/status.md +46 -0
  120. package/docs/docs/cmd/version.md +26 -0
  121. package/npm-shrinkwrap.json +911 -876
  122. package/package.json +12 -12
@@ -0,0 +1,43 @@
1
+ # purview retentioneventtype set
2
+
3
+ Update a retention event type
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentioneventtype set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The id of the retention event type.
15
+
16
+ `-d, --description [description]`
17
+ : The new description of the event type.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Update the description of a retention event type
24
+
25
+ ```sh
26
+ m365 purview retentioneventtype set --id c37d695e-d581-4ae9-82a0-9364eba4291e --description 'some extra information'
27
+ ```
28
+
29
+ ## Remarks
30
+
31
+ !!! attention
32
+ This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
33
+
34
+ !!! attention
35
+ This command currently only supports delegated permissions.
36
+
37
+ ## More information
38
+
39
+ This command is part of a series of commands that have to do with event-based retention. Event-based retention is about starting a retention period when a specific event occurs, instead of the moment a document was labeled or created. [Read more about event-based retention here](https://learn.microsoft.com/en-us/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
40
+
41
+ ## Response
42
+
43
+ The command won't return a response on success.
@@ -58,6 +58,9 @@ m365 purview retentionlabel add --displayName 'some label' --behaviorDuringReten
58
58
  !!! attention
59
59
  This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
60
60
 
61
+ !!! attention
62
+ This command currently only supports delegated permissions.
63
+
61
64
  ## More information
62
65
 
63
66
  - Create retentionLabel: [https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http](https://learn.microsoft.com/en-us/graph/api/security-retentionlabel-post?view=graph-rest-beta&tabs=http)
@@ -28,6 +28,9 @@ m365 purview retentionlabel get --id c37d695e-d581-4ae9-82a0-9364eba4291e
28
28
  !!! attention
29
29
  This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
30
30
 
31
+ !!! attention
32
+ This command currently only supports delegated permissions.
33
+
31
34
  ## Response
32
35
 
33
36
 
@@ -25,6 +25,9 @@ m365 purview retentionlabel list
25
25
  !!! attention
26
26
  This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
27
27
 
28
+ !!! attention
29
+ This command currently only supports delegated permissions.
30
+
28
31
  ## Response
29
32
 
30
33
 
@@ -31,6 +31,9 @@ m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
31
31
  !!! attention
32
32
  This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
33
33
 
34
+ !!! attention
35
+ This command currently only supports delegated permissions.
36
+
34
37
  ## Response
35
38
 
36
39
  The command won't return a response on success.
@@ -58,6 +58,9 @@ m365 purview retentionlabel set --id c37d695e-d581-4ae9-82a0-9364eba4291e --beha
58
58
  !!! attention
59
59
  This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
60
60
 
61
+ !!! attention
62
+ This command currently only supports delegated permissions.
63
+
61
64
  ## Response
62
65
 
63
66
  The command won't return a response on success.
@@ -74,3 +74,77 @@ Call the Microsoft Graph to get a profile photo.
74
74
  ```sh
75
75
  m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
76
76
  ```
77
+
78
+ ## Response
79
+
80
+ The responses below are an example based on the `url` option with the value 'https://graph.microsoft.com/v1.0/me'. The output may differ based on the `url` options
81
+
82
+ === "JSON"
83
+
84
+ ```json
85
+ {
86
+ "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users/$entity",
87
+ "businessPhones": [
88
+ "123456789"
89
+ ],
90
+ "displayName": "John Doe",
91
+ "givenName": "John",
92
+ "jobTitle": null,
93
+ "mail": "john.doe@contoso.onmicrosoft.com",
94
+ "mobilePhone": null,
95
+ "officeLocation": null,
96
+ "preferredLanguage": "en-US",
97
+ "surname": "Doe",
98
+ "userPrincipalName": "john.doe@contoso.onmicrosoft.com",
99
+ "id": "1df1fffa-62b8-44a9-9c7c-49853f5b4ac6"
100
+ }
101
+ ```
102
+
103
+ === "Text"
104
+
105
+ ```text
106
+ @odata.context : https://graph.microsoft.com/v1.0/$metadata#users/$entity
107
+ businessPhones : ["123456789"]
108
+ displayName : John Doe
109
+ givenName : John
110
+ id : 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
111
+ jobTitle : null
112
+ mail : john.doe@contoso.onmicrosoft.com
113
+ mobilePhone : null
114
+ officeLocation : null
115
+ preferredLanguage: en-US
116
+ surname : Doe
117
+ userPrincipalName: john.doe@contoso.onmicrosoft.com
118
+ ```
119
+
120
+ === "CSV"
121
+
122
+ ```csv
123
+ @odata.context,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName,id
124
+ https://graph.microsoft.com/v1.0/$metadata#users/$entity,"[""123456789""]",John Doe,John,,john.doe@contoso.onmicrosoft.com,,,en-US,Doe,john.doe@contoso.onmicrosoft.com,1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
125
+ ```
126
+
127
+ === "Markdown"
128
+
129
+ ```md
130
+ # request --url "https://graph.microsoft.com/v1.0/me" --method "get"
131
+
132
+ Date: 7/2/2023
133
+
134
+ ## John Doe (1df1fffa-62b8-44a9-9c7c-49853f5b4ac6)
135
+
136
+ Property | Value
137
+ ---------|-------
138
+ @odata.context | https://graph.microsoft.com/v1.0/$metadata#users/$entity
139
+ businessPhones | ["494594133"]
140
+ displayName | John Doe
141
+ givenName | John
142
+ jobTitle | null
143
+ mail | john.doe@contoso.onmicrosoft.com
144
+ mobilePhone | null
145
+ officeLocation | null
146
+ preferredLanguage | en-US
147
+ surname | Doe
148
+ userPrincipalName | john.doe@contoso.onmicrosoft.com
149
+ id | 1df1fffa-62b8-44a9-9c7c-49853f5b4ac6
150
+ ```
@@ -0,0 +1,56 @@
1
+ # spo applicationcustomizer add
2
+
3
+ Add an application customizer to a site.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo applicationcustomizer add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : The title of the application customizer.
15
+
16
+ `-u, --webUrl <webUrl>`
17
+ : URL of the site.
18
+
19
+ `-i, --clientSideComponentId <clientSideComponentId>`
20
+ : Client-side component ID of the application customizer (GUID).
21
+
22
+ `--clientSideComponentProperties [clientSideComponentProperties]`
23
+ : JSON string with application customizer properties
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how an application customizer can be created from the Windows cmd.exe:
30
+
31
+ ```sh
32
+ m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
33
+ ```
34
+
35
+ Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
36
+
37
+ !!! warning "Escaping JSON in PowerShell"
38
+ When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
39
+
40
+ ## Examples
41
+
42
+ Adds an application customizer to the sales site.
43
+
44
+ ```sh
45
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webUrl https://contoso.sharepoint.com/sites/sales
46
+ ```
47
+
48
+ Adds an application customizer to the sales site with some properties.
49
+
50
+ ```sh
51
+ m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales
52
+ ```
53
+
54
+ ## Response
55
+
56
+ The command won't return a response on success.
@@ -0,0 +1,46 @@
1
+ # spo file sharinglink clear
2
+
3
+ Removes sharing links of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink clear [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `-s, --scope [scope]`
23
+ : Scope of the sharing link. Possible options are: `anonymous`, `users` or `organization`. If not specified, all links will be removed.
24
+
25
+ `--confirm`
26
+ : Don't prompt for confirmation.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Removes all sharing links from a file specified by id without prompting for confirmation
33
+
34
+ ```sh
35
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --confirm
36
+ ```
37
+
38
+ Removes sharing links of type anonymous from a file specified by url with prompting for confirmation
39
+
40
+ ```sh
41
+ m365 spo file sharinglink clear --webUrl https://contoso.sharepoint.com/sites/demo --fileUrl '/sites/demo/Shared Documents/document.docx' --scope anonymous
42
+ ```
43
+
44
+ ## Response
45
+
46
+ The command won't return a response on success.
@@ -19,7 +19,7 @@ m365 spo file sharinglink list [options]
19
19
  `--fileId [fileId]`
20
20
  : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
21
 
22
- `--scope [scope]`
22
+ `-s, --scope [scope]`
23
23
  : Filter the results to only sharing links of a given scope: `anonymous`, `users` or `organization`. By default all sharing links are listed.
24
24
 
25
25
  --8<-- "docs/cmd/_global.md"
@@ -0,0 +1,104 @@
1
+ # spo file sharinglink set
2
+
3
+ Updates a sharing link of a file
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo file sharinglink set [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the file is located.
15
+
16
+ `--fileUrl [fileUrl]`
17
+ : The server-relative (decoded) URL of the file. Specify either `fileUrl` or `fileId` but not both.
18
+
19
+ `--fileId [fileId]`
20
+ : The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
21
+
22
+ `--id <id>`
23
+ : The ID of the sharing link.
24
+
25
+ `--expirationDateTime <expirationDateTime>`
26
+ : The date and time to set the expiration. This should be defined as a valid ISO 8601 string. This options only works for anonymous links.
27
+
28
+ --8<-- "docs/cmd/_global.md"
29
+
30
+ ## Examples
31
+
32
+ Updates an anonymous sharing link from a file by a specified site-relative URL with the expirationDateTime parameter
33
+
34
+ ```sh
35
+ m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileUrl "/sites/demo/Shared Documents/Document.docx" --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
36
+ ```
37
+
38
+ Updates an anonymous sharing link from a file by id with the expirationDateTime parameter
39
+
40
+ ```sh
41
+ m365 spo file sharinglink set --webUrl https://contoso.sharepoint.com --fileId daebb04b-a773-4baa-b1d1-3625418e3234 --id 7c9f97c9-1bda-433c-9364-bb83e81771ee --expirationDateTime "2023-01-09T16:57:00.000Z"
42
+ ```
43
+
44
+ ## Response
45
+
46
+ === "JSON"
47
+
48
+ ```json
49
+ {
50
+ "id": "7c9f97c9-1bda-433c-9364-bb83e81771ee",
51
+ "roles": [
52
+ "read"
53
+ ],
54
+ "expirationDateTime": "2023-02-09T16:57:00Z",
55
+ "hasPassword": false,
56
+ "grantedToIdentitiesV2": [],
57
+ "grantedToIdentities": [],
58
+ "link": {
59
+ "scope": "anonymous",
60
+ "type": "view",
61
+ "webUrl": "https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g",
62
+ "preventsDownload": false
63
+ }
64
+ }
65
+ ```
66
+
67
+ === "Text"
68
+
69
+ ```text
70
+ expirationDateTime : 2023-02-09T16:57:00Z
71
+ grantedToIdentities : []
72
+ grantedToIdentitiesV2: []
73
+ hasPassword : false
74
+ id : 7c9f97c9-1bda-433c-9364-bb83e81771ee
75
+ link : {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g","preventsDownload":false}
76
+ roles : ["read"]
77
+ ```
78
+
79
+ === "CSV"
80
+
81
+ ```csv
82
+ id,roles,expirationDateTime,hasPassword,grantedToIdentitiesV2,grantedToIdentities,link
83
+ 7c9f97c9-1bda-433c-9364-bb83e81771ee,"[""read""]",2023-02-09T16:57:00Z,,[],[],"{""scope"":""anonymous"",""type"":""view"",""webUrl"":""https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-_527_fI9g"",""preventsDownload"":false}"
84
+ ```
85
+
86
+ === "Markdown"
87
+
88
+ ```md
89
+ # spo file sharinglink set --webUrl "https://contoso.sharepoint.com" --fileUrl "/sites/demo/Shared Documents/Document.docx" --expirationDateTime "2023-02-09T16:57:00.000Z" --id "7c9f97c9-1bda-433c-9364-bb83e81771ee"
90
+
91
+ Date: 5/2/2023
92
+
93
+ ## 7c9f97c9-1bda-433c-9364-bb83e81771ee
94
+
95
+ Property | Value
96
+ ---------|-------
97
+ id | 7c9f97c9-1bda-433c-9364-bb83e81771ee
98
+ roles | ["read"]
99
+ expirationDateTime | 2023-02-09T16:57:00Z
100
+ hasPassword | false
101
+ grantedToIdentitiesV2 | []
102
+ grantedToIdentities | []
103
+ link | {"scope":"anonymous","type":"view","webUrl":"https://contoso.sharepoint.com/:b:/g/EbZx4QPyndlGp6HV-gvSPksBftmUNAiXjm0y-\_527\_fI9g","preventsDownload":false}
104
+ ```
@@ -13,7 +13,7 @@ m365 spo list contenttype add [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the list is located.
15
15
 
16
- `-i, --listId [listId]`
16
+ `-l, --listId [listId]`
17
17
  : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
@@ -13,7 +13,7 @@ m365 spo list contenttype default set [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the list is located.
15
15
 
16
- `-i, --listId [listId]`
16
+ `-l, --listId [listId]`
17
17
  : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
@@ -13,7 +13,7 @@ m365 spo list contenttype list [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the list is located.
15
15
 
16
- `-i, --listId [listId]`
16
+ `-l, --listId [listId]`
17
17
  : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
@@ -13,7 +13,7 @@ m365 spo list contenttype remove [options]
13
13
  `-u, --webUrl <webUrl>`
14
14
  : URL of the site where the list is located.
15
15
 
16
- `-i, --listId [listId]`
16
+ `-l, --listId [listId]`
17
17
  : ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
18
18
 
19
19
  `-t, --listTitle [listTitle]`
@@ -0,0 +1,91 @@
1
+ # spo navigation node get
2
+
3
+ Gets information about a specific navigation node.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo navigation node get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Absolute URL of the site.
15
+
16
+ `--id <id>`
17
+ : Id of the navigation node.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieve information for a specific navigation node.
24
+
25
+ ```sh
26
+ m365 spo navigation node get --webUrl https://contoso.sharepoint.com/sites/team-a --id 2209
27
+ ```
28
+
29
+ ## Response
30
+
31
+ === "JSON"
32
+
33
+ ```json
34
+ {
35
+ "AudienceIds": [
36
+ "0d718612-8407-4d6b-833c-6891a553354f",
37
+ "f864446f-b4d7-475a-a2ba-1080c6474020"
38
+ ],
39
+ "CurrentLCID": 1033,
40
+ "Id": 2209,
41
+ "IsDocLib": true,
42
+ "IsExternal": false,
43
+ "IsVisible": true,
44
+ "ListTemplateType": 100,
45
+ "Title": "Work Status",
46
+ "Url": "/sites/team-a/Lists/Work Status/AllItems.aspx"
47
+ }
48
+ ```
49
+
50
+ === "Text"
51
+
52
+ ```text
53
+ AudienceIds : ["0d718612-8407-4d6b-833c-6891a553354f", "f864446f-b4d7-475a-a2ba-1080c6474020"]
54
+ CurrentLCID : 1033
55
+ Id : 2209
56
+ IsDocLib : true
57
+ IsExternal : false
58
+ IsVisible : true
59
+ ListTemplateType: 100
60
+ Title : Work Status
61
+ Url : /sites/team-a/Lists/Work Status/AllItems.aspx
62
+ ```
63
+
64
+ === "CSV"
65
+
66
+ ```csv
67
+ AudienceIds,CurrentLCID,Id,IsDocLib,IsExternal,IsVisible,ListTemplateType,Title,Url
68
+ [""0d718612-8407-4d6b-833c-6891a553354f"", ""f864446f-b4d7-475a-a2ba-1080c6474020""],1033,2209,1,,1,100,Work Status,/sites/team-a/Lists/Work Status/AllItems.aspx
69
+ ```
70
+
71
+ === "Markdown"
72
+
73
+ ```md
74
+ # spo navigation node get --webUrl "https://contoso.sharepoint.com/sites/team-a" --id "2209"
75
+
76
+ Date: 1/29/2023
77
+
78
+ ## Work Status (2209)
79
+
80
+ Property | Value
81
+ ---------|-------
82
+ AudienceIds | ["0d718612-8407-4d6b-833c-6891a553354f", "f864446f-b4d7-475a-a2ba-1080c6474020"]
83
+ CurrentLCID | 1033
84
+ Id | 2209
85
+ IsDocLib | true
86
+ IsExternal | false
87
+ IsVisible | true
88
+ ListTemplateType | 100
89
+ Title | Work Status
90
+ Url | /sites/team-a/Lists/Work Status/AllItems.aspx
91
+ ```
@@ -28,6 +28,9 @@ m365 spo sitedesign add [options]
28
28
  `-a, --previewImageAltText [previewImageAltText]`
29
29
  : The alt text description of the image for accessibility
30
30
 
31
+ `--thumbnailUrl [thumbnailUrl]`
32
+ : The new URL of a thumbnail image. If none is specified SharePoint will use a generic image
33
+
31
34
  `--isDefault`
32
35
  : Set if the site design is applied as the default site design
33
36
 
@@ -0,0 +1,59 @@
1
+ # spo tenant applicationcustomizer add
2
+
3
+ Add an application customizer as a tenant wide extension.
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo tenant applicationcustomizer add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-t, --title <title>`
14
+ : The title of the Application Customizer.
15
+
16
+ `-i, --clientSideComponentId <clientSideComponentId>`
17
+ : The Client Side Component Id (GUID) of the application customizer.
18
+
19
+ `-p, --clientSideComponentProperties [clientSideComponentProperties]`
20
+ : The Client Side Component properties of the application customizer.
21
+
22
+ `-w, --webTemplate [webTemplate]`
23
+ : Optionally add a web template (e.g. STS#3, SITEPAGEPUBLISHING#0, etc) as a filter for what kind of sites the application customizer is registered on.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ !!! important
28
+ To use this command, you need to be a SharePoint Admin.
29
+
30
+ ## Remarks
31
+
32
+ Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how ApplicationCustomizer user custom action can be created from the Windows cmd.exe:
33
+
34
+ ```sh
35
+ m365 spo tenant applicationcustomizer add --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
36
+ ```
37
+
38
+ Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
39
+
40
+ !!! warning "Escaping JSON in PowerShell"
41
+ When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
42
+
43
+ ## Examples
44
+
45
+ Adds an application customizer that's deployed tenant wide
46
+
47
+ ```sh
48
+ m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc
49
+ ```
50
+
51
+ Adds an application customizer that is configured for all communication sites.
52
+
53
+ ```sh
54
+ m365 spo tenant applicationcustomizer add --title "Some customizer" --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webTemplate "SITEPAGEPUBLISHING#0"
55
+ ```
56
+
57
+ ## Response
58
+
59
+ The command won't return a response on success.
@@ -23,3 +23,49 @@ Show the information about the current login to the Microsoft 365
23
23
  ```sh
24
24
  m365 status
25
25
  ```
26
+
27
+ ## Response
28
+
29
+ === "JSON"
30
+
31
+ ```json
32
+ {
33
+ "connectedAs": "john.doe@contoso.onmicrosoft.com",
34
+ "authType": "DeviceCode",
35
+ "appId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
36
+ "appTenant": "common"
37
+ }
38
+ ```
39
+
40
+ === "Text"
41
+
42
+ ```text
43
+ appId : 31359c7f-bd7e-475c-86db-fdb8c937548e
44
+ appTenant : common
45
+ authType : DeviceCode
46
+ connectedAs: john.doe@contoso.onmicrosoft.com
47
+ ```
48
+
49
+ === "CSV"
50
+
51
+ ```csv
52
+ connectedAs,authType,appId,appTenant
53
+ john.doe@contoso.onmicrosoft.com,DeviceCode,31359c7f-bd7e-475c-86db-fdb8c937548e,common
54
+ ```
55
+
56
+ === "Markdown"
57
+
58
+ ```md
59
+ # status
60
+
61
+ Date: 7/2/2023
62
+
63
+
64
+
65
+ Property | Value
66
+ ---------|-------
67
+ connectedAs | john.doe@contoso.onmicrosoft.com
68
+ authType | DeviceCode
69
+ appId | 31359c7f-bd7e-475c-86db-fdb8c937548e
70
+ appTenant | common
71
+ ```
@@ -19,3 +19,29 @@ Show the version of CLI for Microsoft 365
19
19
  ```sh
20
20
  m365 version
21
21
  ```
22
+
23
+ ## Response
24
+
25
+ === "JSON"
26
+
27
+ ```json
28
+ v6.3.0
29
+ ```
30
+
31
+ === "Text"
32
+
33
+ ```text
34
+ v6.3.0
35
+ ```
36
+
37
+ === "CSV"
38
+
39
+ ```csv
40
+ v6.3.0
41
+ ```
42
+
43
+ === "Markdown"
44
+
45
+ ```md
46
+ v6.3.0
47
+ ```