@pnp/cli-microsoft365 6.4.0-beta.b1f742c → 6.4.0-beta.e3b0f5c

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 (35) hide show
  1. package/.eslintrc.js +1 -0
  2. package/dist/Command.js +1 -0
  3. package/dist/m365/aad/commands/user/user-license-remove.js +2 -1
  4. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +2 -9
  5. package/dist/m365/flow/commands/flow-disable.js +9 -2
  6. package/dist/m365/flow/commands/flow-enable.js +9 -2
  7. package/dist/m365/flow/commands/flow-get.js +9 -2
  8. package/dist/m365/flow/commands/flow-list.js +1 -1
  9. package/dist/m365/flow/commands/flow-remove.js +2 -2
  10. package/dist/m365/flow/commands/owner/owner-add.js +147 -0
  11. package/dist/m365/flow/commands/owner/owner-list.js +89 -0
  12. package/dist/m365/flow/commands/owner/owner-remove.js +147 -0
  13. package/dist/m365/flow/commands/run/run-cancel.js +9 -2
  14. package/dist/m365/flow/commands/run/run-list.js +5 -2
  15. package/dist/m365/flow/commands.js +3 -0
  16. package/dist/m365/planner/commands/roster/roster-member-get.js +98 -0
  17. package/dist/m365/planner/commands.js +1 -0
  18. package/dist/m365/spo/commands/customaction/customaction-get.js +27 -7
  19. package/dist/m365/spo/commands/term/term-get.js +68 -48
  20. package/dist/utils/aadGroup.js +18 -0
  21. package/docs/docs/cmd/aad/approleassignment/approleassignment-add.md +5 -5
  22. package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +3 -3
  23. package/docs/docs/cmd/aad/user/user-remove.md +1 -1
  24. package/docs/docs/cmd/flow/owner/owner-add.md +61 -0
  25. package/docs/docs/cmd/flow/owner/owner-list.md +90 -0
  26. package/docs/docs/cmd/flow/owner/owner-remove.md +67 -0
  27. package/docs/docs/cmd/flow/run/run-list.md +28 -0
  28. package/docs/docs/cmd/planner/roster/roster-member-get.md +87 -0
  29. package/docs/docs/cmd/spo/customaction/customaction-get.md +113 -11
  30. package/docs/docs/cmd/spo/group/group-member-add.md +4 -4
  31. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +1 -1
  32. package/docs/docs/cmd/spo/navigation/navigation-node-set.md +1 -1
  33. package/docs/docs/cmd/spo/tenant/tenant-settings-set.md +26 -26
  34. package/docs/docs/cmd/teams/channel/channel-member-add.md +2 -2
  35. package/package.json +1 -1
@@ -0,0 +1,67 @@
1
+ # flow owner remove
2
+
3
+ Removes owner permissions to a Power Automate flow
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 flow owner remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-e, --environmentName <environmentName>`
14
+ : The name of the environment.
15
+
16
+ `-f, --flowName <flowName>`
17
+ : The name of the Power Automate flow.
18
+
19
+ `--userId [userId]`
20
+ : The ID of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
21
+
22
+ `--userName [userName]`
23
+ : User principal name of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
24
+
25
+ `--groupId [groupId]`
26
+ : The ID of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
27
+
28
+ `--groupName [groupName]`
29
+ : The name of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
30
+
31
+ `--asAdmin`
32
+ : Run the command as admin.
33
+
34
+ `--confirm`
35
+ : Don't prompt for confirmation.
36
+
37
+ --8<-- "docs/cmd/_global.md"
38
+
39
+ ## Examples
40
+
41
+ Remove owner permissions from a specific Power Automate flow for a user by ID without prompting for confirmation
42
+
43
+ ```sh
44
+ m365 flow owner remove --userId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --confirm
45
+ ```
46
+
47
+ Remove owner permissions from a specific Power Automate flow for a user by UPN as admin
48
+
49
+ ```sh
50
+ m365 flow owner remove --userName john.doe@contoso.com --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --asAdmin
51
+ ```
52
+
53
+ Remove owner permissions from a specific Power Automate flow for a group by ID
54
+
55
+ ```sh
56
+ m365 flow owner remove --groupId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72
57
+ ```
58
+
59
+ Remove owner permissions from a specific Power Automate flow for a group by name as admin
60
+
61
+ ```sh
62
+ m365 flow owner remove --groupName "Test group" --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --asAdmin
63
+ ```
64
+
65
+ ## Response
66
+
67
+ The command won't return a response on success.
@@ -25,6 +25,9 @@ m365 flow run list [options]
25
25
  `--triggerEndTime [triggerEndTime]`
26
26
  : Time indicating the exclusive end of a time range of flow runs to return. This should be defined as a valid ISO 8601 string (2021-12-16T18:28:48.6964197Z).
27
27
 
28
+ `--asAdmin`
29
+ : Run the command as admin. Use this flag when targeting flows you don't own.
30
+
28
31
  --8<-- "docs/cmd/_global.md"
29
32
 
30
33
  ## Remarks
@@ -56,6 +59,12 @@ List runs of the specified Microsoft Flow between a specific time range
56
59
  m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --triggerStartTime 2023-01-21T18:19:00Z --triggerEndTime 2023-01-22T00:00:00Z
57
60
  ```
