@pnp/cli-microsoft365 10.1.0-beta.10765f6 → 10.1.0-beta.63210ca
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/README.md +2 -2
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/AuthServer.js +1 -1
- package/dist/Command.js +2 -2
- package/dist/cli/cli.js +2 -2
- package/dist/m365/base/AppCommand.js +5 -2
- package/dist/m365/entra/commands/administrativeunit/administrativeunit-get.js +18 -4
- package/dist/m365/entra/commands/administrativeunit/administrativeunit-list.js +34 -2
- package/dist/m365/entra/commands/app/app-get.js +17 -5
- package/dist/m365/entra/commands/app/app-list.js +34 -2
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +3 -0
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +3 -0
- package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +3 -0
- package/dist/m365/entra/commands/group/group-get.js +6 -3
- package/dist/m365/entra/commands/group/group-list.js +16 -1
- package/dist/m365/entra/commands/m365group/m365group-add.js +1 -1
- package/dist/m365/entra/commands/m365group/m365group-conversation-list.js +21 -6
- package/dist/m365/entra/commands/m365group/m365group-get.js +29 -7
- package/dist/m365/entra/commands/m365group/m365group-list.js +1 -1
- package/dist/m365/entra/commands/m365group/m365group-remove.js +21 -9
- package/dist/m365/entra/commands/m365group/m365group-renew.js +19 -7
- package/dist/m365/entra/commands/m365group/m365group-set.js +1 -1
- package/dist/m365/entra/commands/m365group/m365group-teamify.js +12 -21
- package/dist/m365/file/commands/convert/convert-pdf.js +3 -4
- package/dist/m365/file/commands/file-add.js +5 -6
- package/dist/m365/graph/commands/subscription/subscription-add.js +46 -5
- package/dist/m365/pp/commands/{chatbot/chatbot-get.js → copilot/copilot-get.js} +24 -20
- package/dist/m365/pp/commands/{chatbot/chatbot-list.js → copilot/copilot-list.js} +16 -12
- package/dist/m365/pp/commands/{chatbot/chatbot-remove.js → copilot/copilot-remove.js} +28 -24
- package/dist/m365/pp/commands.js +3 -0
- package/dist/m365/spfx/commands/package/package-generate.js +1 -1
- package/dist/m365/spfx/commands/project/JsonRule.js +2 -2
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN016004_TS_property_pane_property_import.js +2 -2
- package/dist/m365/spfx/commands/spfx-doctor.js +1 -1
- package/dist/m365/spo/commands/contenttype/contenttype-get.js +2 -2
- package/dist/m365/spo/commands/contenttype/contenttype-list.js +6 -3
- package/dist/m365/spo/commands/file/file-add.js +1 -1
- package/dist/m365/spo/commands/file/file-retentionlabel-ensure.js +1 -2
- package/dist/m365/spo/commands/file/file-retentionlabel-remove.js +1 -2
- package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -2
- package/dist/m365/spo/commands/folder/folder-retentionlabel-remove.js +1 -2
- package/dist/m365/spo/commands/list/list-contenttype-list.js +5 -2
- package/dist/m365/spo/commands/listitem/listitem-batch-remove.js +10 -8
- package/dist/m365/spo/commands/listitem/listitem-batch-set.js +1 -1
- package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +1 -2
- package/dist/m365/spo/commands/listitem/listitem-retentionlabel-remove.js +1 -2
- package/dist/m365/spo/commands/page/page-add.js +1 -1
- package/dist/m365/spo/commands/site/site-admin-add.js +4 -12
- package/dist/m365/spo/commands/site/site-admin-list.js +3 -11
- package/dist/m365/spo/commands/site/site-admin-remove.js +4 -12
- package/dist/m365/spo/commands/site/site-set.js +1 -1
- package/dist/m365/spp/commands/model/model-remove.js +105 -0
- package/dist/m365/spp/commands.js +2 -1
- package/dist/m365/teams/commands/user/user-app-list.js +1 -1
- package/dist/m365/tenant/commands/report/report-office365activationcounts.js +2 -8
- package/dist/m365/tenant/commands/report/report-office365activationsusercounts.js +2 -8
- package/dist/m365/tenant/commands/report/report-office365activationsuserdetail.js +2 -8
- package/dist/m365/todo/commands/list/list-remove.js +2 -1
- package/dist/m365/todo/commands/list/list-set.js +2 -1
- package/dist/m365/todo/commands/task/task-add.js +2 -1
- package/dist/m365/todo/commands/task/task-get.js +2 -1
- package/dist/m365/todo/commands/task/task-list.js +2 -1
- package/dist/m365/todo/commands/task/task-remove.js +2 -1
- package/dist/m365/todo/commands/task/task-set.js +1 -1
- package/dist/m365/viva/commands/engage/engage-community-set.js +111 -0
- package/dist/m365/viva/commands.js +1 -0
- package/dist/utils/entraAdministrativeUnit.js +14 -2
- package/dist/utils/entraGroup.js +49 -6
- package/dist/utils/formatting.js +8 -20
- package/dist/utils/spo.js +5 -4
- package/dist/utils/spp.js +3 -3
- package/dist/utils/urlUtil.js +11 -14
- package/docs/docs/cmd/entra/administrativeunit/administrativeunit-get.mdx +10 -3
- package/docs/docs/cmd/entra/administrativeunit/administrativeunit-list.mdx +16 -1
- package/docs/docs/cmd/entra/app/app-get.mdx +13 -8
- package/docs/docs/cmd/entra/app/app-list.mdx +16 -1
- package/docs/docs/cmd/entra/group/group-get.mdx +10 -3
- package/docs/docs/cmd/entra/group/group-list.mdx +9 -2
- package/docs/docs/cmd/entra/m365group/m365group-conversation-list.mdx +12 -3
- package/docs/docs/cmd/entra/m365group/m365group-get.mdx +29 -5
- package/docs/docs/cmd/entra/m365group/m365group-remove.mdx +7 -4
- package/docs/docs/cmd/entra/m365group/m365group-renew.mdx +11 -2
- package/docs/docs/cmd/entra/m365group/m365group-teamify.mdx +12 -3
- package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +2 -2
- package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +6 -0
- package/docs/docs/cmd/entra/m365group/m365group-user-remove.mdx +1 -1
- package/docs/docs/cmd/entra/m365group/m365group-user-set.mdx +3 -3
- package/docs/docs/cmd/graph/subscription/subscription-add.mdx +30 -5
- package/docs/docs/cmd/login.mdx +45 -44
- package/docs/docs/cmd/pp/{chatbot/chatbot-get.mdx → copilot/copilot-get.mdx} +24 -18
- package/docs/docs/cmd/pp/{chatbot/chatbot-list.mdx → copilot/copilot-list.mdx} +20 -14
- package/docs/docs/cmd/pp/{chatbot/chatbot-remove.mdx → copilot/copilot-remove.mdx} +16 -10
- package/docs/docs/cmd/pp/managementapp/managementapp-add.mdx +1 -1
- package/docs/docs/cmd/spo/contenttype/contenttype-get.mdx +7 -1
- package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +7 -1
- package/docs/docs/cmd/spo/list/list-contenttype-list.mdx +7 -1
- package/docs/docs/cmd/spp/model/model-remove.mdx +57 -0
- package/docs/docs/cmd/viva/engage/engage-community-set.mdx +61 -0
- package/npm-shrinkwrap.json +6 -0
- package/package.json +4 -2
|
@@ -20,22 +20,29 @@ m365 entra group get [options]
|
|
|
20
20
|
|
|
21
21
|
`-n, --displayName [displayName]`
|
|
22
22
|
: The display name of the Entra group. Specify either `id` or `displayName` but not both.
|
|
23
|
+
|
|
24
|
+
`-p, --properties [properties]`
|
|
25
|
+
: Comma-separated list of properties to retrieve.
|
|
23
26
|
```
|
|
24
27
|
|
|
25
28
|
<Global />
|
|
26
29
|
|
|
30
|
+
## Remarks
|
|
31
|
+
|
|
32
|
+
Using the `--properties` option, you can specify a comma-separated list of group properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will output the default properties returned by Graph.
|
|
33
|
+
|
|
27
34
|
## Examples
|
|
28
35
|
|
|
29
|
-
Get information about an Entra Group by id
|
|
36
|
+
Get information about an Entra Group by id.
|
|
30
37
|
|
|
31
38
|
```sh
|
|
32
39
|
m365 entra group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
|
|
33
40
|
```
|
|
34
41
|
|
|
35
|
-
Get information about an Entra Group by its display name
|
|
42
|
+
Get information about an Entra Group by its display name with specified properties.
|
|
36
43
|
|
|
37
44
|
```sh
|
|
38
|
-
m365 entra group get --displayName Finance
|
|
45
|
+
m365 entra group get --displayName Finance --properties "mail,displayName"
|
|
39
46
|
```
|
|
40
47
|
|
|
41
48
|
## Response
|
|
@@ -17,10 +17,17 @@ m365 entra group list [options]
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`--type [type]`
|
|
19
19
|
: Filter the results to only groups of a given type. Allowed values: `microsoft365`, `security`, `distribution`, `mailEnabledSecurity`. By default, all groups are listed.
|
|
20
|
+
|
|
21
|
+
`-p, --properties [properties]`
|
|
22
|
+
: Comma-separated list of properties to retrieve.
|
|
20
23
|
```
|
|
21
24
|
|
|
22
25
|
<Global />
|
|
23
26
|
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
Using the `--properties` option, you can specify a comma-separated list of group properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will output the default properties returned by Graph.
|
|
30
|
+
|
|
24
31
|
## Examples
|
|
25
32
|
|
|
26
33
|
Lists all groups defined in Entra ID.
|
|
@@ -29,10 +36,10 @@ Lists all groups defined in Entra ID.
|
|
|
29
36
|
m365 entra group list
|
|
30
37
|
```
|
|
31
38
|
|
|
32
|
-
List all security groups defined in Entra ID.
|
|
39
|
+
List all security groups defined in Entra ID with specified properties.
|
|
33
40
|
|
|
34
41
|
```sh
|
|
35
|
-
m365 entra group list --type security
|
|
42
|
+
m365 entra group list --type security --properties "mail,displayName"
|
|
36
43
|
```
|
|
37
44
|
|
|
38
45
|
## Response
|
|
@@ -15,20 +15,29 @@ m365 entra m365group conversation list [options]
|
|
|
15
15
|
## Options
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
|
-
`-i, --groupId
|
|
19
|
-
: The ID of the Microsoft 365
|
|
18
|
+
`-i, --groupId [groupId]`
|
|
19
|
+
: The ID of the Microsoft 365 Group. Specify either `groupId` or `groupName`, but not both.
|
|
20
|
+
|
|
21
|
+
`-n, --groupName [groupName]`
|
|
22
|
+
: Display name of the Microsoft 365 Group. Specify either `groupId` or `groupName`, but not both.
|
|
20
23
|
```
|
|
21
24
|
|
|
22
25
|
<Global />
|
|
23
26
|
|
|
24
27
|
## Examples
|
|
25
28
|
|
|
26
|
-
Lists conversations for the
|
|
29
|
+
Lists conversations for the Microsoft 365 group specified by id.
|
|
27
30
|
|
|
28
31
|
```sh
|
|
29
32
|
m365 entra m365group conversation list --groupId '00000000-0000-0000-0000-000000000000'
|
|
30
33
|
```
|
|
31
34
|
|
|
35
|
+
Lists conversations for the Microsoft 365 group specified by displayName.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 entra m365group conversation list --groupName Finance
|
|
39
|
+
```
|
|
40
|
+
|
|
32
41
|
## Response
|
|
33
42
|
|
|
34
43
|
<Tabs>
|
|
@@ -15,8 +15,11 @@ m365 entra m365group get [options]
|
|
|
15
15
|
## Options
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
|
-
`-i, --id
|
|
19
|
-
: The ID of the Microsoft 365 Group or Microsoft Teams team to retrieve information for
|
|
18
|
+
`-i, --id [id]`
|
|
19
|
+
: The ID of the Microsoft 365 Group or Microsoft Teams team to retrieve information for. Specify either `id` or `displayName`, but not both.
|
|
20
|
+
|
|
21
|
+
`-n, --displayName [displayName]`
|
|
22
|
+
: Display name of the Microsoft 365 Group or Microsoft Teams team to retrieve information for. Specify either `id` or `displayName`, but not both.
|
|
20
23
|
|
|
21
24
|
`--includeSiteUrl`
|
|
22
25
|
: Set to retrieve the site URL for the group
|
|
@@ -32,6 +35,12 @@ Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-9
|
|
|
32
35
|
m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
|
|
33
36
|
```
|
|
34
37
|
|
|
38
|
+
Get information about the Microsoft 365 Group with displayName _Finance_
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 entra m365group get --displayName Finance
|
|
42
|
+
```
|
|
43
|
+
|
|
35
44
|
Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ and also retrieve the URL of the corresponding SharePoint site
|
|
36
45
|
|
|
37
46
|
```sh
|
|
@@ -80,7 +89,12 @@ m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --includeSite
|
|
|
80
89
|
"securityIdentifier": "S-1-12-1-4288263055-1337657931-1773679776-1830684296",
|
|
81
90
|
"theme": null,
|
|
82
91
|
"visibility": "Public",
|
|
83
|
-
"onPremisesProvisioningErrors": []
|
|
92
|
+
"onPremisesProvisioningErrors": [],
|
|
93
|
+
"allowExternalSenders": false,
|
|
94
|
+
"autoSubscribeNewMembers": false,
|
|
95
|
+
"isSubscribedByMail": false,
|
|
96
|
+
"hideFromOutlookClients": false,
|
|
97
|
+
"hideFromAddressLists": false
|
|
84
98
|
}
|
|
85
99
|
```
|
|
86
100
|
|
|
@@ -88,6 +102,8 @@ m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --includeSite
|
|
|
88
102
|
<TabItem value="Text">
|
|
89
103
|
|
|
90
104
|
```text
|
|
105
|
+
allowExternalSenders : false
|
|
106
|
+
autoSubscribeNewMembers : false
|
|
91
107
|
classification : null
|
|
92
108
|
createdDateTime : 2023-06-01T20:18:30Z
|
|
93
109
|
creationOptions : []
|
|
@@ -96,8 +112,11 @@ m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --includeSite
|
|
|
96
112
|
displayName : Finance
|
|
97
113
|
expirationDateTime : null
|
|
98
114
|
groupTypes : ["Unified"]
|
|
115
|
+
hideFromAddressLists : false
|
|
116
|
+
hideFromOutlookClients : false
|
|
99
117
|
id : ff99b38f-0a4b-4fbb-a034-b86988061e6d
|
|
100
118
|
isAssignableToRole : null
|
|
119
|
+
isSubscribedByMail : false
|
|
101
120
|
mail : finance@contoso.onmicrosoft.com
|
|
102
121
|
mailEnabled : true
|
|
103
122
|
mailNickname : finance
|
|
@@ -126,8 +145,8 @@ m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --includeSite
|
|
|
126
145
|
<TabItem value="CSV">
|
|
127
146
|
|
|
128
147
|
```csv
|
|
129
|
-
id,createdDateTime,description,displayName,mail,mailEnabled,mailNickname,renewedDateTime,securityEnabled,securityIdentifier,visibility
|
|
130
|
-
ff99b38f-0a4b-4fbb-a034-b86988061e6d,2023-06-01T20:18:30Z,"This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more.",Finance,finance@contoso.onmicrosoft.com,1,finance,2023-06-01T20:18:30Z,,S-1-12-1-4288263055-1337657931-1773679776-1830684296,Public
|
|
148
|
+
id,createdDateTime,description,displayName,mail,mailEnabled,mailNickname,renewedDateTime,securityEnabled,securityIdentifier,visibility,allowExternalSenders,autoSubscribeNewMembers,isSubscribedByMail,hideFromOutlookClients,hideFromAddressLists
|
|
149
|
+
ff99b38f-0a4b-4fbb-a034-b86988061e6d,2023-06-01T20:18:30Z,"This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more.",Finance,finance@contoso.onmicrosoft.com,1,finance,2023-06-01T20:18:30Z,,S-1-12-1-4288263055-1337657931-1773679776-1830684296,Public,false,false,false,false,false
|
|
131
150
|
```
|
|
132
151
|
|
|
133
152
|
</TabItem>
|
|
@@ -153,6 +172,11 @@ m365 entra m365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --includeSite
|
|
|
153
172
|
securityEnabled | false
|
|
154
173
|
securityIdentifier | S-1-12-1-4288263055-1337657931-1773679776-1830684296
|
|
155
174
|
visibility | Public
|
|
175
|
+
allowExternalSenders | false
|
|
176
|
+
autoSubscribeNewMembers | false
|
|
177
|
+
isSubscribedByMail | false
|
|
178
|
+
hideFromOutlookClients | false
|
|
179
|
+
hideFromAddressLists | false
|
|
156
180
|
```
|
|
157
181
|
|
|
158
182
|
</TabItem>
|
|
@@ -13,8 +13,11 @@ m365 entra m365group remove [options]
|
|
|
13
13
|
## Options
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
|
-
`-i, --id
|
|
17
|
-
: The ID of the Microsoft 365 Group to remove
|
|
16
|
+
`-i, --id [id]`
|
|
17
|
+
: The ID of the Microsoft 365 Group to remove. Specify either `id` or `displayName`, but not both.
|
|
18
|
+
|
|
19
|
+
`-n, --displayName [displayName]`
|
|
20
|
+
: Display name of the Microsoft 365 Group to remove. Specify either `id` or `displayName`, but not both.
|
|
18
21
|
|
|
19
22
|
`-f, --force`
|
|
20
23
|
: Don't prompt for confirming removing the group
|
|
@@ -47,10 +50,10 @@ Remove group with id _28beab62-7540-4db1-a23f-29a6018a3848_. Will prompt for con
|
|
|
47
50
|
m365 entra m365group remove --id 28beab62-7540-4db1-a23f-29a6018a3848
|
|
48
51
|
```
|
|
49
52
|
|
|
50
|
-
Remove group with
|
|
53
|
+
Remove group with displayName _Finance_ without prompting for confirmation
|
|
51
54
|
|
|
52
55
|
```sh
|
|
53
|
-
m365 entra m365group remove --
|
|
56
|
+
m365 entra m365group remove --displayName Finance --force
|
|
54
57
|
```
|
|
55
58
|
|
|
56
59
|
Remove group with id _28beab62-7540-4db1-a23f-29a6018a3848_ without prompting for confirmation and without moving it to the Recycle Bin
|
|
@@ -13,8 +13,11 @@ m365 entra m365group renew [options]
|
|
|
13
13
|
## Options
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
|
-
`-i, --id
|
|
17
|
-
: The ID of the Microsoft 365 group to renew
|
|
16
|
+
`-i, --id [id]`
|
|
17
|
+
: The ID of the Microsoft 365 group to renew. Specify either `id` or `displayName`, but not both.
|
|
18
|
+
|
|
19
|
+
`-n, --displayName [displayName]`
|
|
20
|
+
: Display name of the Microsoft 365 Group to renew. Specify either `id` or `displayName`, but not both.
|
|
18
21
|
```
|
|
19
22
|
|
|
20
23
|
<Global />
|
|
@@ -31,6 +34,12 @@ Renew the Microsoft 365 group with id _28beab62-7540-4db1-a23f-29a6018a3848_
|
|
|
31
34
|
m365 entra m365group renew --id 28beab62-7540-4db1-a23f-29a6018a3848
|
|
32
35
|
```
|
|
33
36
|
|
|
37
|
+
Renew the Microsoft 365 group with displayName _Finance_
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
m365 entra m365group renew --displayName Finance
|
|
41
|
+
```
|
|
42
|
+
|
|
34
43
|
## Response
|
|
35
44
|
|
|
36
45
|
The command won't return a response on success.
|
|
@@ -14,10 +14,13 @@ m365 entra m365group teamify [options]
|
|
|
14
14
|
|
|
15
15
|
```md definition-list
|
|
16
16
|
`-i, --id [id]`
|
|
17
|
-
: The ID of the Microsoft 365 Group to connect to Microsoft Teams. Specify either `id` or `mailNickname
|
|
17
|
+
: The ID of the Microsoft 365 Group to connect to Microsoft Teams. Specify either `id`, `displayName` or `mailNickname`, but not multiple.
|
|
18
|
+
|
|
19
|
+
`-n, --displayName [displayName]`
|
|
20
|
+
: Display name of the Microsoft 365 Group to connect to Microsoft Teams. Specify either `id`, `displayName` or `mailNickname`, but not multiple.
|
|
18
21
|
|
|
19
22
|
`--mailNickname [mailNickname]`
|
|
20
|
-
: The mail alias of the Microsoft 365 Group to connect to Microsoft Teams. Specify either `id` or `mailNickname
|
|
23
|
+
: The mail alias of the Microsoft 365 Group to connect to Microsoft Teams. Specify either `id`, `displayName` or `mailNickname`, but not multiple.
|
|
21
24
|
```
|
|
22
25
|
|
|
23
26
|
<Global />
|
|
@@ -30,7 +33,13 @@ Creates a new Microsoft Teams team under existing Microsoft 365 group with the s
|
|
|
30
33
|
m365 entra m365group teamify --id e3f60f99-0bad-481f-9e9f-ff0f572fbd03
|
|
31
34
|
```
|
|
32
35
|
|
|
33
|
-
Creates a new Microsoft Teams team under existing Microsoft 365 group with the specified
|
|
36
|
+
Creates a new Microsoft Teams team under existing Microsoft 365 group with the specified displayName.
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
m365 entra m365group teamify --displayName Finance
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Creates a new Microsoft Teams team under existing Microsoft 365 group with the specified mailNickname._
|
|
34
43
|
|
|
35
44
|
```sh
|
|
36
45
|
m365 entra m365group teamify --mailNickname GroupName
|
|
@@ -13,7 +13,7 @@ m365 entra m365group user add [options]
|
|
|
13
13
|
## Alias
|
|
14
14
|
|
|
15
15
|
```sh
|
|
16
|
-
m365 teams user add
|
|
16
|
+
m365 teams user add [options]
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Options
|
|
@@ -38,7 +38,7 @@ m365 teams user add
|
|
|
38
38
|
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.
|
|
39
39
|
|
|
40
40
|
`-r, --role [role]`
|
|
41
|
-
: The role to be assigned to the new user: `Owner
|
|
41
|
+
: The role to be assigned to the new user. Allowed values: `Owner`, `Member`. Default `Member`.
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
<Global />
|
|
@@ -57,6 +57,12 @@ List specific properties for all group users from a group specified by ID.
|
|
|
57
57
|
m365 entra m365group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe --properties "id,jobTitle,companyName,accountEnabled"
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
+
List all group members that are guest users.
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
m365 entra m365group user list --groupDisplayName Developers --filter "userType eq 'Guest'"
|
|
64
|
+
```
|
|
65
|
+
|
|
60
66
|
## Response
|
|
61
67
|
|
|
62
68
|
<Tabs>
|
|
@@ -17,7 +17,7 @@ m365 entra m365group user remove [options]
|
|
|
17
17
|
: The ID of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
18
18
|
|
|
19
19
|
`--groupName [groupName]`
|
|
20
|
-
: The display name of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName
|
|
20
|
+
: The display name of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
21
21
|
|
|
22
22
|
`--teamId [teamId]`
|
|
23
23
|
: The ID of the Microsoft Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
@@ -32,7 +32,7 @@ m365 entra m365group user set [options]
|
|
|
32
32
|
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify only one of the following `ids` or `userNames`.
|
|
33
33
|
|
|
34
34
|
`-r, --role <role>`
|
|
35
|
-
: Role to set for the given user in the specified Microsoft 365 Group or Microsoft Teams team. Allowed values: `Owner`, `Member
|
|
35
|
+
: Role to set for the given user in the specified Microsoft 365 Group or Microsoft Teams team. Allowed values: `Owner`, `Member`.
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
<Global />
|
|
@@ -70,13 +70,13 @@ m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' -
|
|
|
70
70
|
Demote multiple users specified by the userNames parameter from Owner to Member of the given Microsoft Teams team
|
|
71
71
|
|
|
72
72
|
```sh
|
|
73
|
-
m365
|
|
73
|
+
m365 teams user set --teamId '00000000-0000-0000-0000-000000000000' --userNames 'anne.matthews@contoso.onmicrosoft.com,john.doe@contoso.onmicrosoft.com' --role Member
|
|
74
74
|
```
|
|
75
75
|
|
|
76
76
|
Demote multiple users specified by the ids parameter from Owner to Member in the given Microsoft Teams team
|
|
77
77
|
|
|
78
78
|
```sh
|
|
79
|
-
m365
|
|
79
|
+
m365 teams user set --teamName 'Engineering' --ids '74a3b772-3122-447b-b9da-10895e238219,dd3d21e4-a142-46b9-8482-bca8fe9596b3' --role Member
|
|
80
80
|
```
|
|
81
81
|
|
|
82
82
|
## Response
|
|
@@ -29,6 +29,24 @@ m365 graph subscription add [options]
|
|
|
29
29
|
|
|
30
30
|
`-s, --clientState [clientState]`
|
|
31
31
|
: The value of the clientState property sent by the service in each notification. The maximum length is 128 characters.
|
|
32
|
+
|
|
33
|
+
`--lifecycleNotificationUrl [lifecycleNotificationUrl]`
|
|
34
|
+
: The URL of the endpoint that will receive the lifecycle notifications. This URL must use the HTTPS protocol.
|
|
35
|
+
|
|
36
|
+
`--notificationUrlAppId [notificationUrlAppId]`
|
|
37
|
+
: The app ID that the subscription service can use to generate the validation token. The value allows the client to validate the authenticity of the notification received.
|
|
38
|
+
|
|
39
|
+
`--latestTLSVersion [latestTLSVersion]`
|
|
40
|
+
: The latest version of TLS that the notification endpoint supports. Allowed values are `v1_0`, `v1_1`, `v1_2`, `v1_3`. Default is `v1_2`.
|
|
41
|
+
|
|
42
|
+
`--includeResourceData`
|
|
43
|
+
: When set, the change notifications will include the changed resource data.
|
|
44
|
+
|
|
45
|
+
`--encryptionCertificate [encryptionCertificate]`
|
|
46
|
+
: A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `includeResourceData`.
|
|
47
|
+
|
|
48
|
+
`--encryptionCertificateId [encryptionCertificateId]`
|
|
49
|
+
: A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `includeResourceData`.
|
|
32
50
|
```
|
|
33
51
|
|
|
34
52
|
<Global />
|
|
@@ -47,6 +65,13 @@ To subscribe to change notifications of Outlook contacts, events, or messages in
|
|
|
47
65
|
- Use the corresponding application permission to subscribe to changes of items in a folder or mailbox of any user in the tenant.
|
|
48
66
|
- Do not use the Outlook sharing permissions (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared, and their read/write counterparts), as they do not support subscribing to change notifications on items in shared or delegated folders.
|
|
49
67
|
|
|
68
|
+
:::info
|
|
69
|
+
|
|
70
|
+
For subscribers whose notification endpoint supports a version lower than the currently recommended version (TLS 1.2), specifying this property by a set timeline allows them to temporarily use their deprecated version of TLS before completing their upgrade to TLS 1.2.
|
|
71
|
+
For these subscribers, not setting this property per the timeline would result in subscription operations failing.
|
|
72
|
+
|
|
73
|
+
:::
|
|
74
|
+
|
|
50
75
|
## Examples
|
|
51
76
|
|
|
52
77
|
Create a subscription
|
|
@@ -55,16 +80,16 @@ Create a subscription
|
|
|
55
80
|
m365 graph subscription add --resource "me/mailFolders('Inbox')/messages" --changeTypes "updated" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
|
|
56
81
|
```
|
|
57
82
|
|
|
58
|
-
Create a subscription on multiple change types
|
|
83
|
+
Create a subscription on multiple change types and include resource data
|
|
59
84
|
|
|
60
85
|
```sh
|
|
61
|
-
m365 graph subscription add --resource
|
|
86
|
+
m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --includeResourceData --encryptionCertificate 'Q0xJIGZvciBNaWNyb3NvZnQgMzY1' --encryptionCertificateId 'myCert' --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
|
|
62
87
|
```
|
|
63
88
|
|
|
64
89
|
Create a subscription using the maximum allowed expiration for Group resources
|
|
65
90
|
|
|
66
91
|
```sh
|
|
67
|
-
m365 graph subscription add --resource groups --changeTypes "updated" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient"
|
|
92
|
+
m365 graph subscription add --resource groups --changeTypes "updated" --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --lifecycleNotificationUrl "https://webhook.azurewebsites.net/api/send/lifecycleNotifications"
|
|
68
93
|
```
|
|
69
94
|
|
|
70
95
|
Create a subscription for Event Hub location if you are using Key Vault
|
|
@@ -79,10 +104,10 @@ Create a subscription for Event Hub location if you are using role-based access
|
|
|
79
104
|
m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --notificationUrl "EventHub:https://eventHubNamespace.servicebus.windows.net/eventhubname/eventHubName?tenantId=contoso.com"
|
|
80
105
|
```
|
|
81
106
|
|
|
82
|
-
Create a subscription for Event Grid Partner Topic.
|
|
107
|
+
Create a subscription for Event Grid Partner Topic and use TLS 1.3
|
|
83
108
|
|
|
84
109
|
```sh
|
|
85
|
-
m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --notificationUrl "EventGrid:?azuresubscriptionid=8A8A8A8A-4B4B-4C4C-4D4D-12E12E12E12E&resourcegroup=resourceGroupName&partnertopic=partnerTopicName&location=partnerTopicAzureRegionName"
|
|
110
|
+
m365 graph subscription add --resource user --changeTypes "created,updated,deleted" --latestTLSVersion 'v1_3' --notificationUrl "EventGrid:?azuresubscriptionid=8A8A8A8A-4B4B-4C4C-4D4D-12E12E12E12E&resourcegroup=resourceGroupName&partnertopic=partnerTopicName&location=partnerTopicAzureRegionName"
|
|
86
111
|
```
|
|
87
112
|
|
|
88
113
|
## Response
|
package/docs/docs/cmd/login.mdx
CHANGED
|
@@ -15,6 +15,12 @@ m365 login [options]
|
|
|
15
15
|
## Options
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
|
+
`--appId [appId]`
|
|
19
|
+
: App ID of the Microsoft Entra application to use for authentication. This option is crucial and should be specified if it isn't defined elsewhere.
|
|
20
|
+
|
|
21
|
+
`--tenant [tenant]`
|
|
22
|
+
: ID of the tenant from which accounts should authenticate. Use `common` or `organization` for multitenant apps. Defaults to `common` if not specified and if the config value `tenantId` and the environment variable `CLIMICROSOFT365_TENANT` are also not set.
|
|
23
|
+
|
|
18
24
|
`-t, --authType [authType]`
|
|
19
25
|
: The type of authentication to use. Allowed values `certificate`, `deviceCode`, `password`, `identity`, `browser`, `secret`. Default `deviceCode`
|
|
20
26
|
|
|
@@ -36,12 +42,6 @@ m365 login [options]
|
|
|
36
42
|
`-s, --secret [secret]`
|
|
37
43
|
: Client Secret of the Microsoft Entra application to use for authentication. Required when `authType` is set to `secret`.
|
|
38
44
|
|
|
39
|
-
`--appId [appId]`
|
|
40
|
-
: App ID of the Microsoft Entra application to use for authentication. If not specified, use the app specified in the `CLIMICROSOFT365_ENTRAAPPID` environment variable. If the environment variable is not defined, use the multitenant PnP Management Shell app
|
|
41
|
-
|
|
42
|
-
`--tenant [tenant]`
|
|
43
|
-
: ID of the tenant from which accounts should be able to authenticate. Use `common` or `organization` if the app is multitenant. If not specified, use the tenant specified in the `CLIMICROSOFT365_TENANT` environment variable. If the environment variable is not defined, use `common` as the tenant identifier
|
|
44
|
-
|
|
45
45
|
`--cloud [cloud]`
|
|
46
46
|
: Cloud to connect to. Allowed values `Public`, `USGov`, `USGovHigh`, `USGovDoD` and `China`. Default `Public`
|
|
47
47
|
|
|
@@ -56,6 +56,20 @@ m365 login [options]
|
|
|
56
56
|
|
|
57
57
|
## Remarks
|
|
58
58
|
|
|
59
|
+
:::tip
|
|
60
|
+
|
|
61
|
+
The CLI determines the `appId` and `tenant` values in the following order of precedence:
|
|
62
|
+
|
|
63
|
+
1. The `appId` or `tenant` option specified during login.
|
|
64
|
+
2. The `clientId` or `tenantId` value set in the configuration.
|
|
65
|
+
3. The `CLIMICROSOFT365_ENTRAAPPID` or `CLIMICROSOFT365_TENANT` environment variable.
|
|
66
|
+
|
|
67
|
+
For `appId`, it is **required** that at least one of the options is specified during login.
|
|
68
|
+
|
|
69
|
+
For `tenant`, if none are specified, the CLI will default to `common`.
|
|
70
|
+
|
|
71
|
+
:::
|
|
72
|
+
|
|
59
73
|
Using the `login` command you can log in to Microsoft 365.
|
|
60
74
|
|
|
61
75
|
By default, the `login` command uses device code OAuth flow to log in to Microsoft 365. Alternatively, you can authenticate using a user name and password or certificate, which are convenient for CI/CD scenarios, but which come with their own [limitations](../user-guide/connecting-microsoft-365.mdx). The default `authType` can be configured using `m365 cli config set`. This means you'll be able to run `m365 login` without specifying the `--authType` option.
|
|
@@ -78,116 +92,103 @@ When signing in with multiple identities, every signin will be saved as a connec
|
|
|
78
92
|
|
|
79
93
|
## Examples
|
|
80
94
|
|
|
81
|
-
Log in to Microsoft 365 using the device code
|
|
95
|
+
Log in to Microsoft 365 using the device code.
|
|
96
|
+
|
|
97
|
+
```sh
|
|
98
|
+
m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548e
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Log in to Microsoft 365 using the device code and set the connection name.
|
|
82
102
|
|
|
83
103
|
```sh
|
|
84
|
-
m365 login
|
|
104
|
+
m365 login --connectionName 'myworkaccount' --appId 31359c7f-bd7e-475c-86db-fdb8c937548e
|
|
85
105
|
```
|
|
86
106
|
|
|
87
|
-
Log in to Microsoft 365 using
|
|
107
|
+
Log in to Microsoft 365 using your own Microsoft Entra application that's restricted only to allow accounts from the specific tenant.
|
|
88
108
|
|
|
89
109
|
```sh
|
|
90
|
-
m365 login --
|
|
110
|
+
m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a
|
|
91
111
|
```
|
|
92
112
|
|
|
93
|
-
Log in to Microsoft 365 using
|
|
113
|
+
Log in to Microsoft 365 using your own Microsoft Entra application and a personal information exchange (.pfx) file.
|
|
94
114
|
|
|
95
115
|
```sh
|
|
96
|
-
m365 login --
|
|
116
|
+
m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
|
|
97
117
|
```
|
|
98
118
|
|
|
99
|
-
Log in to Microsoft 365 using a user name and password
|
|
119
|
+
Log in to Microsoft 365 using a user name and password with `clientId` set in the configuration.
|
|
100
120
|
|
|
101
121
|
```sh
|
|
102
122
|
m365 login --authType password --userName user@contoso.com --password pass@word1
|
|
103
123
|
```
|
|
104
124
|
|
|
105
|
-
Log in to Microsoft 365 using a PEM certificate
|
|
125
|
+
Log in to Microsoft 365 using a PEM certificate with `clientId` set in the configuration.
|
|
106
126
|
|
|
107
127
|
```sh
|
|
108
128
|
m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem
|
|
109
129
|
```
|
|
110
130
|
|
|
111
|
-
Log in to Microsoft 365 using a PEM certificate. Use the specified thumbprint
|
|
131
|
+
Log in to Microsoft 365 using a PEM certificate with `clientId` set in the configuration. Use the specified thumbprint.
|
|
112
132
|
|
|
113
133
|
```sh
|
|
114
134
|
m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1
|
|
115
135
|
```
|
|
116
136
|
|
|
117
|
-
Log in to Microsoft 365 using a personal information exchange (.pfx) file
|
|
137
|
+
Log in to Microsoft 365 using a personal information exchange (.pfx) file with `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
|
|
118
138
|
|
|
119
139
|
```sh
|
|
120
140
|
m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
|
|
121
141
|
```
|
|
122
142
|
|
|
123
|
-
Log in to Microsoft 365 using a personal information exchange (.pfx) file protected with an empty password
|
|
143
|
+
Log in to Microsoft 365 using a personal information exchange (.pfx) file protected with an empty password and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
|
|
124
144
|
|
|
125
145
|
```sh
|
|
126
146
|
m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password
|
|
127
147
|
```
|
|
128
148
|
|
|
129
|
-
Log in to Microsoft 365 using a personal information exchange (.pfx) file not protected with a password
|
|
149
|
+
Log in to Microsoft 365 using a personal information exchange (.pfx) file not protected with a password and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
|
|
130
150
|
|
|
131
151
|
```sh
|
|
132
152
|
m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx
|
|
133
153
|
```
|
|
134
154
|
|
|
135
|
-
Log in to Microsoft 365 using a personal information exchange (.pfx) file. Use the specified thumbprint
|
|
155
|
+
Log in to Microsoft 365 using a personal information exchange (.pfx) file. Use the specified thumbprint and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
|
|
136
156
|
|
|
137
157
|
```sh
|
|
138
158
|
m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1 --password 'pass@word1'
|
|
139
159
|
```
|
|
140
160
|
|
|
141
|
-
Log in to Microsoft 365 using a certificate from a base64-encoded string
|
|
161
|
+
Log in to Microsoft 365 using a certificate from a base64-encoded string with `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
|
|
142
162
|
|
|
143
163
|
```sh
|
|
144
164
|
m365 login --authType certificate --certificateBase64Encoded MIII2QIBAzCCCJ8GCSqGSIb3DQEHAaCCCJAEg...eX1N5AgIIAA== --thumbprint D0C9B442DE249F55D10CDA1A2418952DC7D407A3
|
|
145
165
|
```
|
|
146
166
|
|
|
147
|
-
Log in to Microsoft 365 using a system assigned managed identity. Applies to Azure resources with managed identity enabled,
|
|
148
|
-
such as Azure Virtual Machines, Azure App Service or Azure Functions
|
|
167
|
+
Log in to Microsoft 365 using a system assigned managed identity with `clientId` set in the configuration. Applies to Azure resources with managed identity enabled, such as Azure Virtual Machines, Azure App Service or Azure Functions.
|
|
149
168
|
|
|
150
169
|
```sh
|
|
151
170
|
m365 login --authType identity
|
|
152
171
|
```
|
|
153
172
|
|
|
154
|
-
Log in to Microsoft 365 using managed identity in Azure Cloud Shell. Uses the identity of the current user.
|
|
173
|
+
Log in to Microsoft 365 using managed identity in Azure Cloud Shell with `clientId` set in the configuration. Uses the identity of the current user.
|
|
155
174
|
|
|
156
175
|
```sh
|
|
157
176
|
m365 login --authType identity
|
|
158
177
|
```
|
|
159
178
|
|
|
160
|
-
Log in to Microsoft 365 using a user-assigned managed identity. Client id or principal id also known as object id value can be specified in the `userName` option. Applies to Azure resources with managed identity enabled, such as Azure Virtual Machines, Azure App Service or Azure Functions
|
|
179
|
+
Log in to Microsoft 365 using a user-assigned managed identity with `clientId` set in the configuration. Client id or principal id also known as object id value can be specified in the `userName` option. Applies to Azure resources with managed identity enabled, such as Azure Virtual Machines, Azure App Service or Azure Functions.
|
|
161
180
|
|
|
162
181
|
```sh
|
|
163
182
|
m365 login --authType identity --userName ac9fbed5-804c-4362-a369-21a4ec51109e
|
|
164
183
|
```
|
|
165
184
|
|
|
166
|
-
Log in to Microsoft 365 using
|
|
167
|
-
|
|
168
|
-
```sh
|
|
169
|
-
m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
Log in to Microsoft 365 using your own Microsoft Entra application that's restricted only to allow accounts from the specific tenant
|
|
173
|
-
|
|
174
|
-
```sh
|
|
175
|
-
m365 login --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
Log in to Microsoft 365 using your own Microsoft Entra application and a personal information exchange (.pfx) file
|
|
179
|
-
|
|
180
|
-
```sh
|
|
181
|
-
m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
Log in to Microsoft 365 using the interactive browser authentication. Uses the identity of the current user.
|
|
185
|
+
Log in to Microsoft 365 using the interactive browser authentication with `clientId` set in the configuration. Uses the identity of the current user.
|
|
185
186
|
|
|
186
187
|
```sh
|
|
187
188
|
m365 login --authType browser
|
|
188
189
|
```
|
|
189
190
|
|
|
190
|
-
Log in to Microsoft 365 using a client secret.
|
|
191
|
+
Log in to Microsoft 365 using a client secret with `clientId` set in the configuration.
|
|
191
192
|
|
|
192
193
|
```sh
|
|
193
194
|
m365 login --authType secret --secret topSeCr3t@007
|