@pnp/cli-microsoft365 9.0.0-beta.2f8dd1e → 9.0.0-beta.59b026e
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.cjs +1 -0
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/Auth.js +10 -18
- package/dist/Command.js +49 -2
- package/dist/chili/chili.js +0 -23
- package/dist/cli/cli.js +61 -101
- package/dist/config.js +1 -1
- package/dist/m365/app/commands/permission/permission-add.js +9 -9
- package/dist/m365/commands/login.js +44 -96
- package/dist/m365/commands/setup.js +0 -4
- package/dist/m365/commands/status.js +2 -2
- package/dist/m365/connection/commands/connection-remove.js +6 -2
- package/dist/m365/connection/commands/connection-set.js +4 -1
- package/dist/m365/connection/commands/connection-use.js +25 -4
- 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-set.js +66 -29
- package/dist/m365/entra/commands/m365group/m365group-user-add.js +109 -32
- package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
- package/dist/m365/entra/commands/m365group/m365group-user-set.js +159 -84
- package/dist/m365/entra/commands/multitenant/MultitenantOrganization.js +2 -0
- package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
- package/dist/m365/entra/commands/multitenant/multitenant-get.js +32 -0
- package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
- package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
- package/dist/m365/entra/commands.js +4 -0
- package/dist/m365/external/commands/connection/connection-doctor.js +10 -24
- package/dist/m365/flow/commands/flow-get.js +1 -1
- package/dist/m365/flow/commands/flow-list.js +23 -24
- package/dist/m365/graph/commands/subscription/subscription-add.js +4 -2
- package/dist/m365/outlook/commands/message/message-get.js +11 -11
- package/dist/m365/spe/ContainerTypeProperties.js +2 -0
- package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
- package/dist/m365/spe/commands.js +2 -1
- package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
- package/dist/m365/spfx/commands/project/base-project-command.js +36 -126
- package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
- package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
- package/dist/m365/spo/commands/cdn/cdn-get.js +12 -15
- package/dist/m365/spo/commands/cdn/cdn-set.js +6 -4
- package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
- package/dist/m365/spo/commands/contenttype/contenttype-field-list.js +124 -0
- package/dist/m365/spo/commands/field/field-list.js +1 -1
- package/dist/m365/spo/commands/file/file-copy.js +55 -34
- package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
- package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
- package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
- package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
- package/dist/m365/spo/commands/folder/folder-set.js +0 -4
- package/dist/m365/spo/commands/folder/folder-sharinglink-get.js +86 -0
- package/dist/m365/spo/commands/folder/folder-sharinglink-list.js +110 -0
- package/dist/m365/spo/commands/group/group-member-add.js +103 -99
- package/dist/m365/spo/commands/list/ListInstance.js +6 -1
- package/dist/m365/spo/commands/list/list-get.js +9 -3
- package/dist/m365/spo/commands/list/list-list.js +1 -4
- package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
- package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
- package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +2 -3
- package/dist/m365/spo/commands/page/page-text-add.js +2 -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/spo-search.js +3 -4
- package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
- package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
- package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
- package/dist/m365/spo/commands.js +3 -1
- package/dist/m365/teams/commands/meeting/meeting-attendancereport-get.js +119 -0
- package/dist/m365/teams/commands/message/message-remove.js +112 -0
- package/dist/m365/teams/commands.js +2 -0
- package/dist/m365/viva/commands/engage/engage-community-add.js +166 -0
- package/dist/m365/viva/commands.js +1 -0
- package/dist/utils/drive.js +61 -0
- package/dist/utils/formatting.js +30 -1
- package/dist/utils/spo.js +143 -6
- package/dist/utils/teams.js +49 -0
- package/dist/utils/validation.js +19 -0
- package/dist/utils/zod.js +124 -0
- package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
- package/docs/docs/cmd/connection/connection-use.mdx +8 -2
- 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-set.mdx +37 -7
- package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +28 -10
- package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
- package/docs/docs/cmd/entra/m365group/m365group-user-set.mdx +35 -11
- package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
- package/docs/docs/cmd/entra/multitenant/multitenant-get.mdx +94 -0
- package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
- package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
- package/docs/docs/cmd/external/connection/connection-doctor.mdx +9 -9
- package/docs/docs/cmd/flow/flow-get.mdx +149 -283
- package/docs/docs/cmd/flow/flow-list.mdx +114 -56
- package/docs/docs/cmd/graph/subscription/subscription-add.mdx +18 -0
- package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
- package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
- package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
- package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +87 -38
- package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
- package/docs/docs/cmd/spo/cdn/cdn-set.mdx +3 -3
- package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
- package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
- package/docs/docs/cmd/spo/contenttype/contenttype-field-list.mdx +172 -0
- package/docs/docs/cmd/spo/contenttype/contenttype-list.mdx +3 -3
- package/docs/docs/cmd/spo/field/field-list.mdx +3 -3
- package/docs/docs/cmd/spo/file/file-copy.mdx +119 -12
- package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
- package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
- package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
- package/docs/docs/cmd/spo/folder/folder-set.mdx +0 -6
- package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +110 -0
- package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +114 -0
- package/docs/docs/cmd/spo/group/group-member-add.mdx +34 -27
- package/docs/docs/cmd/spo/list/list-get.mdx +6 -0
- package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
- package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
- package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
- package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
- package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
- package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
- package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
- package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +11 -2
- package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
- package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
- package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
- package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
- package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
- package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
- package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
- package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
- package/docs/docs/cmd/teams/meeting/meeting-attendancereport-get.mdx +138 -0
- package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
- package/docs/docs/cmd/teams/message/message-remove.mdx +63 -0
- package/docs/docs/cmd/viva/engage/engage-community-add.mdx +168 -0
- package/npm-shrinkwrap.json +588 -1022
- package/package.json +7 -3
|
@@ -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
|
|
@@ -35,10 +35,22 @@ m365 aad m365group set [options]
|
|
|
35
35
|
: Comma-separated list of Microsoft 365 Group members to add
|
|
36
36
|
|
|
37
37
|
`--isPrivate [isPrivate]`
|
|
38
|
-
: Set to true if the Microsoft 365 Group should be private and
|
|
38
|
+
: Set to `true` if the Microsoft 365 Group should be private and `false` if it should be public.
|
|
39
39
|
|
|
40
40
|
`-l, --logoPath [logoPath]`
|
|
41
41
|
: Local path to the image file to use as group logo
|
|
42
|
+
|
|
43
|
+
`--allowExternalSenders [allowExternalSenders]`
|
|
44
|
+
: Indicates if people external to the organization can send messages to the group. Valid values: `true`, `false`.
|
|
45
|
+
|
|
46
|
+
`--autoSubscribeNewMembers [autoSubscribeNewMembers]`
|
|
47
|
+
: Indicates if new members added to the group will be auto-subscribed to receive email notifications. Valid values: `true`, `false`.
|
|
48
|
+
|
|
49
|
+
`--hideFromAddressLists [hideFromAddressLists]`
|
|
50
|
+
: Indicates if the group is not displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups. Valid values: `true`, `false`.
|
|
51
|
+
|
|
52
|
+
`--hideFromOutlookClients [hideFromOutlookClients]`
|
|
53
|
+
: Indicates if the group is not displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. Valid values: `true`, `false`.
|
|
42
54
|
```
|
|
43
55
|
|
|
44
56
|
<Global />
|
|
@@ -49,38 +61,56 @@ When updating group's owners and members, the command will add newly specified u
|
|
|
49
61
|
|
|
50
62
|
When specifying the path to the logo image you can use both relative and absolute paths. Note, that ~ in the path, will not be resolved and will most likely result in an error.
|
|
51
63
|
|
|
64
|
+
:::note
|
|
65
|
+
|
|
66
|
+
Options `allowExternalSenders` and `autoSubscribeNewMembers` can only be set using delegated permissions.
|
|
67
|
+
|
|
68
|
+
:::
|
|
69
|
+
|
|
52
70
|
## Examples
|
|
53
71
|
|
|
54
|
-
Update Microsoft 365 Group display name
|
|
72
|
+
Update Microsoft 365 Group display name.
|
|
55
73
|
|
|
56
74
|
```sh
|
|
57
75
|
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --displayName Finance
|
|
58
76
|
```
|
|
59
77
|
|
|
60
|
-
Change Microsoft 365 Group visibility to public
|
|
78
|
+
Change Microsoft 365 Group visibility to public.
|
|
61
79
|
|
|
62
80
|
```sh
|
|
63
|
-
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate false
|
|
81
|
+
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate `false`
|
|
64
82
|
```
|
|
65
83
|
|
|
66
|
-
Add new Microsoft 365 Group owners
|
|
84
|
+
Add new Microsoft 365 Group owners.
|
|
67
85
|
|
|
68
86
|
```sh
|
|
69
87
|
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --owners "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
|
|
70
88
|
```
|
|
71
89
|
|
|
72
|
-
Add new Microsoft 365 Group members
|
|
90
|
+
Add new Microsoft 365 Group members.
|
|
73
91
|
|
|
74
92
|
```sh
|
|
75
93
|
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --members "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
|
|
76
94
|
```
|
|
77
95
|
|
|
78
|
-
Update Microsoft 365 Group logo
|
|
96
|
+
Update Microsoft 365 Group logo.
|
|
79
97
|
|
|
80
98
|
```sh
|
|
81
99
|
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --logoPath images/logo.png
|
|
82
100
|
```
|
|
83
101
|
|
|
102
|
+
Hide the Microsoft 365 group from the address lists and the Outlook clients.
|
|
103
|
+
|
|
104
|
+
```sh
|
|
105
|
+
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --hideFromOutlookClients true --hideFromAddressLists true
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
Auto-subscribe new members to receive email notifications and do not allow external senders to send messages to the group.
|
|
109
|
+
|
|
110
|
+
```sh
|
|
111
|
+
m365 entra m365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --autoSubscribeNewMembers true --allowExternalSenders false
|
|
112
|
+
```
|
|
113
|
+
|
|
84
114
|
## Response
|
|
85
115
|
|
|
86
116
|
The command won't return a response on success.
|
|
@@ -26,13 +26,25 @@ m365 teams user add
|
|
|
26
26
|
|
|
27
27
|
```md definition-list
|
|
28
28
|
`-i, --groupId [groupId]`
|
|
29
|
-
: The ID of the Microsoft 365
|
|
29
|
+
: The ID of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
30
|
+
|
|
31
|
+
`--groupName [groupName]`
|
|
32
|
+
: The display name of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
30
33
|
|
|
31
34
|
`--teamId [teamId]`
|
|
32
|
-
: The ID of the Teams team
|
|
35
|
+
: The ID of the Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
36
|
+
|
|
37
|
+
`--teamName [teamName]`
|
|
38
|
+
: The display name of the Microsoft Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
39
|
+
|
|
40
|
+
`-n, --userName [userName]`
|
|
41
|
+
: (deprecated) User's UPN (User Principal Name), e.g. johndoe@example.com.
|
|
42
|
+
|
|
43
|
+
`--ids [ids]`
|
|
44
|
+
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both.
|
|
33
45
|
|
|
34
|
-
|
|
35
|
-
:
|
|
46
|
+
`--userNames [userNames]`
|
|
47
|
+
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.
|
|
36
48
|
|
|
37
49
|
`-r, --role [role]`
|
|
38
50
|
: The role to be assigned to the new user: `Owner,Member`. Default `Member`
|
|
@@ -42,22 +54,28 @@ m365 teams user add
|
|
|
42
54
|
|
|
43
55
|
## Examples
|
|
44
56
|
|
|
45
|
-
Add a new member to the specified Microsoft 365 Group
|
|
57
|
+
Add a new member with the userNames parameter to the specified Microsoft 365 Group
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
m365 entra m365group user add --groupId '00000000-0000-0000-0000-000000000000' --userNames 'anne.matthews@contoso.onmicrosoft.com'
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Add multiple new owners with the userNames parameter to the specified Microsoft 365 Group
|
|
46
64
|
|
|
47
65
|
```sh
|
|
48
|
-
m365 entra m365group user add --
|
|
66
|
+
m365 entra m365group user add --groupName 'Contoso' --userNames 'anne.matthews@contoso.onmicrosoft.com, john.doe@contoso.onmicrosoft.com' --role Owner
|
|
49
67
|
```
|
|
50
68
|
|
|
51
|
-
Add a new
|
|
69
|
+
Add a new member with the userNames parameter to the specified Microsoft Teams team
|
|
52
70
|
|
|
53
71
|
```sh
|
|
54
|
-
m365 entra m365group
|
|
72
|
+
m365 entra m365group member add --teamId '00000000-0000-0000-0000-000000000000' --userNames 'anne.matthews@contoso.onmicrosoft.com' --role Member
|
|
55
73
|
```
|
|
56
74
|
|
|
57
|
-
Add
|
|
75
|
+
Add multiple new members with the ids parameter to the specified Microsoft Teams team
|
|
58
76
|
|
|
59
77
|
```sh
|
|
60
|
-
m365
|
|
78
|
+
m365 entra m365group user add --teamName 'Engineering' --ids '74a3b772-3122-447b-b9da-10895e238219,dd3d21e4-a142-46b9-8482-bca8fe9596b3' --role Member
|
|
61
79
|
```
|
|
62
80
|
|
|
63
81
|
## 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.
|
|
@@ -2,7 +2,7 @@ import Global from '/docs/cmd/_global.mdx';
|
|
|
2
2
|
|
|
3
3
|
# entra m365group user set
|
|
4
4
|
|
|
5
|
-
Updates role of the specified
|
|
5
|
+
Updates role of the specified users in the specified Microsoft 365 Group or Microsoft Teams team
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
|
@@ -24,13 +24,25 @@ m365 aad teams user set
|
|
|
24
24
|
|
|
25
25
|
```md definition-list
|
|
26
26
|
`-i, --groupId [groupId]`
|
|
27
|
-
: The ID of the Microsoft 365 group
|
|
27
|
+
: The ID of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
28
|
+
|
|
29
|
+
`--groupName [groupName]`
|
|
30
|
+
: The display name of the Microsoft 365 group. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
28
31
|
|
|
29
32
|
`--teamId [teamId]`
|
|
30
|
-
: The ID of the
|
|
33
|
+
: The ID of the Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
34
|
+
|
|
35
|
+
`--teamName [teamName]`
|
|
36
|
+
: The display name of the Microsoft Teams team. Specify only one of the following: `groupId`, `groupName`, `teamId`, or `teamName`.
|
|
37
|
+
|
|
38
|
+
`-n, --userName [userName]`
|
|
39
|
+
: (deprecated) User's UPN (User Principal Name), e.g. johndoe@example.com.
|
|
31
40
|
|
|
32
|
-
|
|
33
|
-
:
|
|
41
|
+
`--ids [ids]`
|
|
42
|
+
: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify only one of the following `userName`, `ids` or `userNames`.
|
|
43
|
+
|
|
44
|
+
`--userNames [userNames]`
|
|
45
|
+
: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify only one of the following `userName`, `ids` or `userNames`.
|
|
34
46
|
|
|
35
47
|
`-r, --role <role>`
|
|
36
48
|
: Role to set for the given user in the specified Microsoft 365 Group or Microsoft Teams team. Allowed values: `Owner`, `Member`
|
|
@@ -44,28 +56,40 @@ The command will return an error if the user already has the specified role in t
|
|
|
44
56
|
|
|
45
57
|
## Examples
|
|
46
58
|
|
|
47
|
-
Promote
|
|
59
|
+
Promote a single user to Owner of the given Microsoft 365 Group
|
|
48
60
|
|
|
49
61
|
```sh
|
|
50
62
|
m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Owner
|
|
51
63
|
```
|
|
52
64
|
|
|
53
|
-
|
|
65
|
+
Promote multiple users specified by the userNames parameter to Owner of the given Microsoft 365 Group
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
m365 entra m365group user set --groupName 'Contoso' --userNames 'anne.matthews@contoso.onmicrosoft.com,john.doe@contoso.onmicrosoft.com' --role Owner
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Promote multiple users specified by the ids parameter to Owner of the given Microsoft 365 Group
|
|
72
|
+
|
|
73
|
+
```sh
|
|
74
|
+
m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --ids '74a3b772-3122-447b-b9da-10895e238219,dd3d21e4-a142-46b9-8482-bca8fe9596b3' --role Owner
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Demote a single user from Owner to Member in the given Microsoft 365 Group
|
|
54
78
|
|
|
55
79
|
```sh
|
|
56
80
|
m365 entra m365group user set --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Member
|
|
57
81
|
```
|
|
58
82
|
|
|
59
|
-
|
|
83
|
+
Demote multiple users specified by the userNames parameter from Owner to Member of the given Microsoft Teams team
|
|
60
84
|
|
|
61
85
|
```sh
|
|
62
|
-
m365 entra teams user set --teamId '00000000-0000-0000-0000-000000000000' --
|
|
86
|
+
m365 entra teams user set --teamId '00000000-0000-0000-0000-000000000000' --userNames 'anne.matthews@contoso.onmicrosoft.com,john.doe@contoso.onmicrosoft.com' --role Member
|
|
63
87
|
```
|
|
64
88
|
|
|
65
|
-
Demote
|
|
89
|
+
Demote multiple users specified by the ids parameter from Owner to Member in the given Microsoft Teams team
|
|
66
90
|
|
|
67
91
|
```sh
|
|
68
|
-
m365 entra teams user set --
|
|
92
|
+
m365 entra teams user set --teamName 'Engineering' --ids '74a3b772-3122-447b-b9da-10895e238219,dd3d21e4-a142-46b9-8482-bca8fe9596b3' --role Member
|
|
69
93
|
```
|
|
70
94
|
|
|
71
95
|
## Response
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# entra multitenant add
|
|
6
|
+
|
|
7
|
+
Creates a new multitenant organization
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 entra multitenant add [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-n, --displayname <displayName>`
|
|
19
|
+
: Display name for the multitenant organization.
|
|
20
|
+
|
|
21
|
+
`-d, --description [description]`
|
|
22
|
+
: Description for the multitenant organiztion.
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
<Global />
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
:::info
|
|
30
|
+
|
|
31
|
+
To use this command you must be at least **Security Administrator**.
|
|
32
|
+
|
|
33
|
+
:::
|
|
34
|
+
|
|
35
|
+
## Examples
|
|
36
|
+
|
|
37
|
+
Create a new multitenant organization with display name only.
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
m365 entra multitenant add --displayName 'Contoso organization'
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Create a new multitenant organization with display name and description.
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
m365 entra multitenant add --displayName 'Contoso organization' --description 'Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank'
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Response
|
|
50
|
+
|
|
51
|
+
<Tabs>
|
|
52
|
+
<TabItem value="JSON">
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"id": "c231d4a5-138f-4bdf-9fee-f26a90ea3ad0",
|
|
57
|
+
"createdDateTime": "2024-05-05T05:05:05Z",
|
|
58
|
+
"state": "active",
|
|
59
|
+
"displayName": "Contoso organization",
|
|
60
|
+
"description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
</TabItem>
|
|
65
|
+
<TabItem value="Text">
|
|
66
|
+
|
|
67
|
+
```text
|
|
68
|
+
createdDateTime: 2024-05-05T05:05:05Z
|
|
69
|
+
description : Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
|
|
70
|
+
displayName : Contoso organization
|
|
71
|
+
id : c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
|
|
72
|
+
state : active
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
</TabItem>
|
|
76
|
+
<TabItem value="CSV">
|
|
77
|
+
|
|
78
|
+
```csv
|
|
79
|
+
id,createdDateTime,state,displayName,description
|
|
80
|
+
c231d4a5-138f-4bdf-9fee-f26a90ea3ad0,2024-05-05T05:05:05Z,active,Contoso organization,"Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
</TabItem>
|
|
84
|
+
<TabItem value="Markdown">
|
|
85
|
+
|
|
86
|
+
```md
|
|
87
|
+
# entra multitenant add
|
|
88
|
+
|
|
89
|
+
Date: 5/5/2024
|
|
90
|
+
|
|
91
|
+
## Contoso organization (c231d4a5-138f-4bdf-9fee-f26a90ea3ad0)
|
|
92
|
+
|
|
93
|
+
Property | Value
|
|
94
|
+
---------|-------
|
|
95
|
+
id | c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
|
|
96
|
+
createdDateTime | 2024-05-05T05:05:05Z
|
|
97
|
+
state | active
|
|
98
|
+
displayName | Contoso organization
|
|
99
|
+
description | Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
</TabItem>
|
|
103
|
+
</Tabs>
|
|
104
|
+
|
|
105
|
+
## More information
|
|
106
|
+
|
|
107
|
+
- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
|
|
2
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
3
|
+
import Tabs from '@theme/Tabs';
|
|
4
|
+
import TabItem from '@theme/TabItem';
|
|
5
|
+
|
|
6
|
+
# entra multitenant get
|
|
7
|
+
|
|
8
|
+
Gets properties of the multitenant organization
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
m365 entra multitenant get [options]
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Options
|
|
17
|
+
|
|
18
|
+
<Global />
|
|
19
|
+
|
|
20
|
+
## Remarks
|
|
21
|
+
|
|
22
|
+
:::info
|
|
23
|
+
|
|
24
|
+
To use this command you must be at least **Security Administrator**.
|
|
25
|
+
|
|
26
|
+
:::
|
|
27
|
+
|
|
28
|
+
## Examples
|
|
29
|
+
|
|
30
|
+
Gets properties of the multitenant organization
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
m365 entra multitenant get
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Response
|
|
37
|
+
|
|
38
|
+
<Tabs>
|
|
39
|
+
<TabItem value="JSON">
|
|
40
|
+
|
|
41
|
+
```json
|
|
42
|
+
{
|
|
43
|
+
"id": "c231d4a5-138f-4bdf-9fee-f26a90ea3ad0",
|
|
44
|
+
"createdDateTime": "2024-05-05T05:05:05Z",
|
|
45
|
+
"state": "active",
|
|
46
|
+
"displayName": "Contoso organization",
|
|
47
|
+
"description": "Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
</TabItem>
|
|
52
|
+
<TabItem value="Text">
|
|
53
|
+
|
|
54
|
+
```text
|
|
55
|
+
createdDateTime: 2024-05-05T05:05:05Z
|
|
56
|
+
description : Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
|
|
57
|
+
displayName : Contoso organization
|
|
58
|
+
id : c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
|
|
59
|
+
state : active
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
</TabItem>
|
|
63
|
+
<TabItem value="CSV">
|
|
64
|
+
|
|
65
|
+
```csv
|
|
66
|
+
id,createdDateTime,state,displayName,description
|
|
67
|
+
c231d4a5-138f-4bdf-9fee-f26a90ea3ad0,2024-05-05T05:05:05Z,active,Contoso organization,"Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank"
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
</TabItem>
|
|
71
|
+
<TabItem value="Markdown">
|
|
72
|
+
|
|
73
|
+
```md
|
|
74
|
+
# entra multitenant get
|
|
75
|
+
|
|
76
|
+
Date: 5/5/2024
|
|
77
|
+
|
|
78
|
+
## Contoso organization (c231d4a5-138f-4bdf-9fee-f26a90ea3ad0)
|
|
79
|
+
|
|
80
|
+
Property | Value
|
|
81
|
+
---------|-------
|
|
82
|
+
id | c231d4a5-138f-4bdf-9fee-f26a90ea3ad0
|
|
83
|
+
createdDateTime | 2024-05-05T05:05:05Z
|
|
84
|
+
state | active
|
|
85
|
+
displayName | Contoso organization
|
|
86
|
+
description | Multitenant organization between Contoso, Fabrikam, and Woodgrove Bank
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
</TabItem>
|
|
90
|
+
</Tabs>
|
|
91
|
+
|
|
92
|
+
## More information
|
|
93
|
+
|
|
94
|
+
- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
|
|
3
|
+
# entra multitenant remove
|
|
4
|
+
|
|
5
|
+
Removes a multitenant organization
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
m365 entra multitenant remove [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## options
|
|
14
|
+
|
|
15
|
+
```md definition-list
|
|
16
|
+
`-f, --force`
|
|
17
|
+
: Don't prompt for confirmation.
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
<Global />
|
|
21
|
+
|
|
22
|
+
## Remarks
|
|
23
|
+
|
|
24
|
+
:::info
|
|
25
|
+
|
|
26
|
+
To use this command you must be at least **Security Administrator**.
|
|
27
|
+
|
|
28
|
+
:::
|
|
29
|
+
|
|
30
|
+
:::info
|
|
31
|
+
|
|
32
|
+
When removing a Multi-Tenant Organization, all associations with other tenants will be removed too.
|
|
33
|
+
|
|
34
|
+
The removing process can take up to 2 hours to complete.
|
|
35
|
+
|
|
36
|
+
:::
|
|
37
|
+
|
|
38
|
+
## Examples
|
|
39
|
+
|
|
40
|
+
Remove the multitenant organization.
|
|
41
|
+
|
|
42
|
+
```sh
|
|
43
|
+
m365 entra multitenant remove
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Remove the multitenant organization without prompting for confirmation.
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
m365 entra multitenant remove --force
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Response
|
|
53
|
+
|
|
54
|
+
The command won't return a response on success
|
|
55
|
+
|
|
56
|
+
## More information
|
|
57
|
+
|
|
58
|
+
- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
|
|
3
|
+
# entra multitenant set
|
|
4
|
+
|
|
5
|
+
Updates the properties of a multitenant organization
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
m365 entra multitenant set [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Options
|
|
14
|
+
|
|
15
|
+
```md definition-list
|
|
16
|
+
`-n, --displayName [displayName]`
|
|
17
|
+
: New display name of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
|
|
18
|
+
|
|
19
|
+
`-d, --description [description]`
|
|
20
|
+
: New description of the multitenant organization. Both options, `displayName` and `description` are optional but at least must be specified.
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
<Global />
|
|
24
|
+
|
|
25
|
+
## Remarks
|
|
26
|
+
|
|
27
|
+
:::info
|
|
28
|
+
|
|
29
|
+
To use this command you must be at least **Security Administrator**.
|
|
30
|
+
|
|
31
|
+
:::
|
|
32
|
+
|
|
33
|
+
## Examples
|
|
34
|
+
|
|
35
|
+
Update display name of multitenant organization.
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 entra multitenant set --displayName 'Fabrikam organization'
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Update display name and description of multitenant organization.
|
|
42
|
+
|
|
43
|
+
```sh
|
|
44
|
+
m365 entra multitenant set --displayName 'Fabrikam organization' --description 'Multitenant organization between Fabrikam and Contoso'
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Response
|
|
48
|
+
|
|
49
|
+
The command won't return a response on success
|
|
50
|
+
|
|
51
|
+
## More information
|
|
52
|
+
|
|
53
|
+
- Multitenant organization: https://learn.microsoft.com/entra/identity/multi-tenant-organizations/overview
|