@pnp/cli-microsoft365 9.1.0-beta.acd25f7 → 10.0.0-beta.04ac437
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/config/config-set.js +0 -1
- 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-list.js +4 -4
- 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-user-list.js +6 -9
- package/dist/m365/outlook/commands/message/message-get.js +11 -11
- 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/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/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/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/tenant/tenant-recyclebinitem-restore.js +2 -22
- package/dist/m365/spo/commands.js +0 -1
- 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/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-user-list.mdx +7 -7
- 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-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/npm-shrinkwrap.json +2 -2
- package/package.json +1 -1
- package/dist/m365/viva/commands/engage/yammerCommands.js +0 -25
|
@@ -22,39 +22,39 @@ m365 entra sp add [options]
|
|
|
22
22
|
## Options
|
|
23
23
|
|
|
24
24
|
```md definition-list
|
|
25
|
-
|
|
26
|
-
: ID of the app for which the enterprise application should be created
|
|
25
|
+
`-i, --id [id]`
|
|
26
|
+
: ID of the app for which the enterprise application should be created.
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
: Display name of the app for which the enterprise application should be created
|
|
28
|
+
`-n, --displayName [displayName]`
|
|
29
|
+
: Display name of the app for which the enterprise application should be created.
|
|
30
30
|
|
|
31
31
|
`--objectId [objectId]`
|
|
32
|
-
: ObjectId of the app for which the enterprise application should be created
|
|
32
|
+
: ObjectId of the app for which the enterprise application should be created.
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
<Global />
|
|
36
36
|
|
|
37
37
|
## Remarks
|
|
38
38
|
|
|
39
|
-
Specify either the `
|
|
39
|
+
Specify either the `id`, `displayName` or `objectId`. If you specify more than one option value, the command will fail with an error.
|
|
40
40
|
|
|
41
41
|
If you register an application in the portal, an application object as well as an enterprise application object are automatically created in your home tenant. If you register an application using CLI for Microsoft 365 or the Microsoft Graph, you'll need to create the enterprise application separately. To register/create an application using the CLI for Microsoft 365, use the [m365 entra app add](../app/app-add.mdx) command.
|
|
42
42
|
|
|
43
43
|
## Examples
|
|
44
44
|
|
|
45
|
-
Creates an enterprise application for a registered Entra app with
|
|
45
|
+
Creates an enterprise application for a registered Entra app with the specified id.
|
|
46
46
|
|
|
47
47
|
```sh
|
|
48
|
-
m365 entra enterpriseapp add --
|
|
48
|
+
m365 entra enterpriseapp add --id b2307a39-e878-458b-bc90-03bc578531d6
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
Creates an enterprise application for a registered Entra app with
|
|
51
|
+
Creates an enterprise application for a registered Entra app with the specified displayName.
|
|
52
52
|
|
|
53
53
|
```sh
|
|
54
|
-
m365 entra enterpriseapp add --
|
|
54
|
+
m365 entra enterpriseapp add --displayName "Microsoft Graph"
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Creates an enterprise application for a registered Entra app with objectId
|
|
57
|
+
Creates an enterprise application for a registered Entra app with the specified objectId.
|
|
58
58
|
|
|
59
59
|
```sh
|
|
60
60
|
m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
|
|
@@ -172,7 +172,7 @@ m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
|
|
|
172
172
|
<TabItem value="Markdown">
|
|
173
173
|
|
|
174
174
|
```md
|
|
175
|
-
# entra enterpriseapp add --
|
|
175
|
+
# entra enterpriseapp add --id "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
|
|
176
176
|
|
|
177
177
|
Date: 2023-06-02
|
|
178
178
|
|
|
@@ -22,40 +22,40 @@ m365 entra sp get [options]
|
|
|
22
22
|
## Options
|
|
23
23
|
|
|
24
24
|
```md definition-list
|
|
25
|
-
`-i, --
|
|
26
|
-
: ID of the application for which the enterprise application should be retrieved
|
|
25
|
+
`-i, --id [id]`
|
|
26
|
+
: ID of the application for which the enterprise application should be retrieved.
|
|
27
27
|
|
|
28
|
-
`-n, --
|
|
29
|
-
: Display name of the application for which the enterprise application should be retrieved
|
|
28
|
+
`-n, --displayName [displayName]`
|
|
29
|
+
: Display name of the application for which the enterprise application should be retrieved.
|
|
30
30
|
|
|
31
|
-
`--
|
|
32
|
-
: ObjectId of the application for which the enterprise application should be retrieved
|
|
31
|
+
`--objectId [objectId]`
|
|
32
|
+
: ObjectId of the application for which the enterprise application should be retrieved.
|
|
33
33
|
```
|
|
34
34
|
|
|
35
35
|
<Global />
|
|
36
36
|
|
|
37
37
|
## Remarks
|
|
38
38
|
|
|
39
|
-
Specify either the `
|
|
39
|
+
Specify either the `id`, `objectId` or `displayName`. If you specify more than one option value, the command will fail with an error.
|
|
40
40
|
|
|
41
41
|
## Examples
|
|
42
42
|
|
|
43
|
-
Return details about the enterprise application with
|
|
43
|
+
Return details about the enterprise application with the specified id.
|
|
44
44
|
|
|
45
45
|
```sh
|
|
46
|
-
m365 entra enterpriseapp get --
|
|
46
|
+
m365 entra enterpriseapp get --id b2307a39-e878-458b-bc90-03bc578531d6
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Return details about the
|
|
49
|
+
Return details about the enterprise application with the specified displayName.
|
|
50
50
|
|
|
51
51
|
```sh
|
|
52
|
-
m365 entra enterpriseapp get --
|
|
52
|
+
m365 entra enterpriseapp get --displayName "Microsoft Graph"
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
Return details about the enterprise application with ObjectId
|
|
55
|
+
Return details about the enterprise application with the specified ObjectId.
|
|
56
56
|
|
|
57
57
|
```sh
|
|
58
|
-
m365 entra enterpriseapp get --
|
|
58
|
+
m365 entra enterpriseapp get --objectId b2307a39-e878-458b-bc90-03bc578531dd
|
|
59
59
|
```
|
|
60
60
|
|
|
61
61
|
## Response
|
|
@@ -198,7 +198,7 @@ m365 entra enterpriseapp get --appObjectId b2307a39-e878-458b-bc90-03bc578531dd
|
|
|
198
198
|
<TabItem value="Markdown">
|
|
199
199
|
|
|
200
200
|
```md
|
|
201
|
-
# entra enterpriseapp get --
|
|
201
|
+
# entra enterpriseapp get --id "ac7c9b4b-83b0-4a5e-ace2-a3530162c8f8"
|
|
202
202
|
|
|
203
203
|
Date: 2023-06-02
|
|
204
204
|
|
|
@@ -22,24 +22,24 @@ m365 entra sp list [options]
|
|
|
22
22
|
## Options
|
|
23
23
|
|
|
24
24
|
```md definition-list
|
|
25
|
-
|
|
26
|
-
: Returns only enterprise applications with the specified name
|
|
25
|
+
`-n, --displayName [displayName]`
|
|
26
|
+
: Returns only enterprise applications with the specified name.
|
|
27
27
|
|
|
28
28
|
`--tag [tag]`
|
|
29
|
-
: Returns only enterprise applications with the specified tag
|
|
29
|
+
: Returns only enterprise applications with the specified tag.
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
<Global />
|
|
33
33
|
|
|
34
34
|
## Examples
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
Returns a list of all enterprise applications.
|
|
37
37
|
|
|
38
38
|
```sh
|
|
39
39
|
m365 entra enterpriseapp list
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
|
|
42
|
+
Returns a list of all enterprise applications that comply with the specified display name and the tag parameters.
|
|
43
43
|
|
|
44
44
|
```sh
|
|
45
45
|
m365 entra enterpriseapp list --displayName "My custom enterprise application" --tag "WindowsAzureActiveDirectoryIntegratedApp"
|
|
@@ -22,10 +22,10 @@ m365 aad group user list [options]
|
|
|
22
22
|
|
|
23
23
|
```md definition-list
|
|
24
24
|
`-i, --groupId [groupId]`
|
|
25
|
-
: The ID of the Entra group. Specify `groupId` or `
|
|
25
|
+
: The ID of the Entra group. Specify `groupId` or `groupName` but not both.
|
|
26
26
|
|
|
27
|
-
`-n, --
|
|
28
|
-
: The display name of the Entra group. Specify `groupId` or `
|
|
27
|
+
`-n, --groupName [groupName]`
|
|
28
|
+
: The display name of the Entra group. Specify `groupId` or `groupName` but not both.
|
|
29
29
|
|
|
30
30
|
`-r, --role [role]`
|
|
31
31
|
: Filter the results to only users with the given role: `Owner`, `Member`.
|
|
@@ -54,25 +54,25 @@ m365 entra group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
|
|
|
54
54
|
List all owners from a group specified by display name.
|
|
55
55
|
|
|
56
56
|
```sh
|
|
57
|
-
m365 entra group user list --
|
|
57
|
+
m365 entra group user list --groupName Developers --role Owner
|
|
58
58
|
```
|
|
59
59
|
|
|
60
60
|
List all group users from a group specified by name. For each one return the display name, e-mail address, and manager display name.
|
|
61
61
|
|
|
62
62
|
```sh
|
|
63
|
-
m365 entra group user list --
|
|
63
|
+
m365 entra group user list --groupName Developers --properties "displayName,mail,manager/displayName"
|
|
64
64
|
```
|
|
65
65
|
|
|
66
66
|
List all group users from a group specified by name. For each one return the display name, e-mail address, and manager information.
|
|
67
67
|
|
|
68
68
|
```sh
|
|
69
|
-
m365 entra group user list --
|
|
69
|
+
m365 entra group user list --groupName Developers --properties "displayName,mail,manager/*"
|
|
70
70
|
```
|
|
71
71
|
|
|
72
72
|
List all group members that are guest users.
|
|
73
73
|
|
|
74
74
|
```sh
|
|
75
|
-
m365 entra group user list --
|
|
75
|
+
m365 entra group user list --groupName Developers --filter "userType eq 'Guest'"
|
|
76
76
|
```
|
|
77
77
|
|
|
78
78
|
## Response
|
|
@@ -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
|
|
@@ -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]`
|