@pnp/cli-microsoft365 6.3.0-beta.655c566 → 6.3.0-beta.80fcd21

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 (127) hide show
  1. package/dist/appInsights.js +2 -1
  2. package/dist/cli/Cli.js +58 -1
  3. package/dist/m365/aad/commands/license/license-list.js +41 -0
  4. package/dist/m365/aad/commands/user/user-add.js +223 -0
  5. package/dist/m365/aad/commands/user/user-license-add.js +88 -0
  6. package/dist/m365/aad/commands/user/user-license-list.js +99 -0
  7. package/dist/m365/aad/commands/user/user-license-remove.js +114 -0
  8. package/dist/m365/aad/commands/user/user-recyclebinitem-clear.js +103 -0
  9. package/dist/m365/aad/commands/user/user-recyclebinitem-list.js +41 -0
  10. package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
  11. package/dist/m365/aad/commands/user/user-recyclebinitem-restore.js +77 -0
  12. package/dist/m365/aad/commands/user/user-remove.js +107 -0
  13. package/dist/m365/aad/commands.js +10 -0
  14. package/dist/m365/flow/commands/environment/FlowEnvironmentDetails.js +3 -0
  15. package/dist/m365/flow/commands/environment/environment-get.js +26 -11
  16. package/dist/m365/pa/commands/environment/environment-get.js +13 -5
  17. package/dist/m365/planner/commands/plan/plan-get.js +17 -10
  18. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  19. package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
  20. package/dist/m365/planner/commands.js +1 -0
  21. package/dist/m365/pp/commands/environment/environment-get.js +18 -9
  22. package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +3 -4
  23. package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +3 -4
  24. package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
  25. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +5 -0
  26. package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +3 -4
  27. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
  28. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
  29. package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
  30. package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
  31. package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
  32. package/dist/m365/purview/commands.js +1 -0
  33. package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
  34. package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
  35. package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
  36. package/dist/m365/spo/commands/file/file-move.js +0 -2
  37. package/dist/m365/spo/commands/folder/folder-copy.js +0 -2
  38. package/dist/m365/spo/commands/folder/folder-move.js +0 -2
  39. package/dist/m365/spo/commands/site/site-add.js +0 -3
  40. package/dist/m365/spo/commands/site/site-remove.js +0 -3
  41. package/dist/m365/spo/commands/site/site-set.js +0 -2
  42. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js +0 -1
  43. package/dist/m365/teams/commands/team/team-add.js +3 -8
  44. package/dist/utils/aadUser.js +38 -0
  45. package/dist/utils/planner.js +1 -4
  46. package/dist/utils/session.js +18 -0
  47. package/dist/utils/spo.js +64 -12
  48. package/docs/docs/cmd/aad/license/license-list.md +87 -0
  49. package/docs/docs/cmd/aad/user/user-add.md +168 -0
  50. package/docs/docs/cmd/aad/user/user-license-add.md +108 -0
  51. package/docs/docs/cmd/aad/user/user-license-list.md +98 -0
  52. package/docs/docs/cmd/aad/user/user-license-remove.md +43 -0
  53. package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
  54. package/docs/docs/cmd/aad/user/user-recyclebinitem-list.md +82 -0
  55. package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
  56. package/docs/docs/cmd/aad/user/user-recyclebinitem-restore.md +99 -0
  57. package/docs/docs/cmd/aad/user/user-remove.md +51 -0
  58. package/docs/docs/cmd/aad/user/user-set.md +1 -1
  59. package/docs/docs/cmd/flow/environment/environment-get.md +31 -3
  60. package/docs/docs/cmd/login.md +26 -0
  61. package/docs/docs/cmd/logout.md +4 -0
  62. package/docs/docs/cmd/pa/environment/environment-get.md +8 -2
  63. package/docs/docs/cmd/planner/plan/plan-get.md +12 -12
  64. package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
  65. package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +1 -1
  66. package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
  67. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +3 -0
  68. package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +1 -1
  69. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
  70. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
  71. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
  72. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
  73. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
  74. package/docs/docs/cmd/request.md +74 -0
  75. package/docs/docs/cmd/spo/homesite/homesite-get.md +20 -1
  76. package/docs/docs/cmd/spo/homesite/homesite-remove.md +8 -2
  77. package/docs/docs/cmd/spo/homesite/homesite-set.md +8 -2
  78. package/docs/docs/cmd/spo/hubsite/hubsite-connect.md +9 -9
  79. package/docs/docs/cmd/spo/hubsite/hubsite-data-get.md +34 -5
  80. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +6 -6
  81. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +36 -19
  82. package/docs/docs/cmd/spo/hubsite/hubsite-list.md +59 -1
  83. package/docs/docs/cmd/spo/hubsite/hubsite-register.md +30 -1
  84. package/docs/docs/cmd/spo/hubsite/hubsite-rights-grant.md +6 -6
  85. package/docs/docs/cmd/spo/hubsite/hubsite-rights-revoke.md +4 -4
  86. package/docs/docs/cmd/spo/hubsite/hubsite-set.md +40 -15
  87. package/docs/docs/cmd/spo/hubsite/hubsite-unregister.md +4 -4
  88. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.md +7 -1
  89. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.md +9 -3
  90. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.md +8 -2
  91. package/docs/docs/cmd/spo/list/list-add.md +123 -57
  92. package/docs/docs/cmd/spo/list/list-contenttype-add.md +50 -5
  93. package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +4 -4
  94. package/docs/docs/cmd/spo/list/list-contenttype-list.md +49 -4
  95. package/docs/docs/cmd/spo/list/list-contenttype-remove.md +6 -6
  96. package/docs/docs/cmd/spo/list/list-get.md +70 -4
  97. package/docs/docs/cmd/spo/list/list-list.md +70 -2
  98. package/docs/docs/cmd/spo/list/list-remove.md +6 -6
  99. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +2 -2
  100. package/docs/docs/cmd/spo/list/list-retentionlabel-get.md +36 -3
  101. package/docs/docs/cmd/spo/list/list-retentionlabel-remove.md +3 -3
  102. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +6 -6
  103. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +3 -3
  104. package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +9 -9
  105. package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +7 -7
  106. package/docs/docs/cmd/spo/list/list-set.md +61 -61
  107. package/docs/docs/cmd/spo/list/list-sitescript-get.md +35 -3
  108. package/docs/docs/cmd/spo/list/list-view-add.md +66 -5
  109. package/docs/docs/cmd/spo/list/list-view-field-add.md +10 -10
  110. package/docs/docs/cmd/spo/list/list-view-get.md +61 -0
  111. package/docs/docs/cmd/spo/list/list-view-list.md +61 -0
  112. package/docs/docs/cmd/spo/list/list-view-set.md +1 -1
  113. package/docs/docs/cmd/spo/list/list-webhook-add.md +19 -0
  114. package/docs/docs/cmd/spo/list/list-webhook-get.md +19 -0
  115. package/docs/docs/cmd/spo/list/list-webhook-list.md +19 -0
  116. package/docs/docs/cmd/spo/listitem/listitem-add.md +29 -0
  117. package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +17 -2
  118. package/docs/docs/cmd/spo/listitem/listitem-get.md +57 -0
  119. package/docs/docs/cmd/spo/listitem/listitem-isrecord.md +6 -0
  120. package/docs/docs/cmd/spo/listitem/listitem-list.md +28 -0
  121. package/docs/docs/cmd/spo/listitem/listitem-record-declare.md +15 -0
  122. package/docs/docs/cmd/spo/listitem/listitem-set.md +30 -0
  123. package/docs/docs/cmd/spo/navigation/navigation-node-add.md +22 -0
  124. package/docs/docs/cmd/status.md +46 -0
  125. package/docs/docs/cmd/version.md +26 -0
  126. package/npm-shrinkwrap.json +912 -876
  127. package/package.json +13 -12
