@pnp/cli-microsoft365 6.3.0-beta.655c566 → 6.3.0-beta.82f99fc
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.
- package/dist/cli/Cli.js +38 -0
- package/dist/m365/aad/commands/user/user-recyclebinitem-clear.js +103 -0
- package/dist/m365/aad/commands/user/user-recyclebinitem-remove.js +92 -0
- package/dist/m365/aad/commands.js +2 -0
- package/dist/m365/flow/commands/environment/FlowEnvironmentDetails.js +3 -0
- package/dist/m365/flow/commands/environment/environment-get.js +26 -11
- package/dist/m365/pa/commands/environment/environment-get.js +13 -5
- package/dist/m365/planner/commands/plan/plan-get.js +17 -10
- package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
- package/dist/m365/planner/commands/roster/roster-member-remove.js +140 -0
- package/dist/m365/planner/commands.js +1 -0
- package/dist/m365/pp/commands/environment/environment-get.js +18 -9
- package/dist/m365/purview/commands/retentionevent/retentionevent-get.js +3 -4
- package/dist/m365/purview/commands/retentionevent/retentionevent-list.js +3 -4
- package/dist/m365/purview/commands/retentionevent/retentionevent-remove.js +97 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-get.js +5 -0
- package/dist/m365/purview/commands/retentioneventtype/retentioneventtype-list.js +3 -4
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-list.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-remove.js +5 -0
- package/dist/m365/purview/commands/retentionlabel/retentionlabel-set.js +11 -1
- package/dist/m365/purview/commands.js +1 -0
- package/dist/m365/spo/commands/customaction/customaction-get.js +17 -66
- package/dist/m365/spo/commands/customaction/customaction-list.js +2 -36
- package/dist/m365/spo/commands/customaction/customaction-remove.js +11 -18
- package/dist/utils/aadUser.js +38 -0
- package/dist/utils/planner.js +1 -4
- package/dist/utils/spo.js +61 -0
- package/docs/docs/cmd/aad/user/user-recyclebinitem-clear.md +42 -0
- package/docs/docs/cmd/aad/user/user-recyclebinitem-remove.md +45 -0
- package/docs/docs/cmd/flow/environment/environment-get.md +31 -3
- package/docs/docs/cmd/login.md +26 -0
- package/docs/docs/cmd/logout.md +4 -0
- package/docs/docs/cmd/pa/environment/environment-get.md +8 -2
- package/docs/docs/cmd/planner/plan/plan-get.md +12 -12
- package/docs/docs/cmd/planner/roster/roster-member-remove.md +51 -0
- package/docs/docs/cmd/purview/retentionevent/retentionevent-list.md +1 -1
- package/docs/docs/cmd/purview/retentionevent/retentionevent-remove.md +45 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-get.md +3 -0
- package/docs/docs/cmd/purview/retentioneventtype/retentioneventtype-list.md +1 -1
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-list.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md +3 -0
- package/docs/docs/cmd/purview/retentionlabel/retentionlabel-set.md +3 -0
- package/docs/docs/cmd/request.md +74 -0
- package/docs/docs/cmd/spo/list/list-contenttype-add.md +1 -1
- package/docs/docs/cmd/spo/list/list-contenttype-default-set.md +1 -1
- package/docs/docs/cmd/spo/list/list-contenttype-list.md +1 -1
- package/docs/docs/cmd/spo/list/list-contenttype-remove.md +1 -1
- package/docs/docs/cmd/status.md +46 -0
- package/docs/docs/cmd/version.md +26 -0
- package/npm-shrinkwrap.json +911 -876
- package/package.json +12 -12
package/dist/utils/spo.js
CHANGED
|
@@ -18,6 +18,7 @@ const config_1 = require("../config");
|
|
|
18
18
|
const base_permissions_1 = require("../m365/spo/base-permissions");
|
|
19
19
|
const request_1 = require("../request");
|
|
20
20
|
const formatting_1 = require("./formatting");
|
|
21
|
+
const odata_1 = require("./odata");
|
|
21
22
|
exports.spo = {
|
|
22
23
|
getRequestDigest(siteUrl) {
|
|
23
24
|
const requestOptions = {
|
|
@@ -484,6 +485,66 @@ exports.spo = {
|
|
|
484
485
|
const res = yield request_1.default.get(requestOptions);
|
|
485
486
|
return res;
|
|
486
487
|
});
|
|
488
|
+
},
|
|
489
|
+
/**
|
|
490
|
+
* Retrieves a list of Custom Actions from a SharePoint site.
|
|
491
|
+
* @param webUrl Web url
|
|
492
|
+
* @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
|
|
493
|
+
* @param filter An OData filter query to limit the results.
|
|
494
|
+
*/
|
|
495
|
+
getCustomActions(webUrl, scope, filter) {
|
|
496
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
497
|
+
if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
|
|
498
|
+
throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
|
|
499
|
+
}
|
|
500
|
+
const queryString = filter ? `?$filter=${filter}` : "";
|
|
501
|
+
if (scope && scope !== "All") {
|
|
502
|
+
return yield odata_1.odata.getAllItems(`${webUrl}/_api/${scope}/UserCustomActions${queryString}`);
|
|
503
|
+
}
|
|
504
|
+
const customActions = [
|
|
505
|
+
...yield odata_1.odata.getAllItems(`${webUrl}/_api/Site/UserCustomActions${queryString}`),
|
|
506
|
+
...yield odata_1.odata.getAllItems(`${webUrl}/_api/Web/UserCustomActions${queryString}`)
|
|
507
|
+
];
|
|
508
|
+
return customActions;
|
|
509
|
+
});
|
|
510
|
+
},
|
|
511
|
+
/**
|
|
512
|
+
* Retrieves a Custom Actions from a SharePoint site by Id.
|
|
513
|
+
* @param webUrl Web url
|
|
514
|
+
* @param id The Id of the Custom Action
|
|
515
|
+
* @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
|
|
516
|
+
*/
|
|
517
|
+
getCustomActionById(webUrl, id, scope) {
|
|
518
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
519
|
+
if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
|
|
520
|
+
throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
|
|
521
|
+
}
|
|
522
|
+
function getById(webUrl, id, scope) {
|
|
523
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
524
|
+
const requestOptions = {
|
|
525
|
+
url: `${webUrl}/_api/${scope}/UserCustomActions(guid'${id}')`,
|
|
526
|
+
headers: {
|
|
527
|
+
accept: 'application/json;odata=nometadata'
|
|
528
|
+
},
|
|
529
|
+
responseType: 'json'
|
|
530
|
+
};
|
|
531
|
+
const result = yield request_1.default.get(requestOptions);
|
|
532
|
+
if (result["odata.null"] === true) {
|
|
533
|
+
return undefined;
|
|
534
|
+
}
|
|
535
|
+
return result;
|
|
536
|
+
});
|
|
537
|
+
}
|
|
538
|
+
if (scope && scope !== "All") {
|
|
539
|
+
return yield getById(webUrl, id, scope);
|
|
540
|
+
}
|
|
541
|
+
const customActionOnWeb = yield getById(webUrl, id, "Web");
|
|
542
|
+
if (customActionOnWeb) {
|
|
543
|
+
return customActionOnWeb;
|
|
544
|
+
}
|
|
545
|
+
const customActionOnSite = yield getById(webUrl, id, "Site");
|
|
546
|
+
return customActionOnSite;
|
|
547
|
+
});
|
|
487
548
|
}
|
|
488
549
|
};
|
|
489
550
|
//# sourceMappingURL=spo.js.map
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# aad user recyclebinitem clear
|
|
2
|
+
|
|
3
|
+
Removes all users from the tenant recycle bin
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 aad user recyclebinitem clear [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--confirm`
|
|
14
|
+
: Don't prompt for confirmation.
|
|
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 all deleted users are effectively removed from the tenant.
|
|
25
|
+
|
|
26
|
+
## Examples
|
|
27
|
+
|
|
28
|
+
Removes all users from the tenant recycle bin
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
m365 aad user recyclebinitem clear
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Removes all users from the tenant recycle bin without confirmation prompt
|
|
35
|
+
|
|
36
|
+
```sh
|
|
37
|
+
m365 aad user recyclebinitem clear --confirm
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Response
|
|
41
|
+
|
|
42
|
+
The command won't return a response on success.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# aad user recyclebinitem remove
|
|
2
|
+
|
|
3
|
+
Removes a user from the recycle bin in the current tenant
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 aad user recyclebinitem remove [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--id <id>`
|
|
14
|
+
: ID of the deleted user.
|
|
15
|
+
|
|
16
|
+
`--confirm`
|
|
17
|
+
: Don't prompt for confirmation.
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Remarks
|
|
22
|
+
|
|
23
|
+
!!! important
|
|
24
|
+
To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
|
|
25
|
+
|
|
26
|
+
!!! note
|
|
27
|
+
After running this command, it may take a minute before the deleted user is effectively removed from the tenant.
|
|
28
|
+
|
|
29
|
+
## Examples
|
|
30
|
+
|
|
31
|
+
Removes a specific user from the recycle bin
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Removes a specific user from the recycle bin without confirmation prompt
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3 --confirm
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Response
|
|
44
|
+
|
|
45
|
+
The command won't return a response on success.
|
|
@@ -10,8 +10,8 @@ m365 flow environment get [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-n, --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
|
|
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
|
+
```
|
package/docs/docs/cmd/login.md
CHANGED
|
@@ -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
|
+
```
|
package/docs/docs/cmd/logout.md
CHANGED
|
@@ -10,8 +10,8 @@ m365 pa environment get [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-n, --name
|
|
14
|
-
: The name of the environment
|
|
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 `
|
|
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 `
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
55
|
+
Returns the Microsoft Planner plan by roster id
|
|
56
56
|
|
|
57
57
|
```sh
|
|
58
|
-
m365 planner plan get --
|
|
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
|
|
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
|
|
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.
|
package/docs/docs/cmd/request.md
CHANGED
|
@@ -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
|
+
```
|
|
@@ -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
|
-
`-
|
|
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
|
-
`-
|
|
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
|
-
`-
|
|
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
|
-
`-
|
|
16
|
+
`-l, --listId [listId]`
|
|
17
17
|
: ID of the list. Specify either `listTitle`, `listId` or `listUrl`.
|
|
18
18
|
|
|
19
19
|
`-t, --listTitle [listTitle]`
|