58
61
 
62
+ List runs of the specified Microsoft Flow owned by another user
63
+
64
+ ```sh
65
+ m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --flowName 5923cb07-ce1a-4a5c-ab81-257ce820109a --asAdmin
66
+ ```
67
+
59
68
  ## Response
60
69
 
61
70
  ### Standard response
@@ -123,3 +132,22 @@ m365 flow run list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c
123
132
  name,startTime,status
124
133
  08585329112602833828909892130CU17,2022-11-17T14:33:45.2763872Z,Running
125
134
  ```
135
+
136
+ === "Markdown"
137
+
138
+ ```md
139
+ # flow run list --environmentName "Default-de348bc7-1aeb-4406-8cb3-97db021cadb4" --flowName "08585329112602833828909892130CU17"
140
+
141
+ Date: 1/3/2023
142
+
143
+ ## 08585329112602833828909892130CU17 (/providers/Microsoft.ProcessSimple/environments/Default-de348bc7-1aeb-4406-8cb3-97db021cadb4/flows/170fb67e-a514-4d84-8727-582022bd13a9/runs/08585329112602833828909892130CU17)
144
+
145
+ Property | Value
146
+ ---------|-------
147
+ name | 08585329112602833828909892130CU17
148
+ id | /providers/Microsoft.ProcessSimple/environments/Default-de348bc7-1aeb-4406-8cb3-97db021cadb4/flows/170fb67e-a514-4d84-8727-582022bd13a9/runs/08585329112602833828909892130CU17
149
+ type | Microsoft.ProcessSimple/environments/flows/runs
150
+ properties | {"startTime":"2022-11-17T14:33:45.2763872Z","status":"Running","correlation":{"clientTrackingId":"08585329112602833829909892130CU00"},"trigger":{"name":"When_a_new_response_is_submitted","inputsLink":{"uri":"https://prod-08.centralindia.logic.azure.com:443/workflows/f7bf8f6b5c494e63bfc21b54087a596e/runs/08585329112602833828909892130CU17/contents/TriggerInputs?api-version=2016-06-01&se=2022-11-17T18%3A00%3A00.0000000Z&sp=%2Fruns%2F08585329112602833828909892130CU17%2Fcontents%2FTriggerInputs%2Fread&sv=1.0&sig=jmdMRWvY7uGoxTmqd3_a2bJtegXuVyuKTKKUVLiwh38","contentVersion":"6ZrBBE+MJg7IvhMgyJLMmA==","contentSize":349,"contentHash":{"algorithm":"md5","value":"6ZrBBE+MJg7IvhMgyJLMmA=="}},"outputsLink":{"uri":"https://prod-08.centralindia.logic.azure.com:443/workflows/f7bf8f6b5c494e63bfc21b54087a596e/runs/08585329112602833828909892130CU17/contents/TriggerOutputs?api-version=2016-06-01&se=2022-11-17T18%3A00%3A00.0000000Z&sp=%2Fruns%2F08585329112602833828909892130CU17%2Fcontents%2FTriggerOutputs%2Fread&sv=1.0&sig=Y3qqjuWrrcQJrmF7uvm6LVzQy5w-dNOFWJ8Yt8khXvA","contentVersion":"Z/4a8tfYygNAR1xpc44iww==","contentSize":493,"contentHash":{"algorithm":"md5","value":"Z/4a8tfYygNAR1xpc44iww=="}},"startTime":"2022-11-17T14:33:45.1914506Z","endTime":"2022-11-17T14:33:45.1914506Z","originHistoryName":"08585329112602833829909892130CU00","correlation":{"clientTrackingId":"08585329112602833829909892130CU00"},"status":"Succeeded"}}
151
+ startTime | 2022-11-17T14:33:45.2763872Z
152
+ status | Running
153
+ ```
@@ -0,0 +1,87 @@
1
+ # planner roster member get
2
+
3
+ Gets a member of the specified Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster member get [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--rosterId <rosterId>`
14
+ : ID of the Planner Roster.
15
+
16
+ `--userId [userId]`
17
+ : User's Azure AD ID. Specify either `userId` or `userName` but not both.
18
+
19
+ `--userName [userName]`
20
+ : User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId` or `userName` but not both.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! attention
27
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
28
+
29
+ ## Examples
30
+
31
+ Gets a specific user by user name as member of the Planner Roster
32
+
33
+ ```sh
34
+ m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
35
+ ```
36
+
37
+ Gets a specific user by ID as member of the Planner Roster
38
+
39
+ ```sh
40
+ m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
41
+ ```
42
+
43
+ ## Response
44
+
45
+ === "JSON"
46
+
47
+ ```json
48
+ {
49
+ "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
50
+ "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
51
+ "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
52
+ "roles": []
53
+ }
54
+ ```
55
+
56
+ === "Text"
57
+
58
+ ```text
59
+ id : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
60
+ roles : []
61
+ tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
62
+ userId : 2056d2f6-3257-4253-8cfc-b73393e414e5
63
+ ```
64
+
65
+ === "CSV"
66
+
67
+ ```csv
68
+ id,userId,tenantId,roles
69
+ b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
70
+ ```
71
+
72
+ === "Markdown"
73
+
74
+ ```md
75
+ # planner roster member get --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
76
+
77
+ Date: 18/2/2023
78
+
79
+ ## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
80
+
81
+ Property | Value
82
+ ---------|-------
83
+ id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
84
+ userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
85
+ tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
86
+ roles | []
87
+ ```
@@ -11,10 +11,13 @@ m365 spo customaction get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : ID of the user custom action to retrieve information for. Specify either `id` or `title`
14
+ : ID of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
15
15
 
16
16
  `-t, --title [title]`
17
- : Title of the user custom action to retrieve information for. Specify either `id` or `title`
17
+ : Title of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
18
+
19
+ `-c, --clientSideComponentId [clientSideComponentId]`
20
+ : clientSideComponentId of the user custom action to retrieve information for. Specify either `id`, `title` or `clientSideComponentId`
18
21
 
19
22
  `-u, --webUrl <webUrl>`
20
23
  : Url of the site or site collection to retrieve the custom action from
@@ -26,34 +29,133 @@ m365 spo customaction get [options]
26
29
 
27
30
  ## Remarks
28
31
 
29
- If the command finds multiple user custom actions with the specified title, it will prompt you to disambiguate which user custom action it should use, listing the discovered IDs.
32
+ If the command finds multiple user custom actions with the specified `title` or `clientSideComponentId`, it will prompt you to disambiguate which user custom action it should get, listing the discovered IDs.
30
33
 
31
34
  ## Examples
32
35
 
33
- Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
36
+ Return details about the user custom action based on the id and a given url
34
37
 
35
38
  ```sh
