@pnp/cli-microsoft365 6.0.0-beta.8352f49 → 6.0.0-beta.fe4e66d
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/Command.js +22 -0
- 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 +16 -16
- 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-reference-add.js +1 -7
- package/dist/m365/planner/commands/task/task-reference-remove.js +11 -14
- package/dist/m365/planner/commands/task/task-remove.js +4 -19
- package/dist/m365/planner/commands/task/task-set.js +17 -23
- package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
- package/dist/m365/search/commands.js +1 -0
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN015008_FILE_eslintrc_js.js +7 -0
- package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.0.js +6 -4
- 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/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +1 -9
- package/dist/utils/accessToken.js +18 -0
- package/dist/utils/planner.js +6 -6
- package/dist/utils/validation.js +5 -1
- package/docs/docs/cmd/aad/user/user-get.md +12 -0
- 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/plan/plan-remove.md +1 -1
- 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
|
@@ -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
|
+
```
|
|
@@ -20,10 +20,13 @@ m365 spo field set [options]
|
|
|
20
20
|
: Title of the list where the field is located (if list column). Specify `listTitle` or `listId` but not both
|
|
21
21
|
|
|
22
22
|
`-i, --id [id]`
|
|
23
|
-
: ID of the field to update. Specify `
|
|
23
|
+
: ID of the field to update. Specify `id` or `title` but not both
|
|
24
|
+
|
|
25
|
+
`-t, --title [title]`
|
|
26
|
+
: Title or internal name of the field to update. Specify `id` or `title` but not both
|
|
24
27
|
|
|
25
28
|
`-n, --name [name]`
|
|
26
|
-
: Title or internal name of the field to update. Specify `
|
|
29
|
+
: (deprecated. Use `title` instead) Title or internal name of the field to update. Specify `id` or `name` but not both
|
|
27
30
|
|
|
28
31
|
`--updateExistingLists`
|
|
29
32
|
: Set, to push the update to existing lists. Otherwise, the changes will apply to new lists only
|
|
@@ -39,7 +42,7 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin
|
|
|
39
42
|
Update the title of the site column specified by its internal name and push changes to existing lists
|
|
40
43
|
|
|
41
44
|
```sh
|
|
42
|
-
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --
|
|
45
|
+
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --title 'MyColumn' --updateExistingLists --Title 'My column'
|
|
43
46
|
```
|
|
44
47
|
|
|
45
48
|
Update the title of the list column specified by its ID
|
|
@@ -51,5 +54,5 @@ m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --lis
|
|
|
51
54
|
Update column formatting of the specified list column
|
|
52
55
|
|
|
53
56
|
```sh
|
|
54
|
-
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --
|
|
57
|
+
m365 spo field set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'My List' --title 'MyColumn' --CustomFormatter '`{"schema":"https://developer.microsoft.com/json-schemas/sp/column-formatting.schema.json", "elmType": "div", "txtContent": "@currentField"}`'
|
|
55
58
|
```
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# spo group add
|
|
2
|
+
|
|
3
|
+
Creates group in the specified site
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo group add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the group should be added.
|
|
15
|
+
|
|
16
|
+
`-n, --name <name>`
|
|
17
|
+
: Name of the group to add.
|
|
18
|
+
|
|
19
|
+
`--description [description]`
|
|
20
|
+
: The description for the group.
|
|
21
|
+
|
|
22
|
+
`--allowMembersEditMembership [allowMembersEditMembership]`
|
|
23
|
+
: Who can edit the membership of the group? When `true` members can edit membership, otherwise only owners can do this. Default `false`.
|
|
24
|
+
|
|
25
|
+
`--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
|
|
26
|
+
: Who can view the membership of the group? When `false` everyone can view the group membership, otherwise only group members can. Default `true`.
|
|
27
|
+
|
|
28
|
+
`--allowRequestToJoinLeave [allowRequestToJoinLeave]`
|
|
29
|
+
: Specify whether to allow users to request membership in this group and allow users to request to leave the group. Default `false`.
|
|
30
|
+
|
|
31
|
+
`--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
|
|
32
|
+
: If auto-accept is enabled, users will automatically be added or removed when they make a request. Default `false`.
|
|
33
|
+
|
|
34
|
+
`--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
|
|
35
|
+
: All membership requests will be sent to the email address specified.
|
|
36
|
+
|
|
37
|
+
--8<-- "docs/cmd/_global.md"
|
|
38
|
+
|
|
39
|
+
## Examples
|
|
40
|
+
|
|
41
|
+
Create group with title and description
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --description "This group contains all project leaders"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Create group with membership requests
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 spo group add --webUrl https://contoso.sharepoint.com/sites/project-x --name "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
|
|
51
|
+
```
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# spo group set
|
|
2
|
+
|
|
3
|
+
Updates a group in the specified site
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo group set [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the group is located.
|
|
15
|
+
|
|
16
|
+
`-i, --id [id]`
|
|
17
|
+
: ID of the group to update. Specify either `id` or `name` but not both.
|
|
18
|
+
|
|
19
|
+
`-n, --name [name]`
|
|
20
|
+
: Name of the group. Specify either `id` or `name` but not both.
|
|
21
|
+
|
|
22
|
+
`--newName [newName]`
|
|
23
|
+
: New name for the group.
|
|
24
|
+
|
|
25
|
+
`--description [description]`
|
|
26
|
+
: The description for the group.
|
|
27
|
+
|
|
28
|
+
`--allowMembersEditMembership [allowMembersEditMembership]`
|
|
29
|
+
: Who can edit the membership of the group? When `true` members can edit membership, otherwise only owners can do this.
|
|
30
|
+
|
|
31
|
+
`--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]`
|
|
32
|
+
: Who can view the membership of the group? When `true` only group members can view the membership, otherwise everyone can.
|
|
33
|
+
|
|
34
|
+
`--allowRequestToJoinLeave [allowRequestToJoinLeave]`
|
|
35
|
+
: Specify whether to allow users to request membership in this group and allow users to request to leave the group.
|
|
36
|
+
|
|
37
|
+
`--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]`
|
|
38
|
+
: If auto-accept is enabled, users will automatically be added or removed when they make a request.
|
|
39
|
+
|
|
40
|
+
`--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]`
|
|
41
|
+
: All membership requests will be sent to the email address specified.
|
|
42
|
+
|
|
43
|
+
`--ownerEmail [ownerEmail]`
|
|
44
|
+
: Set user with this email as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
|
|
45
|
+
|
|
46
|
+
`--ownerUserName [ownerUserName]`
|
|
47
|
+
: Set user with this login name as owner of the group. Specify either `ownerEmail` or `ownerUserName` but not both.
|
|
48
|
+
|
|
49
|
+
--8<-- "docs/cmd/_global.md"
|
|
50
|
+
|
|
51
|
+
## Examples
|
|
52
|
+
|
|
53
|
+
Update group title and description
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --newTitle "Project leaders" --description "This group contains all project leaders"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Update group with membership requests
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --title "Project leaders" --allowRequestToJoinLeave true --requestToJoinLeaveEmailSetting john.doe@contoso.com
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Sets a specified user as group owner
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
m365 spo group set --webUrl https://contoso.sharepoint.com/sites/project-x --id 18 --ownerEmail john.doe@contoso.com
|
|
69
|
+
```
|
|
@@ -10,17 +10,19 @@ m365 spo hubsite get [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-i, --id
|
|
14
|
-
:
|
|
13
|
+
`-i, --id [id]`
|
|
14
|
+
: ID of the hubsite. Specify either `id`, `title` or `url` but not multiple.
|
|
15
15
|
|
|
16
|
-
--
|
|
16
|
+
`-t, --title [title]`
|
|
17
|
+
: Title of the hubsite. Specify either `id`, `title` or `url` but not multiple.
|
|
17
18
|
|
|
18
|
-
|
|
19
|
+
`-u, --url [url]`
|
|
20
|
+
: URL of the hubsite. Specify either `id`, `title` or `url` but not multiple.
|
|
19
21
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
+
`--includeAssociatedSites`
|
|
23
|
+
: Include the associated sites in the result (only in JSON output)
|
|
22
24
|
|
|
23
|
-
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
24
26
|
|
|
25
27
|
## Examples
|
|
26
28
|
|
|
@@ -30,6 +32,36 @@ Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
|
|
|
30
32
|
m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a
|
|
31
33
|
```
|
|
32
34
|
|
|
35
|
+
Get information about the hub site with Title _My Hub Site_
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo hubsite get --title 'My Hub Site'
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Get information about the hub site with ID _2c1ba4c4-cd9b-4417-832f-92a34bc34b2a_, including its associated sites. Associated site info is only shown in JSON output.
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Get information about the hub site with Title _My Hub Site_
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
m365 spo hubsite get --title "My Hub Site"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Get information about the hub site with URL _https://contoso.sharepoint.com/sites/HubSite_
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
m365 spo hubsite get --url "https://contoso.sharepoint.com/sites/HubSite"
|
|
63
|
+
```
|
|
64
|
+
|
|
33
65
|
## More information
|
|
34
66
|
|
|
35
67
|
- SharePoint hub sites new in Microsoft 365: [https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547](https://techcommunity.microsoft.com/t5/SharePoint-Blog/SharePoint-hub-sites-new-in-Office-365/ba-p/109547)
|
|
@@ -27,6 +27,10 @@ m365 spo listitem get [options]
|
|
|
27
27
|
|
|
28
28
|
--8<-- "docs/cmd/_global.md"
|
|
29
29
|
|
|
30
|
+
## Remarks
|
|
31
|
+
|
|
32
|
+
If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
|
|
33
|
+
|
|
30
34
|
## Examples
|
|
31
35
|
|
|
32
36
|
Get an item with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
|
|
@@ -35,9 +39,14 @@ Get an item with ID _147_ from list with title _Demo List_ in site _https://cont
|
|
|
35
39
|
m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x
|
|
36
40
|
```
|
|
37
41
|
|
|
38
|
-
|
|
39
|
-
Get an items Title and Created column and with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
|
|
42
|
+
Get an items _Title_ and _Created_ column with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
|
|
40
43
|
|
|
41
44
|
```sh
|
|
42
45
|
m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created"
|
|
43
46
|
```
|
|
47
|
+
|
|
48
|
+
Get an items _Title_, _Created_ column and lookup column _Company_ with ID _147_ from list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
m365 spo listitem get --listTitle "Demo List" --id 147 --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Created,Company/Title"
|
|
52
|
+
```
|
|
@@ -46,6 +46,8 @@ m365 spo listitem list [options]
|
|
|
46
46
|
|
|
47
47
|
`pageNumber` is specified as a 0-based index. A value of `2` returns the third page of items.
|
|
48
48
|
|
|
49
|
+
If you want to specify a lookup type in the `properties` option, define which columns from the related list should be returned.
|
|
50
|
+
|
|
49
51
|
## Examples
|
|
50
52
|
|
|
51
53
|
Get all items from a list named Demo List
|
|
@@ -72,6 +74,12 @@ Get all items from list named _Demo List_. For each item, retrieve the value of
|
|
|
72
74
|
m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified"
|
|
73
75
|
```
|
|
74
76
|
|
|
77
|
+
Get all items from list named _Demo List_. For each item, retrieve the value of the _ID_, _Title_, _Modified_ fields, and the value of lookup field _Company_
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
m365 spo listitem list --listTitle "Demo List" --webUrl https://contoso.sharepoint.com/sites/project-x --fields "ID,Title,Modified,Company/Title"
|
|
81
|
+
```
|
|
82
|
+
|
|
75
83
|
From a list named _Demo List_ get all items with title _Demo list item_ using an OData filter
|
|
76
84
|
|
|
77
85
|
```sh
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# spo roledefinition get
|
|
2
|
+
|
|
3
|
+
Gets specified role definition from web by id
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo roledefinition get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site for which to retrieve the role definition
|
|
15
|
+
|
|
16
|
+
`-i, --id <id>`
|
|
17
|
+
: The Id of the role definition to retrieve.
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Examples
|
|
22
|
+
|
|
23
|
+
Retrieve the role definition for site _https://contoso.sharepoint.com/sites/project-x_ with id _1_
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
m365 spo roledefinition get --webUrl https://contoso.sharepoint.com/sites/project-x --id 1
|
|
27
|
+
```
|
|
@@ -10,8 +10,14 @@ m365 teams team archive [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-i, --
|
|
14
|
-
: The ID of the Microsoft Teams team to archive
|
|
13
|
+
`-i, --id [id]`
|
|
14
|
+
: The ID of the Microsoft Teams team to archive. Specify either id or name but not both
|
|
15
|
+
|
|
16
|
+
`-n, --name [name]`
|
|
17
|
+
: The display name of the Microsoft Teams team to archive. Specify either id or name but not both
|
|
18
|
+
|
|
19
|
+
`--teamId [teamId]`
|
|
20
|
+
: (deprecated. Use `id` instead) The ID of the Microsoft Teams team to archive
|
|
15
21
|
|
|
16
22
|
`--shouldSetSpoSiteReadOnlyForMembers`
|
|
17
23
|
: Sets the permissions for team members to read-only on the SharePoint Online site associated with the team
|
|
@@ -22,18 +28,27 @@ m365 teams team archive [options]
|
|
|
22
28
|
|
|
23
29
|
Using this command, global admins and Microsoft Teams service admins can access teams that they are not a member of.
|
|
24
30
|
|
|
31
|
+
If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
|
|
32
|
+
|
|
25
33
|
When a team is archived, users can no longer send or like messages on any channel in the team, edit the team's name, description, or other settings, or in general make most changes to the team. Membership changes to the team continue to be allowed.
|
|
26
34
|
|
|
35
|
+
|
|
27
36
|
## Examples
|
|
28
37
|
|
|
29
|
-
Archive the specified Microsoft Teams team
|
|
38
|
+
Archive the specified Microsoft Teams team with id _6f6fd3f7-9ba5-4488-bbe6-a789004d0d55_
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 teams team archive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Archive the specified Microsoft Teams team with name _Team Name_
|
|
30
45
|
|
|
31
46
|
```sh
|
|
32
|
-
m365 teams team archive --
|
|
47
|
+
m365 teams team archive --name "Team Name"
|
|
33
48
|
```
|
|
34
49
|
|
|
35
50
|
Archive the specified Microsoft Teams team and set permissions for team members to read-only on the SharePoint Online site associated with the team
|
|
36
51
|
|
|
37
52
|
```sh
|
|
38
|
-
m365 teams team archive --
|
|
53
|
+
m365 teams team archive --id 6f6fd3f7-9ba5-4488-bbe6-a789004d0d55 --shouldSetSpoSiteReadOnlyForMembers
|
|
39
54
|
```
|
|
@@ -10,8 +10,14 @@ m365 teams team remove [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-i, --
|
|
14
|
-
: The ID of the Teams team to remove
|
|
13
|
+
`-i, --id [id]`
|
|
14
|
+
: The ID of the Microsoft Teams team to remove. Specify either id or name but not both
|
|
15
|
+
|
|
16
|
+
`-n, --name [name]`
|
|
17
|
+
: The display name of the Microsoft Teams team to remove. Specify either id or name but not both
|
|
18
|
+
|
|
19
|
+
`--teamId [teamId]`
|
|
20
|
+
: (deprecated. Use `id` instead) The ID of the Teams team to remove
|
|
15
21
|
|
|
16
22
|
`--confirm`
|
|
17
23
|
: Don't prompt for confirming removing the specified team
|
|
@@ -22,18 +28,26 @@ m365 teams team remove [options]
|
|
|
22
28
|
|
|
23
29
|
When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This applies only to Microsoft 365 groups.
|
|
24
30
|
|
|
31
|
+
If the command finds multiple Microsoft Teams teams with the specified name, it will prompt you to disambiguate which team it should use, listing the discovered team IDs.
|
|
32
|
+
|
|
25
33
|
## Examples
|
|
26
34
|
|
|
27
|
-
Removes the specified team
|
|
35
|
+
Removes the specified Microsoft Teams team with id _00000000-0000-0000-0000-000000000000_
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 teams team remove --id 00000000-0000-0000-0000-000000000000
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Removes the specified Microsoft Teams team with name _Team Name_
|
|
28
42
|
|
|
29
43
|
```sh
|
|
30
|
-
m365 teams team remove --
|
|
44
|
+
m365 teams team remove --name "Team Name"
|
|
31
45
|
```
|
|
32
46
|
|
|
33
47
|
Removes the specified team without confirmation
|
|
34
48
|
|
|
35
49
|
```sh
|
|
36
|
-
m365 teams team remove --
|
|
50
|
+
m365 teams team remove --id 00000000-0000-0000-0000-000000000000 --confirm
|
|
37
51
|
```
|
|
38
52
|
|
|
39
53
|
## More information
|