@pnp/cli-microsoft365 5.3.0-beta.f028e14 → 5.3.0
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/.eslintrc.js +1 -0
- package/dist/Auth.js +5 -0
- package/dist/m365/aad/commands/app/app-add.js +91 -35
- package/dist/m365/aad/commands/app/app-role-list.js +1 -1
- package/dist/m365/aad/commands/app/app-set.js +91 -0
- package/dist/m365/aad/commands/approleassignment/approleassignment-list.js +55 -22
- package/dist/m365/aad/commands/group/group-list.js +1 -1
- package/dist/m365/aad/commands/groupsetting/groupsetting-list.js +1 -1
- package/dist/m365/aad/commands/groupsettingtemplate/groupsettingtemplate-get.js +1 -1
- package/dist/m365/aad/commands/groupsettingtemplate/groupsettingtemplate-list.js +1 -1
- package/dist/m365/aad/commands/o365group/o365group-conversation-list.js +1 -1
- package/dist/m365/aad/commands/o365group/o365group-conversation-post-list.js +1 -1
- package/dist/m365/aad/commands/o365group/o365group-list.js +1 -1
- package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-clear.js +3 -3
- package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-list.js +1 -1
- package/dist/m365/aad/commands/o365group/o365group-user-list.js +2 -2
- package/dist/m365/aad/commands/o365group/o365group-user-set.js +2 -2
- package/dist/m365/aad/commands/user/user-list.js +1 -1
- package/dist/m365/aad/commands/user/user-signin-list.js +1 -1
- package/dist/m365/aad/commands.js +1 -1
- package/dist/m365/app/commands/app-open.js +64 -0
- package/dist/m365/app/commands.js +1 -0
- package/dist/m365/base/PowerBICommand.js +10 -0
- package/dist/m365/file/commands/file-list.js +1 -1
- package/dist/m365/outlook/commands/message/message-list.js +1 -1
- package/dist/m365/outlook/commands/room/room-list.js +1 -1
- package/dist/m365/outlook/commands/roomlist/roomlist-list.js +1 -1
- package/dist/m365/planner/commands/bucket/bucket-add.js +8 -16
- package/dist/m365/planner/commands/bucket/bucket-get.js +186 -0
- package/dist/m365/planner/commands/bucket/bucket-list.js +10 -19
- package/dist/m365/planner/commands/bucket/bucket-remove.js +8 -20
- package/dist/m365/planner/commands/bucket/bucket-set.js +9 -21
- package/dist/m365/planner/commands/plan/plan-add.js +6 -1
- package/dist/m365/planner/commands/plan/plan-details-get.js +12 -15
- package/dist/m365/planner/commands/plan/plan-get.js +13 -18
- package/dist/m365/planner/commands/plan/plan-list.js +10 -13
- package/dist/m365/planner/commands/task/task-add.js +8 -16
- package/dist/m365/planner/commands/task/task-details-get.js +6 -0
- package/dist/m365/planner/commands/task/task-get.js +138 -7
- package/dist/m365/planner/commands/task/task-list.js +15 -24
- package/dist/m365/planner/commands/task/task-reference-add.js +75 -0
- package/dist/m365/planner/commands/task/task-reference-list.js +45 -0
- package/dist/m365/planner/commands/task/task-set.js +9 -18
- package/dist/m365/planner/commands.js +4 -1
- package/dist/m365/pp/commands/gateway/gateway-list.js +36 -0
- package/dist/m365/pp/commands/managementapp/managementapp-list.js +1 -1
- package/dist/m365/pp/commands.js +1 -0
- package/dist/m365/search/commands/externalconnection/externalconnection-list.js +26 -0
- package/dist/m365/search/commands.js +2 -1
- package/dist/m365/spo/commands/eventreceiver/eventreceiver-get.js +119 -0
- package/dist/m365/spo/commands/field/field-list.js +84 -0
- package/dist/m365/spo/commands/list/list-roleinheritance-break.js +84 -0
- package/dist/m365/spo/commands/list/list-roleinheritance-reset.js +76 -0
- package/dist/m365/spo/commands/list/list-view-add.js +113 -0
- package/dist/m365/spo/commands/listitem/listitem-roleinheritance-break.js +83 -0
- package/dist/m365/spo/commands/listitem/listitem-roleinheritance-reset.js +79 -0
- package/dist/m365/spo/commands/roledefinition/roledefinition-list.js +49 -0
- package/dist/m365/spo/commands.js +8 -0
- package/dist/m365/teams/commands/app/app-list.js +1 -1
- package/dist/m365/teams/commands/channel/channel-list.js +1 -1
- package/dist/m365/teams/commands/channel/channel-member-add.js +4 -1
- package/dist/m365/teams/commands/channel/channel-member-list.js +1 -1
- package/dist/m365/teams/commands/channel/channel-member-remove.js +3 -0
- package/dist/m365/teams/commands/channel/channel-member-set.js +3 -0
- package/dist/m365/teams/commands/chat/chat-get.js +8 -8
- package/dist/m365/teams/commands/chat/chat-list.js +1 -1
- package/dist/m365/teams/commands/chat/chat-member-list.js +1 -1
- package/dist/m365/teams/commands/chat/chat-message-list.js +1 -1
- package/dist/m365/teams/commands/chat/chat-message-send.js +6 -6
- package/dist/m365/teams/commands/chat/chatUtil.js +4 -4
- package/dist/m365/teams/commands/message/message-list.js +1 -1
- package/dist/m365/teams/commands/message/message-reply-list.js +1 -1
- package/dist/m365/teams/commands/tab/tab-list.js +1 -1
- package/dist/m365/teams/commands/team/team-list.js +1 -1
- package/dist/m365/teams/commands/user/user-app-list.js +1 -1
- package/dist/m365/teams/commands/user/user-list.js +2 -2
- package/dist/m365/tenant/commands/security/security-alerts-list.js +71 -0
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-healthissue-list.js +1 -1
- package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-message-list.js +1 -1
- package/dist/m365/tenant/commands.js +1 -0
- package/dist/m365/todo/commands/list/list-list.js +1 -1
- package/dist/m365/todo/commands/task/task-list.js +1 -1
- package/dist/utils/accessToken.js +18 -0
- package/dist/utils/formatting.js +11 -2
- package/dist/utils/odata.js +2 -2
- package/dist/utils/planner.js +65 -0
- package/docs/docs/cmd/aad/app/app-add.md +15 -0
- package/docs/docs/cmd/aad/app/app-set.md +17 -0
- package/docs/docs/cmd/aad/approleassignment/approleassignment-remove.md +1 -1
- package/docs/docs/cmd/app/app-open.md +45 -0
- package/docs/docs/cmd/planner/bucket/bucket-get.md +57 -0
- package/docs/docs/cmd/planner/task/task-get.md +30 -3
- package/docs/docs/cmd/planner/task/task-reference-add.md +45 -0
- package/docs/docs/cmd/planner/task/task-reference-list.md +24 -0
- package/docs/docs/cmd/pp/gateway/gateway-list.md +21 -0
- package/docs/docs/cmd/search/externalconnection/externalconnection-list.md +21 -0
- package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md +70 -0
- package/docs/docs/cmd/spo/field/field-list.md +51 -0
- package/docs/docs/cmd/spo/list/list-roleinheritance-break.md +55 -0
- package/docs/docs/cmd/spo/list/list-roleinheritance-reset.md +36 -0
- package/docs/docs/cmd/spo/list/list-view-add.md +67 -0
- package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-break.md +58 -0
- package/docs/docs/cmd/spo/listitem/listitem-roleinheritance-reset.md +39 -0
- package/docs/docs/cmd/spo/roledefinition/roledefinition-list.md +24 -0
- package/docs/docs/cmd/spo/userprofile/userprofile-get.md +1 -1
- package/docs/docs/cmd/teams/channel/channel-member-list.md +4 -4
- package/docs/docs/cmd/teams/channel/channel-member-remove.md +2 -2
- package/docs/docs/cmd/teams/channel/channel-member-set.md +2 -2
- package/docs/docs/cmd/tenant/security/security-alerts-list.md +30 -0
- package/npm-shrinkwrap.json +1515 -1282
- package/package.json +26 -25
|
@@ -49,6 +49,15 @@ m365 aad app add [options]
|
|
|
49
49
|
`--scopeAdminConsentDescription [scopeAdminConsentDescription]`
|
|
50
50
|
: Scope admin consent description
|
|
51
51
|
|
|
52
|
+
`--certificateFile [certificateFile]`
|
|
53
|
+
: Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
|
|
54
|
+
|
|
55
|
+
`--certificateBase64Encoded [certificateBase64Encoded]`
|
|
56
|
+
: Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
|
|
57
|
+
|
|
58
|
+
`--certificateDisplayName [certificateDisplayName]`
|
|
59
|
+
: Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
|
|
60
|
+
|
|
52
61
|
`--manifest [manifest]`
|
|
53
62
|
: Azure AD app manifest as retrieved from the Azure Portal to create the app registration from
|
|
54
63
|
|
|
@@ -152,3 +161,9 @@ Create new Azure AD app registration with the specified name. Store information
|
|
|
152
161
|
```sh
|
|
153
162
|
m365 aad app add --name 'My AAD app' --save
|
|
154
163
|
```
|
|
164
|
+
|
|
165
|
+
Create new Azure AD app registration with a certificate
|
|
166
|
+
|
|
167
|
+
```sh
|
|
168
|
+
m365 aad app add --name 'My AAD app' --certificateDisplayName "Some certificate name" --certificateFile c:\temp\some-certificate.cer
|
|
169
|
+
```
|
|
@@ -31,6 +31,15 @@ m365 aad app set [options]
|
|
|
31
31
|
`--redirectUrisToRemove [redirectUrisToRemove]`
|
|
32
32
|
: Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
|
|
33
33
|
|
|
34
|
+
`--certificateFile [certificateFile]`
|
|
35
|
+
: Path to the file with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
|
|
36
|
+
|
|
37
|
+
`--certificateBase64Encoded [certificateBase64Encoded]`
|
|
38
|
+
: Base64-encoded string with certificate public key. Specify either `certificateFile` or `certificateBase64Encoded`
|
|
39
|
+
|
|
40
|
+
`--certificateDisplayName [certificateDisplayName]`
|
|
41
|
+
: Display name for the certificate. If not given, the displayName will be set to the certificate subject. When specified, also specify either `certificateFile` or `certificateBase64Encoded`
|
|
42
|
+
|
|
34
43
|
--8<-- "docs/cmd/_global.md"
|
|
35
44
|
|
|
36
45
|
## Remarks
|
|
@@ -39,6 +48,8 @@ For best performance use the `objectId` option to reference the Azure AD applica
|
|
|
39
48
|
|
|
40
49
|
If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
|
|
41
50
|
|
|
51
|
+
When a certificate is specified it will be added to the list of certificates of the app without changing existing certificates.
|
|
52
|
+
|
|
42
53
|
## Examples
|
|
43
54
|
|
|
44
55
|
Update the app URI of the Azure AD application registration specified by its object ID
|
|
@@ -70,3 +81,9 @@ Replace one redirect URI with another for SPA authentication
|
|
|
70
81
|
```sh
|
|
71
82
|
m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
|
|
72
83
|
```
|
|
84
|
+
|
|
85
|
+
Add a certificate to the app
|
|
86
|
+
|
|
87
|
+
```sh
|
|
88
|
+
m365 aad app set --certificateDisplayName "Some certificate name" --certificateFile c:\temp\some-certificate.cer
|
|
89
|
+
```
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# aad app open
|
|
2
|
+
|
|
3
|
+
Returns deep link of the current AD app to open the Azure portal on the Azure AD app registration management page.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 app open [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--appId [appId]`
|
|
14
|
+
: Optional Application (client) ID of the Azure AD application registration to open. Uses the app from the `.m365rc.json` file corresponding to the `appId`. If multiple apps are available, this will evade the prompt to choose an app. If the `appId` is not available in the list of apps, an error is thrown.
|
|
15
|
+
|
|
16
|
+
`--preview`
|
|
17
|
+
: Use to open the url of the Azure AD preview portal.
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Remarks
|
|
22
|
+
|
|
23
|
+
If config setting `autoOpenLinksInBrowser` is configured to true, the command will automatically open the link to the Azure Portal in the browser.
|
|
24
|
+
|
|
25
|
+
Gets the app from the `.m365rc.json` file in the current directory. If the `--appId` option is not used and multiple apps are available, it will prompt the user to choose one.
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Prints the URL to the Azure AD application registration management page on the Azure Portal.
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 app open
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Prints the url of the Azure AD application registration management page on the preview Azure Portal.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 app open --preview
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Prints the URL to the Azure AD application registration management page on the Azure Portal, evading a possible choice prompt in the case of multiple saved apps in the `.m365rc.json` file.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 app open --appId d75be2e1-0204-4f95-857d-51a37cf40be8
|
|
45
|
+
```
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# planner bucket get
|
|
2
|
+
|
|
3
|
+
Gets the Microsoft Planner bucket in a plan
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner bucket get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --id [id]`
|
|
14
|
+
: ID of the bucket to retrieve details. Specify either `id` or `name` but not both.
|
|
15
|
+
|
|
16
|
+
`-name, --name [name]`
|
|
17
|
+
: Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
|
|
18
|
+
|
|
19
|
+
`--planId [planId]`
|
|
20
|
+
: Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
|
|
21
|
+
|
|
22
|
+
`--planName [planName]`
|
|
23
|
+
: Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
|
|
24
|
+
|
|
25
|
+
`--ownerGroupId [ownerGroupId]`
|
|
26
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
27
|
+
|
|
28
|
+
`--ownerGroupName [ownerGroupName]`
|
|
29
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
30
|
+
|
|
31
|
+
--8<-- "docs/cmd/_global.md"
|
|
32
|
+
|
|
33
|
+
## Examples
|
|
34
|
+
|
|
35
|
+
Gets the specified Microsoft Planner bucket
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 planner bucket get --id "5h1uuYFk4kKQ0hfoTUkRLpgALtYi"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Gets the Microsoft Planner bucket in the PlanId xqQg5FS2LkCp935s-FIFm2QAFkHM
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
|
|
57
|
+
```
|
|
@@ -10,8 +10,29 @@ m365 planner task get [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
-
`-i, --id
|
|
14
|
-
: ID of the task to
|
|
13
|
+
`-i, --id [id]`
|
|
14
|
+
: ID of the task. Specify either `id` or `title` but not both. When you specify the task ID, you no longer need to provide the information for `bucket`, `plan`, and `ownerGroup`.
|
|
15
|
+
|
|
16
|
+
`-t, --title [title]`
|
|
17
|
+
: Title of the task. Specify either `id` or `title` but not both.
|
|
18
|
+
|
|
19
|
+
`--bucketId [bucketId]`
|
|
20
|
+
: Bucket ID to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
|
|
21
|
+
|
|
22
|
+
`--bucketName [bucketName]`
|
|
23
|
+
: Bucket Name to which the task belongs. Specify `bucketId` or `bucketName` when using `title`.
|
|
24
|
+
|
|
25
|
+
`--planId [planId]`
|
|
26
|
+
: Plan ID to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
|
|
27
|
+
|
|
28
|
+
`--planName [planName]`
|
|
29
|
+
: Plan Name to which the task belongs. Specify `planId` or `planName` when using `bucketName`.
|
|
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`.
|
|
15
36
|
|
|
16
37
|
--8<-- "docs/cmd/_global.md"
|
|
17
38
|
|
|
@@ -22,8 +43,14 @@ m365 planner task get [options]
|
|
|
22
43
|
|
|
23
44
|
## Examples
|
|
24
45
|
|
|
25
|
-
Retrieve the the specified planner task
|
|
46
|
+
Retrieve the the specified planner task by id.
|
|
26
47
|
|
|
27
48
|
```sh
|
|
28
49
|
m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
|
|
29
50
|
```
|
|
51
|
+
|
|
52
|
+
Retrieve the the specified planner task with the title _My Planner Task_ from the bucket named _My Planner Bucket_. Based on the plan with the name _My Planner Plan_ owned by the group _My Planner Group_.
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
m365 planner task get --title "My Planner Task" --bucketName "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
|
|
56
|
+
```
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# planner task reference add
|
|
2
|
+
|
|
3
|
+
Adds a new reference to a Planner task.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner task reference add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --taskId <taskId>`
|
|
14
|
+
: ID of the task.
|
|
15
|
+
|
|
16
|
+
`-u, --url <url>`
|
|
17
|
+
: URL location of the reference.
|
|
18
|
+
|
|
19
|
+
`--alias [alias]`
|
|
20
|
+
: A name alias to describe the reference.
|
|
21
|
+
|
|
22
|
+
`--type [type]`
|
|
23
|
+
: Used to describe the type of the reference. Types include: `PowerPoint`, `Word`, `Excel`, `Other`.
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Add a new reference with the url _https://www.microsoft.com_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Add a new reference with the url _https://www.microsoft.com_ and with the alias _Parker_ to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --alias "Parker"
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Add a new reference with the url _https://www.microsoft.com_ and with the type Excel to a Planner task with the id _2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2_
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 planner task reference add --taskId "2Vf8JHgsBUiIf-nuvBtv-ZgAAYw2" --url "https://www.microsoft.com" --type "Excel"
|
|
45
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# planner task reference list
|
|
2
|
+
|
|
3
|
+
Retrieve the references associated to a Planner task.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner task reference list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --taskId <taskId>`
|
|
14
|
+
: ID of the task to retrieve references from
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Examples
|
|
19
|
+
|
|
20
|
+
Retrieve the references of the specified planner task
|
|
21
|
+
|
|
22
|
+
```sh
|
|
23
|
+
m365 planner task reference list --taskId uBk5fK_MHkeyuPYlCo4OFpcAM
|
|
24
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# pp gateway list
|
|
2
|
+
|
|
3
|
+
Returns a list of gateways for which the user is an admin
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 pp gateway list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
--8<-- "docs/cmd/_global.md"
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
|
|
17
|
+
List gateways for which the user is an admin
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
m365 pp gateway list
|
|
21
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# search externalconnection list
|
|
2
|
+
|
|
3
|
+
Lists external connections defined in Microsoft Search
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 search externalconnection list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
--8<-- "docs/cmd/_global.md"
|
|
14
|
+
|
|
15
|
+
## Examples
|
|
16
|
+
|
|
17
|
+
List external connections defined in Microsoft Search
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
m365 search externalconnection list
|
|
21
|
+
```
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# spo eventreceiver get
|
|
2
|
+
|
|
3
|
+
Retrieves specific event receiver for the specified web, site or list by event receiver name or id.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo eventreceiver get [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The URL of the web for which to retrieve the event receivers.
|
|
15
|
+
|
|
16
|
+
`--listTitle [listTitle]`
|
|
17
|
+
: The title of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
|
|
18
|
+
Specify either `listTitle`, `listId` or `listUrl`.
|
|
19
|
+
|
|
20
|
+
`--listId [listId]`
|
|
21
|
+
: The id of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
|
|
22
|
+
Specify either `listTitle`, `listId` or `listUrl`.
|
|
23
|
+
|
|
24
|
+
`--listUrl [listUrl]`
|
|
25
|
+
: The url of the list for which to retrieve the event receivers, _if the event receivers should be retrieved from a list_.
|
|
26
|
+
Specify either `listTitle`, `listId` or `listUrl`.
|
|
27
|
+
|
|
28
|
+
`-n, --name [name]`
|
|
29
|
+
The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
|
|
30
|
+
|
|
31
|
+
`-i, --id [id]`
|
|
32
|
+
The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
|
|
33
|
+
|
|
34
|
+
`-s, --scope [scope]`
|
|
35
|
+
: The scope of which to retrieve the Event Receivers.
|
|
36
|
+
Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
|
|
37
|
+
|
|
38
|
+
--8<-- "docs/cmd/_global.md"
|
|
39
|
+
|
|
40
|
+
## Examples
|
|
41
|
+
|
|
42
|
+
Retrieve event receivers in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Retrieve event receivers in site _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Retrieve event receivers for list with title _Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Retrieve event receivers for list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with id _c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec_.
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Retrieve event receivers for list with url _/sites/contoso-sales/lists/Events_ in web _<https://contoso.sharepoint.com/sites/contoso-sales>_ with name _PnP Test Receiver_.
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
m365 spo eventreceiver list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
|
|
70
|
+
```
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# spo field list
|
|
2
|
+
|
|
3
|
+
Retrieves columns for the specified list or site
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo field list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: Absolute URL of the site where fields are located
|
|
15
|
+
|
|
16
|
+
`-t, --listTitle [listTitle]`
|
|
17
|
+
: Title of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
|
|
18
|
+
|
|
19
|
+
`-i --listId [listId]`
|
|
20
|
+
: ID of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Server- or web-relative URL of the list where fields are located. Specify `listTitle`, `listId` or `listUrl`
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Retrieves site columns for site _https://contoso.sharepoint.com/sites/contoso-sales_.
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Retrieves list columns for list _Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Retrieves list columns for list _202b8199-b9de-43fd-9737-7f213f51c991_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991'
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Retrieves list columns for list _/sites/contoso-sales/lists/Events_ in site _https://contoso.sharepoint.com/sites/contoso-sales_
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 spo field list --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events'
|
|
51
|
+
```
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# spo list roleinheritance break
|
|
2
|
+
|
|
3
|
+
Breaks role inheritance on list or library
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo list roleinheritance break [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the list to retrieve is located
|
|
15
|
+
|
|
16
|
+
`-i, --listId [listId]`
|
|
17
|
+
: ID of the list to retrieve information for. Specify either id or title but not both
|
|
18
|
+
|
|
19
|
+
`-t, --listTitle [listTitle]`
|
|
20
|
+
: Title of the list to retrieve information for. Specify either id or title but not both
|
|
21
|
+
|
|
22
|
+
`-c, --clearExistingPermissions`
|
|
23
|
+
: Flag if used clears all roles from the list
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
By default, when breaking permissions inheritance, the list will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
|
|
30
|
+
|
|
31
|
+
## Examples
|
|
32
|
+
|
|
33
|
+
Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991"
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Break inheritance of list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
|
|
46
|
+
|
|
47
|
+
```sh
|
|
48
|
+
m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "someList" --clearExistingPermissions
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Break inheritance of list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
m365 spo list roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listId "202b8199-b9de-43fd-9737-7f213f51c991" --clearExistingPermissions
|
|
55
|
+
```
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# spo list roleinheritance reset
|
|
2
|
+
|
|
3
|
+
Restores role inheritance on list or library
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo list roleinheritance reset [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the list is located
|
|
15
|
+
|
|
16
|
+
`-i, --listId [listId]`
|
|
17
|
+
: ID of the list. Specify either id or title but not both
|
|
18
|
+
|
|
19
|
+
`-t, --listTitle [listTitle]`
|
|
20
|
+
: Title of the list. Specify either id or title but not both
|
|
21
|
+
|
|
22
|
+
--8<-- "docs/cmd/_global.md"
|
|
23
|
+
|
|
24
|
+
## Examples
|
|
25
|
+
|
|
26
|
+
Restore role inheritance of list with ID _0cd891ef-afce-4e55-b836-fce03286cccf_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Restore role inheritance of list with title _test_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 spo list roleinheritance reset --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle test
|
|
36
|
+
```
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# spo list view add
|
|
2
|
+
|
|
3
|
+
Adds a new view to a SharePoint list
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo list view add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the list is located.
|
|
15
|
+
|
|
16
|
+
`--listId [listId]`
|
|
17
|
+
: ID of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
|
|
18
|
+
|
|
19
|
+
`--listTitle [listTitle]`
|
|
20
|
+
: Title of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
|
|
21
|
+
|
|
22
|
+
`--listUrl [listUrl]`
|
|
23
|
+
: Relative URL of the list to which the view should be added. Specify either `listId`, `listTitle` or `listUrl` but not multiple.
|
|
24
|
+
|
|
25
|
+
`--title <title>`
|
|
26
|
+
: Title of the view to be created for the list.
|
|
27
|
+
|
|
28
|
+
`--fields <fields>`
|
|
29
|
+
: Comma-separated list of **case-sensitive** internal names of the fields to add to the view.
|
|
30
|
+
|
|
31
|
+
`--personal`
|
|
32
|
+
: View will be created as personal view, if specified.
|
|
33
|
+
|
|
34
|
+
`--default`
|
|
35
|
+
: View will be set as default view, if specified.
|
|
36
|
+
|
|
37
|
+
`--paged`
|
|
38
|
+
: View supports paging, if specified (recommended to use this).
|
|
39
|
+
|
|
40
|
+
`--rowLimit [rowLimit]`
|
|
41
|
+
: Sets the number of items to display for the view. Default value is 30.
|
|
42
|
+
|
|
43
|
+
--8<-- "docs/cmd/_global.md"
|
|
44
|
+
|
|
45
|
+
## Remarks
|
|
46
|
+
|
|
47
|
+
We recommend using the `paged` option. When specified, the view supports displaying more items page by page (default behavior). When not specified, the `rowLimit` is absolute, and there is no link to see more items.
|
|
48
|
+
|
|
49
|
+
## Examples
|
|
50
|
+
|
|
51
|
+
Add a view called _All events_ to a list with specific title.
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "My List" --title "All events" --fields "FieldName1,FieldName2,Created,Author,Modified,Editor" --paged
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Add a view as default view with title _All events_ to a list with a specific URL.
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl "/Lists/MyList" --title "All events" --fields "FieldName1,Created" --paged --default
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Add a personal view called _All events_ to a list with a specific ID.
|
|
64
|
+
|
|
65
|
+
```sh
|
|
66
|
+
spo list view add --webUrl https://contoso.sharepoint.com/sites/project-x --listId 00000000-0000-0000-0000-000000000000 --title "All events" --fields "FieldName1,Created" --paged --personal
|
|
67
|
+
```
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# spo listitem roleinheritance break
|
|
2
|
+
|
|
3
|
+
Break inheritance of list item.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo listitem roleinheritance break [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: URL of the site where the item for which to break role inheritance is located
|
|
15
|
+
|
|
16
|
+
`--listItemId <listItemId>`
|
|
17
|
+
: ID of the item for which to break role inheritance
|
|
18
|
+
|
|
19
|
+
`-l, --listId [listId]`
|
|
20
|
+
: ID of the list. Specify listId or listTitle but not both
|
|
21
|
+
|
|
22
|
+
`-t, --listTitle [listTitle]`
|
|
23
|
+
Title of the list. Specify listId or listTitle but not both
|
|
24
|
+
|
|
25
|
+
`-c, --clearExistingPermissions`
|
|
26
|
+
: Set to clear existing roles from the list item
|
|
27
|
+
|
|
28
|
+
--8<-- "docs/cmd/_global.md"
|
|
29
|
+
|
|
30
|
+
## Remarks
|
|
31
|
+
|
|
32
|
+
By default, when breaking permissions inheritance, the list item will retain existing permissions. To remove existing permissions, use the `--clearExistingPermissions` option.
|
|
33
|
+
|
|
34
|
+
## Examples
|
|
35
|
+
|
|
36
|
+
Break inheritance of list item _1_ in list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --id 1
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --id 1
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Break inheritance of list item _1_ in list _someList_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
m365 spo listitem roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --listTitle "_someList_" --id 1 --clearExistingPermissions
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Break inheritance of list item _1_ in list with ID _202b8199-b9de-43fd-9737-7f213f51c991_ located in site _https://contoso.sharepoint.com/sites/project-x_ with clearing permissions
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
m365 spo listitem roleinheritance break --webUrl https://contoso.sharepoint.com/sites/project-x --listId 202b8199-b9de-43fd-9737-7f213f51c991 --id 1 --clearExistingPermissions
|
|
58
|
+
```
|