36
39
  m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test
37
40
  ```
38
41
 
39
- Return details about the user custom action with Title _YourAppCustomizer_ located in site or site collection _https://contoso.sharepoint.com/sites/test_
42
+ Return details about the user custom action based on the title and a given url
40
43
 
41
44
  ```sh
42
45
  m365 spo customaction get --title "YourAppCustomizer" --webUrl https://contoso.sharepoint.com/sites/test
43
46
  ```
44
47
 
45
- Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site collection _https://contoso.sharepoint.com/sites/test_
48
+ Return details about the user custom action based on the clientSideComponentId and a given url
49
+
50
+ ```sh
51
+ m365 spo customaction get --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --webUrl https://contoso.sharepoint.com/sites/test
52
+ ```
53
+
54
+ Return details about the user custom action based on the id and a given url and the scope
46
55
 
47
56
  ```sh
48
- m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Site
57
+ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Site
49
58
  ```
50
59
 
51
- Return details about the user custom action with ID _058140e3-0e37-44fc-a1d3-79c487d371a3_ located in site _https://contoso.sharepoint.com/sites/test_
60
+ Return details about the user custom action based on the id and a given url and the scope
52
61
 
53
62
  ```sh
54
- m365 spo customaction get --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --webUrl https://contoso.sharepoint.com/sites/test --scope Web
63
+ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
55
64
  ```
56
65
 
57
- ## More information
66
+ Return details about the user custom action based on the id and a given url and the scope
67
+
68
+ ```sh
69
+ m365 spo customaction get --id "058140e3-0e37-44fc-a1d3-79c487d371a3" --webUrl https://contoso.sharepoint.com/sites/test --scope Web
70
+ ```
58
71
 
59
- - UserCustomAction REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction](https://msdn.microsoft.com/en-us/library/office/dn531432.aspx#bk_UserCustomAction)
72
+ ## Response
73
+
74
+ === "JSON"
75
+
76
+ ```json
77
+ {
78
+ "ClientSideComponentId": "34a019f9-6198-4053-a3b6-fbdea9a107fd",
79
+ "ClientSideComponentProperties": "{\"sampleTextOne\":\"One item is selected in the list.\", \"sampleTextTwo\":\"This command is always visible.\"}",
80
+ "CommandUIExtension": null,
81
+ "Description": null,
82
+ "Group": null,
83
+ "Id": "158cb0d1-8703-4a36-866d-84aed8233bd3",
84
+ "ImageUrl": null,
85
+ "Location": "ClientSideExtension.ListViewCommandSet.CommandBar",
86
+ "Name": "{158cb0d1-8703-4a36-866d-84aed8233bd3}",
87
+ "RegistrationId": "100",
88
+ "RegistrationType": 1,
89
+ "Rights": "{\"High\":0,\"Low\":0}",
90
+ "Scope": "Web",
91
+ "ScriptBlock": null,
92
+ "ScriptSrc": null,
93
+ "Sequence": 65536,
94
+ "Title": "ExtensionTraining",
95
+ "Url": null,
96
+ "VersionOfUserCustomAction": "1.0.1.0"
97
+ }
98
+ ```
99
+
100
+ === "Text"
101
+
102
+ ```text
103
+ ClientSideComponentId : 34a019f9-6198-4053-a3b6-fbdea9a107fd
104
+ ClientSideComponentProperties: {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
105
+ CommandUIExtension : null
106
+ Description : null
107
+ Group : null
108
+ Id : 158cb0d1-8703-4a36-866d-84aed8233bd3
109
+ ImageUrl : null
110
+ Location : ClientSideExtension.ListViewCommandSet.CommandBar
111
+ Name : {158cb0d1-8703-4a36-866d-84aed8233bd3}
112
+ RegistrationId : 100
113
+ RegistrationType : 1
114
+ Rights : {"High":0,"Low":0}
115
+ Scope : Web
116
+ ScriptBlock : null
117
+ ScriptSrc : null
118
+ Sequence : 65536
119
+ Title : ExtensionTraining
120
+ Url : null
121
+ VersionOfUserCustomAction : 1.0.1.0
122
+ ```
123
+
124
+ === "CSV"
125
+
126
+ ```csv
127
+ ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Rights,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
128
+ 34a019f9-6198-4053-a3b6-fbdea9a107fd,"{""sampleTextOne"":""One item is selected in the list."", ""sampleTextTwo"":""This command is always visible.""}",,,,158cb0d1-8703-4a36-866d-84aed8233bd3,,ClientSideExtension.ListViewCommandSet.CommandBar,{158cb0d1-8703-4a36-866d-84aed8233bd3},100,1,"{""High"":0,""Low"":0}",Web,,,65536,ExtensionTraining,,1.0.1.0
129
+ ```
130
+
131
+ === "Markdown"
132
+
133
+ ```md
134
+ # spo customaction get --webUrl "https://contoso.sharepoint.com" --clientSideComponentId "34a019f9-6198-4053-a3b6-fbdea9a107fd" --scope "Web"
135
+
136
+ Date: 27/1/2023
137
+
138
+ ## ExtensionTraining (158cb0d1-8703-4a36-866d-84aed8233bd3)
139
+
140
+ Property | Value
141
+ ---------|-------
142
+ ClientSideComponentId | 34a019f9-6198-4053-a3b6-fbdea9a107fd
143
+ ClientSideComponentProperties | {"sampleTextOne":"One item is selected in the list.", "sampleTextTwo":"This command is always visible."}
144
+ CommandUIExtension | null
145
+ Description | null
146
+ Group | null
147
+ Id | 158cb0d1-8703-4a36-866d-84aed8233bd3
148
+ ImageUrl | null
149
+ Location | ClientSideExtension.ListViewCommandSet.CommandBar
150
+ Name | {158cb0d1-8703-4a36-866d-84aed8233bd3}
151
+ RegistrationId | 100
152
+ RegistrationType | 1
153
+ Rights | {"High":0,"Low":0}
154
+ Scope | Web
155
+ ScriptBlock | null
156
+ ScriptSrc | null
157
+ Sequence | 65536
158
+ Title | ExtensionTraining
159
+ Url | null
160
+ VersionOfUserCustomAction | 1.0.1.0
161
+ ```
@@ -20,16 +20,16 @@ m365 spo group member add [options]
20
20
  : Name of the SharePoint Group to which the user needs to be added, specify either `groupId` or `groupName`
21
21
 
22
22
  `--userName [userName]`
23
- : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
23
+ : User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma-separated (e.g. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
24
24
 
25
25
  `--email [email]`
26
- : User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
26
+ : User's email (eg. megan.bowen@contoso.com). If multiple users need to be added, they have to be comma-separated (e.g. megan.bowen@contoso.com,alex.wilber@contoso.com). Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
27
27
 
28
28
  `--userId [userId]`
29
- : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
29
+ : The user Id of the user to add as a member. (Id of the site user, for example: 14) If multiple users need to be added, the Ids have to be comma-separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
30
30
 
31
31
  `--aadGroupId [aadGroupId]`
32
- : The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
32
+ : The object Id of the Azure AD group to add as a member. If multiple groups need to be added, the Ids have to be comma-separated. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
33
33
 
34
34
  `--aadGroupName [aadGroupName]`
35
35
  : The name of the Azure AD group to add as a member. Specify either `userId`, `userName`, `email`, `aadGroupId` or `aadGroupName`
@@ -29,7 +29,7 @@ m365 spo navigation node add [options]
29
29
  : Set, if the navigation node points to an external URL.
30
30
 
31
31
  `--audienceIds [audienceIds]`
32
- : Comma separated list of group IDs that will be used for audience targeting. The limit is 10 ids per navigation node.
32
+ : Comma-separated list of group IDs that will be used for audience targeting. The limit is 10 ids per navigation node.
33
33
 
34
34
  --8<-- "docs/cmd/_global.md"
35
35
 
@@ -23,7 +23,7 @@ m365 spo navigation node set [options]
23
23
  : New URL of the navigation node.
24
24
 
25
25
  `--audienceIds [audienceIds]`
26
- : Comma separated list of group IDs that will be used for audience targeting. Speficy an empty string `""` to clear this value. The limit is 10 ids per navigation node.
26
+ : Comma-separated list of group IDs that will be used for audience targeting. Speficy an empty string `""` to clear this value. The limit is 10 ids per navigation node.
27
27
 
28
28
  `--isExternal [isExternal]`
29
29
  : Whether the navigation node points to an external URL. Valid values: `true` or `false`.
@@ -10,8 +10,6 @@ m365 spo tenant settings set [options]
10
10
 
11
11
  ## Options
12
12
 
13
- --8<-- "docs/cmd/_global.md"
14
-
15
13
  `--MinCompatibilityLevel [MinCompatibilityLevel]`
16
14
  : Specifies the lower bound on the compatibility level for new sites
17
15
 
@@ -19,7 +17,7 @@ m365 spo tenant settings set [options]
19
17
  : Specifies the upper bound on the compatibility level for new sites
20
18
 
21
19
  `--ExternalServicesEnabled [ExternalServicesEnabled]`
22
- : Enables external services for a tenant. External services are defined as services that are not in the Microsoft 365 datacenters. Allowed values `true,false`
20
+ : Enables external services for a tenant. External services are defined as services that are not in the Microsoft 365 data centers. Allowed values `true,false`
23
21
 
24
22
  `--NoAccessRedirectUrl [NoAccessRedirectUrl]`
25
23
  : Specifies the URL of the redirected site for those site collections which have the locked state "NoAccess"
@@ -34,43 +32,43 @@ m365 spo tenant settings set [options]
34
32
  : Specifies URL of the form to load in the Start a Site dialog. The valid values are: "" (default) - Blank by default, this will also remove or clear any value that has been set. Full URL - Example:"https://contoso.sharepoint.com/path/to/form"
35
33
 
36
34
  `--ShowEveryoneClaim [ShowEveryoneClaim]`
37
- : Enables the administrator to hide the Everyone claim in the People Picker. When users share an item with Everyone, it is accessible to all authenticated users in the tenant\'s Azure Active Directory, including any active external users who have previously accepted invitations. Note, that some SharePoint system resources such as templates and pages are required to be shared to Everyone and this type of sharing does not expose any user data or metadata. Allowed values `true,false`
35
+ : Enables the administrator to hide the Everyone claim in the People Picker. When users share an item with Everyone, it is accessible to all authenticated users in the tenant's Azure Active Directory, including any active external users who have previously accepted invitations. Note, that some SharePoint system resources such as templates and pages are required to be shared with Everyone and this type of sharing does not expose any user data or metadata. Allowed values `true,false`
38
36
 
39
37
  `--ShowAllUsersClaim [ShowAllUsersClaim]`
40
- : Enables the administrator to hide the All Users claim groups in People Picker. When users share an item with "All Users (x)", it is accessible to all organization members in the tenant\'s Azure Active Directory who have authenticated with via this method. When users share an item with "All Users (x)" it is accessible to all organization members in the tenant that used NTLM to authentication with SharePoint. Allowed values `true,false`
38
+ : Enables the administrator to hide the All Users claim groups in People Picker. When users share an item with "All Users (x)", it is accessible to all organization members in the tenant's Azure Active Directory who have authenticated via this method. When users share an item with "All Users (x)" it is accessible to all organization members in the tenant that used NTLM to authenticate with SharePoint. Allowed values `true,false`
41
39
 
42
40
  `--ShowEveryoneExceptExternalUsersClaim [ShowEveryoneExceptExternalUsersClaim]`
43
41
  : Enables the administrator to hide the "Everyone except external users" claim in the People Picker. When users share an item with "Everyone except external users", it is accessible to all organization members in the tenant's Azure Active Directory, but not to any users who have previously accepted invitations. Allowed values `true,false`
44
42
 
45
43
  `--SearchResolveExactEmailOrUPN [SearchResolveExactEmailOrUPN]`
46
- : Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until browser cache is cleared or expired. SharePoint Administrators will still be able to use starts with or partial name matching when enabled. Allowed values `true,false`
44
+ : Removes the search capability from People Picker. Note, recently resolved names will still appear in the list until the browser cache is cleared or expired. SharePoint Administrators will still be able to use starts with or partial name matching when enabled. Allowed values `true,false`
47
45
 
48
46
  `--OfficeClientADALDisabled [OfficeClientADALDisabled]`
49
47
  : When set to true this will disable the ability to use Modern Authentication that leverages ADAL across the tenant. Allowed values `true,false`
50
48
 
51
49
  `--LegacyAuthProtocolsEnabled [LegacyAuthProtocolsEnabled]`
52
- : By default this value is set to true. Setting this parameter prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. A value of true - Enables Office clients using non-modern authentication protocols (such as, Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. Allowed values `true,false`
50
+ : By default, this value is set to true. Setting this parameter prevents Office clients using non-modern authentication protocols from accessing SharePoint Online resources. A value of true - Enables Office clients using non-modern authentication protocols (such as Forms-Based Authentication (FBA) or Identity Client Runtime Library (IDCRL)) to access SharePoint resources. Allowed values `true,false`
53
51
 
54
52
  `--RequireAcceptingAccountMatchInvitedAccount [RequireAcceptingAccountMatchInvitedAccount]`
55
53
  : Ensures that an external user can only accept an external sharing invitation with an account matching the invited email address. Administrators who desire increased control over external collaborators should consider enabling this feature. Allowed values `true,false`
56
54
 
57
55
  `--ProvisionSharedWithEveryoneFolder [ProvisionSharedWithEveryoneFolder]`
58
- : Creates a Shared with Everyone folder in every user\'s new OneDrive for Business document library. The valid values are: True (default) - The Shared with Everyone folder is created. False - No folder is created when the site and OneDrive for Business document library is created. Allowed values `true,false`
56
+ : Creates a Shared with Everyone folder in every user's new OneDrive for Business document library. The valid values are: True (default) - The Shared with Everyone folder is created. False - No folder is created when the site and OneDrive for Business document library are created. Allowed values `true,false`
59
57
 
60
58
  `--SignInAccelerationDomain [SignInAccelerationDomain]`
61
- : Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. Acceleration will not occur on site collections that are shared externally. This value should be configured with the login domain that is used by your company (that is, example@contoso.com). If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. The valid values are: "" (default) - Blank by default, this will also remove or clear any value that has been set. Login Domain - For example: "contoso.com". No value assigned by default
59
+ : Specifies the home realm discovery value to be sent to Azure Active Directory (AAD) during the user sign-in process. When the organization uses a third-party identity provider, this prevents the user from seeing the Azure Active Directory Home Realm Discovery web page and ensures the user only sees their company's Identity Provider's portal. This value can also be used with Azure Active Directory Premium to customize the Azure Active Directory login page. Acceleration will not occur on-site collections that are shared externally. This value should be configured with the login domain that is used by your company (that is, example@contoso.com). If your company has multiple third-party identity providers, configuring the sign-in acceleration value will break sign-in for your organization. The valid values are: "" (default) - Blank by default, this will also remove or clear any value that has been set. Login Domain - For example: "contoso.com". No value assigned by default
62
60
 
63
61
  `--EnableGuestSignInAcceleration [EnableGuestSignInAcceleration]`
64
62
  : Accelerates guest-enabled site collections as well as member-only site collections when the SignInAccelerationDomain parameter is set. Allowed values `true,false`
65
63
 
66
64
  `--UsePersistentCookiesForExplorerView [UsePersistentCookiesForExplorerView]`
67
- : Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. "Open with Explorer" requires persisted cookies to operate correctly. When the user does not select "Keep Me Signed in" at the time of sign -in, "Open with Explorer" will fail. This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.To clear this cookie, the user must log out of their Windows session. The valid values are: False(default) - No special cookie is generated and the normal Microsoft 365 sign -in length / timing applies. True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign -in. Allowed values `true,false`
65
+ : Lets SharePoint issue a special cookie that will allow this feature to work even when "Keep Me Signed In" is not selected. "Open with Explorer" requires persisted cookies to operate correctly. When the user does not select "Keep Me Signed in" at the time of sign-in, "Open with Explorer" will fail. This special cookie expires after 30 minutes and cannot be cleared by closing the browser or signing out of SharePoint Online.To clear this cookie, the user must log out of their Windows session. The valid values are: False(default) - No special cookie is generated and the normal Microsoft 365 sign-in length/timing applies. True - Generates a special cookie that will allow "Open with Explorer" to function if the "Keep Me Signed In" box is not checked at sign-in. Allowed values `true,false`
68
66
 
69
67
  `--BccExternalSharingInvitations [BccExternalSharingInvitations]`
70
- : When the feature is enabled, all external sharing invitations that are sent will blind copy the e-mail messages listed in the BccExternalSharingsInvitationList. Allowed values `true,false`
68
+ : When the feature is enabled, all external sharing invitations that are sent will blindly copy the e-mail messages listed in the BccExternalSharingsInvitationList. Allowed values `true,false`
71
69
 
72
70
  `--BccExternalSharingInvitationsList [BccExternalSharingInvitationsList]`
73
- : Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. Multiple addresses can be specified by creating a comma separated list with no spaces
71
+ : Specifies a list of e-mail addresses to be BCC'd when the BCC for External Sharing feature is enabled. Multiple addresses can be specified by creating a comma-separated list with no spaces
74
72
 
75
73
  `--UserVoiceForFeedbackEnabled [UserVoiceForFeedbackEnabled]`
76
74
  : Enables or disables the User Voice Feedback button. Allowed values `true,false`
@@ -79,16 +77,16 @@ m365 spo tenant settings set [options]
79
77
  : Enables or disables the publish CDN. Allowed values `true,false`
80
78
 
81
79
  `--PublicCdnAllowedFileTypes [PublicCdnAllowedFileTypes]`
82
- : Sets public CDN allowed file types
80
+ : Sets public CDN-allowed file types
83
81
 
84
82
  `--RequireAnonymousLinksExpireInDays [RequireAnonymousLinksExpireInDays]`
85
83
  : Specifies all anonymous links that have been created (or will be created) will expire after the set number of days. To remove the expiration requirement, set the value to zero (0)
86
84
 
87
85
  `--SharingAllowedDomainList [SharingAllowedDomainList]`
88
- : Specifies a list of email domains that is allowed for sharing with the external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com"
86
+ : Specifies a list of email domains that are allowed for sharing with external collaborators. Use the space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com"
89
87
 
90
88
  `--SharingBlockedDomainList [SharingBlockedDomainList]`
91
- : Specifies a list of email domains that is blocked or prohibited for sharing with the external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com"
89
+ : Specifies a list of email domains that are blocked or prohibited from sharing with external collaborators. Use space character as the delimiter for entering multiple values. For example, "contoso.com fabrikam.com"
92
90
 
93
91
  `--SharingDomainRestrictionMode [SharingDomainRestrictionMode]`
94
92
  : Specifies the external sharing mode for domains. Allowed values `None,AllowList,BlockList`
@@ -97,7 +95,7 @@ m365 spo tenant settings set [options]
97
95
  : Sets a default OneDrive for Business storage quota for the tenant. It will be used for new OneDrive for Business sites created. A typical use will be to reduce the amount of storage associated with OneDrive for Business to a level below what the License entitles the users. For example, it could be used to set the quota to 10 gigabytes (GB) by default
98
96
 
99
97
  `--OneDriveForGuestsEnabled [OneDriveForGuestsEnabled]`
100
- : Lets OneDrive for Business creation for administrator managed guest users. Administrator managed Guest users use credentials in the resource tenant to access the resources. Allowed values `true,false`
98
+ : Lets OneDrive for Business creation for administrator-managed guest users. Administrator-managed Guest users use credentials in the resource tenant to access the resources. Allowed values `true,false`
101
99
 
102
100
  `--IPAddressEnforcement [IPAddressEnforcement]`
103
101
  : Allows access from network locations that are defined by an administrator. The values are true and false. The default value is false which means the setting is disabled. Before the iPAddressEnforcement parameter is set, make sure you add a valid IPv4 or IPv6 address to the iPAddressAllowList parameter. Allowed values `true,false`
@@ -109,10 +107,10 @@ m365 spo tenant settings set [options]
109
107
  : Sets IP Address WAC token lifetime'
110
108
 
111
109
  `--UseFindPeopleInPeoplePicker [UseFindPeopleInPeoplePicker]`
112
- : Sets use find people in PeoplePicker to true or false. Note: When set to true, users aren\'t able to share with security groups or SharePoint groups. Allowed values `true,false`
110
+ : Sets use to find people in PeoplePicker to true or false. Note: When set to true, users aren't able to share with security groups or SharePoint groups. Allowed values `true,false`
113
111
 
114
112
  `--DefaultSharingLinkType [DefaultSharingLinkType]`
115
- : Lets administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. Allowed values `None,Direct,Internal,AnonymousAccess`
113
+ : Let's administrators choose what type of link appears is selected in the “Get a link” sharing dialog box in OneDrive for Business and SharePoint Online. Allowed values `None,Direct,Internal,AnonymousAccess`
116
114
 
117
115
  `--ODBMembersCanShare [ODBMembersCanShare]`
118
116
  : Lets administrators set policy on re-sharing behavior in OneDrive for Business. Allowed values `Unspecified,On,Off`
@@ -145,7 +143,7 @@ m365 spo tenant settings set [options]
145
143
  : Enables or disables notifications in SharePoint. Allowed values `true,false`
146
144
 
147
145
  `--OwnerAnonymousNotification [OwnerAnonymousNotification]`
148
- : Enables or disables owner anonymous notification. Allowed values `true,false`
146
+ : Enables or disables owner-anonymous notification. Allowed values `true,false`
149
147
 
150
148
  `--CommentsOnSitePagesDisabled [CommentsOnSitePagesDisabled]`
151
149
  : Enables or disables comments on site pages. Allowed values `true,false`
@@ -160,19 +158,19 @@ m365 spo tenant settings set [options]
160
158
  : Prevents the Download button from being displayed on the Virus Found warning page. Allowed values `true,false`
161
159
 
162
160
  `--DefaultLinkPermission [DefaultLinkPermission]`
163
- : Choose the dafault permission that is selected when users share. This applies to anonymous access, internal and direct links. Allowed values `None,View,Edit`
161
+ : Choose the default permission that is selected when users share. This applies to anonymous access, internal and direct links. Allowed values `None,View,Edit`
164
162
 
165
163
  `--ConditionalAccessPolicy [ConditionalAccessPolicy]`
166
164
  : Configures conditional access policy. Allowed values `AllowFullAccess,AllowLimitedAccess,BlockAccess`
167
165
 
168
166
  `--AllowDownloadingNonWebViewableFiles [AllowDownloadingNonWebViewableFiles]`
169
- : Allows downloading non web viewable files. The Allowed values `true,false`
167
+ : Allows downloading non-web viewable files. The Allowed values `true,false`
170
168
 
171
169
  `--AllowEditing [AllowEditing]`
172
170
  : Allows editing. Allowed values `true,false`
173
171
 
174
172
  `--ApplyAppEnforcedRestrictionsToAdHocRecipients [ApplyAppEnforcedRestrictionsToAdHocRecipients]`
175
- : Applies app enforced restrictions to AdHoc recipients. Allowed values `true,false`
173
+ : Applies app-enforced restrictions to AdHoc recipients. Allowed values `true,false`
176
174
 
177
175
  `--FilePickerExternalImageSearchEnabled [FilePickerExternalImageSearchEnabled]`
178
176
  : Enables file picker external image search. Allowed values `true,false`
@@ -190,7 +188,7 @@ m365 spo tenant settings set [options]
190
188
  : Blocks access on unmanaged devices. Allowed values `true,false`
191
189
 
192
190
  `--AllowLimitedAccessOnUnmanagedDevices [AllowLimitedAccessOnUnmanagedDevices]`
193
- : Allows limited access on unmanaged devices blocks. Allowed values `true,false`
191
+ : Allows limited access on unmanaged device blocks. Allowed values `true,false`
194
192
 
195
193
  `--BlockDownloadOfAllFilesForGuests [BlockDownloadOfAllFilesForGuests]`
196
194
  : Blocks download of all files for guests. Allowed values `true,false`
@@ -211,7 +209,7 @@ m365 spo tenant settings set [options]
211
209
  : Disables report problem dialog. Allowed values `true,false`
212
210
 
213
211
  `--DisplayNamesOfFileViewers [DisplayNamesOfFileViewers]`
214
- : Displayes names of file viewers. Allowed values `true,false`
212
+ : Displays names of file viewers. Allowed values `true,false`
215
213
 
216
214
  `--EnableMinimumVersionRequirement [EnableMinimumVersionRequirement]`
217
215
  : Enables minimum version requirement. Allowed values `true,false`
@@ -235,7 +233,7 @@ m365 spo tenant settings set [options]
235
233
  : Organization news site url'
236
234
 
237
235
  `--PermissiveBrowserFileHandlingOverride [PermissiveBrowserFileHandlingOverride]`
238
- : Permissive browser fileHandling override. Allowed values `true,false`
236
+ : Permissive browser file handling override. Allowed values `true,false`
239
237
 
240
238
  `--ShowNGSCDialogForSyncOnODB [ShowNGSCDialogForSyncOnODB]`
241
239
  : Show NGSC dialog for sync on OneDrive for Business. Allowed values `true,false`
@@ -264,8 +262,10 @@ m365 spo tenant settings set [options]
264
262
  `--SyncAadB2BManagementPolicy [SyncAadB2BManagementPolicy]`
265
263
  : Syncs Azure B2B Management Policies. Allowed values `true,false`. For more information, see [SharePoint and OneDrive integration with Azure AD B2B](https://aka.ms/spo-b2b-integration).
266
264
 
265
+ --8<-- "docs/cmd/_global.md"
266
+
267
267
  !!! important
268
- To use this command you have to have permissions to access the tenant admin site.
268
+ To use this command you have to have permission to access the tenant admin site.
269
269
 
270
270
  ## Examples
271
271
 
@@ -23,10 +23,10 @@ m365 teams channel member add [options]
23
23
  : The display name of the Microsoft Teams team channel. Specify either `channelId` or `channelName`, but not both.
24
24
 
25
25
  `--userId [userId]`
26
- : The user's ID or principal name. You can also pass a comma separated list of userIds.
26
+ : The user's ID or principal name. You can also pass a comma-separated list of userIds.
27
27
 
28
28
  `--userDisplayName [userDisplayName]`
29
- : The display name of a user. You can also pass a comma separated list of display names.
29
+ : The display name of a user. You can also pass a comma-separated list of display names.
30
30
 
31
31
  `--owner`
32
32
  : Assign the user the owner role. Defaults to member permissions.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pnp/cli-microsoft365",
3
- "version": "6.4.0-beta.b1f742c",
3
+ "version": "6.4.0-beta.e3b0f5c",
4
4
  "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
5
5
  "license": "MIT",
6
6
  "main": "./dist/api.js",