@pnp/cli-microsoft365 10.9.0-beta.bc13e90 → 10.10.0-beta.3dc1bcf
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/.devcontainer/Dockerfile +1 -1
- package/.devproxy/api-specs/sharepoint-admin.yaml +67 -0
- package/.devproxy/api-specs/sharepoint.yaml +230 -0
- package/.devproxy/devproxyrc.json +48 -0
- package/.devproxy/generate-openapi-spec.json +24 -0
- package/.devproxy/spo-csom-types.json +54 -0
- package/.eslintrc.cjs +8 -0
- package/Dockerfile +3 -3
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/cli/cli.js +1 -1
- package/dist/m365/entra/commands/m365group/m365group-get.js +16 -3
- package/dist/m365/entra/commands/m365group/m365group-list.js +7 -1
- package/dist/m365/entra/commands/pim/pim-role-assignment-eligibility-list.js +9 -3
- package/dist/m365/entra/commands/pim/pim-role-assignment-list.js +9 -3
- package/dist/m365/entra/commands/pim/pim-role-request-list.js +9 -3
- package/dist/m365/file/commands/file-copy.js +2 -2
- package/dist/m365/file/commands/file-move.js +1 -1
- package/dist/m365/flow/commands/flow-list.js +14 -7
- package/dist/m365/flow/commands/run/run-get.js +1 -1
- package/dist/m365/graph/commands/subscription/subscription-add.js +10 -3
- package/dist/m365/planner/commands/tenant/tenant-settings-list.js +0 -3
- package/dist/m365/pp/commands/solution/solution-publisher-list.js +8 -1
- package/dist/m365/purview/commands/threatassessment/threatassessment-get.js +9 -2
- package/dist/m365/spo/commands/contenttype/contenttype-add.js +3 -65
- package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +5 -50
- package/dist/m365/spo/commands/contenttype/contenttype-field-set.js +4 -48
- package/dist/m365/spo/commands/contenttype/contenttype-set.js +8 -58
- package/dist/m365/spo/commands/contenttype/contenttype-sync.js +2 -2
- package/dist/m365/spo/commands/file/file-move.js +8 -2
- package/dist/m365/spo/commands/folder/folder-sharinglink-add.js +1 -1
- package/dist/m365/spo/commands/folder/folder-sharinglink-clear.js +1 -1
- package/dist/m365/spo/commands/folder/folder-sharinglink-get.js +1 -1
- package/dist/m365/spo/commands/folder/folder-sharinglink-list.js +1 -1
- package/dist/m365/spo/commands/folder/folder-sharinglink-remove.js +1 -1
- package/dist/m365/spo/commands/folder/folder-sharinglink-set.js +1 -1
- package/dist/m365/spo/commands/hubsite/hubsite-get.js +14 -5
- package/dist/m365/spo/commands/hubsite/hubsite-list.js +9 -2
- package/dist/m365/spo/commands/listitem/listitem-batch-set.js +3 -27
- package/dist/m365/spo/commands/page/Page.js +16 -1
- package/dist/m365/spo/commands/page/clientsidepages.js +49 -17
- package/dist/m365/spo/commands/page/page-add.js +1 -1
- package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +2 -8
- package/dist/m365/spo/commands/page/page-control-remove.js +99 -0
- package/dist/m365/spo/commands/page/page-control-set.js +1 -1
- package/dist/m365/spo/commands/page/page-header-set.js +9 -40
- package/dist/m365/spo/commands/page/page-publish.js +2 -10
- package/dist/m365/spo/commands/page/page-section-add.js +2 -8
- package/dist/m365/spo/commands/page/page-set.js +1 -1
- package/dist/m365/spo/commands/site/site-admin-add.js +1 -12
- package/dist/m365/spo/commands/tenant/tenant-site-list.js +16 -5
- package/dist/m365/spo/commands/term/term-list.js +10 -3
- package/dist/m365/spo/commands.js +1 -0
- package/dist/m365/teams/commands/chat/chat-member-add.js +10 -4
- package/dist/m365/viva/commands/engage/engage-community-remove.js +99 -0
- package/dist/m365/viva/commands/engage/engage-network-list.js +8 -2
- package/dist/m365/viva/commands.js +1 -0
- package/dist/utils/md.js +3 -3
- package/dist/utils/spo.js +87 -3
- package/docs/docs/cmd/_global.mdx +1 -1
- package/docs/docs/cmd/entra/m365group/m365group-get.mdx +8 -5
- package/docs/docs/cmd/entra/m365group/m365group-list.mdx +14 -12
- package/docs/docs/cmd/entra/pim/pim-role-assignment-eligibility-list.mdx +7 -4
- package/docs/docs/cmd/entra/pim/pim-role-assignment-list.mdx +9 -6
- package/docs/docs/cmd/entra/pim/pim-role-request-list.mdx +7 -4
- package/docs/docs/cmd/flow/flow-list.mdx +8 -5
- package/docs/docs/cmd/flow/run/run-get.mdx +1 -1
- package/docs/docs/cmd/graph/subscription/subscription-add.mdx +6 -3
- package/docs/docs/cmd/planner/bucket/bucket-add.mdx +19 -0
- package/docs/docs/cmd/planner/bucket/bucket-get.mdx +19 -0
- package/docs/docs/cmd/planner/bucket/bucket-list.mdx +19 -0
- package/docs/docs/cmd/planner/bucket/bucket-remove.mdx +21 -0
- package/docs/docs/cmd/planner/bucket/bucket-set.mdx +21 -0
- package/docs/docs/cmd/planner/plan/plan-add.mdx +19 -0
- package/docs/docs/cmd/planner/plan/plan-get.mdx +19 -0
- package/docs/docs/cmd/planner/plan/plan-list.mdx +19 -0
- package/docs/docs/cmd/planner/plan/plan-remove.mdx +21 -0
- package/docs/docs/cmd/planner/plan/plan-set.mdx +19 -0
- package/docs/docs/cmd/planner/roster/roster-add.mdx +19 -0
- package/docs/docs/cmd/planner/roster/roster-get.mdx +19 -0
- package/docs/docs/cmd/planner/roster/roster-member-add.mdx +19 -0
- package/docs/docs/cmd/planner/roster/roster-member-get.mdx +19 -0
- package/docs/docs/cmd/planner/roster/roster-member-list.mdx +19 -0
- package/docs/docs/cmd/planner/roster/roster-member-remove.mdx +21 -0
- package/docs/docs/cmd/planner/roster/roster-plan-list.mdx +19 -0
- package/docs/docs/cmd/planner/roster/roster-remove.mdx +21 -0
- package/docs/docs/cmd/planner/task/task-add.mdx +19 -0
- package/docs/docs/cmd/planner/task/task-checklistitem-add.mdx +19 -0
- package/docs/docs/cmd/planner/task/task-checklistitem-list.mdx +19 -0
- package/docs/docs/cmd/planner/task/task-checklistitem-remove.mdx +21 -0
- package/docs/docs/cmd/planner/task/task-get.mdx +27 -0
- package/docs/docs/cmd/planner/task/task-list.mdx +19 -0
- package/docs/docs/cmd/planner/task/task-reference-add.mdx +19 -0
- package/docs/docs/cmd/planner/task/task-reference-list.mdx +19 -0
- package/docs/docs/cmd/planner/task/task-reference-remove.mdx +21 -0
- package/docs/docs/cmd/planner/task/task-remove.mdx +21 -0
- package/docs/docs/cmd/planner/task/task-set.mdx +19 -0
- package/docs/docs/cmd/planner/tenant/tenant-settings-list.mdx +44 -7
- package/docs/docs/cmd/planner/tenant/tenant-settings-set.mdx +43 -8
- package/docs/docs/cmd/pp/solution/solution-publisher-list.mdx +7 -4
- package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx +7 -4
- package/docs/docs/cmd/spo/file/file-move.mdx +4 -1
- package/docs/docs/cmd/spo/hubsite/hubsite-get.mdx +6 -3
- package/docs/docs/cmd/spo/hubsite/hubsite-list.mdx +7 -4
- package/docs/docs/cmd/spo/list/list-add.mdx +1 -1
- package/docs/docs/cmd/spo/list/list-set.mdx +2 -2
- package/docs/docs/cmd/spo/page/page-control-remove.mdx +56 -0
- package/docs/docs/cmd/spo/tenant/tenant-site-list.mdx +10 -7
- package/docs/docs/cmd/spo/term/term-list.mdx +7 -4
- package/docs/docs/cmd/teams/chat/chat-member-add.mdx +6 -3
- package/docs/docs/cmd/viva/engage/engage-community-remove.mdx +61 -0
- package/docs/docs/cmd/viva/engage/engage-network-list.mdx +7 -4
- package/npm-shrinkwrap.json +112 -97
- package/package.json +17 -14
package/dist/utils/spo.js
CHANGED
|
@@ -1403,13 +1403,13 @@ export const spo = {
|
|
|
1403
1403
|
await request.post(requestOptions);
|
|
1404
1404
|
},
|
|
1405
1405
|
/**
|
|
1406
|
-
* Retrieves the site ID for a given web URL.
|
|
1406
|
+
* Retrieves the site ID for a given web URL by the MS Graph.
|
|
1407
1407
|
* @param webUrl The web URL for which to retrieve the site ID.
|
|
1408
1408
|
* @param logger The logger object.
|
|
1409
1409
|
* @param verbose Set for verbose logging
|
|
1410
|
-
* @returns
|
|
1410
|
+
* @returns The site ID as a string.
|
|
1411
1411
|
*/
|
|
1412
|
-
async
|
|
1412
|
+
async getSiteIdByMSGraph(webUrl, logger, verbose) {
|
|
1413
1413
|
if (verbose && logger) {
|
|
1414
1414
|
await logger.logToStderr(`Getting site id for URL: ${webUrl}...`);
|
|
1415
1415
|
}
|
|
@@ -1424,6 +1424,90 @@ export const spo = {
|
|
|
1424
1424
|
const site = await request.get(requestOptions);
|
|
1425
1425
|
return site.id;
|
|
1426
1426
|
},
|
|
1427
|
+
/**
|
|
1428
|
+
* Retrieves the SharePoint Online site ID for the specified web URL by the SharePoint REST API.
|
|
1429
|
+
* @param webUrl The web URL of the SharePoint Online site to retrieve the site ID for.
|
|
1430
|
+
* @param logger The logger object.
|
|
1431
|
+
* @param verbose Set for verbose logging
|
|
1432
|
+
* @returns The site ID as a string.
|
|
1433
|
+
*/
|
|
1434
|
+
async getSiteIdBySPApi(webUrl, logger, verbose) {
|
|
1435
|
+
if (verbose && logger) {
|
|
1436
|
+
await logger.logToStderr(`Getting site id for URL: ${webUrl}...`);
|
|
1437
|
+
}
|
|
1438
|
+
const requestOptions = {
|
|
1439
|
+
url: `${webUrl}/_api/site?$select=Id`,
|
|
1440
|
+
headers: {
|
|
1441
|
+
accept: 'application/json;odata=nometadata'
|
|
1442
|
+
},
|
|
1443
|
+
responseType: 'json'
|
|
1444
|
+
};
|
|
1445
|
+
const siteResponse = await request.get(requestOptions);
|
|
1446
|
+
return siteResponse.Id;
|
|
1447
|
+
},
|
|
1448
|
+
/**
|
|
1449
|
+
* Retrieves the id of a SharePoint web for the specified web URL.
|
|
1450
|
+
* @param webUrl The web URL for which to retrieve the web ID.
|
|
1451
|
+
* @param logger The logger object for logging messages.
|
|
1452
|
+
* @param verbose Set to true for verbose logging.
|
|
1453
|
+
* @returns The web ID as a string.
|
|
1454
|
+
*/
|
|
1455
|
+
async getWebId(webUrl, logger, verbose) {
|
|
1456
|
+
if (verbose && logger) {
|
|
1457
|
+
await logger.logToStderr(`Getting web id for URL: ${webUrl}...`);
|
|
1458
|
+
}
|
|
1459
|
+
const requestOptions = {
|
|
1460
|
+
url: `${webUrl}/_api/web?$select=Id`,
|
|
1461
|
+
headers: {
|
|
1462
|
+
accept: 'application/json;odata=nometadata'
|
|
1463
|
+
},
|
|
1464
|
+
responseType: 'json'
|
|
1465
|
+
};
|
|
1466
|
+
const webResponse = await request.get(requestOptions);
|
|
1467
|
+
return webResponse.Id;
|
|
1468
|
+
},
|
|
1469
|
+
/**
|
|
1470
|
+
* Retrieves the ID of a SharePoint list by its title or URL.
|
|
1471
|
+
* @param webUrl The base URL of the SharePoint site.
|
|
1472
|
+
* @param listTitle The title of the list (optional).
|
|
1473
|
+
* @param listUrl The server-relative URL of the list (optional).
|
|
1474
|
+
* @param logger The logger object for logging messages (optional).
|
|
1475
|
+
* @param verbose Set to true for verbose logging (optional).
|
|
1476
|
+
* @returns The list ID as a string.
|
|
1477
|
+
*/
|
|
1478
|
+
async getListId(webUrl, listTitle, listUrl, logger, verbose) {
|
|
1479
|
+
if (verbose && logger) {
|
|
1480
|
+
await logger.logToStderr(`Retrieving list id...`);
|
|
1481
|
+
}
|
|
1482
|
+
if (!listTitle && !listUrl) {
|
|
1483
|
+
throw new Error('Either listTitle or listUrl must be provided.');
|
|
1484
|
+
}
|
|
1485
|
+
let listId = '';
|
|
1486
|
+
if (listTitle) {
|
|
1487
|
+
const requestOptions = {
|
|
1488
|
+
url: `${webUrl}/_api/web/lists/getByTitle('${formatting.encodeQueryParameter(listTitle)}')?$select=Id`,
|
|
1489
|
+
headers: {
|
|
1490
|
+
accept: 'application/json;odata=nometadata'
|
|
1491
|
+
},
|
|
1492
|
+
responseType: 'json'
|
|
1493
|
+
};
|
|
1494
|
+
const listResponse = await request.get(requestOptions);
|
|
1495
|
+
listId = listResponse.Id;
|
|
1496
|
+
}
|
|
1497
|
+
else if (listUrl) {
|
|
1498
|
+
const listServerRelativeUrl = urlUtil.getServerRelativePath(webUrl, listUrl);
|
|
1499
|
+
const requestOptions = {
|
|
1500
|
+
url: `${webUrl}/_api/web/GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')?$select=Id`,
|
|
1501
|
+
headers: {
|
|
1502
|
+
accept: 'application/json;odata=nometadata'
|
|
1503
|
+
},
|
|
1504
|
+
responseType: 'json'
|
|
1505
|
+
};
|
|
1506
|
+
const listResponse = await request.get(requestOptions);
|
|
1507
|
+
listId = listResponse.Id;
|
|
1508
|
+
}
|
|
1509
|
+
return listId;
|
|
1510
|
+
},
|
|
1427
1511
|
/**
|
|
1428
1512
|
* Retrieves the server-relative URL of a folder.
|
|
1429
1513
|
* @param webUrl Web URL
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
```md definition-list
|
|
2
2
|
`-h, --help [help]`
|
|
3
|
-
: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `response`, `full`. Default is `options`.
|
|
3
|
+
: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `permissions`, `response`, `full`. Default is `options`.
|
|
4
4
|
|
|
5
5
|
`--query [query]`
|
|
6
6
|
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples.
|
|
@@ -22,29 +22,32 @@ m365 entra m365group get [options]
|
|
|
22
22
|
: Display name of the Microsoft 365 Group or Microsoft Teams team to retrieve information for. Specify either `id` or `displayName`, but not both.
|
|
23
23
|
|
|
24
24
|
`--includeSiteUrl`
|
|
25
|
-
: Set to retrieve the site URL for the group
|
|
25
|
+
: (deprecated. Use option `withSiteUrl` instead) Set to retrieve the site URL for the group.
|
|
26
|
+
|
|
27
|
+
`--withSiteUrl`
|
|
28
|
+
: Set to retrieve the site URL for the group.
|
|
26
29
|
```
|
|
27
30
|
|
|
28
31
|
<Global />
|
|
29
32
|
|
|
30
33
|
## Examples
|
|
31
34
|
|
|
32
|
-
Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
|
|
35
|
+
Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_.
|
|
33
36
|
|
|
34
37
|
```sh
|
|
35
38
|
m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
|
|
36
39
|
```
|
|
37
40
|
|
|
38
|
-
Get information about the Microsoft 365 Group with displayName _Finance_
|
|
41
|
+
Get information about the Microsoft 365 Group with displayName _Finance_.
|
|
39
42
|
|
|
40
43
|
```sh
|
|
41
44
|
m365 entra m365group get --displayName Finance
|
|
42
45
|
```
|
|
43
46
|
|
|
44
|
-
Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ and also retrieve the URL of the corresponding SharePoint site
|
|
47
|
+
Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ and also retrieve the URL of the corresponding SharePoint site.
|
|
45
48
|
|
|
46
49
|
```sh
|
|
47
|
-
m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --
|
|
50
|
+
m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --withSiteUrl
|
|
48
51
|
```
|
|
49
52
|
|
|
50
53
|
## Response
|
|
@@ -16,54 +16,56 @@ m365 entra m365group list [options]
|
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`-d, --displayName [displayName]`
|
|
19
|
-
: Retrieve only groups with displayName starting with the specified value
|
|
19
|
+
: Retrieve only groups with displayName starting with the specified value.
|
|
20
20
|
|
|
21
21
|
`-m, --mailNickname [displayName]`
|
|
22
|
-
: Retrieve only groups with mailNickname starting with the specified value
|
|
22
|
+
: Retrieve only groups with mailNickname starting with the specified value.
|
|
23
23
|
|
|
24
24
|
`--includeSiteUrl`
|
|
25
|
-
: Set to retrieve the site URL for each group
|
|
25
|
+
: (deprecated. Use option `withSiteUrl` instead) Set to retrieve the site URL for each group.
|
|
26
|
+
|
|
27
|
+
`--withSiteUrl`
|
|
28
|
+
: Set to retrieve the site URL for each group.
|
|
26
29
|
|
|
27
30
|
`--orphaned`
|
|
28
|
-
: Set to only retrieve groups without owners
|
|
31
|
+
: Set to only retrieve groups without owners.
|
|
29
32
|
```
|
|
30
33
|
|
|
31
34
|
<Global />
|
|
32
35
|
|
|
33
36
|
## Remarks
|
|
34
37
|
|
|
35
|
-
Using the `--
|
|
38
|
+
Using the `--withSiteUrl` option, you can retrieve the URL of the site associated with the particular Microsoft 365 Group. If you however retrieve too many groups and will try to get their site URLs, you will most likely get an error as the command will get throttled, issuing too many requests, too frequently. If you get an error, consider narrowing down the result set using the `--displayName` and `--mailNickname` filters.
|
|
36
39
|
|
|
37
40
|
Using the `--orphaned` option, you can retrieve Microsoft 365 Groups without owners.
|
|
38
41
|
|
|
39
42
|
## Examples
|
|
40
43
|
|
|
41
|
-
List all Microsoft 365 Groups in the tenant
|
|
44
|
+
List all Microsoft 365 Groups in the tenant.
|
|
42
45
|
|
|
43
46
|
```sh
|
|
44
47
|
m365 entra m365group list
|
|
45
48
|
```
|
|
46
49
|
|
|
47
|
-
List Microsoft 365 Groups with display name starting with _Project_
|
|
50
|
+
List Microsoft 365 Groups with display name starting with _Project_.
|
|
48
51
|
|
|
49
52
|
```sh
|
|
50
53
|
m365 entra m365group list --displayName Project
|
|
51
54
|
```
|
|
52
55
|
|
|
53
|
-
List Microsoft 365 Groups mail nick name starting with _team_
|
|
56
|
+
List Microsoft 365 Groups mail nick name starting with _team_.
|
|
54
57
|
|
|
55
58
|
```sh
|
|
56
59
|
m365 entra m365group list --mailNickname team
|
|
57
60
|
```
|
|
58
61
|
|
|
59
|
-
List Microsoft 365 Groups with display name starting with _Project_ including
|
|
60
|
-
the URL of the corresponding SharePoint site
|
|
62
|
+
List Microsoft 365 Groups with display name starting with _Project_ including the URL of the corresponding SharePoint site.
|
|
61
63
|
|
|
62
64
|
```sh
|
|
63
|
-
m365 entra m365group list --displayName Project --
|
|
65
|
+
m365 entra m365group list --displayName Project --withSiteUrl
|
|
64
66
|
```
|
|
65
67
|
|
|
66
|
-
List Microsoft 365 Groups without owners
|
|
68
|
+
List Microsoft 365 Groups without owners.
|
|
67
69
|
|
|
68
70
|
```sh
|
|
69
71
|
m365 entra m365group list --orphaned
|
|
@@ -28,6 +28,9 @@ m365 entra pim role assignment eligibility list [options]
|
|
|
28
28
|
: Display name of the group for which to list eligible roles. Specify either `userId`, `userName`, `groupId` or `groupName`. If not specified, all eligible roles will be listed.
|
|
29
29
|
|
|
30
30
|
`--includePrincipalDetails`
|
|
31
|
+
: (deprecated. Use option `withPrincipalDetails` instead) An optional flag to include details of the principals that were eligible for a role.
|
|
32
|
+
|
|
33
|
+
`--withPrincipalDetails`
|
|
31
34
|
: An optional flag to include details of the principals that were eligible for a role.
|
|
32
35
|
```
|
|
33
36
|
|
|
@@ -50,7 +53,7 @@ m365 entra pim role assignment eligibility list --userId '@meID'
|
|
|
50
53
|
Get a list of eligible roles for any user with principal details.
|
|
51
54
|
|
|
52
55
|
```sh
|
|
53
|
-
m365 entra pim role assignment eligibility list --
|
|
56
|
+
m365 entra pim role assignment eligibility list --withPrincipalDetails
|
|
54
57
|
```
|
|
55
58
|
|
|
56
59
|
## Response
|
|
@@ -121,9 +124,9 @@ m365 entra pim role assignment eligibility list --includePrincipalDetails
|
|
|
121
124
|
</TabItem>
|
|
122
125
|
</Tabs>
|
|
123
126
|
|
|
124
|
-
### `
|
|
127
|
+
### `withPrincipalDetails` response
|
|
125
128
|
|
|
126
|
-
When we make use of the option `
|
|
129
|
+
When we make use of the option `withPrincipalDetails` the response will differ.
|
|
127
130
|
|
|
128
131
|
<Tabs>
|
|
129
132
|
<TabItem value="JSON">
|
|
@@ -183,7 +186,7 @@ When we make use of the option `includePrincipalDetails` the response will diffe
|
|
|
183
186
|
<TabItem value="Markdown">
|
|
184
187
|
|
|
185
188
|
```md
|
|
186
|
-
# entra pim role assignment eligibility list --
|
|
189
|
+
# entra pim role assignment eligibility list --withPrincipalDetails "true"
|
|
187
190
|
|
|
188
191
|
Date: 4/8/2024
|
|
189
192
|
|
|
@@ -31,7 +31,10 @@ m365 entra pim role assignment list [options]
|
|
|
31
31
|
: An optional ISO 8601 formatted date filter to search from.
|
|
32
32
|
|
|
33
33
|
`--includePrincipalDetails`
|
|
34
|
-
: An optional flag to include details of the principals that were assigned a role
|
|
34
|
+
: (deprecated. Use option `withPrincipalDetails` instead) An optional flag to include details of the principals that were assigned a role.
|
|
35
|
+
|
|
36
|
+
`--withPrincipalDetails`
|
|
37
|
+
: An optional flag to include details of the principals that were assigned a role.
|
|
35
38
|
```
|
|
36
39
|
|
|
37
40
|
<Global />
|
|
@@ -50,7 +53,7 @@ Get a list of Entra role assignments for the current user.
|
|
|
50
53
|
m365 entra pim role assignment list --userId '@meID'
|
|
51
54
|
```
|
|
52
55
|
|
|
53
|
-
Get a list of Entra role assignments since the first of January 2024
|
|
56
|
+
Get a list of Entra role assignments since the first of January 2024.
|
|
54
57
|
|
|
55
58
|
```sh
|
|
56
59
|
m365 entra pim role assignment list --startDateTime 2024-01-01T00:00:00Z
|
|
@@ -59,7 +62,7 @@ m365 entra pim role assignment list --startDateTime 2024-01-01T00:00:00Z
|
|
|
59
62
|
Get a list of Entra role assignments with principal details.
|
|
60
63
|
|
|
61
64
|
```sh
|
|
62
|
-
m365 entra pim role assignment list --
|
|
65
|
+
m365 entra pim role assignment list --withPrincipalDetails
|
|
63
66
|
```
|
|
64
67
|
|
|
65
68
|
## Response
|
|
@@ -135,9 +138,9 @@ m365 entra pim role assignment list --includePrincipalDetails
|
|
|
135
138
|
</TabItem>
|
|
136
139
|
</Tabs>
|
|
137
140
|
|
|
138
|
-
### `
|
|
141
|
+
### `withPrincipalDetails` response
|
|
139
142
|
|
|
140
|
-
When we make use of the option `
|
|
143
|
+
When we make use of the option `withPrincipalDetails` the response will differ.
|
|
141
144
|
|
|
142
145
|
<Tabs>
|
|
143
146
|
<TabItem value="JSON">
|
|
@@ -201,7 +204,7 @@ When we make use of the option `includePrincipalDetails` the response will diffe
|
|
|
201
204
|
<TabItem value="Markdown">
|
|
202
205
|
|
|
203
206
|
```md
|
|
204
|
-
# entra pim role assignment list --
|
|
207
|
+
# entra pim role assignment list --withPrincipalDetails "true"
|
|
205
208
|
|
|
206
209
|
Date: 3/31/2024
|
|
207
210
|
|
|
@@ -34,6 +34,9 @@ m365 entra pim role request list [options]
|
|
|
34
34
|
: An optional value to filter the list of requests. Allowed values are: `Canceled`, `Denied`, `Failed`, `Granted`, `PendingAdminDecision`, `PendingApproval`, `PendingProvisioning`, `PendingScheduleCreation`, `Provisioned`, `Revoked`, and `ScheduleCreated`.
|
|
35
35
|
|
|
36
36
|
`--includePrincipalDetails`
|
|
37
|
+
: (deprecated. Use option `withPrincipalDetails` instead) An optional flag to include details of the principals that were assigned a role.
|
|
38
|
+
|
|
39
|
+
`--withPrincipalDetails`
|
|
37
40
|
: An optional flag to include details of the principals that were assigned a role.
|
|
38
41
|
```
|
|
39
42
|
|
|
@@ -62,7 +65,7 @@ m365 entra pim role request list --createdDateTime 2024-01-01T00:00:00Z
|
|
|
62
65
|
Get a list of PIM requests with principal details.
|
|
63
66
|
|
|
64
67
|
```sh
|
|
65
|
-
m365 entra pim role request list --
|
|
68
|
+
m365 entra pim role request list --withPrincipalDetails
|
|
66
69
|
```
|
|
67
70
|
|
|
68
71
|
Get a list of PIM requests with pending approvals.
|
|
@@ -158,9 +161,9 @@ m365 entra pim role request list --status PendingApproval
|
|
|
158
161
|
</TabItem>
|
|
159
162
|
</Tabs>
|
|
160
163
|
|
|
161
|
-
### `
|
|
164
|
+
### `withPrincipalDetails` response
|
|
162
165
|
|
|
163
|
-
When we make use of the option `
|
|
166
|
+
When we make use of the option `withPrincipalDetails` the response will differ.
|
|
164
167
|
|
|
165
168
|
<Tabs>
|
|
166
169
|
<TabItem value="JSON">
|
|
@@ -238,7 +241,7 @@ When we make use of the option `includePrincipalDetails` the response will diffe
|
|
|
238
241
|
<TabItem value="Markdown">
|
|
239
242
|
|
|
240
243
|
```md
|
|
241
|
-
# entra pim role request list --
|
|
244
|
+
# entra pim role request list --withPrincipalDetails "true"
|
|
242
245
|
|
|
243
246
|
Date: 5/30/2024
|
|
244
247
|
|
|
@@ -22,6 +22,9 @@ m365 flow list [options]
|
|
|
22
22
|
: List a specific type of flows. Valid values: `ownedByMe`, `personal`, `sharedWithMe`, `all`. Defaults to `ownedByMe`. Don't specify this option when using asAdmin.
|
|
23
23
|
|
|
24
24
|
`--includeSolutions`
|
|
25
|
+
: (deprecated. Use option `withSolutions` instead) Include flows from solutions.
|
|
26
|
+
|
|
27
|
+
`--withSolutions`
|
|
25
28
|
: Include flows from solutions.
|
|
26
29
|
|
|
27
30
|
`--asAdmin`
|
|
@@ -49,28 +52,28 @@ When you specify a value for `sharingStatus`, consider the following:
|
|
|
49
52
|
|
|
50
53
|
## Examples
|
|
51
54
|
|
|
52
|
-
List all your flows in the given environment
|
|
55
|
+
List all your flows in the given environment.
|
|
53
56
|
|
|
54
57
|
```sh
|
|
55
58
|
m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5
|
|
56
59
|
```
|
|
57
60
|
|
|
58
|
-
List all flows in the given environment
|
|
61
|
+
List all flows in the given environment.
|
|
59
62
|
|
|
60
63
|
```sh
|
|
61
64
|
m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
|
|
62
65
|
```
|
|
63
66
|
|
|
64
|
-
List all flows that are shared with the current user
|
|
67
|
+
List all flows that are shared with the current user.
|
|
65
68
|
|
|
66
69
|
```sh
|
|
67
70
|
m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus sharedWithMe
|
|
68
71
|
```
|
|
69
72
|
|
|
70
|
-
List all personal flows and include flows from solutions
|
|
73
|
+
List all personal flows and include flows from solutions.
|
|
71
74
|
|
|
72
75
|
```sh
|
|
73
|
-
m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus personal --
|
|
76
|
+
m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus personal --withSolutions
|
|
74
77
|
```
|
|
75
78
|
|
|
76
79
|
## Response
|
|
@@ -22,7 +22,7 @@ m365 flow run get [options]
|
|
|
22
22
|
: The name of the Power Automate flow for which to retrieve information.
|
|
23
23
|
|
|
24
24
|
`-e, --environmentName <environmentName>`
|
|
25
|
-
: The name of the environment where the flow is located
|
|
25
|
+
: The name of the environment where the flow is located.
|
|
26
26
|
|
|
27
27
|
`--includeTriggerInformation`
|
|
28
28
|
: (deprecated. Use option `withTrigger` instead) If specified, include information about the trigger details.
|
|
@@ -40,13 +40,16 @@ m365 graph subscription add [options]
|
|
|
40
40
|
: The latest version of TLS that the notification endpoint supports. Allowed values are `v1_0`, `v1_1`, `v1_2`, `v1_3`. Default is `v1_2`.
|
|
41
41
|
|
|
42
42
|
`--includeResourceData`
|
|
43
|
+
: (deprecated. Use option `withResourceData` instead) When set, the change notifications will include the changed resource data.
|
|
44
|
+
|
|
45
|
+
`--withResourceData`
|
|
43
46
|
: When set, the change notifications will include the changed resource data.
|
|
44
47
|
|
|
45
48
|
`--encryptionCertificate [encryptionCertificate]`
|
|
46
|
-
: A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `
|
|
49
|
+
: A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `withResourceData`.
|
|
47
50
|
|
|
48
51
|
`--encryptionCertificateId [encryptionCertificateId]`
|
|
49
|
-
: A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `
|
|
52
|
+
: A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `withResourceData`.
|
|
50
53
|
```
|
|
51
54
|
|
|
52
55
|
<Global />
|
|
@@ -83,7 +86,7 @@ m365 graph subscription add --resource "me/mailFolders('Inbox')/messages" --chan
|
|
|
83
86
|
Create a subscription on multiple change types and include resource data
|
|
84
87
|
|
|
85
88
|
```sh
|
|
86
|
-
m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --
|
|
89
|
+
m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --withResourceData --encryptionCertificate 'Q0xJIGZvciBNaWNyb3NvZnQgMzY1' --encryptionCertificateId 'myCert' --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
|
|
87
90
|
```
|
|
88
91
|
|
|
89
92
|
Create a subscription using the maximum allowed expiration for Group resources
|
|
@@ -47,6 +47,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
|
|
|
47
47
|
|
|
48
48
|
:::
|
|
49
49
|
|
|
50
|
+
## Permissions
|
|
51
|
+
|
|
52
|
+
<Tabs>
|
|
53
|
+
<TabItem value="Delegated">
|
|
54
|
+
|
|
55
|
+
| Resource | Permissions |
|
|
56
|
+
|-----------------|---------------------------------------|
|
|
57
|
+
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
|
|
58
|
+
|
|
59
|
+
</TabItem>
|
|
60
|
+
<TabItem value="Application">
|
|
61
|
+
|
|
62
|
+
| Resource | Permissions |
|
|
63
|
+
|-----------------|-------------------------------------------|
|
|
64
|
+
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
|
|
65
|
+
|
|
66
|
+
</TabItem>
|
|
67
|
+
</Tabs>
|
|
68
|
+
|
|
50
69
|
## Examples
|
|
51
70
|
|
|
52
71
|
Adds a Microsoft Planner bucket for a plan based on its ID with an order hint
|
|
@@ -47,6 +47,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
|
|
|
47
47
|
|
|
48
48
|
:::
|
|
49
49
|
|
|
50
|
+
## Permissions
|
|
51
|
+
|
|
52
|
+
<Tabs>
|
|
53
|
+
<TabItem value="Delegated">
|
|
54
|
+
|
|
55
|
+
| Resource | Permissions |
|
|
56
|
+
|-----------------|----------------------------------|
|
|
57
|
+
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |
|
|
58
|
+
|
|
59
|
+
</TabItem>
|
|
60
|
+
<TabItem value="Application">
|
|
61
|
+
|
|
62
|
+
| Resource | Permissions |
|
|
63
|
+
|-----------------|--------------------------------------|
|
|
64
|
+
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
|
|
65
|
+
|
|
66
|
+
</TabItem>
|
|
67
|
+
</Tabs>
|
|
68
|
+
|
|
50
69
|
## Examples
|
|
51
70
|
|
|
52
71
|
Gets the specified Microsoft Planner bucket
|
|
@@ -41,6 +41,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
|
|
|
41
41
|
|
|
42
42
|
:::
|
|
43
43
|
|
|
44
|
+
## Permissions
|
|
45
|
+
|
|
46
|
+
<Tabs>
|
|
47
|
+
<TabItem value="Delegated">
|
|
48
|
+
|
|
49
|
+
| Resource | Permissions |
|
|
50
|
+
|-----------------|----------------------------------|
|
|
51
|
+
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |
|
|
52
|
+
|
|
53
|
+
</TabItem>
|
|
54
|
+
<TabItem value="Application">
|
|
55
|
+
|
|
56
|
+
| Resource | Permissions |
|
|
57
|
+
|-----------------|--------------------------------------|
|
|
58
|
+
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
|
|
59
|
+
|
|
60
|
+
</TabItem>
|
|
61
|
+
</Tabs>
|
|
62
|
+
|
|
44
63
|
## Examples
|
|
45
64
|
|
|
46
65
|
Lists the Microsoft Planner buckets based on its plan ID
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
2
4
|
|
|
3
5
|
# planner bucket remove
|
|
4
6
|
|
|
@@ -48,6 +50,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
|
|
|
48
50
|
|
|
49
51
|
:::
|
|
50
52
|
|
|
53
|
+
## Permissions
|
|
54
|
+
|
|
55
|
+
<Tabs>
|
|
56
|
+
<TabItem value="Delegated">
|
|
57
|
+
|
|
58
|
+
| Resource | Permissions |
|
|
59
|
+
|-----------------|---------------------------------------|
|
|
60
|
+
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
|
|
61
|
+
|
|
62
|
+
</TabItem>
|
|
63
|
+
<TabItem value="Application">
|
|
64
|
+
|
|
65
|
+
| Resource | Permissions |
|
|
66
|
+
|-----------------|-------------------------------------------|
|
|
67
|
+
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
|
|
68
|
+
|
|
69
|
+
</TabItem>
|
|
70
|
+
</Tabs>
|
|
71
|
+
|
|
51
72
|
## Examples
|
|
52
73
|
|
|
53
74
|
Removes the Microsoft Planner bucket by ID
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
2
4
|
|
|
3
5
|
# planner bucket set
|
|
4
6
|
|
|
@@ -51,6 +53,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
|
|
|
51
53
|
|
|
52
54
|
:::
|
|
53
55
|
|
|
56
|
+
## Permissions
|
|
57
|
+
|
|
58
|
+
<Tabs>
|
|
59
|
+
<TabItem value="Delegated">
|
|
60
|
+
|
|
61
|
+
| Resource | Permissions |
|
|
62
|
+
|-----------------|---------------------------------------|
|
|
63
|
+
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
|
|
64
|
+
|
|
65
|
+
</TabItem>
|
|
66
|
+
<TabItem value="Application">
|
|
67
|
+
|
|
68
|
+
| Resource | Permissions |
|
|
69
|
+
|-----------------|-------------------------------------------|
|
|
70
|
+
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
|
|
71
|
+
|
|
72
|
+
</TabItem>
|
|
73
|
+
</Tabs>
|
|
74
|
+
|
|
54
75
|
## Examples
|
|
55
76
|
|
|
56
77
|
Updates the Microsoft Planner bucket by its ID
|
|
@@ -42,6 +42,25 @@ m365 planner plan add [options]
|
|
|
42
42
|
|
|
43
43
|
- Hint: Unlike for groups, a Planner Roster can contain only 1 plan.
|
|
44
44
|
|
|
45
|
+
## Permissions
|
|
46
|
+
|
|
47
|
+
<Tabs>
|
|
48
|
+
<TabItem value="Delegated">
|
|
49
|
+
|
|
50
|
+
| Resource | Permissions |
|
|
51
|
+
|-----------------|---------------------------------------|
|
|
52
|
+
| Microsoft Graph | Tasks.ReadWrite, GroupMember.Read.All |
|
|
53
|
+
|
|
54
|
+
</TabItem>
|
|
55
|
+
<TabItem value="Application">
|
|
56
|
+
|
|
57
|
+
| Resource | Permissions |
|
|
58
|
+
|-----------------|-------------------------------------------|
|
|
59
|
+
| Microsoft Graph | Tasks.ReadWrite.All, GroupMember.Read.All |
|
|
60
|
+
|
|
61
|
+
</TabItem>
|
|
62
|
+
</Tabs>
|
|
63
|
+
|
|
45
64
|
## Examples
|
|
46
65
|
|
|
47
66
|
Adds a Microsoft Planner plan with a Group by id.
|
|
@@ -41,6 +41,25 @@ When using `rosterId`, the command is based on an API that is currently in previ
|
|
|
41
41
|
|
|
42
42
|
:::
|
|
43
43
|
|
|
44
|
+
## Permissions
|
|
45
|
+
|
|
46
|
+
<Tabs>
|
|
47
|
+
<TabItem value="Delegated">
|
|
48
|
+
|
|
49
|
+
| Resource | Permissions |
|
|
50
|
+
|-----------------|----------------------------------|
|
|
51
|
+
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |
|
|
52
|
+
|
|
53
|
+
</TabItem>
|
|
54
|
+
<TabItem value="Application">
|
|
55
|
+
|
|
56
|
+
| Resource | Permissions |
|
|
57
|
+
|-----------------|--------------------------------------|
|
|
58
|
+
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
|
|
59
|
+
|
|
60
|
+
</TabItem>
|
|
61
|
+
</Tabs>
|
|
62
|
+
|
|
44
63
|
## Examples
|
|
45
64
|
|
|
46
65
|
Returns the Microsoft Planner plan by id.
|
|
@@ -35,6 +35,25 @@ When using rosterId, the command is based on an API that is currently in preview
|
|
|
35
35
|
|
|
36
36
|
:::
|
|
37
37
|
|
|
38
|
+
## Permissions
|
|
39
|
+
|
|
40
|
+
<Tabs>
|
|
41
|
+
<TabItem value="Delegated">
|
|
42
|
+
|
|
43
|
+
| Resource | Permissions |
|
|
44
|
+
|-----------------|----------------------------------|
|
|
45
|
+
| Microsoft Graph | Tasks.Read, GroupMember.Read.All |
|
|
46
|
+
|
|
47
|
+
</TabItem>
|
|
48
|
+
<TabItem value="Application">
|
|
49
|
+
|
|
50
|
+
| Resource | Permissions |
|
|
51
|
+
|-----------------|--------------------------------------|
|
|
52
|
+
| Microsoft Graph | Tasks.Read.All, GroupMember.Read.All |
|
|
53
|
+
|
|
54
|
+
</TabItem>
|
|
55
|
+
</Tabs>
|
|
56
|
+
|
|
38
57
|
## Examples
|
|
39
58
|
|
|
40
59
|
Returns a list of Microsoft Planner plans for the specified Group by id.
|