@pnp/cli-microsoft365 5.0.0-beta.117f66f → 5.0.0-beta.21e7f85
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/devcontainer.json +9 -1
- package/.eslintrc.js +2 -0
- package/dist/Command.js +1 -1
- package/dist/Utils.js +7 -0
- package/dist/api.d.ts +11 -0
- package/dist/api.js +17 -0
- package/dist/cli/Cli.js +26 -13
- package/dist/m365/aad/commands/app/app-add.js +43 -7
- package/dist/m365/aad/commands/app/app-delete.js +123 -0
- package/dist/m365/aad/commands/app/app-set.js +98 -3
- package/dist/m365/aad/commands/group/group-list.js +54 -0
- package/dist/m365/aad/commands/o365group/{Group.js → GroupExtended.js} +1 -1
- package/dist/m365/aad/commands/o365group/o365group-conversation-list.js +41 -0
- package/dist/m365/aad/commands/o365group/o365group-user-set.js +3 -3
- package/dist/m365/aad/commands/user/user-get.js +33 -6
- package/dist/m365/aad/commands/user/user-hibp.js +67 -0
- package/dist/m365/aad/commands/user/user-list.js +7 -4
- package/dist/m365/aad/commands.js +4 -0
- package/dist/m365/cli/commands/config/config-set.js +4 -1
- package/dist/m365/flow/commands/flow-get.js +2 -2
- package/dist/m365/outlook/commands/room/room-list.js +43 -0
- package/dist/m365/outlook/commands/roomlist/roomlist-list.js +25 -0
- package/dist/m365/outlook/commands.js +2 -0
- package/dist/m365/pa/cds-project-mutator.js +1 -1
- package/dist/m365/{aad/commands/o365group/GroupUser.js → planner/AppliedCategories.js} +1 -1
- package/dist/m365/planner/commands/task/task-add.js +288 -0
- package/dist/m365/planner/commands/task/task-details-get.js +39 -0
- package/dist/m365/planner/commands/task/task-get.js +37 -0
- package/dist/m365/planner/commands/task/task-list.js +37 -7
- package/dist/m365/planner/commands/task/task-set.js +357 -0
- package/dist/m365/planner/commands.js +5 -1
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014008_CODE_launch_hostedWorkbench_type.js +62 -0
- package/dist/m365/spfx/commands/project/project-upgrade/{upgrade-1.14.0-beta.4.js → upgrade-1.14.0-rc.2.js} +27 -25
- package/dist/m365/spfx/commands/project/project-upgrade.js +1 -1
- package/dist/m365/spo/commands/group/group-user-add.js +74 -16
- package/dist/m365/spo/commands/group/group-user-remove.js +100 -0
- package/dist/m365/spo/commands/site/site-ensure.js +1 -1
- package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
- package/dist/m365/spo/commands.js +2 -0
- package/dist/m365/teams/commands/app/app-list.js +9 -6
- package/dist/m365/teams/commands/channel/channel-get.js +29 -7
- package/dist/m365/teams/commands/chat/chat-list.js +43 -0
- package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
- package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
- package/dist/m365/teams/commands/chat/chat-message-send.js +225 -0
- package/dist/m365/teams/commands/message/message-get.js +1 -1
- package/dist/m365/teams/commands/tab/tab-get.js +9 -6
- package/dist/m365/teams/commands.js +4 -0
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +57 -0
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-list.js +56 -0
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-get.js +39 -0
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +38 -0
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-get.js +51 -0
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +38 -0
- package/dist/m365/tenant/commands.js +6 -0
- package/dist/settingsNames.js +6 -1
- package/docs/docs/cmd/aad/app/app-delete.md +51 -0
- package/docs/docs/cmd/aad/app/app-set.md +21 -0
- package/docs/docs/cmd/aad/group/group-list.md +30 -0
- package/docs/docs/cmd/aad/o365group/o365group-conversation-list.md +24 -0
- package/docs/docs/cmd/aad/user/user-get.md +13 -4
- package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
- package/docs/docs/cmd/aad/user/user-list.md +9 -0
- package/docs/docs/cmd/outlook/room/room-list.md +30 -0
- package/docs/docs/cmd/outlook/roomlist/roomlist-list.md +21 -0
- package/docs/docs/cmd/planner/task/task-add.md +78 -0
- package/docs/docs/cmd/planner/task/task-details-get.md +24 -0
- package/docs/docs/cmd/planner/task/task-get.md +29 -0
- package/docs/docs/cmd/planner/task/task-list.md +5 -0
- package/docs/docs/cmd/planner/task/task-set.md +99 -0
- package/docs/docs/cmd/search/externalconnection/externalconnection-add.md +3 -3
- package/docs/docs/cmd/spo/group/group-user-add.md +28 -6
- package/docs/docs/cmd/spo/group/group-user-remove.md +39 -0
- package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
- package/docs/docs/cmd/teams/channel/channel-get.md +11 -2
- package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
- package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
- package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
- package/docs/docs/cmd/teams/chat/chat-message-send.md +55 -0
- package/docs/docs/cmd/teams/message/message-get.md +0 -3
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +33 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +30 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.md +24 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +34 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.md +28 -0
- package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +34 -0
- package/npm-shrinkwrap.json +938 -1001
- package/package.json +33 -27
- package/dist/m365/base/AadCommand.js +0 -10
|
@@ -22,6 +22,15 @@ m365 aad app set [options]
|
|
|
22
22
|
`-u, --uri [uri]`
|
|
23
23
|
: Application ID URI to update
|
|
24
24
|
|
|
25
|
+
`-r, --redirectUris [redirectUris]`
|
|
26
|
+
: Comma-separated list of redirect URIs to add to the app registration. Requires `platform` to be specified
|
|
27
|
+
|
|
28
|
+
`-p, --platform [platform]`
|
|
29
|
+
: Platform for which the `redirectUri` should be configured. Allowed values `spa,web,publicClient`
|
|
30
|
+
|
|
31
|
+
`--redirectUrisToRemove [redirectUrisToRemove]`
|
|
32
|
+
: Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
|
|
33
|
+
|
|
25
34
|
--8<-- "docs/cmd/_global.md"
|
|
26
35
|
|
|
27
36
|
## Remarks
|
|
@@ -49,3 +58,15 @@ Update the app URI of the Azure AD application registration specified by its nam
|
|
|
49
58
|
```sh
|
|
50
59
|
m365 aad app set --name "My app" --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
|
|
51
60
|
```
|
|
61
|
+
|
|
62
|
+
Add a new redirect URI for SPA authentication
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Replace one redirect URI with another for SPA authentication
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
|
|
72
|
+
```
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# aad group list
|
|
2
|
+
|
|
3
|
+
Lists Azure AD groups
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 aad group list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-d, --deleted`
|
|
14
|
+
: Use to retrieve deleted groups
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
Lists all groups defined in Azure Active Directory.
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
m365 aad group list
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
List all recently deleted groups in the tenant
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
m365 aad group list --deleted
|
|
30
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# aad o365group conversation list
|
|
2
|
+
|
|
3
|
+
Lists conversations for the specified Microsoft 365 group
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 aad o365group conversation list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --groupId <groupId>`
|
|
14
|
+
: The ID of the Microsoft 365 group
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
Lists conversations for the specified Microsoft 365 group
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
m365 aad o365group conversation list --groupId '00000000-0000-0000-0000-000000000000'
|
|
24
|
+
```
|
|
@@ -11,10 +11,13 @@ m365 aad user get [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`-i, --id [id]`
|
|
14
|
-
: The ID of the user to retrieve information for.
|
|
14
|
+
: The ID of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
|
|
15
15
|
|
|
16
16
|
`-n, --userName [userName]`
|
|
17
|
-
: The name of the user to retrieve information for.
|
|
17
|
+
: The name of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
|
|
18
|
+
|
|
19
|
+
`--email [email]`
|
|
20
|
+
: The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
|
|
18
21
|
|
|
19
22
|
`-p, --properties [properties]`
|
|
20
23
|
: Comma-separated list of properties to retrieve
|
|
@@ -23,9 +26,9 @@ m365 aad user get [options]
|
|
|
23
26
|
|
|
24
27
|
## Remarks
|
|
25
28
|
|
|
26
|
-
You can retrieve information about a user, either by specifying that user's id
|
|
29
|
+
You can retrieve information about a user, either by specifying that user's id, user name (`userPrincipalName`), or email (`mail`), but not all.
|
|
27
30
|
|
|
28
|
-
If the user with the specified id
|
|
31
|
+
If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
|
|
29
32
|
|
|
30
33
|
## Examples
|
|
31
34
|
|
|
@@ -41,6 +44,12 @@ Get information about the user with user name _AarifS@contoso.onmicrosoft.com_
|
|
|
41
44
|
m365 aad user get --userName AarifS@contoso.onmicrosoft.com
|
|
42
45
|
```
|
|
43
46
|
|
|
47
|
+
Get information about the user with email _AarifS@contoso.onmicrosoft.com_
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 aad user get --email AarifS@contoso.onmicrosoft.com
|
|
51
|
+
```
|
|
52
|
+
|
|
44
53
|
For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user name, e-mail address and full name
|
|
45
54
|
|
|
46
55
|
```sh
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# aad user hibp
|
|
2
|
+
|
|
3
|
+
Allows you to retrieve all accounts that have been pwned with the specified username
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 aad user hibp [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-n, --userName <userName>`
|
|
14
|
+
: The name of the user to retrieve information for.
|
|
15
|
+
|
|
16
|
+
`--apiKey, <apiKey>`
|
|
17
|
+
: Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
|
|
18
|
+
|
|
19
|
+
`--domain, [domain]`
|
|
20
|
+
: Limit the returned breaches only contain results with the domain specified.
|
|
21
|
+
|
|
22
|
+
--8<-- "docs/cmd/_global.md"
|
|
23
|
+
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
|
|
27
|
+
|
|
28
|
+
If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
|
|
29
|
+
|
|
30
|
+
## Examples
|
|
31
|
+
|
|
32
|
+
Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## More information
|
|
45
|
+
|
|
46
|
+
- Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)
|
|
@@ -13,6 +13,9 @@ m365 aad user list [options]
|
|
|
13
13
|
`-p, --properties [properties]`
|
|
14
14
|
: Comma-separated list of properties to retrieve
|
|
15
15
|
|
|
16
|
+
`-d, --deleted`
|
|
17
|
+
: Use to retrieve deleted users
|
|
18
|
+
|
|
16
19
|
--8<-- "docs/cmd/_global.md"
|
|
17
20
|
|
|
18
21
|
## Remarks
|
|
@@ -31,6 +34,12 @@ List all users in the tenant
|
|
|
31
34
|
m365 aad user list
|
|
32
35
|
```
|
|
33
36
|
|
|
37
|
+
List all recently deleted users in the tenant
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
m365 aad user list --deleted
|
|
41
|
+
```
|
|
42
|
+
|
|
34
43
|
List all users in the tenant. For each one return the display name and e-mail address
|
|
35
44
|
|
|
36
45
|
```sh
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# outlook room list
|
|
2
|
+
|
|
3
|
+
Get a collection of all available rooms
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 outlook room list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--roomlistEmail [roomlistEmail]`
|
|
14
|
+
: Use to filter returned rooms by their roomlist email (eg. bldg2@contoso.com)
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
Get all the rooms
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
m365 outlook room list
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Get all the rooms of specified roomlist e-mail address
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
m365 outlook room list --roomlistEmail "bldg2@contoso.com"
|
|
30
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# outlook roomlist list
|
|
2
|
+
|
|
3
|
+
Get a collection of available roomlists
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 outlook roomlist list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
--8<-- "docs/cmd/_global.md"
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
|
|
17
|
+
Get all roomlists in your tenant
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
m365 outlook roomlist list
|
|
21
|
+
```
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# planner task add
|
|
2
|
+
|
|
3
|
+
Adds a new Microsoft Planner task
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner task add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-t, --title <title>`
|
|
14
|
+
: Title of the task to add.
|
|
15
|
+
|
|
16
|
+
`--planId [planId]`
|
|
17
|
+
: Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
|
|
18
|
+
|
|
19
|
+
`--planName [planName]`
|
|
20
|
+
: Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
|
|
21
|
+
|
|
22
|
+
`--ownerGroupId [ownerGroupId]`
|
|
23
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
24
|
+
|
|
25
|
+
`--ownerGroupName [ownerGroupName]`
|
|
26
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
27
|
+
|
|
28
|
+
`--bucketId [bucketId]`
|
|
29
|
+
: Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
|
|
30
|
+
|
|
31
|
+
`--bucketName [bucketName]`
|
|
32
|
+
: Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
|
|
33
|
+
|
|
34
|
+
`--startDateTime [startDateTime]`
|
|
35
|
+
: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
|
|
36
|
+
|
|
37
|
+
`--dueDateTime [dueDateTime]`
|
|
38
|
+
: The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
|
|
39
|
+
|
|
40
|
+
`--percentComplete [percentComplete]`
|
|
41
|
+
: Percentage of task completion. Number between 0 and 100.
|
|
42
|
+
- When set to 0, the task is considered _Not started_.
|
|
43
|
+
- When set between 1 and 99, the task is considered _In progress_.
|
|
44
|
+
- When set to 100, the task is considered _Completed_.
|
|
45
|
+
|
|
46
|
+
`--assignedToUserIds [assignedToUserIds]`
|
|
47
|
+
: The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
|
|
48
|
+
|
|
49
|
+
`--assignedToUserNames [assignedToUserNames]`
|
|
50
|
+
: The comma-separated UPNs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
|
|
51
|
+
|
|
52
|
+
`--description [description]`
|
|
53
|
+
: Description of the task
|
|
54
|
+
|
|
55
|
+
`--orderHint [orderHint]`
|
|
56
|
+
: 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).
|
|
57
|
+
|
|
58
|
+
--8<-- "docs/cmd/_global.md"
|
|
59
|
+
|
|
60
|
+
## Examples
|
|
61
|
+
|
|
62
|
+
Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
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_
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
|
|
78
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# planner task details get
|
|
2
|
+
|
|
3
|
+
Retrieve the details of the specified planner task
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner task details get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --taskId <taskId>`
|
|
14
|
+
: ID of the task to retrieve details from
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
Retrieve the details of the specified planner task
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
|
|
24
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# planner task get
|
|
2
|
+
|
|
3
|
+
Retrieve the the specified planner task
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner task get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --id <id>`
|
|
14
|
+
: ID of the task to retrieve details from
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Remarks
|
|
19
|
+
|
|
20
|
+
!!! attention
|
|
21
|
+
This command uses an API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
|
|
22
|
+
|
|
23
|
+
## Examples
|
|
24
|
+
|
|
25
|
+
Retrieve the the specified planner task
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
|
|
29
|
+
```
|
|
@@ -30,6 +30,11 @@ m365 planner task list [options]
|
|
|
30
30
|
|
|
31
31
|
--8<-- "docs/cmd/_global.md"
|
|
32
32
|
|
|
33
|
+
## Remarks
|
|
34
|
+
|
|
35
|
+
!!! attention
|
|
36
|
+
This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
|
|
37
|
+
|
|
33
38
|
## Examples
|
|
34
39
|
|
|
35
40
|
List tasks for the currently logged in user
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# planner task set
|
|
2
|
+
|
|
3
|
+
Updates a Microsoft Planner task
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner task set [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --id <id>`
|
|
14
|
+
: ID of the task.
|
|
15
|
+
|
|
16
|
+
`-t, --title [title]`
|
|
17
|
+
: New title of the task.
|
|
18
|
+
|
|
19
|
+
`--bucketId [bucketId]`
|
|
20
|
+
: ID of the bucket to move the task to. Specify either `bucketId` or `bucketName` but not both.
|
|
21
|
+
|
|
22
|
+
`--bucketName [bucketName]`
|
|
23
|
+
: Name of the bucket to move the task to. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
|
|
24
|
+
|
|
25
|
+
`--planId [planId]`
|
|
26
|
+
: ID of the plan to move the task to. Specify either `planId` or `planName` but not both.
|
|
27
|
+
|
|
28
|
+
`--planName [planName]`
|
|
29
|
+
: Name of the plan to move the task to. Specify either `planId` or `planName` but not both.
|
|
30
|
+
|
|
31
|
+
`--ownerGroupId [ownerGroupId]`
|
|
32
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
33
|
+
|
|
34
|
+
`--ownerGroupName [ownerGroupName]`
|
|
35
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
36
|
+
|
|
37
|
+
`--startDateTime [startDateTime]`
|
|
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`
|
|
39
|
+
|
|
40
|
+
`--dueDateTime [dueDateTime]`
|
|
41
|
+
: The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
|
|
42
|
+
|
|
43
|
+
`--percentComplete [percentComplete]`
|
|
44
|
+
: Percentage of task completion. Number between 0 and 100.
|
|
45
|
+
|
|
46
|
+
`--assignedToUserIds [assignedToUserIds]`
|
|
47
|
+
: Comma-separated IDs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
|
|
48
|
+
|
|
49
|
+
`--assignedToUserNames [assignedToUserNames]`
|
|
50
|
+
: Comma-separated UPNs of the assignees that should be added to the task assignment. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
|
|
51
|
+
|
|
52
|
+
`--description [description]`
|
|
53
|
+
: Description of the task
|
|
54
|
+
|
|
55
|
+
`--orderHint [orderHint]`
|
|
56
|
+
: Hint used to order items of this type in a list view
|
|
57
|
+
|
|
58
|
+
`--assigneePriority [assigneePriority]`
|
|
59
|
+
: Hint used to order items of this type in a list view
|
|
60
|
+
|
|
61
|
+
`--appliedCategories [appliedCategories]`
|
|
62
|
+
: Comma-separated categories that should be added to the task
|
|
63
|
+
|
|
64
|
+
--8<-- "docs/cmd/_global.md"
|
|
65
|
+
|
|
66
|
+
## Remarks
|
|
67
|
+
|
|
68
|
+
When you specify the value for `percentageComplete`, consider the following:
|
|
69
|
+
|
|
70
|
+
- when set to 0, the task is considered _Not started_
|
|
71
|
+
- when set between 1 and 99, the task is considered _In progress_
|
|
72
|
+
- when set to 100, the task is considered _Completed_
|
|
73
|
+
|
|
74
|
+
You can add up to 6 categories to the task. An example to add _category1_ and _category3_ would be `category1,category3`.
|
|
75
|
+
|
|
76
|
+
## Examples
|
|
77
|
+
|
|
78
|
+
Updates a Microsoft Planner task name to _My Planner Task_ for the task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_
|
|
79
|
+
|
|
80
|
+
```sh
|
|
81
|
+
m365 planner task set --id "Z-RLQGfppU6H3663DBzfs5gAMD3o" --title "My Planner Task"
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Moves a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ to the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_
|
|
85
|
+
|
|
86
|
+
```sh
|
|
87
|
+
m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Marks a Microsoft Planner task with the ID _Z-RLQGfppU6H3663DBzfs5gAMD3o_ as 50% complete and assigned to categories 1 and 3.
|
|
91
|
+
|
|
92
|
+
```sh
|
|
93
|
+
m365 planner task set --id "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --percentComplete 50 --appliedCategories "category1,category3"
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Additional information
|
|
97
|
+
|
|
98
|
+
- Using order hints in Planner: [https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0](https://docs.microsoft.com/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0)
|
|
99
|
+
- Applied categories in Planner: [https://docs.microsoft.com/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/resources/plannerappliedcategories?view=graph-rest-1.0)
|
|
@@ -30,14 +30,14 @@ The `id` must be at least 3 and no more than 32 characters long. It can contain
|
|
|
30
30
|
|
|
31
31
|
## Examples
|
|
32
32
|
|
|
33
|
-
Adds a new external connection with name and description of test
|
|
33
|
+
Adds a new external connection with name and description of test app
|
|
34
34
|
|
|
35
35
|
```sh
|
|
36
|
-
m365 search externalconnection add --id MyApp --name "
|
|
36
|
+
m365 search externalconnection add --id MyApp --name "Test" --description "Test"
|
|
37
37
|
```
|
|
38
38
|
|
|
39
39
|
Adds a new external connection with a limited number of authorized apps
|
|
40
40
|
|
|
41
41
|
```sh
|
|
42
|
-
m365 search externalconnection add --id MyApp --name "
|
|
42
|
+
m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
|
|
43
43
|
```
|
|
@@ -13,24 +13,46 @@ m365 spo group user add [options]
|
|
|
13
13
|
`-u, --webUrl <webUrl>`
|
|
14
14
|
: URL of the site where the SharePoint group is available
|
|
15
15
|
|
|
16
|
-
`--groupId
|
|
17
|
-
: Id of the SharePoint Group to which user needs to be added
|
|
16
|
+
`--groupId [groupId]`
|
|
17
|
+
: Id of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
|
|
18
18
|
|
|
19
|
-
`--
|
|
20
|
-
:
|
|
19
|
+
`--groupName [groupName]`
|
|
20
|
+
: Name of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
|
|
21
|
+
|
|
22
|
+
`--userName [userName]`
|
|
23
|
+
: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
|
|
24
|
+
|
|
25
|
+
`--email [email]`
|
|
26
|
+
: User's email (eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
|
|
21
27
|
|
|
22
28
|
--8<-- "docs/cmd/_global.md"
|
|
23
29
|
|
|
30
|
+
## Remarks
|
|
31
|
+
|
|
32
|
+
For the `--userName` or `--email` options you can specify multiple values by separating them with a comma. If one of the specified entries is not valid, the command will fail with an error message showing the list invalid values.
|
|
33
|
+
|
|
24
34
|
## Examples
|
|
25
35
|
|
|
26
|
-
Add a user to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
36
|
+
Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
27
37
|
|
|
28
38
|
```sh
|
|
29
39
|
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
|
|
30
40
|
```
|
|
31
41
|
|
|
32
|
-
Add multiple users to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
42
|
+
Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
33
43
|
|
|
34
44
|
```sh
|
|
35
45
|
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
|
|
36
46
|
```
|
|
47
|
+
|
|
48
|
+
Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
|
|
58
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# spo group user remove
|
|
2
|
+
|
|
3
|
+
Removes the specified user from a SharePoint group
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo group user remove [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the SharePoint group is available
|
|
15
|
+
|
|
16
|
+
`--groupId [groupId]`
|
|
17
|
+
: Id of the SharePoint group from which user has to be removed from. Use either `groupName` or `groupId`, but not both
|
|
18
|
+
|
|
19
|
+
`--groupName [groupName]`
|
|
20
|
+
: Name of the SharePoint group from which user has to be removed from. Use either `groupName` or `groupId`, but not both
|
|
21
|
+
|
|
22
|
+
`--userName <userName>`
|
|
23
|
+
: User's UPN (user principal name, eg. megan.bowen@contoso.com).
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Remove a user from SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 spo group user remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Remove a user from SharePoint group with Name _Site A Visitors_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo group user remove --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Site A Visitors" --userName "Alex.Wilber@contoso.com"
|
|
39
|
+
```
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# spo site recyclebinitem list
|
|
2
|
+
|
|
3
|
+
Lists items from recycle bin
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo site recyclebinitem list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --siteUrl <siteUrl>`
|
|
14
|
+
: URL of the site for which to retrieve the recycle bin items
|
|
15
|
+
|
|
16
|
+
`--type [type]`
|
|
17
|
+
: Type of items which should be retrieved (listItems, folders, files)
|
|
18
|
+
|
|
19
|
+
`--secondary`
|
|
20
|
+
: Use this switch to retrieve items from secondary recycle bin
|
|
21
|
+
|
|
22
|
+
--8<-- "docs/cmd/_global.md"
|
|
23
|
+
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
When type is not specified then the command will return all items in the recycle bin
|
|
27
|
+
|
|
28
|
+
## Examples
|
|
29
|
+
|
|
30
|
+
Lists all files, items and folders from recycle bin for site _https://contoso.sharepoint.com/site_
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Lists only files from recycle bin for site _https://contoso.sharepoint.com/site_
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site --type files
|
|
40
|
+
```
|