@pnp/cli-microsoft365 9.1.0 → 10.0.0-beta.0b765ef
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/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/cli/cli.js +1 -1
- package/dist/m365/app/commands/permission/permission-add.js +9 -9
- package/dist/m365/cli/commands/cli-consent.js +3 -7
- package/dist/m365/cli/commands/cli-doctor.js +2 -2
- package/dist/m365/cli/commands/config/config-set.js +0 -1
- package/dist/m365/cli/commands.js +1 -2
- package/dist/m365/commands/setupPresets.js +2 -4
- package/dist/m365/commands/status.js +2 -2
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
- package/dist/m365/entra/commands/group/{group-user-add.js → group-member-add.js} +18 -18
- package/dist/m365/entra/commands/group/{group-user-list.js → group-member-list.js} +21 -21
- package/dist/m365/entra/commands/group/{group-user-set.js → group-member-set.js} +19 -19
- package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
- package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
- package/dist/m365/entra/commands/m365group/m365group-set.js +24 -16
- package/dist/m365/entra/commands/m365group/m365group-user-add.js +5 -12
- package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
- package/dist/m365/entra/commands/oauth2grant/oauth2grant-list.js +3 -12
- package/dist/m365/entra/commands.js +3 -3
- package/dist/m365/flow/commands/environment/environment-list.js +1 -1
- package/dist/m365/outlook/commands/message/message-get.js +11 -11
- package/dist/m365/pa/commands/app/app-list.js +1 -6
- package/dist/m365/pa/commands/connector/connector-list.js +1 -6
- package/dist/m365/pa/commands/environment/environment-list.js +1 -1
- package/dist/m365/pp/commands/environment/environment-list.js +1 -1
- package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
- package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
- package/dist/m365/spo/commands/app/app-instance-list.js +3 -18
- package/dist/m365/spo/commands/app/app-list.js +1 -8
- package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +0 -1
- package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +8 -8
- package/dist/m365/spo/commands/contenttype/contenttype-field-set.js +2 -2
- package/dist/m365/spo/commands/feature/feature-list.js +1 -8
- package/dist/m365/spo/commands/file/file-copy.js +59 -34
- package/dist/m365/spo/commands/file/file-move.js +55 -33
- package/dist/m365/spo/commands/folder/folder-set.js +0 -4
- package/dist/m365/spo/commands/list/list-list.js +1 -4
- package/dist/m365/spo/commands/list/list-webhook-list.js +1 -6
- package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +1 -8
- package/dist/m365/spo/commands/page/page-list.js +1 -1
- package/dist/m365/spo/commands/page/page-template-list.js +1 -3
- package/dist/m365/spo/commands/site/site-appcatalog-remove.js +48 -24
- package/dist/m365/spo/commands/site/site-remove.js +1 -7
- package/dist/m365/spo/commands/sitescript/sitescript-get.js +3 -2
- package/dist/m365/spo/commands/sitescript/sitescript-list.js +1 -3
- package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
- package/dist/m365/spo/commands/{site/site-rename.js → tenant/tenant-site-rename.js} +29 -32
- package/dist/m365/spo/commands/theme/theme-list.js +1 -1
- package/dist/m365/spo/commands/web/web-clientsidewebpart-list.js +1 -6
- package/dist/m365/spo/commands.js +1 -2
- package/dist/m365/teams/commands/tab/tab-list.js +5 -3
- package/dist/m365/viva/commands/engage/engage-group-list.js +0 -5
- package/dist/m365/viva/commands/engage/engage-group-user-add.js +0 -5
- package/dist/m365/viva/commands/engage/engage-group-user-remove.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-add.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-get.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-like-set.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-list.js +0 -5
- package/dist/m365/viva/commands/engage/engage-message-remove.js +0 -5
- package/dist/m365/viva/commands/engage/engage-network-list.js +0 -5
- package/dist/m365/viva/commands/engage/engage-report-activitycounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-activityusercounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-activityuserdetail.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-deviceusagedistributionusercounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-deviceusageusercounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-deviceusageuserdetail.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-groupsactivitycounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-groupsactivitydetail.js +0 -8
- package/dist/m365/viva/commands/engage/engage-report-groupsactivitygroupcounts.js +0 -8
- package/dist/m365/viva/commands/engage/engage-search.js +0 -5
- package/dist/m365/viva/commands/engage/engage-user-get.js +0 -5
- package/dist/m365/viva/commands/engage/engage-user-list.js +0 -5
- package/dist/settingsNames.js +0 -1
- package/dist/utils/spo.js +76 -0
- package/docs/docs/_clisettings.mdx +0 -1
- package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
- package/docs/docs/cmd/cli/cli-consent.mdx +1 -1
- package/docs/docs/cmd/cli/cli-doctor.mdx +24 -23
- package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
- package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
- package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
- package/docs/docs/cmd/entra/group/group-member-add.mdx +62 -0
- package/docs/docs/cmd/entra/group/{group-user-list.mdx → group-member-list.mdx} +17 -17
- package/docs/docs/cmd/entra/group/group-member-set.mdx +62 -0
- package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
- package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
- package/docs/docs/cmd/entra/m365group/m365group-set.mdx +9 -6
- package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +0 -3
- package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
- package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
- package/docs/docs/cmd/setup.mdx +1 -3
- package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +6 -5
- package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +7 -7
- package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-copy.mdx +119 -12
- package/docs/docs/cmd/spo/file/file-move.mdx +116 -9
- package/docs/docs/cmd/spo/folder/folder-set.mdx +0 -6
- package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
- package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +11 -2
- package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
- package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +14 -1
- package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
- package/docs/docs/cmd/spo/{site/site-rename.mdx → tenant/tenant-site-rename.mdx} +7 -7
- package/docs/docs/cmd/teams/tab/tab-list.mdx +1 -2
- package/npm-shrinkwrap.json +2 -2
- package/package.json +2 -2
- package/dist/m365/cli/commands/cli-reconsent.js +0 -29
- package/dist/m365/viva/commands/engage/yammerCommands.js +0 -25
- package/docs/docs/cmd/cli/cli-reconsent.mdx +0 -62
- package/docs/docs/cmd/entra/group/group-user-add.mdx +0 -62
- package/docs/docs/cmd/entra/group/group-user-set.mdx +0 -62
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
|
|
3
|
+
# entra group member set
|
|
4
|
+
|
|
5
|
+
Updates role of members in a Microsoft Entra ID group
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
m365 entra group member set [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Options
|
|
14
|
+
|
|
15
|
+
```md definition-list
|
|
16
|
+
`-i, --groupId [groupId]`
|
|
17
|
+
: The ID of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.
|
|
18
|
+
|
|
19
|
+
`-n, --groupDisplayName [groupDisplayName]`
|
|
20
|
+
: The display name of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.
|
|
21
|
+
|
|
22
|
+
`--ids [ids]`
|
|
23
|
+
: Comma-separated list of user IDs. Specify either `ids` or `userNames` but not both.
|
|
24
|
+
|
|
25
|
+
`--userNames [userNames]`
|
|
26
|
+
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.
|
|
27
|
+
|
|
28
|
+
`-r, --role <role>`
|
|
29
|
+
: The new role to be assigned to the members. Valid values: `Owner`, `Member`.
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
<Global />
|
|
33
|
+
|
|
34
|
+
## Examples
|
|
35
|
+
|
|
36
|
+
Update a single member specified by ID to a member of a group specified by display name
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
m365 entra group member set --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Update multiple members specified by ID to members of a group specified by ID
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Update a single member specified by UPN to an owner of a group specified by display name
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
m365 entra group member set --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Update multiple members specified by UPN to owners of a group specified by ID
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "john.doe@contoso.com,adele.vance@contoso.com" --role Owner
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Response
|
|
61
|
+
|
|
62
|
+
The command won't return a response on success.
|
|
@@ -22,10 +22,10 @@ m365 aad m365group conversation post list [options]
|
|
|
22
22
|
|
|
23
23
|
```md definition-list
|
|
24
24
|
`-i, --groupId [groupId]`
|
|
25
|
-
: The Id of the Microsoft 365 Group. You can specify the groupId or
|
|
25
|
+
: The Id of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
|
|
26
26
|
|
|
27
|
-
`-d, --
|
|
28
|
-
: The Displayname of the Microsoft 365 Group. You can specify the groupId or
|
|
27
|
+
`-d, --groupName [groupName]`
|
|
28
|
+
: The Displayname of the Microsoft 365 Group. You can specify the groupId or groupName, but not both.
|
|
29
29
|
|
|
30
30
|
`-t, --threadId <threadId>`
|
|
31
31
|
: The ID of the thread to retrieve details for
|
|
@@ -41,10 +41,10 @@ Lists the posts of the specific conversation of Microsoft 365 group by groupId
|
|
|
41
41
|
m365 entra m365group conversation post list --groupId '00000000-0000-0000-0000-000000000000' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Lists the posts of the specific conversation of Microsoft 365 group by
|
|
44
|
+
Lists the posts of the specific conversation of Microsoft 365 group by groupName
|
|
45
45
|
|
|
46
46
|
```sh
|
|
47
|
-
m365 entra m365group conversation post list --
|
|
47
|
+
m365 entra m365group conversation post list --groupName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
## Response
|
|
@@ -21,7 +21,7 @@ m365 aad m365group recyclebinitem list [options]
|
|
|
21
21
|
## Options
|
|
22
22
|
|
|
23
23
|
```md definition-list
|
|
24
|
-
`-d, --
|
|
24
|
+
`-d, --groupName [groupName]`
|
|
25
25
|
: Lists groups with DisplayName starting with the specified value
|
|
26
26
|
|
|
27
27
|
`-m, --groupMailNickname [groupMailNickname]`
|
|
@@ -41,7 +41,7 @@ m365 entra m365group recyclebinitem list
|
|
|
41
41
|
List deleted Microsoft 365 Groups with display name starting with _Project_
|
|
42
42
|
|
|
43
43
|
```sh
|
|
44
|
-
m365 entra m365group recyclebinitem list --
|
|
44
|
+
m365 entra m365group recyclebinitem list --groupName Project
|
|
45
45
|
```
|
|
46
46
|
|
|
47
47
|
List deleted Microsoft 365 Groups mail nick name starting with _team_
|
|
@@ -53,7 +53,7 @@ m365 entra m365group recyclebinitem list --groupMailNickname team
|
|
|
53
53
|
List deleted Microsoft 365 Groups mail nick name starting with _team_ and with display name starting with _Project_
|
|
54
54
|
|
|
55
55
|
```sh
|
|
56
|
-
m365 entra m365group recyclebinitem list --groupMailNickname team --
|
|
56
|
+
m365 entra m365group recyclebinitem list --groupMailNickname team --groupName Project
|
|
57
57
|
```
|
|
58
58
|
|
|
59
59
|
## Response
|
|
@@ -19,11 +19,14 @@ m365 aad m365group set [options]
|
|
|
19
19
|
## Options
|
|
20
20
|
|
|
21
21
|
```md definition-list
|
|
22
|
-
`-i, --id
|
|
22
|
+
`-i, --id [id]`
|
|
23
23
|
: The ID of the Microsoft 365 Group to update
|
|
24
24
|
|
|
25
25
|
`-n, --displayName [displayName]`
|
|
26
|
-
: Display name
|
|
26
|
+
: Display name of the Microsoft 365 Group to update
|
|
27
|
+
|
|
28
|
+
`--newDisplayName [newDisplayName]`
|
|
29
|
+
: New display name for the Microsoft 365 Group
|
|
27
30
|
|
|
28
31
|
`-d, --description [description]`
|
|
29
32
|
: Description for the Microsoft 365 Group
|
|
@@ -72,7 +75,7 @@ Options `allowExternalSenders` and `autoSubscribeNewMembers` can only be set usi
|
|
|
72
75
|
Update Microsoft 365 Group display name.
|
|
73
76
|
|
|
74
77
|
```sh
|
|
75
|
-
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --
|
|
78
|
+
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --newDisplayName Finance
|
|
76
79
|
```
|
|
77
80
|
|
|
78
81
|
Change Microsoft 365 Group visibility to public.
|
|
@@ -81,16 +84,16 @@ Change Microsoft 365 Group visibility to public.
|
|
|
81
84
|
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate `false`
|
|
82
85
|
```
|
|
83
86
|
|
|
84
|
-
Add new Microsoft 365 Group owners.
|
|
87
|
+
Add new Microsoft 365 Group owners of group.
|
|
85
88
|
|
|
86
89
|
```sh
|
|
87
|
-
m365 entra m365group set --
|
|
90
|
+
m365 entra m365group set --displayName 'Project Team' --owners "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
|
|
88
91
|
```
|
|
89
92
|
|
|
90
93
|
Add new Microsoft 365 Group members.
|
|
91
94
|
|
|
92
95
|
```sh
|
|
93
|
-
m365 entra m365group set --
|
|
96
|
+
m365 entra m365group set --displayName 'Project Team' --members "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
|
|
94
97
|
```
|
|
95
98
|
|
|
96
99
|
Update Microsoft 365 Group logo.
|
|
@@ -37,9 +37,6 @@ m365 teams user add
|
|
|
37
37
|
`--teamName [teamName]`
|
|
38
38
|
: The display name of the Microsoft Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
39
39
|
|
|
40
|
-
`-n, --userName [userName]`
|
|
41
|
-
: (deprecated) User's UPN (User Principal Name), e.g. johndoe@example.com.
|
|
42
|
-
|
|
43
40
|
`--ids [ids]`
|
|
44
41
|
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both.
|
|
45
42
|
|
|
@@ -28,7 +28,7 @@ m365 aad m365group user list [options]
|
|
|
28
28
|
: The display name of the Microsoft 365 group. Specify `groupId` or `groupDisplayName` but not both.
|
|
29
29
|
|
|
30
30
|
`-r, --role [role]`
|
|
31
|
-
: Filter the results to only users with the given role. Allowed values: `Owner`, `Member
|
|
31
|
+
: Filter the results to only users with the given role. Allowed values: `Owner`, `Member`.
|
|
32
32
|
|
|
33
33
|
`-p, --properties [properties]`
|
|
34
34
|
: Comma-separated list of properties to retrieve.
|
|
@@ -19,10 +19,10 @@ m365 outlook message get [options]
|
|
|
19
19
|
: ID of the message.
|
|
20
20
|
|
|
21
21
|
`--userId [userId]`
|
|
22
|
-
: ID of the user from which to retrieve the message. Specify either `userId` or `
|
|
22
|
+
: ID of the user from which to retrieve the message. Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
|
|
23
23
|
|
|
24
|
-
`--
|
|
25
|
-
: UPN of the user from which to retrieve the message Specify either `userId` or `
|
|
24
|
+
`--userName [userName]`
|
|
25
|
+
: UPN of the user from which to retrieve the message Specify either `userId` or `userName`, but not both. This option is required when using application permissions.
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
<Global />
|
|
@@ -38,7 +38,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
|
|
|
38
38
|
Get a specific message using delegated permissions from a shared mailbox.
|
|
39
39
|
|
|
40
40
|
```sh
|
|
41
|
-
m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --
|
|
41
|
+
m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName sharedmailbox@tenant.com
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
Get a specific message from a specific user retrieved by user ID using application permissions.
|
|
@@ -50,7 +50,7 @@ m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYm
|
|
|
50
50
|
Get a specific message from a specific user retrieved by user principal name using application permissions.
|
|
51
51
|
|
|
52
52
|
```sh
|
|
53
|
-
m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --
|
|
53
|
+
m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userName user@tenant.com
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
## Response
|
package/docs/docs/cmd/setup.mdx
CHANGED
|
@@ -37,7 +37,7 @@ The command will ask you the following questions:
|
|
|
37
37
|
|
|
38
38
|
- _How do you plan to use the CLI?_
|
|
39
39
|
|
|
40
|
-
You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors
|
|
40
|
+
You can choose between **interactive** and **scripting** use. In interactive mode, the CLI for Microsoft 365 will prompt you for additional information when needed, automatically open links browser, automatically show help on errors. In **scripting** mode, the CLI will not use interactivity to prevent blocking your scripts.
|
|
41
41
|
|
|
42
42
|
- _Are you going to use the CLI in PowerShell?_ (asked only when you chose to configure CLI for scripting)
|
|
43
43
|
|
|
@@ -60,7 +60,6 @@ The `m365 setup` command uses the following presets:
|
|
|
60
60
|
- printErrorsAsPlainText: true,
|
|
61
61
|
- prompt: true,
|
|
62
62
|
- showHelpOnFailure: true,
|
|
63
|
-
- showSpinner: true
|
|
64
63
|
- scripting use:
|
|
65
64
|
- autoOpenLinksInBrowser: false,
|
|
66
65
|
- copyDeviceCodeToClipboard: false,
|
|
@@ -68,7 +67,6 @@ The `m365 setup` command uses the following presets:
|
|
|
68
67
|
- printErrorsAsPlainText: false,
|
|
69
68
|
- prompt: false,
|
|
70
69
|
- showHelpOnFailure: false,
|
|
71
|
-
- showSpinner: false
|
|
72
70
|
- use in PowerShell:
|
|
73
71
|
- errorOutput: 'stdout'
|
|
74
72
|
- beginner:
|
|
@@ -14,28 +14,25 @@ m365 spfx project github workflow add [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-n, --name [name]`
|
|
17
|
-
: Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'
|
|
17
|
+
: Name of the workflow that will be created. If none is specified a default name will be used 'Deploy Solution ${name of sppkg file}'.
|
|
18
18
|
|
|
19
19
|
`-b, --branchName [branchName]`
|
|
20
|
-
: Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'
|
|
20
|
+
: Specify the branch name which should trigger the workflow on push. If none is specified a default will be used which is 'main'.
|
|
21
21
|
|
|
22
22
|
`-m, --manuallyTrigger`
|
|
23
|
-
: When specified a manual trigger option will be added to the workflow: `workflow_dispatch
|
|
23
|
+
: When specified a manual trigger option will be added to the workflow: `workflow_dispatch`.
|
|
24
24
|
|
|
25
25
|
`-l, --loginMethod [loginMethod]`
|
|
26
|
-
: Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application
|
|
26
|
+
: Specify the login method used for the login action. Possible options are: `user`, `application`. Default `application`.
|
|
27
27
|
|
|
28
28
|
`-s, --scope [scope]`
|
|
29
|
-
: Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant
|
|
29
|
+
: Scope of the app catalog: `tenant`, `sitecollection`. Default is `tenant`.
|
|
30
30
|
|
|
31
31
|
`-u, --siteUrl [siteUrl]`
|
|
32
|
-
: The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection
|
|
32
|
+
: The URL of the site collection where the solution package will be added. Required if scope is set to `sitecollection`.
|
|
33
33
|
|
|
34
34
|
`--skipFeatureDeployment`
|
|
35
|
-
: When specified and the app supports tenant-wide deployment, deploy it to the whole tenant
|
|
36
|
-
|
|
37
|
-
`--overwrite`
|
|
38
|
-
: When specified the workflow will overwrite the existing .sppkg if it is already deployed in the app catalog.
|
|
35
|
+
: When specified and the app supports tenant-wide deployment, deploy it to the whole tenant.
|
|
39
36
|
```
|
|
40
37
|
|
|
41
38
|
<Global />
|
|
@@ -59,6 +56,8 @@ For the `user` login method you will need to create the following secrets in Git
|
|
|
59
56
|
|
|
60
57
|
This method is perfect to test your workflow, in a dev context, for personal usage. It will not work for accounts with MFA.
|
|
61
58
|
|
|
59
|
+
The workflow will overwrite the existing .sppkg if it is already deployed in the app catalog. Overwriting your sppkg file on every deployment is required to make continuous delivery of the latest version of your app which is the aim of the continuous delivery pipeline.
|
|
60
|
+
|
|
62
61
|
:::info
|
|
63
62
|
|
|
64
63
|
Run this command in the SPFx solution folder.
|
|
@@ -67,7 +66,7 @@ Run this command in the SPFx solution folder.
|
|
|
67
66
|
|
|
68
67
|
## Examples
|
|
69
68
|
|
|
70
|
-
Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main
|
|
69
|
+
Adds a GitHub workflow for a SharePoint Framework project with `application` login method triggered on push to main.
|
|
71
70
|
|
|
72
71
|
```sh
|
|
73
72
|
m365 spfx project github workflow add
|
|
@@ -79,7 +78,7 @@ Adds a GitHub workflow for a SharePoint Framework project with `user` login meth
|
|
|
79
78
|
m365 spfx project github workflow add --manuallyTrigger --loginMethod "user"
|
|
80
79
|
```
|
|
81
80
|
|
|
82
|
-
Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog
|
|
81
|
+
Adds a GitHub workflow for a SharePoint Framework project with deployment to a site collection app catalog.
|
|
83
82
|
|
|
84
83
|
```sh
|
|
85
84
|
m365 spfx project github workflow add --scope "sitecollection" --siteUrl "https://some.sharepoint.com/sites/someSite"
|
|
@@ -93,7 +93,10 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
|
|
|
93
93
|
"Name": "{4a428b32-08cf-45c7-9986-17585af38806}",
|
|
94
94
|
"RegistrationId": null,
|
|
95
95
|
"RegistrationType": 0,
|
|
96
|
-
"Rights":
|
|
96
|
+
"Rights": {
|
|
97
|
+
"High": 0,
|
|
98
|
+
"Low": 0
|
|
99
|
+
},
|
|
97
100
|
"Scope": "Web",
|
|
98
101
|
"ScriptBlock": null,
|
|
99
102
|
"ScriptSrc": null,
|
|
@@ -120,7 +123,6 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
|
|
|
120
123
|
Name : {4a428b32-08cf-45c7-9986-17585af38806}
|
|
121
124
|
RegistrationId : null
|
|
122
125
|
RegistrationType : 0
|
|
123
|
-
Rights : {"High":"0","Low":"0"}
|
|
124
126
|
Scope : Web
|
|
125
127
|
ScriptBlock : null
|
|
126
128
|
ScriptSrc : null
|
|
@@ -134,8 +136,8 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
|
|
|
134
136
|
<TabItem value="CSV">
|
|
135
137
|
|
|
136
138
|
```csv
|
|
137
|
-
ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,
|
|
138
|
-
9a8b100c-246b-4592-9454-67826523e159,"{""testMessage"":""Test message""}"
|
|
139
|
+
ClientSideComponentId,ClientSideComponentProperties,CommandUIExtension,Description,Group,Id,ImageUrl,Location,Name,RegistrationId,RegistrationType,Scope,ScriptBlock,ScriptSrc,Sequence,Title,Url,VersionOfUserCustomAction
|
|
140
|
+
9a8b100c-246b-4592-9454-67826523e159,"{""testMessage"":""Test message""}",,,,4a428b32-08cf-45c7-9986-17585af38806,,ClientSideExtension.ApplicationCustomizer,Some customizer,,0,Web,,,0,Some customizer,,16.0.1.0
|
|
139
141
|
```
|
|
140
142
|
|
|
141
143
|
</TabItem>
|
|
@@ -157,7 +159,6 @@ m365 spo applicationcustomizer get --id 14125658-a9bc-4ddf-9c75-1b5767c9a337 --w
|
|
|
157
159
|
Location | ClientSideExtension.ApplicationCustomizer
|
|
158
160
|
Name | {4a428b32-08cf-45c7-9986-17585af38806}
|
|
159
161
|
RegistrationType | 0
|
|
160
|
-
Rights | {"High":"0","Low":"0"}
|
|
161
162
|
Scope | Web
|
|
162
163
|
Sequence | 65536
|
|
163
164
|
Title | HelloWorld
|
|
@@ -25,10 +25,10 @@ m365 spo contenttype field remove [options]
|
|
|
25
25
|
`--listUrl [listUrl]`
|
|
26
26
|
: Server- or site-relative URL of the list (if it is a list content type). Specify either `listTitle`, `listId` or `listUrl`.
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
`--contentTypeId <contentTypeId>`
|
|
29
29
|
: The ID of the content type to remove the column from.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
`-i, --id <id>`
|
|
32
32
|
: The ID of the column to remove.
|
|
33
33
|
|
|
34
34
|
`-c, --updateChildContentTypes`
|
|
@@ -45,31 +45,31 @@ m365 spo contenttype field remove [options]
|
|
|
45
45
|
Remove column with a specific ID from a content type with a specific ID from a specific site.
|
|
46
46
|
|
|
47
47
|
```sh
|
|
48
|
-
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --
|
|
48
|
+
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --id "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --force
|
|
49
49
|
```
|
|
50
50
|
|
|
51
51
|
Remove column with a specific ID from a content type with a specific ID from a specific site and updating the child content types.
|
|
52
52
|
|
|
53
53
|
```sh
|
|
54
|
-
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --
|
|
54
|
+
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A6" --id "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --updateChildContentTypes
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
Remove fieldLink with a specific ID from a list (obtained by Title) content type with a specific ID on a specific site.
|
|
58
58
|
|
|
59
59
|
```sh
|
|
60
|
-
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --
|
|
60
|
+
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --id "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listTitle "Documents"
|
|
61
61
|
```
|
|
62
62
|
|
|
63
63
|
Remove fieldLink with a specific ID from a list (obtained by ID) content type with a specific ID on a specific site.
|
|
64
64
|
|
|
65
65
|
```sh
|
|
66
|
-
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --
|
|
66
|
+
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --id "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listId "8c7a0fcd-9d64-4634-85ea-ce2b37b2ec0c"
|
|
67
67
|
```
|
|
68
68
|
|
|
69
69
|
Remove fieldLink with a specific ID from a list (obtained by URL) content type with a specific ID on a specific site.
|
|
70
70
|
|
|
71
71
|
```sh
|
|
72
|
-
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --
|
|
72
|
+
m365 spo contenttype field remove --contentTypeId "0x0100CA0FA0F5DAEF784494B9C6020C3020A60062F089A38C867747942DB2C3FC50FF6A" --id "880d2f46-fccb-43ca-9def-f88e722cef80" --webUrl https://contoso.sharepoint.com --listUrl "/shared documents"
|
|
73
73
|
```
|
|
74
74
|
|
|
75
75
|
## Response
|
|
@@ -16,10 +16,10 @@ m365 spo contenttype field set [options]
|
|
|
16
16
|
`-u, --webUrl <webUrl>`
|
|
17
17
|
: Absolute URL of the site where the content type is located.
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
`--contentTypeId <contentTypeId>`
|
|
20
20
|
: ID of the content type on which the field reference should be set.
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
`-i, --id <id>`
|
|
23
23
|
: ID of the field to which the reference should be set.
|
|
24
24
|
|
|
25
25
|
`-r, --required [required]`
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
2
4
|
|
|
3
5
|
# spo file copy
|
|
4
6
|
|
|
@@ -31,11 +33,14 @@ m365 spo file copy [options]
|
|
|
31
33
|
`--nameConflictBehavior [nameConflictBehavior]`
|
|
32
34
|
: Behavior when a document with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`.
|
|
33
35
|
|
|
34
|
-
`--resetAuthorAndCreated`
|
|
35
|
-
: Use this option to clear the author and created date. When not specified, the values from the source file are used.
|
|
36
|
-
|
|
37
36
|
`--bypassSharedLock`
|
|
38
37
|
: This indicates whether a file with a share lock can still be copied. Use this option to copy a file that is locked.
|
|
38
|
+
|
|
39
|
+
`--ignoreVersionHistory`
|
|
40
|
+
: Only copy the most recent version of the file and ignore the version history.
|
|
41
|
+
|
|
42
|
+
`--skipWait`
|
|
43
|
+
: Don't wait for the copy operation to complete.
|
|
39
44
|
```
|
|
40
45
|
|
|
41
46
|
<Global />
|
|
@@ -43,7 +48,6 @@ m365 spo file copy [options]
|
|
|
43
48
|
## Remarks
|
|
44
49
|
|
|
45
50
|
When you specify a value for `nameConflictBehavior`, consider the following:
|
|
46
|
-
|
|
47
51
|
- `fail` will throw an error when the destination file already exists.
|
|
48
52
|
- `replace` will replace the destination file if it already exists.
|
|
49
53
|
- `rename` will add a suffix (e.g. Document1.pdf) when the destination file already exists.
|
|
@@ -56,16 +60,16 @@ Copy a file by server-relative URL to a document library in another site collect
|
|
|
56
60
|
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
|
|
57
61
|
```
|
|
58
62
|
|
|
59
|
-
Copy a file by site-relative URL to a document library in another site collection and
|
|
63
|
+
Copy a file by site-relative URL to a document library in another site collection and ignore the file history.
|
|
60
64
|
|
|
61
65
|
```sh
|
|
62
|
-
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --
|
|
66
|
+
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --ignoreVersionHistory
|
|
63
67
|
```
|
|
64
68
|
|
|
65
|
-
Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file.
|
|
69
|
+
Copy file by sourceId (UniqueId) to a document library in another site collection and rename the file (without specifying the file extension).
|
|
66
70
|
|
|
67
71
|
```sh
|
|
68
|
-
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report
|
|
72
|
+
m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourceId "b2307a39-e878-458b-bc90-03bc578531d6" --targetUrl "/sites/IT/Shared Documents" --newName "Report"
|
|
69
73
|
```
|
|
70
74
|
|
|
71
75
|
Copy file by sourceId (UniqueId) to a document library in another site collection with a new name, rename the file if it already exists.
|
|
@@ -76,8 +80,111 @@ m365 spo file copy --webUrl https://contoso.sharepoint.com/sites/project --sourc
|
|
|
76
80
|
|
|
77
81
|
## Response
|
|
78
82
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
83
|
+
### Standard Response
|
|
84
|
+
|
|
85
|
+
<Tabs>
|
|
86
|
+
<TabItem value="JSON">
|
|
87
|
+
|
|
88
|
+
```json
|
|
89
|
+
{
|
|
90
|
+
"CheckInComment": "",
|
|
91
|
+
"CheckOutType": 2,
|
|
92
|
+
"ContentTag": "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",
|
|
93
|
+
"CustomizedPageStatus": 0,
|
|
94
|
+
"ETag": "\"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1\"",
|
|
95
|
+
"Exists": true,
|
|
96
|
+
"IrmEnabled": false,
|
|
97
|
+
"Length": "5987",
|
|
98
|
+
"Level": 1,
|
|
99
|
+
"LinkingUri": null,
|
|
100
|
+
"LinkingUrl": "",
|
|
101
|
+
"MajorVersion": 1,
|
|
102
|
+
"MinorVersion": 0,
|
|
103
|
+
"Name": "Test1.docx",
|
|
104
|
+
"ServerRelativeUrl": "/sites/project-x/documents/Test1.docx",
|
|
105
|
+
"TimeCreated": "2022-10-30T10:16:18Z",
|
|
106
|
+
"TimeLastModified": "2022-10-30T10:16:18Z",
|
|
107
|
+
"Title": null,
|
|
108
|
+
"UIVersion": 512,
|
|
109
|
+
"UIVersionLabel": "1.0",
|
|
110
|
+
"UniqueId": "b2307a39-e878-458b-bc90-03bc578531d6"
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
</TabItem>
|
|
115
|
+
<TabItem value="Text">
|
|
116
|
+
|
|
117
|
+
```text
|
|
118
|
+
CheckInComment :
|
|
119
|
+
CheckOutType : 2
|
|
120
|
+
ContentTag : {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
|
|
121
|
+
CustomizedPageStatus: 0
|
|
122
|
+
ETag : "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
|
|
123
|
+
Exists : true
|
|
124
|
+
IrmEnabled : false
|
|
125
|
+
Length : 5987
|
|
126
|
+
Level : 1
|
|
127
|
+
LinkingUri : null
|
|
128
|
+
LinkingUrl :
|
|
129
|
+
MajorVersion : 1
|
|
130
|
+
MinorVersion : 0
|
|
131
|
+
Name : Test1.docx
|
|
132
|
+
ServerRelativeUrl : /sites/project-x/documents/Test1.docx
|
|
133
|
+
TimeCreated : 2022-10-30T10:16:18Z
|
|
134
|
+
TimeLastModified : 2022-10-30T10:16:18Z
|
|
135
|
+
Title : null
|
|
136
|
+
UIVersion : 512
|
|
137
|
+
UIVersionLabel : 1.0
|
|
138
|
+
UniqueId : b2307a39-e878-458b-bc90-03bc578531d6
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
</TabItem>
|
|
142
|
+
<TabItem value="CSV">
|
|
143
|
+
|
|
144
|
+
```csv
|
|
145
|
+
CheckInComment,CheckOutType,ContentTag,CustomizedPageStatus,ETag,Exists,IrmEnabled,Length,Level,LinkingUri,LinkingUrl,MajorVersion,MinorVersion,Name,ServerRelativeUrl,TimeCreated,TimeLastModified,Title,UIVersion,UIVersionLabel,UniqueId
|
|
146
|
+
,2,"{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1",0,"""{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1""",1,,5987,1,,,1,0,Test1.docx,/sites/project-x/documents/Test1.docx,2022-10-30T10:16:18Z,2022-10-30T10:16:18Z,,512,1.0,b2307a39-e878-458b-bc90-03bc578531d6
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
</TabItem>
|
|
150
|
+
<TabItem value="Markdown">
|
|
151
|
+
|
|
152
|
+
```md
|
|
153
|
+
# spo file copy --webUrl "https://contoso.sharepoint.com/sites/IT" --sourceUrl "/Shared Documents/Document.docx" --targetUrl "/sites/project-x/Shared Documents"
|
|
154
|
+
|
|
155
|
+
Date: 10/3/2023
|
|
156
|
+
|
|
157
|
+
## b2307a39-e878-458b-bc90-03bc578531d6
|
|
158
|
+
|
|
159
|
+
Property | Value
|
|
160
|
+
---------|-------
|
|
161
|
+
CheckInComment |
|
|
162
|
+
CheckOutType | 2
|
|
163
|
+
ContentTag | {03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1,1
|
|
164
|
+
CustomizedPageStatus | 0
|
|
165
|
+
ETag | "{03E171B6-9DF2-46D9-A7A1-D5FA0BD23E4B},1"
|
|
166
|
+
Exists | true
|
|
167
|
+
ExistsAllowThrowForPolicyFailures | true
|
|
168
|
+
IrmEnabled | false
|
|
169
|
+
Length | 5987
|
|
170
|
+
Level | 1
|
|
171
|
+
LinkingUri | https://contoso.sharepoint.com/sites/project-x/shared%20documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
|
|
172
|
+
LinkingUrl | https://contoso.sharepoint.com/sites/project-x/shared documents/Document.docx?d=w59d4e6fcf6f94ce78bea0273cedb1a19
|
|
173
|
+
MajorVersion | 1
|
|
174
|
+
MinorVersion | 0
|
|
175
|
+
Name | Document.docx
|
|
176
|
+
ServerRelativeUrl | /sites/project-x/shared documents/Document.docx
|
|
177
|
+
TimeCreated | 2023-05-23T09:51:34Z
|
|
178
|
+
TimeLastModified | 2023-05-23T10:13:01Z
|
|
179
|
+
Title |
|
|
180
|
+
UIVersion | 1536
|
|
181
|
+
UIVersionLabel | 1.0
|
|
182
|
+
UniqueId | b2307a39-e878-458b-bc90-03bc578531d6
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
</TabItem>
|
|
186
|
+
</Tabs>
|
|
187
|
+
|
|
188
|
+
### `skipWait` response
|
|
82
189
|
|
|
83
|
-
|
|
190
|
+
The command won't return a response on success.
|