@@ -0,0 +1,99 @@
1
+ # aad user recyclebinitem restore
2
+
3
+ Restores a user from the recycle bin in the current tenant
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user recyclebinitem restore [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--id <id>`
14
+ : ID of the deleted user.
15
+
16
+ --8<-- "docs/cmd/_global.md"
17
+
18
+ ## Remarks
19
+
20
+ !!! important
21
+ To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
22
+
23
+ !!! note
24
+ After running this command, it may take a minute before the user will reappear in the active users.
25
+
26
+ ## Examples
27
+
28
+ Restore user from the recycle bin
29
+
30
+ ```sh
31
+ m365 aad user recyclebinitem restore --id 990e2425-f595-43bc-85ed-b89a44093793
32
+ ```
33
+
34
+ ## Response
35
+
36
+ === "JSON"
37
+
38
+ ```json
39
+ {
40
+ "id": "990e2425-f595-43bc-85ed-b89a44093793",
41
+ "businessPhones": [],
42
+ "displayName": "John Doe",
43
+ "givenName": "John",
44
+ "jobTitle": "Sales Manager",
45
+ "mail": null,
46
+ "mobilePhone": null,
47
+ "officeLocation": null,
48
+ "preferredLanguage": "nl-BE",
49
+ "surname": "Doe",
50
+ "userPrincipalName": "john.doe@contoso.com",
51
+ }
52
+ ```
53
+
54
+ === "Text"
55
+
56
+ ```text
57
+ businessPhones : []
58
+ displayName : John Doe
59
+ givenName : John
60
+ id : 990e2425-f595-43bc-85ed-b89a44093793
61
+ jobTitle : Sales Manager
62
+ mail : null
63
+ mobilePhone : null
64
+ officeLocation : null
65
+ preferredLanguage: nl-BE
66
+ surname : Doe
67
+ userPrincipalName: john.doe@contoso.com
68
+ ```
69
+
70
+ === "CSV"
71
+
72
+ ```csv
73
+ id,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName
74
+ 990e2425-f595-43bc-85ed-b89a44093793,[],John Doe,John,Sales Manager,,,,nl-BE,Doe,john.doe@contoso.com
75
+ ```
76
+
77
+ === "Markdown"
78
+
79
+ ```md
80
+ # user recyclebin restore --id 990e2425-f595-43bc-85ed-b89a44093793
81
+
82
+ Date: 16/02/2023
83
+
84
+ ## John Doe (990e2425-f595-43bc-85ed-b89a44093793)
85
+
86
+ Property | Value
87
+ ---------|-------
88
+ id | 990e2425-f595-43bc-85ed-b89a44093793
89
+ businessPhones | []
90
+ displayName | John Doe
91
+ givenName | John
92
+ jobTitle | Sales Manager
93
+ mail | null
94
+ mobilePhone | null
95
+ officeLocation | null
96
+ preferredLanguage | nl-BE
97
+ surname | Doe
98
+ userPrincipalName | john.doe@contoso.com
99
+ ```
@@ -0,0 +1,51 @@
1
+ # aad user remove
2
+
3
+ Removes a specific user
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 aad user remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `--id [id]`
14
+ : The ID of the user. Specify either `id` or `userName` but not both.
15
+
16
+ `--userName [userName]`
17
+ : User principal name of the user. Specify either `id` or `userName` but not both.
18
+
19
+ `--confirm`
20
+ : Don't prompt for confirmation.
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ !!! important
27
+ If the user with the specified id or user name doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
28
+
29
+ !!! important
30
+ To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
31
+
32
+ !!! note
33
+ After running this command, it may take a minute before the user is effectively moved to the recycle bin.
34
+
35
+ ## Examples
36
+
37
+ Removes a specific user by id
38
+
39
+ ```sh
40
+ m365 aad user remove --id a33bd401-9117-4e0e-bb7b-3f61c1539e10
41
+ ```
42
+
43
+ Removes a specific user by its UPN
44
+
45
+ ```sh
46
+ m365 aad user remove --name john.doe@contoso.com
47
+ ```
48
+
49
+ ## Response
50
+
51
+ The command won't return a response on success.
@@ -74,7 +74,7 @@ m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabl
74
74
  Reset password of a given user by userPrincipalName and require the user to change the password on the next sign in
75
75
 
76
76
  ```sh
77
- m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --password 6NLUId79Lc24 --forceChangePasswordNextSignIn
77
+ m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --newPassword 6NLUId79Lc24 --forceChangePasswordNextSignIn
78
78
  ```
79
79
 
80
80
  Change password of the currently logged in user
@@ -10,8 +10,8 @@ m365 flow environment get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-n, --name <name>`
14
- : The name of the environment to get information about
13
+ `-n, --name [name]`
14
+ : The name of the environment to get information about. When not specified, the default environment is retrieved.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -24,12 +24,17 @@ If the environment with the name you specified doesn't exist, you will get the `
24
24
 
25
25
  ## Examples
26
26
 
27
- Get information about the Microsoft Flow environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
27
+ Get information about a Microsoft Flow environment specified by name
28
28
 
29
29
  ```sh
30
30
  m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
31
31
  ```
32
32
 
33
+ Get information about the default Microsoft Flow environment
34
+ ```sh
35
+ m365 flow environment get
36
+ ```
37
+
33
38
  ## Response
34
39
 
35
40
  ### Standard response
@@ -129,3 +134,26 @@ m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
129
134
  name,id,location,displayName,provisioningState,environmentSku,azureRegionHint,isDefault
130
135
  Default-d87a7535-dd31-4437-bfe1-95340acd55c5,/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5,india,contoso (default),Succeeded,Default,centralindia,1
131
136
  ```
137
+
138
+ === "Markdown"
139
+
140
+ ```md
141
+ # flow environment get
142
+
143
+ Date: 8/2/2023
144
+
145
+ ## contoso (default) (/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5)
146
+
147
+ Property | Value
148
+ ---------|-------
149
+ name | Default-d87a7535-dd31-4437-bfe1-95340acd55c5
150
+ location | india
151
+ type | Microsoft.ProcessSimple/environments
152
+ id | /providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5
153
+ properties | {"displayName":"contoso (default)","createdTime":"2019-12-21T18:32:11.8708704Z","createdBy":{"id":"SYSTEM","displayName": "SYSTEM","type": "NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"NotSpecified","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"isDefault":true,"isPayAsYouGoEnabled":false,"azureRegionHint":"centralindia","runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://india.api.bap.microsoft.com","microsoft.CommonDataModel":"https://india.api.cds.microsoft.com","microsoft.PowerApps":"https://india.api.powerapps.com",microsoft.PowerAppsAdvisor":"https://india.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.in-il101.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.INDIA.azure-apihub.net","microsoft.Flow":"https://india.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"NotSpecified","resourceId":"3aa550bf-52ac-42fc-98f7-5d1833c1501c","friendlyName":"contoso (default)","uniqueName":"orgfc80770f","domainName":"orgfc80770f","version":"9.2.22105.00154","instanceUrl":"https://orgfc80770f.crm8.dynamics.com/","instanceApiUrl":"https://orgfc80770f.api.crm8.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2019-12-25T15:46:14.433Z"},"environmentFeatures":{"isOpenApiEnabled":false},"cluster":{"category":"Prod","number":"101","uriSuffix":"in-il101.gateway.prod.island","geoShortName":"IN","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
154
+ displayName | contoso (default)
155
+ provisioningState | Succeeded
156
+ environmentSku | Default
157
+ azureRegionHint | centralindia
158
+ isDefault | true
159
+ ```
@@ -159,3 +159,29 @@ Log in to Microsoft 365 using a client secret.
159
159
  ```sh
160
160
  m365 login --authType secret --secret topSeCr3t@007
161
161
  ```
162
+
163
+ ## Response
164
+
165
+ === "JSON"
166
+
167
+ ```json
168
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
169
+ ```
170
+
171
+ === "Text"
172
+
173
+ ```text
174
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
175
+ ```
176
+
177
+ === "CSV"
178
+
179
+ ```csv
180
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
181
+ ```
182
+
183
+ === "Markdown"
184
+
185
+ ```md
186
+ To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code CQBMTLEFC to authenticate.
187
+ ```
@@ -29,3 +29,7 @@ Log out from Microsoft 365 in debug mode including detailed debug information in
29
29
  ```sh
30
30
  m365 logout --debug
31
31
  ```
32
+
33
+ ## Response
34
+
35
+ The command won't return a response on success.
@@ -10,8 +10,8 @@ m365 pa environment get [options]
10
10
 
11
11
  ## Options
12
12
 
13
- `-n, --name <name>`
14
- : The name of the environment to get information about
13
+ `-n, --name [name]`
14
+ : The name of the environment. When not specified, the default environment is retrieved.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -24,6 +24,12 @@ If the environment with the name you specified doesn't exist, you will get the `
24
24
 
25
25
  ## Examples
26
26
 
27
+ Get information about the default Power Apps environment
28
+
29
+ ```sh
30
+ m365 pa environment get
31
+ ```
32
+
27
33
  Get information about the Power Apps environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
28
34
 
29
35
  ```sh
@@ -11,19 +11,19 @@ m365 planner plan get [options]
11
11
  ## Options
12
12
 
13
13
  `-i, --id [id]`
14
- : ID of the plan. Specify either `id` or `title` but not both.
14
+ : ID of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
15
15
 
16
16
  `-t, --title [title]`
17
- : Title of the plan. Specify either `id` or `title` but not both.
17
+ : Title of the plan. Specify either `id`, `title` or `rosterId` but not multiple.
18
+
19
+ `--rosterId [rosterId]`
20
+ : ID of the Planner Roster. Specify either `id`, `title` or `rosterId` but not multiple.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId` when using `title`.
23
+ : ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the Group that owns the plan. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId` when using `title`.
24
-
25
- `--rosterId [rosterId]`
26
- : ID of the Planner Roster. Specify either `ownerGroupId`, `ownerGroupName` or `rosterId` when using `title`.
26
+ : Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` when using `title` but not both.
27
27
 
28
28
  --8<-- "docs/cmd/_global.md"
29
29
 
@@ -34,28 +34,28 @@ When using `rosterId`, the command is based on an API that is currently in previ
34
34
 
35
35
  ## Examples
36
36
 
37
- Returns the Microsoft Planner plan with id _gndWOTSK60GfPQfiDDj43JgACDCb_
37
+ Returns the Microsoft Planner plan by id
38
38
 
39
39
  ```sh
40
40
  m365 planner plan get --id "gndWOTSK60GfPQfiDDj43JgACDCb"
41
41
  ```
42
42
 
43
- Returns the Microsoft Planner plan with title _MyPlan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
43
+ Returns the Microsoft Planner plan by title and owner group id
44
44
 
45
45
  ```sh
46
46
  m365 planner plan get --title "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
47
47
  ```
48
48
 
49
- Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Group_
49
+ Returns the Microsoft Planner plan by title and owner group name
50
50
 
51
51
  ```sh
52
52
  m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
53
53
  ```
54
54
 
55
- Returns the Microsoft Planner plan with title _MyPlan_ for Roster _FeMZFDoK8k2oWmuGE-XFHZcAEwtn_
55
+ Returns the Microsoft Planner plan by roster id
56
56
 
57
57
  ```sh
58
- m365 planner plan get --title "MyPlan" --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
58
+ m365 planner plan get --rosterId "FeMZFDoK8k2oWmuGE-XFHZcAEwtn"
59
59
  ```
60
60
 
61
61
  ## Response
@@ -0,0 +1,51 @@
1
+ # planner roster member remove
2
+
3
+ Removes a member from a Microsoft Planner Roster
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 planner roster member remove [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
+ `--confirm`
23
+ : Don't prompt for confirmation.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ !!! attention
30
+ This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
31
+
32
+ !!! attention
33
+ The Planner Roster will be deleted when it doesn't have any users remaining in the membership list because the last user removed themselves. Roster, its plan and all contained tasks will be deleted within 30 days of this operation. We will show an extra prompt when this happens. This prompt is also suppressed when specifying `--confirm`.
34
+
35
+ ## Examples
36
+
37
+ Remove a Roster member by its Azure AD ID
38
+
39
+ ```sh
40
+ m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId 126878e5-d8f9-4db2-951d-d25486488d38
41
+ ```
42
+
43
+ Remove a Roster member by its UPN
44
+
45
+ ```sh
46
+ m365 planner roster member remove --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
47
+ ```
48
+
49
+ ## Response
50
+
51
+ The command won't return a response on success.
@@ -26,7 +26,7 @@ m365 purview retentionevent list
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
28
  !!! attention
29
- This command currently does not support app only permissions.
29
+ This command currently only supports delegated permissions.
30
30
 
31
31
  ## More information
32
32
 
@@ -0,0 +1,45 @@
1
+ # purview retentionevent remove
2
+
3
+ Delete a retention event
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 purview retentionevent remove [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : The Id of the retention event.
15
+
16
+ `--confirm`
17
+ : Don't prompt for confirmation to remove the retention event.
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Delete a retention event by id
24
+
25
+ ```sh
26
+ m365 purview retentionevent remove --id c37d695e-d581-4ae9-82a0-9364eba4291e
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.
40
+
41
+ [Read more on event-based retention here](https://learn.microsoft.com/microsoft-365/compliance/event-driven-retention?view=o365-worldwide)
42
+
43
+ ## Response
44
+
45
+ The command won't return a response on success.
@@ -28,6 +28,9 @@ m365 purview retentioneventtype get --id c37d695e-d581-4ae9-82a0-9364eba4291e
28
28
  !!! attention
29
29
  This command is based on an 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
  ## More information
32
35
 
33
36
  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.
@@ -26,7 +26,7 @@ m365 purview retentioneventtype list
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
28
  !!! attention
29
- This command currently does not support app only permissions.
29
+ This command currently only supports delegated permissions.
30
30
 
31
31
  ## More information
32
32
 
@@ -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
+ ```
@@ -14,7 +14,7 @@ m365 spo homesite get [options]
14
14
 
15
15
  ## Examples
16
16
 
17
- Get information about the Home Site
17
+ Get information about the Home Site.
18
18
 
19
19
  ```sh
20
20
  m365 spo homesite get
@@ -51,6 +51,25 @@ m365 spo homesite get
51
51
  af80c11f-0138-4d72-bb37-514542c3aabb,6f90666d-b0e7-40c3-991f-4ab051d00a70,https://contoso.sharepoint.com/sites/intra/siteassets/work.png,Intranet,https://contoso.sharepoint.com/sites/intra
52
52
  ```
53
53
 
54
+ === "Markdown"
55
+
56
+ ```md
57
+ # spo homesite get
58
+
59
+ Date: 2/20/2023
60
+
61
+ ## Intranet (https://contoso.sharepoint.com/sites/intra)
62
+
63
+ Property | Value
64
+ ---------|-------
65
+ IsInDraftMode | false
66
+ SiteId | af80c11f-0138-4d72-bb37-514542c3aabb
67
+ WebId |6f90666d-b0e7-40c3-991f-4ab051d00a70
68
+ LogoUrl | https://contoso.sharepoint.com/sites/intra/siteassets/work.png
69
+ Title | Intranet
70
+ Url | https://contoso.sharepoint.com/sites/intra
71
+ ```
72
+
54
73
  ## More information
55
74
 
56
75
  - SharePoint home sites: a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)
@@ -11,7 +11,7 @@ m365 spo homesite remove [options]
11
11
  ## Options
12
12
 
13
13
  `--confirm`
14
- : Do not prompt for confirmation before removing the Home Site
14
+ : Do not prompt for confirmation before removing the Home Site.
15
15
 
16
16
  --8<-- "docs/cmd/_global.md"
17
17
 
@@ -20,7 +20,7 @@ m365 spo homesite remove [options]
20
20
 
21
21
  ## Examples
22
22
 
23
- Removes the current Home Site without confirmation
23
+ Removes the current Home Site without confirmation.
24
24
 
25
25
  ```sh
26
26
  m365 spo homesite remove --confirm
@@ -46,6 +46,12 @@ m365 spo homesite remove --confirm
46
46
  https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details.
47
47
  ```
48
48
 
49
+ === "Markdown"
50
+
51
+ ```md
52
+ https://contoso.sharepoint.com has been removed as a Home site. It may take some time for the change to apply. Check aka.ms/homesites for details.
53
+ ```
54
+
49
55
  ## More information
50
56
 
51
57
  - SharePoint home sites, a landing for your organization on the intelligent intranet: [https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933](https://techcommunity.microsoft.com/t5/Microsoft-SharePoint-Blog/SharePoint-home-sites-a-landing-for-your-organization-on-the/ba-p/621933)