@pnp/cli-microsoft365 5.5.0-beta.d1aff8a → 5.5.0-beta.e5cdbaf
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/Auth.js +2 -2
- package/dist/m365/base/PowerAppsCommand.js +10 -0
- package/dist/m365/pa/commands/app/app-get.js +3 -5
- package/dist/m365/pa/commands/app/app-list.js +10 -9
- package/dist/m365/pa/commands/app/app-remove.js +3 -3
- package/dist/m365/pa/commands/connector/connector-export.js +3 -3
- package/dist/m365/pa/commands/connector/connector-list.js +10 -9
- package/dist/m365/pa/commands/environment/environment-get.js +3 -3
- package/dist/m365/pa/commands/environment/environment-list.js +4 -4
- package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
- package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
- package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
- package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
- package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
- package/dist/m365/planner/commands/plan/plan-add.js +98 -5
- package/dist/m365/planner/commands/plan/plan-get.js +1 -1
- package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
- package/dist/m365/planner/commands/task/task-add.js +15 -9
- package/dist/m365/planner/commands/task/task-get.js +14 -9
- package/dist/m365/planner/commands/task/task-list.js +19 -11
- package/dist/m365/planner/commands/task/task-remove.js +4 -19
- package/dist/m365/planner/commands/task/task-set.js +15 -9
- package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
- package/dist/m365/search/commands.js +1 -0
- package/dist/m365/spo/base-permissions.js +9 -0
- package/dist/m365/spo/commands/field/field-set.js +16 -9
- package/dist/m365/spo/commands/group/group-add.js +96 -0
- package/dist/m365/spo/commands/group/group-set.js +167 -0
- package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
- package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
- package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
- package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
- package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
- package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
- package/dist/m365/spo/commands.js +3 -0
- package/dist/m365/teams/commands/team/team-archive.js +51 -15
- package/dist/m365/teams/commands/team/team-remove.js +47 -11
- package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
- package/dist/utils/planner.js +6 -6
- package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
- package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
- package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
- package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
- package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
- package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
- package/docs/docs/cmd/planner/task/task-add.md +11 -8
- package/docs/docs/cmd/planner/task/task-get.md +17 -8
- package/docs/docs/cmd/planner/task/task-list.md +9 -6
- package/docs/docs/cmd/planner/task/task-set.md +9 -6
- package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
- package/docs/docs/cmd/spo/field/field-set.md +7 -4
- package/docs/docs/cmd/spo/group/group-add.md +51 -0
- package/docs/docs/cmd/spo/group/group-set.md +69 -0
- package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
- package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
- package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
- package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
- package/docs/docs/cmd/teams/team/team-archive.md +20 -5
- package/docs/docs/cmd/teams/team/team-remove.md +19 -5
- package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
- package/package.json +1 -1
|
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
const cli_1 = require("../../../../cli");
|
|
4
4
|
const request_1 = require("../../../../request");
|
|
5
5
|
const utils_1 = require("../../../../utils");
|
|
6
|
+
const aadGroup_1 = require("../../../../utils/aadGroup");
|
|
6
7
|
const GraphCommand_1 = require("../../../base/GraphCommand");
|
|
7
8
|
const commands_1 = require("../../commands");
|
|
8
9
|
class TeamsTeamRemoveCommand extends GraphCommand_1.default {
|
|
@@ -17,17 +18,37 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
|
|
|
17
18
|
telemetryProps.confirm = (!(!args.options.confirm)).toString();
|
|
18
19
|
return telemetryProps;
|
|
19
20
|
}
|
|
21
|
+
getTeamId(args) {
|
|
22
|
+
if (args.options.id) {
|
|
23
|
+
return Promise.resolve(args.options.id);
|
|
24
|
+
}
|
|
25
|
+
return aadGroup_1.aadGroup
|
|
26
|
+
.getGroupByDisplayName(args.options.name)
|
|
27
|
+
.then(group => {
|
|
28
|
+
if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
|
|
29
|
+
return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
|
|
30
|
+
}
|
|
31
|
+
return group.id;
|
|
32
|
+
});
|
|
33
|
+
}
|
|
20
34
|
commandAction(logger, args, cb) {
|
|
35
|
+
if (args.options.teamId) {
|
|
36
|
+
args.options.id = args.options.teamId;
|
|
37
|
+
this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
|
|
38
|
+
}
|
|
21
39
|
const removeTeam = () => {
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
40
|
+
this
|
|
41
|
+
.getTeamId(args)
|
|
42
|
+
.then((teamId) => {
|
|
43
|
+
const requestOptions = {
|
|
44
|
+
url: `${this.resource}/v1.0/groups/${encodeURIComponent(teamId)}`,
|
|
45
|
+
headers: {
|
|
46
|
+
accept: 'application/json;odata.metadata=none'
|
|
47
|
+
},
|
|
48
|
+
responseType: 'json'
|
|
49
|
+
};
|
|
50
|
+
return request_1.default.delete(requestOptions);
|
|
51
|
+
})
|
|
31
52
|
.then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
|
|
32
53
|
};
|
|
33
54
|
if (args.options.confirm) {
|
|
@@ -52,7 +73,13 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
|
|
|
52
73
|
options() {
|
|
53
74
|
const options = [
|
|
54
75
|
{
|
|
55
|
-
option: '-i, --
|
|
76
|
+
option: '-i, --id [id]'
|
|
77
|
+
},
|
|
78
|
+
{
|
|
79
|
+
option: '-n, --name [name]'
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
option: '--teamId [teamId]'
|
|
56
83
|
},
|
|
57
84
|
{
|
|
58
85
|
option: '--confirm'
|
|
@@ -62,9 +89,18 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
|
|
|
62
89
|
return options.concat(parentOptions);
|
|
63
90
|
}
|
|
64
91
|
validate(args) {
|
|
65
|
-
if (!
|
|
92
|
+
if (!args.options.id && !args.options.name && !args.options.teamId) {
|
|
93
|
+
return 'Specify either id or name';
|
|
94
|
+
}
|
|
95
|
+
if (args.options.name && (args.options.id || args.options.teamId)) {
|
|
96
|
+
return 'Specify either id or name but not both';
|
|
97
|
+
}
|
|
98
|
+
if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
|
|
66
99
|
return `${args.options.teamId} is not a valid GUID`;
|
|
67
100
|
}
|
|
101
|
+
if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
|
|
102
|
+
return `${args.options.id} is not a valid GUID`;
|
|
103
|
+
}
|
|
68
104
|
return true;
|
|
69
105
|
}
|
|
70
106
|
}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const request_1 = require("../../../../request");
|
|
4
4
|
const utils_1 = require("../../../../utils");
|
|
5
|
+
const aadGroup_1 = require("../../../../utils/aadGroup");
|
|
5
6
|
const GraphCommand_1 = require("../../../base/GraphCommand");
|
|
6
7
|
const commands_1 = require("../../commands");
|
|
7
8
|
class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
|
|
@@ -11,33 +12,68 @@ class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
|
|
|
11
12
|
get description() {
|
|
12
13
|
return 'Restores an archived Microsoft Teams team';
|
|
13
14
|
}
|
|
15
|
+
getTeamId(args) {
|
|
16
|
+
if (args.options.id) {
|
|
17
|
+
return Promise.resolve(args.options.id);
|
|
18
|
+
}
|
|
19
|
+
return aadGroup_1.aadGroup
|
|
20
|
+
.getGroupByDisplayName(args.options.name)
|
|
21
|
+
.then(group => {
|
|
22
|
+
if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
|
|
23
|
+
return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
|
|
24
|
+
}
|
|
25
|
+
return group.id;
|
|
26
|
+
});
|
|
27
|
+
}
|
|
14
28
|
commandAction(logger, args, cb) {
|
|
29
|
+
if (args.options.teamId) {
|
|
30
|
+
args.options.id = args.options.teamId;
|
|
31
|
+
this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
|
|
32
|
+
}
|
|
15
33
|
const endpoint = `${this.resource}/v1.0`;
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
34
|
+
this
|
|
35
|
+
.getTeamId(args)
|
|
36
|
+
.then((teamId) => {
|
|
37
|
+
const requestOptions = {
|
|
38
|
+
url: `${endpoint}/teams/${encodeURIComponent(teamId)}/unarchive`,
|
|
39
|
+
headers: {
|
|
40
|
+
'content-type': 'application/json;odata=nometadata',
|
|
41
|
+
'accept': 'application/json;odata.metadata=none'
|
|
42
|
+
},
|
|
43
|
+
responseType: 'json'
|
|
44
|
+
};
|
|
45
|
+
return request_1.default.post(requestOptions);
|
|
46
|
+
})
|
|
26
47
|
.then(_ => cb(), (res) => this.handleRejectedODataJsonPromise(res, logger, cb));
|
|
27
48
|
}
|
|
28
49
|
options() {
|
|
29
50
|
const options = [
|
|
30
51
|
{
|
|
31
|
-
option: '-i, --
|
|
52
|
+
option: '-i, --id [id]'
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
option: '-n, --name [name]'
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
option: '--teamId [teamId]'
|
|
32
59
|
}
|
|
33
60
|
];
|
|
34
61
|
const parentOptions = super.options();
|
|
35
62
|
return options.concat(parentOptions);
|
|
36
63
|
}
|
|
37
64
|
validate(args) {
|
|
38
|
-
if (!
|
|
65
|
+
if (!args.options.id && !args.options.name && !args.options.teamId) {
|
|
66
|
+
return 'Specify either id or name';
|
|
67
|
+
}
|
|
68
|
+
if (args.options.name && (args.options.id || args.options.teamId)) {
|
|
69
|
+
return 'Specify either id or name but not both';
|
|
70
|
+
}
|
|
71
|
+
if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
|
|
39
72
|
return `${args.options.teamId} is not a valid GUID`;
|
|
40
73
|
}
|
|
74
|
+
if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
|
|
75
|
+
return `${args.options.id} is not a valid GUID`;
|
|
76
|
+
}
|
|
41
77
|
return true;
|
|
42
78
|
}
|
|
43
79
|
}
|
package/dist/utils/planner.js
CHANGED
|
@@ -45,19 +45,19 @@ exports.planner = {
|
|
|
45
45
|
return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups/${groupId}/planner/plans`, 'none');
|
|
46
46
|
},
|
|
47
47
|
/**
|
|
48
|
-
* Get Planner plan by
|
|
49
|
-
* @param
|
|
48
|
+
* Get Planner plan by title in a specific group.
|
|
49
|
+
* @param title Title of the Planner plan. Case insensitive.
|
|
50
50
|
* @param groupId Owner group ID .
|
|
51
51
|
*/
|
|
52
|
-
|
|
52
|
+
getPlanByTitle(title, groupId) {
|
|
53
53
|
return __awaiter(this, void 0, void 0, function* () {
|
|
54
54
|
const plans = yield this.getPlansByGroupId(groupId);
|
|
55
|
-
const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() ===
|
|
55
|
+
const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === title.toLowerCase());
|
|
56
56
|
if (!filteredPlans.length) {
|
|
57
|
-
throw Error(`The specified plan '${
|
|
57
|
+
throw Error(`The specified plan '${title}' does not exist.`);
|
|
58
58
|
}
|
|
59
59
|
if (filteredPlans.length > 1) {
|
|
60
|
-
throw Error(`Multiple plans with
|
|
60
|
+
throw Error(`Multiple plans with title '${title}' found: ${filteredPlans.map(x => x.id)}.`);
|
|
61
61
|
}
|
|
62
62
|
return filteredPlans[0];
|
|
63
63
|
});
|
|
@@ -14,16 +14,19 @@ m365 planner bucket add [options]
|
|
|
14
14
|
: Name of the bucket to add.
|
|
15
15
|
|
|
16
16
|
`--planId [planId]`
|
|
17
|
-
:
|
|
17
|
+
: ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
|
|
18
|
+
|
|
19
|
+
`--planTitle [planTitle]`
|
|
20
|
+
: Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
|
|
18
21
|
|
|
19
22
|
`--planName [planName]`
|
|
20
|
-
:
|
|
23
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
21
24
|
|
|
22
25
|
`--ownerGroupId [ownerGroupId]`
|
|
23
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
26
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
24
27
|
|
|
25
28
|
`--ownerGroupName [ownerGroupName]`
|
|
26
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
29
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
27
30
|
|
|
28
31
|
`--orderHint [orderHint]`
|
|
29
32
|
: Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
|
|
@@ -38,8 +41,8 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
|
|
|
38
41
|
m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
|
|
39
42
|
```
|
|
40
43
|
|
|
41
|
-
Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the
|
|
44
|
+
Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
|
|
42
45
|
|
|
43
46
|
```sh
|
|
44
|
-
m365 planner bucket add --name "My Planner Bucket" --
|
|
47
|
+
m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
|
|
45
48
|
```
|
|
@@ -17,16 +17,19 @@ m365 planner bucket get [options]
|
|
|
17
17
|
: Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
|
|
18
18
|
|
|
19
19
|
`--planId [planId]`
|
|
20
|
-
:
|
|
20
|
+
: ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
|
|
21
|
+
|
|
22
|
+
`--planTitle [planTitle]`
|
|
23
|
+
: Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
|
|
21
24
|
|
|
22
25
|
`--planName [planName]`
|
|
23
|
-
:
|
|
26
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
24
27
|
|
|
25
28
|
`--ownerGroupId [ownerGroupId]`
|
|
26
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
29
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
27
30
|
|
|
28
31
|
`--ownerGroupName [ownerGroupName]`
|
|
29
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
32
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
30
33
|
|
|
31
34
|
--8<-- "docs/cmd/_global.md"
|
|
32
35
|
|
|
@@ -47,11 +50,11 @@ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIF
|
|
|
47
50
|
Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
|
|
48
51
|
|
|
49
52
|
```sh
|
|
50
|
-
m365 planner bucket get --name "Planner Bucket A" --
|
|
53
|
+
m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
|
|
51
54
|
```
|
|
52
55
|
|
|
53
56
|
Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
|
|
54
57
|
|
|
55
58
|
```sh
|
|
56
|
-
m365 planner bucket get --name "Planner Bucket A" --
|
|
57
|
-
```
|
|
59
|
+
m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
|
|
60
|
+
```
|
|
@@ -11,16 +11,19 @@ m365 planner bucket list [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`--planId [planId]`
|
|
14
|
-
: ID of the plan to list the buckets of. Specify either `planId` or `
|
|
14
|
+
: ID of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
|
|
15
|
+
|
|
16
|
+
`--planTitle [planTitle]`
|
|
17
|
+
: Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
|
|
15
18
|
|
|
16
19
|
`--planName [planName]`
|
|
17
|
-
:
|
|
20
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
18
21
|
|
|
19
22
|
`--ownerGroupId [ownerGroupId]`
|
|
20
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
23
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
21
24
|
|
|
22
25
|
`--ownerGroupName [ownerGroupName]`
|
|
23
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
26
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
24
27
|
|
|
25
28
|
--8<-- "docs/cmd/_global.md"
|
|
26
29
|
|
|
@@ -35,5 +38,5 @@ m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
|
|
|
35
38
|
Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
|
|
36
39
|
|
|
37
40
|
```sh
|
|
38
|
-
m365 planner bucket list --
|
|
41
|
+
m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
|
|
39
42
|
```
|
|
@@ -17,16 +17,19 @@ m365 planner bucket remove [options]
|
|
|
17
17
|
: Name of the bucket to remove. Specify either `id` or `name` but not both.
|
|
18
18
|
|
|
19
19
|
`--planId [planId]`
|
|
20
|
-
: ID of the plan to which the bucket to remove belongs. Specify either `planId` or `
|
|
20
|
+
: ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
|
|
21
|
+
|
|
22
|
+
`--planTitle [planTitle]`
|
|
23
|
+
: Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
|
|
21
24
|
|
|
22
25
|
`--planName [planName]`
|
|
23
|
-
:
|
|
26
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
24
27
|
|
|
25
28
|
`--ownerGroupId [ownerGroupId]`
|
|
26
|
-
: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `
|
|
29
|
+
: ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
27
30
|
|
|
28
31
|
`--ownerGroupName [ownerGroupName]`
|
|
29
|
-
: Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `
|
|
32
|
+
: Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
30
33
|
|
|
31
34
|
`--confirm`
|
|
32
35
|
: Don't prompt for confirmation
|
|
@@ -56,5 +59,5 @@ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcA
|
|
|
56
59
|
Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
|
|
57
60
|
|
|
58
61
|
```sh
|
|
59
|
-
m365 planner bucket remove --name "My Bucket" --
|
|
62
|
+
m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
|
|
60
63
|
```
|
|
@@ -17,16 +17,19 @@ m365 planner bucket set [options]
|
|
|
17
17
|
: Name of the bucket. Specify either `id` or `name` but not both.
|
|
18
18
|
|
|
19
19
|
`--planId [planId]`
|
|
20
|
-
: ID of the plan to update the bucket of. Specify either `planId` or `
|
|
20
|
+
: ID of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`.
|
|
21
|
+
|
|
22
|
+
`--planTitle [planTitle]`
|
|
23
|
+
: Title of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
|
|
21
24
|
|
|
22
25
|
`--planName [planName]`
|
|
23
|
-
:
|
|
26
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
24
27
|
|
|
25
28
|
`--ownerGroupId [ownerGroupId]`
|
|
26
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
29
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
27
30
|
|
|
28
31
|
`--ownerGroupName [ownerGroupName]`
|
|
29
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
32
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
30
33
|
|
|
31
34
|
`--newName [newName]`
|
|
32
35
|
: New name of the bucket.
|
|
@@ -47,11 +50,11 @@ m365 planner bucket set --id "vncYUXCRBke28qMLB-d4xJcACtNz" --newName "New bucke
|
|
|
47
50
|
Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
|
|
48
51
|
|
|
49
52
|
```sh
|
|
50
|
-
m365 planner bucket set --name "My Bucket" --
|
|
53
|
+
m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
|
|
51
54
|
```
|
|
52
55
|
|
|
53
56
|
Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
|
|
54
57
|
|
|
55
58
|
```sh
|
|
56
|
-
m365 planner bucket set --name "My Bucket" --
|
|
59
|
+
m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
|
|
57
60
|
```
|
|
@@ -19,18 +19,34 @@ m365 planner plan add [options]
|
|
|
19
19
|
`--ownerGroupName [ownerGroupName]`
|
|
20
20
|
: Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
|
|
21
21
|
|
|
22
|
+
`--shareWithUserIds [shareWithUserIds]`
|
|
23
|
+
: The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
|
|
24
|
+
|
|
25
|
+
`--shareWithUserNames [shareWithUserNames]`
|
|
26
|
+
: The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
|
|
27
|
+
|
|
22
28
|
--8<-- "docs/cmd/_global.md"
|
|
23
29
|
|
|
30
|
+
## Remarks
|
|
31
|
+
|
|
32
|
+
Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
|
|
33
|
+
|
|
24
34
|
## Examples
|
|
25
35
|
|
|
26
36
|
Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
|
|
27
37
|
|
|
28
38
|
```sh
|
|
29
|
-
m365 planner plan add --title
|
|
39
|
+
m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
|
|
30
40
|
```
|
|
31
41
|
|
|
32
42
|
Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_
|
|
33
43
|
|
|
34
44
|
```sh
|
|
35
|
-
m365 planner plan add --title
|
|
45
|
+
m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_ and share it with the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
|
|
36
52
|
```
|
|
@@ -14,22 +14,25 @@ m365 planner task add [options]
|
|
|
14
14
|
: Title of the task to add.
|
|
15
15
|
|
|
16
16
|
`--planId [planId]`
|
|
17
|
-
:
|
|
17
|
+
: ID of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
|
|
18
|
+
|
|
19
|
+
`--planTitle [planTitle]`
|
|
20
|
+
: Title of the plan to which the task belongs. Specify either `planId` or `planTitle` but not both.
|
|
18
21
|
|
|
19
22
|
`--planName [planName]`
|
|
20
|
-
:
|
|
23
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
21
24
|
|
|
22
25
|
`--ownerGroupId [ownerGroupId]`
|
|
23
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
26
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
24
27
|
|
|
25
28
|
`--ownerGroupName [ownerGroupName]`
|
|
26
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
29
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
27
30
|
|
|
28
31
|
`--bucketId [bucketId]`
|
|
29
|
-
:
|
|
32
|
+
: ID of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
|
|
30
33
|
|
|
31
34
|
`--bucketName [bucketName]`
|
|
32
|
-
:
|
|
35
|
+
: Name of the bucket to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
|
|
33
36
|
|
|
34
37
|
`--startDateTime [startDateTime]`
|
|
35
38
|
: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
|
|
@@ -89,10 +92,10 @@ Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the
|
|
|
89
92
|
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
|
|
90
93
|
```
|
|
91
94
|
|
|
92
|
-
Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the
|
|
95
|
+
Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
|
|
93
96
|
|
|
94
97
|
```sh
|
|
95
|
-
m365 planner task add --title "My Planner task" --
|
|
98
|
+
m365 planner task add --title "My Planner task" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
|
|
96
99
|
```
|
|
97
100
|
|
|
98
101
|
Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_ and receive a due date for _2021-12-16_
|
|
@@ -8,6 +8,12 @@ Retrieve the specified planner task
|
|
|
8
8
|
m365 planner task get [options]
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
## Alias
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
m365 planner task details get [options]
|
|
15
|
+
```
|
|
16
|
+
|
|
11
17
|
## Options
|
|
12
18
|
|
|
13
19
|
`-i, --id [id]`
|
|
@@ -20,22 +26,25 @@ m365 planner task get [options]
|
|
|
20
26
|
: (deprecated. Use `id` instead) ID of the task.
|
|
21
27
|
|
|
22
28
|
`--bucketId [bucketId]`
|
|
23
|
-
:
|
|
29
|
+
: ID of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
|
|
24
30
|
|
|
25
31
|
`--bucketName [bucketName]`
|
|
26
|
-
:
|
|
32
|
+
: Name of the bucket to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
|
|
27
33
|
|
|
28
34
|
`--planId [planId]`
|
|
29
|
-
:
|
|
35
|
+
: ID of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
|
|
36
|
+
|
|
37
|
+
`--planTitle [planTitle]`
|
|
38
|
+
: Title of the plan to which the task belongs. Specify `planId` or `planTitle` when using `bucketName`.
|
|
30
39
|
|
|
31
40
|
`--planName [planName]`
|
|
32
|
-
:
|
|
41
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
33
42
|
|
|
34
43
|
`--ownerGroupId [ownerGroupId]`
|
|
35
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
44
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
36
45
|
|
|
37
46
|
`--ownerGroupName [ownerGroupName]`
|
|
38
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
47
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
39
48
|
|
|
40
49
|
--8<-- "docs/cmd/_global.md"
|
|
41
50
|
|
|
@@ -47,8 +56,8 @@ Retrieve the specified planner task by id
|
|
|
47
56
|
m365 planner task get --id "vzCcZoOv-U27PwydxHB8opcADJo-"
|
|
48
57
|
```
|
|
49
58
|
|
|
50
|
-
Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_
|
|
59
|
+
Retrieve the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_.
|
|
51
60
|
|
|
52
61
|
```sh
|
|
53
|
-
m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --
|
|
62
|
+
m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
|
|
54
63
|
```
|
|
@@ -17,16 +17,19 @@ m365 planner task list [options]
|
|
|
17
17
|
: Name of the bucket to list the tasks of. To retrieve tasks from a bucket, specify `bucketId` or `bucketName`, but not both.
|
|
18
18
|
|
|
19
19
|
`--planId [planId]`
|
|
20
|
-
: ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `
|
|
20
|
+
: ID of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
|
|
21
|
+
|
|
22
|
+
`--planTitle [planTitle]`
|
|
23
|
+
: Title of a plan to list the tasks of. To retrieve all tasks from a plan, specify either `planId` or `planTitle` but not both. Always use in combination with either `ownerGroupId` or `ownerGroupName`. Use in combination with `bucketName` to retrieve tasks from a specific bucket.
|
|
21
24
|
|
|
22
25
|
`--planName [planName]`
|
|
23
|
-
:
|
|
26
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
24
27
|
|
|
25
28
|
`--ownerGroupId [ownerGroupId]`
|
|
26
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
29
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
27
30
|
|
|
28
31
|
`--ownerGroupName [ownerGroupName]`
|
|
29
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
32
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
30
33
|
|
|
31
34
|
--8<-- "docs/cmd/_global.md"
|
|
32
35
|
|
|
@@ -52,7 +55,7 @@ m365 planner task list --planId "iVPMIgdku0uFlou-KLNg6MkAE1O2"`
|
|
|
52
55
|
List the Microsoft Planner tasks in the plan _My Plan_ in group _My Group_
|
|
53
56
|
|
|
54
57
|
```sh
|
|
55
|
-
m365 planner task list --
|
|
58
|
+
m365 planner task list --planTitle "My Plan" --ownerGroupName "My Group"
|
|
56
59
|
```
|
|
57
60
|
|
|
58
61
|
List the Microsoft Planner tasks in the bucket _FtzysDykv0-9s9toWiZhdskAD67z_
|
|
@@ -70,5 +73,5 @@ m365 planner task list --bucketName "My Bucket" --planId "iVPMIgdku0uFlou-KLNg6M
|
|
|
70
73
|
List the Microsoft Planner tasks in the bucket _My Bucket_ belonging to plan _My Plan_ in group _My Group_
|
|
71
74
|
|
|
72
75
|
```sh
|
|
73
|
-
m365 planner task list --bucketName "My Bucket" --
|
|
76
|
+
m365 planner task list --bucketName "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
|
|
74
77
|
```
|
|
@@ -23,16 +23,19 @@ m365 planner task set [options]
|
|
|
23
23
|
: Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` when using `title`.
|
|
24
24
|
|
|
25
25
|
`--planId [planId]`
|
|
26
|
-
: ID of the plan to which the bucket belongs to. Specify either `planId` or `
|
|
26
|
+
: ID of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
|
|
27
|
+
|
|
28
|
+
`--planTitle [planTitle]`
|
|
29
|
+
: Title of the plan to which the bucket belongs to. Specify either `planId` or `planTitle` when using `bucketName`.
|
|
27
30
|
|
|
28
31
|
`--planName [planName]`
|
|
29
|
-
:
|
|
32
|
+
: (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
|
|
30
33
|
|
|
31
34
|
`--ownerGroupId [ownerGroupId]`
|
|
32
|
-
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
35
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
33
36
|
|
|
34
37
|
`--ownerGroupName [ownerGroupName]`
|
|
35
|
-
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `
|
|
38
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
|
|
36
39
|
|
|
37
40
|
`--startDateTime [startDateTime]`
|
|
38
41
|
: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
|
|
@@ -91,10 +94,10 @@ Updates a Microsoft Planner task name to _My Planner Task_ for the task with the
|
|
|
91
94
|
m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
|
|
92
95
|
```
|
|
93
96
|
|
|
94
|
-
Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the
|
|
97
|
+
Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the title _My Planner Plan_ owned by the group _My Planner Group_
|
|
95
98
|
|
|
96
99
|
```sh
|
|
97
|
-
m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --
|
|
100
|
+
m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
|
|
98
101
|
```
|
|
99
102
|
|
|
100
103
|
Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# search externalconnection get
|
|
2
|
+
|
|
3
|
+
Allow the administrator to get a specific external connection for use in Microsoft Search.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 search externalconnection get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --id [id]`
|
|
14
|
+
: ID of the External Connection to get. Specify either `id` or `name`
|
|
15
|
+
|
|
16
|
+
`-n, --name [name]`
|
|
17
|
+
: Name of the External Connection to get. Specify either `id` or `name`
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Examples
|
|
22
|
+
|
|
23
|
+
Get the External Connection by its id
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
m365 search externalconnection get --id "MyApp"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Get the External Connection by its name
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 search externalconnection get --name "Test"
|
|
33
|
+
```
|