@pnp/cli-microsoft365 10.3.0-beta.cd20f0c → 10.3.0-beta.df85113
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 +2 -0
- package/README.md +11 -6
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/config.js +2 -1
- package/dist/m365/commands/login.js +6 -6
- package/dist/m365/entra/commands/app/app-add.js +3 -0
- package/dist/m365/entra/commands/approleassignment/approleassignment-remove.js +1 -1
- package/dist/m365/entra/commands/group/group-list.js +3 -2
- package/dist/m365/entra/commands/pim/pim-role-assignment-remove.js +186 -0
- package/dist/m365/entra/commands/roledefinition/roledefinition-add.js +58 -0
- package/dist/m365/entra/commands/roledefinition/roledefinition-set.js +84 -0
- package/dist/m365/entra/commands/rolepermission/rolepermission-list.js +42 -0
- package/dist/m365/entra/commands.js +4 -0
- package/dist/m365/exo/commands/approleassignment/approleassignment-add.js +235 -0
- package/dist/m365/exo/commands.js +5 -0
- package/dist/m365/outlook/commands/mailbox/mailbox-settings-set.js +163 -0
- package/dist/m365/outlook/commands.js +1 -0
- package/dist/m365/pp/commands/website/website-get.js +60 -0
- package/dist/m365/pp/commands.js +2 -1
- package/dist/m365/spe/commands/container/container-activate.js +50 -0
- package/dist/m365/spe/commands.js +1 -0
- package/dist/m365/spo/commands/file/file-roleassignment-add.js +26 -2
- package/dist/m365/spo/commands/file/file-roleassignment-remove.js +26 -2
- package/dist/m365/spo/commands/folder/folder-roleassignment-add.js +27 -24
- package/dist/m365/spo/commands/folder/folder-roleassignment-remove.js +24 -7
- package/dist/m365/spo/commands/list/list-defaultvalue-clear.js +184 -0
- package/dist/m365/spo/commands/list/list-defaultvalue-list.js +140 -0
- package/dist/m365/spo/commands/list/list-defaultvalue-remove.js +181 -0
- package/dist/m365/spo/commands/list/list-defaultvalue-set.js +210 -0
- package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js +25 -7
- package/dist/m365/spo/commands/listitem/listitem-roleassignment-remove.js +22 -5
- package/dist/m365/spo/commands/web/web-roleassignment-add.js +22 -5
- package/dist/m365/spo/commands/web/web-roleassignment-remove.js +22 -5
- package/dist/m365/spo/commands.js +4 -0
- package/dist/m365/tenant/commands/people/people-pronouns-set.js +46 -0
- package/dist/m365/tenant/commands/report/report-settings-set.js +47 -0
- package/dist/m365/tenant/commands.js +2 -0
- package/dist/utils/customAppScope.js +29 -0
- package/dist/utils/entraServicePrincipal.js +46 -0
- package/dist/utils/powerPlatform.js +38 -0
- package/dist/utils/roleDefinition.js +23 -0
- package/dist/utils/validation.js +4 -0
- package/docs/docs/cmd/entra/app/app-add.mdx +1 -1
- package/docs/docs/cmd/entra/pim/pim-role-assignment-remove.mdx +197 -0
- package/docs/docs/cmd/entra/roledefinition/roledefinition-add.mdx +131 -0
- package/docs/docs/cmd/entra/roledefinition/roledefinition-set.mdx +64 -0
- package/docs/docs/cmd/entra/rolepermission/rolepermission-list.mdx +162 -0
- package/docs/docs/cmd/exo/approleassignment/approleassignment-add.mdx +170 -0
- package/docs/docs/cmd/outlook/mailbox/mailbox-settings-set.mdx +166 -0
- package/docs/docs/cmd/pp/website/website-get.mdx +153 -0
- package/docs/docs/cmd/spe/container/container-activate.mdx +34 -0
- package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +21 -4
- package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +21 -3
- package/docs/docs/cmd/spo/folder/folder-roleassignment-add.mdx +15 -3
- package/docs/docs/cmd/spo/folder/folder-roleassignment-remove.mdx +15 -3
- package/docs/docs/cmd/spo/list/list-defaultvalue-clear.mdx +62 -0
- package/docs/docs/cmd/spo/list/list-defaultvalue-list.mdx +110 -0
- package/docs/docs/cmd/spo/list/list-defaultvalue-remove.mdx +62 -0
- package/docs/docs/cmd/spo/list/list-defaultvalue-set.mdx +112 -0
- package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +15 -3
- package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +17 -5
- package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +15 -3
- package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +15 -3
- package/docs/docs/cmd/tenant/people/people-pronouns-set.mdx +82 -0
- package/docs/docs/cmd/tenant/report/report-settings-set.mdx +32 -0
- package/npm-shrinkwrap.json +54 -74
- package/package.json +9 -9
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# entra roledefinition add
|
|
6
|
+
|
|
7
|
+
Creates a custom Microsoft Entra ID role definition
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 entra roledefinition add [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-n, --displayName <displayName>`
|
|
19
|
+
: The display name for the role definition.
|
|
20
|
+
|
|
21
|
+
`-a, --allowedResourceActions <allowedResourceActions>`
|
|
22
|
+
: Comma-separated list of resource actions allowed for the role.
|
|
23
|
+
|
|
24
|
+
`-d, --description [description]`
|
|
25
|
+
: The description for the role definition.
|
|
26
|
+
|
|
27
|
+
`-e, --enabled [enabled]`
|
|
28
|
+
: Indicates if the role is enabled for the assignment. If not specified, the role is enabled by default.
|
|
29
|
+
|
|
30
|
+
`-v, --version [version]`
|
|
31
|
+
: The version of the role definition.
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
<Global />
|
|
35
|
+
|
|
36
|
+
## Remarks
|
|
37
|
+
|
|
38
|
+
Use the `m365 entra rolepermission list --resourceNamespace microsoft.directory` command to get a list of available resource actions.
|
|
39
|
+
|
|
40
|
+
## Examples
|
|
41
|
+
|
|
42
|
+
Create a custom Microsoft Entra ID role
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
m365 entra roledefinition add --displayName 'Application Remover' --description 'Allows to remove any Entra ID application' --allowedResourceActions 'microsoft.directory/applications/delete'
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Create a custom Microsoft Entra ID role, but disable it for the assignment
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
m365 entra roledefinition add --displayName 'Application Remover' --version '1.0' --enabled false --allowedResourceActions 'microsoft.directory/applications/delete,microsoft.directory/applications/owners/update'
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Response
|
|
55
|
+
|
|
56
|
+
<Tabs>
|
|
57
|
+
<TabItem value="JSON">
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"id": "3844129d-f748-4c03-8165-4412ee9b4ceb",
|
|
62
|
+
"description": null,
|
|
63
|
+
"displayName": "Custom Role",
|
|
64
|
+
"isBuiltIn": false,
|
|
65
|
+
"isEnabled": true,
|
|
66
|
+
"resourceScopes": [
|
|
67
|
+
"/"
|
|
68
|
+
],
|
|
69
|
+
"templateId": "3844129d-f748-4c03-8165-4412ee9b4ceb",
|
|
70
|
+
"version": "1",
|
|
71
|
+
"rolePermissions": [
|
|
72
|
+
{
|
|
73
|
+
"allowedResourceActions": [
|
|
74
|
+
"microsoft.directory/groups.unified/create",
|
|
75
|
+
"microsoft.directory/groups.unified/delete"
|
|
76
|
+
],
|
|
77
|
+
"condition": null
|
|
78
|
+
}
|
|
79
|
+
]
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
</TabItem>
|
|
84
|
+
<TabItem value="Text">
|
|
85
|
+
|
|
86
|
+
```text
|
|
87
|
+
description : null
|
|
88
|
+
displayName : Custom Role
|
|
89
|
+
id : 3844129d-f748-4c03-8165-4412ee9b4ceb
|
|
90
|
+
isBuiltIn : false
|
|
91
|
+
isEnabled : true
|
|
92
|
+
resourceScopes : ["/"]
|
|
93
|
+
rolePermissions: [{"allowedResourceActions":["microsoft.directory/groups.unified/create","microsoft.directory/groups.unified/delete"],"condition":null}]
|
|
94
|
+
templateId : 3844129d-f748-4c03-8165-4412ee9b4ceb
|
|
95
|
+
version : 1
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
</TabItem>
|
|
99
|
+
<TabItem value="CSV">
|
|
100
|
+
|
|
101
|
+
```csv
|
|
102
|
+
id,description,displayName,isBuiltIn,isEnabled,templateId,version
|
|
103
|
+
3844129d-f748-4c03-8165-4412ee9b4ceb,,Custom Role,0,1,3844129d-f748-4c03-8165-4412ee9b4ceb,1
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
</TabItem>
|
|
107
|
+
<TabItem value="Markdown">
|
|
108
|
+
|
|
109
|
+
```md
|
|
110
|
+
# entra roledefinition add --displayName "Custom Role" --allowedResourceActions "microsoft.directory/groups.unified/create,microsoft.directory/groups.unified/delete" --version 1
|
|
111
|
+
|
|
112
|
+
Date: 12/15/2024
|
|
113
|
+
|
|
114
|
+
## Custom Role (3844129d-f748-4c03-8165-4412ee9b4ceb)
|
|
115
|
+
|
|
116
|
+
Property | Value
|
|
117
|
+
---------|-------
|
|
118
|
+
id | 3844129d-f748-4c03-8165-4412ee9b4ceb
|
|
119
|
+
displayName | Custom Role
|
|
120
|
+
isBuiltIn | false
|
|
121
|
+
isEnabled | true
|
|
122
|
+
templateId | 3844129d-f748-4c03-8165-4412ee9b4ceb
|
|
123
|
+
version | 1
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
</TabItem>
|
|
127
|
+
</Tabs>
|
|
128
|
+
|
|
129
|
+
## More information
|
|
130
|
+
|
|
131
|
+
- https://learn.microsoft.com/graph/api/rbacapplication-post-roledefinitions
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
|
|
3
|
+
# entra roledefinition set
|
|
4
|
+
|
|
5
|
+
Updates a custom Microsoft Entra ID role definition
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
m365 entra roledefinition set [options]
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Options
|
|
14
|
+
|
|
15
|
+
```md definition-list
|
|
16
|
+
`-i, --id [id]`
|
|
17
|
+
: The id of the role definition to be updated. Specify either `id` or `displayName`, but not both.
|
|
18
|
+
|
|
19
|
+
`-n, --displayName [displayName]`
|
|
20
|
+
: The display name of the role definition to be updated. Specify either `id` or `displayName`, but not both.
|
|
21
|
+
|
|
22
|
+
`--newDisplayName [newDisplayName]`
|
|
23
|
+
: Updated display name for the role definition.
|
|
24
|
+
|
|
25
|
+
`-d, --description [description]`
|
|
26
|
+
: Updated description for the role definition.
|
|
27
|
+
|
|
28
|
+
`-e, --enabled [enabled]`
|
|
29
|
+
: Indicates if the role is enabled for the assignment.
|
|
30
|
+
|
|
31
|
+
`a-, --allowedResourceActions [allowedResourceActions]`
|
|
32
|
+
: Updated comma-separated list of resource actions allowed for the role.
|
|
33
|
+
|
|
34
|
+
`-v, --version [version]`
|
|
35
|
+
: Updated version of the role definition.
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
<Global />
|
|
39
|
+
|
|
40
|
+
## Remarks
|
|
41
|
+
|
|
42
|
+
Use the `m365 entra rolepermission list --resourceNamespace microsoft.directory` command to get a list of available resource actions.
|
|
43
|
+
|
|
44
|
+
## Examples
|
|
45
|
+
|
|
46
|
+
Update a custom Microsoft Entra ID role specified by the id
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
m365 entra roledefinition set --id fadbc488-151d-4431-9143-6abbffae759f --newDisplayName 'Application Remover' --description 'Allows to remove any Entra ID application' --allowedResourceActions 'microsoft.directory/applications/delete'
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Update a custom Microsoft Entra ID role specified by the display name
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
m365 entra roledefinition set --displayName 'Application Remover' --version '1.0' --enabled true --allowedResourceActions 'microsoft.directory/applications/delete,microsoft.directory/applications/owners/update'
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Response
|
|
59
|
+
|
|
60
|
+
The command won't return a response on success
|
|
61
|
+
|
|
62
|
+
## More information
|
|
63
|
+
|
|
64
|
+
- https://learn.microsoft.com/graph/api/rbacapplication-post-roledefinitions
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# entra rolepermission list
|
|
6
|
+
|
|
7
|
+
Lists all Microsoft Entra ID role permissions
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 entra rolepermission list [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-n, --resourceNamespace [resourceNamespace]`
|
|
19
|
+
: The namespace of the resource for which to retrieve role permissions.
|
|
20
|
+
|
|
21
|
+
`-p, --privileged`
|
|
22
|
+
: Retrieve only sensitive role permissions.
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
<Global />
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
:::warning
|
|
30
|
+
|
|
31
|
+
The command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
32
|
+
|
|
33
|
+
:::
|
|
34
|
+
|
|
35
|
+
## Examples
|
|
36
|
+
|
|
37
|
+
Get a list of role permissions
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
m365 entra rolepermission list --resourceNamespace 'microsoft.directory'
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Get a list of sensitive role permissions
|
|
44
|
+
|
|
45
|
+
```sh
|
|
46
|
+
m365 entra rolepermission list --resourceNamespace 'microsoft.directory' --privileged
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
## Response
|
|
50
|
+
|
|
51
|
+
<Tabs>
|
|
52
|
+
<TabItem value="JSON">
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
[
|
|
56
|
+
{
|
|
57
|
+
"actionVerb": null,
|
|
58
|
+
"description": "Create and delete access reviews, and read and update all properties of access reviews in Microsoft Entra ID",
|
|
59
|
+
"id": "microsoft.directory-accessReviews-allProperties-allTasks",
|
|
60
|
+
"isPrivileged": false,
|
|
61
|
+
"name": "microsoft.directory/accessReviews/allProperties/allTasks",
|
|
62
|
+
"resourceScopeId": null
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"actionVerb": "GET",
|
|
66
|
+
"description": "Read all properties of access reviews",
|
|
67
|
+
"id": "microsoft.directory-accessReviews-allProperties-read-get",
|
|
68
|
+
"isPrivileged": false,
|
|
69
|
+
"name": "microsoft.directory/accessReviews/allProperties/read",
|
|
70
|
+
"resourceScopeId": null
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"actionVerb": null,
|
|
74
|
+
"description": "Manage access reviews of application role assignments in Microsoft Entra ID",
|
|
75
|
+
"id": "microsoft.directory-accessReviews-definitions.applications-allProperties-allTasks",
|
|
76
|
+
"isPrivileged": false,
|
|
77
|
+
"name": "microsoft.directory/accessReviews/definitions.applications/allProperties/allTasks",
|
|
78
|
+
"resourceScopeId": null
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
"actionVerb": "GET",
|
|
82
|
+
"description": "Read all properties of access reviews of application role assignments in Microsoft Entra ID",
|
|
83
|
+
"id": "microsoft.directory-accessReviews-definitions.applications-allProperties-read-get",
|
|
84
|
+
"isPrivileged": false,
|
|
85
|
+
"name": "microsoft.directory/accessReviews/definitions.applications/allProperties/read",
|
|
86
|
+
"resourceScopeId": null
|
|
87
|
+
}
|
|
88
|
+
]
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
</TabItem>
|
|
92
|
+
<TabItem value="Text">
|
|
93
|
+
|
|
94
|
+
```text
|
|
95
|
+
id name actionVerb isPrivileged
|
|
96
|
+
-------------------------------------------------------------------------------------- --------------------------------------------------------------------------------------- ---------- ------------
|
|
97
|
+
microsoft.directory-accessReviews-allProperties-allTasks microsoft.directory/accessReviews/allProperties/allTasks null false
|
|
98
|
+
microsoft.directory-accessReviews-allProperties-read-get microsoft.directory/accessReviews/allProperties/read GET false
|
|
99
|
+
microsoft.directory-accessReviews-definitions.applications-allProperties-allTasks microsoft.directory/accessReviews/definitions.applications/allProperties/allTasks null false
|
|
100
|
+
microsoft.directory-accessReviews-definitions.applications-allProperties-read-get microsoft.directory/accessReviews/definitions.applications/allProperties/read GET false
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
</TabItem>
|
|
104
|
+
<TabItem value="CSV">
|
|
105
|
+
|
|
106
|
+
```csv
|
|
107
|
+
actionVerb,description,id,isPrivileged,name,resourceScopeId
|
|
108
|
+
,"Create and delete access reviews, and read and update all properties of access reviews in Microsoft Entra ID",microsoft.directory-accessReviews-allProperties-allTasks,0,microsoft.directory/accessReviews/allProperties/allTasks,
|
|
109
|
+
GET,Read all properties of access reviews,microsoft.directory-accessReviews-allProperties-read-get,0,microsoft.directory/accessReviews/allProperties/read,
|
|
110
|
+
,Manage access reviews of application role assignments in Microsoft Entra ID,microsoft.directory-accessReviews-definitions.applications-allProperties-allTasks,0,microsoft.directory/accessReviews/definitions.applications/allProperties/allTasks,
|
|
111
|
+
GET,Read all properties of access reviews of application role assignments in Microsoft Entra ID,microsoft.directory-accessReviews-definitions.applications-allProperties-read-get,0,microsoft.directory/accessReviews/definitions.applications/allProperties/read,
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
</TabItem>
|
|
115
|
+
<TabItem value="Markdown">
|
|
116
|
+
|
|
117
|
+
```md
|
|
118
|
+
# entra rolepermission list --resourceNamespace "microsoft.directory"
|
|
119
|
+
|
|
120
|
+
Date: 1/16/2025
|
|
121
|
+
|
|
122
|
+
## microsoft.directory/accessReviews/allProperties/allTasks (microsoft.directory-accessReviews-allProperties-allTasks)
|
|
123
|
+
|
|
124
|
+
Property | Value
|
|
125
|
+
---------|-------
|
|
126
|
+
description | Create and delete access reviews, and read and update all properties of access reviews in Microsoft Entra ID
|
|
127
|
+
id | microsoft.directory-accessReviews-allProperties-allTasks
|
|
128
|
+
isPrivileged | false
|
|
129
|
+
name | microsoft.directory/accessReviews/allProperties/allTasks
|
|
130
|
+
|
|
131
|
+
## microsoft.directory/accessReviews/allProperties/read (microsoft.directory-accessReviews-allProperties-read-get)
|
|
132
|
+
|
|
133
|
+
Property | Value
|
|
134
|
+
---------|-------
|
|
135
|
+
actionVerb | GET
|
|
136
|
+
description | Read all properties of access reviews
|
|
137
|
+
id | microsoft.directory-accessReviews-allProperties-read-get
|
|
138
|
+
isPrivileged | false
|
|
139
|
+
name | microsoft.directory/accessReviews/allProperties/read
|
|
140
|
+
|
|
141
|
+
## microsoft.directory/accessReviews/definitions.applications/allProperties/allTasks (microsoft.directory-accessReviews-definitions.applications-allProperties-allTasks)
|
|
142
|
+
|
|
143
|
+
Property | Value
|
|
144
|
+
---------|-------
|
|
145
|
+
description | Manage access reviews of application role assignments in Microsoft Entra ID
|
|
146
|
+
id | microsoft.directory-accessReviews-definitions.applications-allProperties-allTasks
|
|
147
|
+
isPrivileged | false
|
|
148
|
+
name | microsoft.directory/accessReviews/definitions.applications/allProperties/allTasks
|
|
149
|
+
|
|
150
|
+
## microsoft.directory/accessReviews/definitions.applications/allProperties/read (microsoft.directory-accessReviews-definitions.applications-allProperties-read-get)
|
|
151
|
+
|
|
152
|
+
Property | Value
|
|
153
|
+
---------|-------
|
|
154
|
+
actionVerb | GET
|
|
155
|
+
description | Read all properties of access reviews of application role assignments in Microsoft Entra ID
|
|
156
|
+
id | microsoft.directory-accessReviews-definitions.applications-allProperties-read-get
|
|
157
|
+
isPrivileged | false
|
|
158
|
+
name | microsoft.directory/accessReviews/definitions.applications/allProperties/read
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
</TabItem>
|
|
162
|
+
</Tabs>
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# exo approleassignment add
|
|
6
|
+
|
|
7
|
+
Grants permissions to an application that's accessing data in Exchange Online and specify which mailboxes an app can access.
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 exo approleassignment add [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`--roleDefinitionId [roleDefinitionId]`
|
|
19
|
+
: Id of a role to be assigned. Specify either `roleDefinitionId` or `roleDefinitionName`, but not both.
|
|
20
|
+
|
|
21
|
+
`--roleDefinitionName [roleDefinitionName]`
|
|
22
|
+
: Name of a role to be assigned. Specify either `roleDefinitionId` or `roleDefinitionName`, but not both.
|
|
23
|
+
|
|
24
|
+
`--principalId [principalId]`
|
|
25
|
+
: Id of a service principal to which the assignment is granted. Specify either `principalId` or `principalName`, but not both.
|
|
26
|
+
|
|
27
|
+
`--principalName [principalName]`
|
|
28
|
+
: Name of a service principal to which the assignment is granted. Specify either `principalId` or `principalName`, but not both.
|
|
29
|
+
|
|
30
|
+
`-s, --scope <scope>`
|
|
31
|
+
: Scope of the roleassignment. Allowed values are: `tenant`, `administrativeUnit`, `group`, `user`, `custom`.
|
|
32
|
+
|
|
33
|
+
`--userId [userId]`
|
|
34
|
+
: Id of a user to which the assignment is scoped. Specify either `userId` or `userName` when scope is set to `user`.
|
|
35
|
+
|
|
36
|
+
`--userName [userName]`
|
|
37
|
+
: UPN of a user to which the assignment is scoped. Specify either `userId` or `userName` when scope is set to `user`.
|
|
38
|
+
|
|
39
|
+
`--groupId [groupId]`
|
|
40
|
+
: Id of a group to which the assignment is scoped. Specify either `groupId` or `groupName` when scope is set to `group`.
|
|
41
|
+
|
|
42
|
+
`--groupName [groupName]`
|
|
43
|
+
: Name of a group to which the assignment is scoped. Specify either `groupId` or `groupName` when scope is set to `group`.
|
|
44
|
+
|
|
45
|
+
`--administrativeUnitId [administrativeUnitId]`
|
|
46
|
+
: Id of an administrative unit to which the assignment is scoped. Specify either `administrativeUnitId` or `administrativeUnitName` when scope is set to `administrativeUnit`.
|
|
47
|
+
|
|
48
|
+
`--administrativeUnitName [administrativeUnitName]`
|
|
49
|
+
: Name of an administrative unit to which the assignment is scoped. Specify either `administrativeUnitId` or `administrativeUnitName` when scope is set to `administrativeUnit`.
|
|
50
|
+
|
|
51
|
+
`--customAppScopeId [customAppScopeId]`
|
|
52
|
+
: Id of a custom application scope to which the assignment is scoped. Specify either `customAppScopeId` or `customAppScopeName` when scope is set to `custom`.
|
|
53
|
+
|
|
54
|
+
`--customAppScopeName [customAppScopeName]`
|
|
55
|
+
: Name of a custom application scope to which the assignment is scoped. Specify either `customAppScopeId` or `customAppScopeName` when scope is set to `custom`.
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
<Global />
|
|
59
|
+
|
|
60
|
+
## Remarks
|
|
61
|
+
|
|
62
|
+
:::info
|
|
63
|
+
|
|
64
|
+
To use this command you must be at least **Privileged Role Administrator**.
|
|
65
|
+
|
|
66
|
+
:::
|
|
67
|
+
|
|
68
|
+
## Examples
|
|
69
|
+
|
|
70
|
+
Assign a role specified by id to a service principal specified by id and scope the assignment to the whole tenant
|
|
71
|
+
|
|
72
|
+
```sh
|
|
73
|
+
m365 exo approleassignment add --roleDefinitionId 777b752-f9b7-4205-a2b1-5db0d6a0ccfc --principalId 7a2ca997-9461-402e-9882-58088a370889 --scope tenant
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Assign a role specified by id to a service principal specified by id and scope the assignment to a user specified by id
|
|
77
|
+
|
|
78
|
+
```sh
|
|
79
|
+
m365 exo approleassignment add --roleDefinitionId 777b752-f9b7-4205-a2b1-5db0d6a0ccfc --principalId 7a2ca997-9461-402e-9882-58088a370889 --scope user --userId a4738dd8-fc0f-4646-87fb-47539f5c651b
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Assign a role specified by name to a service principal specified by name and scope the assignment to a group specified by name
|
|
83
|
+
|
|
84
|
+
```sh
|
|
85
|
+
m365 exo approleassignment add --roleDefinitionName 'Application Contacts.ReadWrite' --principalName 'ContactsSyncApp' --scope group --groupName 'Marketing'
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Assign a role specified by name to a service principal specified by id and scope the assignment to an administrative unit specified by name
|
|
89
|
+
|
|
90
|
+
```sh
|
|
91
|
+
m365 exo approleassignment add --roleDefinitionName 'Application Calendars.Read' --principalId fa631c4d-ac9f-4884-a7f5-13c659d177e3 --scope administrativeUnit --administrativeUnitName 'Equipment - EMEA'
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Response
|
|
95
|
+
|
|
96
|
+
<Tabs>
|
|
97
|
+
<TabItem value="JSON">
|
|
98
|
+
|
|
99
|
+
```json
|
|
100
|
+
{
|
|
101
|
+
"id": "6615d221-3834-4f8f-bbc9-7d0d23620a8e",
|
|
102
|
+
"principalId": "/ServicePrincipals/e483a0d9-8440-455e-8f9a-b9cac6b8b0ef",
|
|
103
|
+
"roleDefinitionId": "1f704712-7d46-481f-b2cd-dbcc978c4f2a",
|
|
104
|
+
"directoryScopeId": "/",
|
|
105
|
+
"appScopeId": null
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
</TabItem>
|
|
110
|
+
<TabItem value="Text">
|
|
111
|
+
|
|
112
|
+
```text
|
|
113
|
+
appScopeId : null
|
|
114
|
+
directoryScopeId: /
|
|
115
|
+
id : 6615d221-3834-4f8f-bbc9-7d0d23620a8e
|
|
116
|
+
principalId : /ServicePrincipals/e483a0d9-8440-455e-8f9a-b9cac6b8b0ef
|
|
117
|
+
roleDefinitionId: 1f704712-7d46-481f-b2cd-dbcc978c4f2a
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
</TabItem>
|
|
121
|
+
<TabItem value="CSV">
|
|
122
|
+
|
|
123
|
+
```csv
|
|
124
|
+
id,principalId,roleDefinitionId,directoryScopeId,appScopeId
|
|
125
|
+
6615d221-3834-4f8f-bbc9-7d0d23620a8e,/ServicePrincipals/e483a0d9-8440-455e-8f9a-b9cac6b8b0ef,1f704712-7d46-481f-b2cd-dbcc978c4f2a,/,
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
</TabItem>
|
|
129
|
+
<TabItem value="Markdown">
|
|
130
|
+
|
|
131
|
+
```md
|
|
132
|
+
# exo approleassignment add --debug "false" --verbose "false" --roleDefinitionId "1f704712-7d46-481f-b2cd-dbcc978c4f2a" --principalId "e483a0d9-8440-455e-8f9a-b9cac6b8b0ef" --scope tenant
|
|
133
|
+
|
|
134
|
+
Date: 10/3/2024
|
|
135
|
+
|
|
136
|
+
## 6615d221-3834-4f8f-bbc9-7d0d23620a8e
|
|
137
|
+
|
|
138
|
+
Property | Value
|
|
139
|
+
---------|-------
|
|
140
|
+
id | 6615d221-3834-4f8f-bbc9-7d0d23620a8e
|
|
141
|
+
principalId | /ServicePrincipals/e483a0d9-8440-455e-8f9a-b9cac6b8b0ef
|
|
142
|
+
roleDefinitionId | 1f704712-7d46-481f-b2cd-dbcc978c4f2a
|
|
143
|
+
directoryScopeId | /
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
</TabItem>
|
|
147
|
+
</Tabs>
|
|
148
|
+
|
|
149
|
+
## More information
|
|
150
|
+
|
|
151
|
+
- Role assignment: https://learn.microsoft.com/graph/api/rbacapplication-post-roleassignments?view=graph-rest-beta
|
|
152
|
+
|
|
153
|
+
The table below lists the available roles and their corresponding ids that are accepted by the `roleDefinitionId` and `roleDefinitionName` parameters.
|
|
154
|
+
|
|
155
|
+
|Role Definition Id | Role Definition Name |
|
|
156
|
+
| --- | --- |
|
|
157
|
+
|1f704712-7d46-481f-b2cd-dbcc978c4f2a|Application Mail.Read|
|
|
158
|
+
|3eca55c8-0e73-4c12-81bf-526549f2e5a3|Application Mail.ReadBasic|
|
|
159
|
+
|82fd214e-61ca-4dc7-98f6-090700bdb205|Application Mail.ReadWrite|
|
|
160
|
+
|8679f4ff-c91d-40d0-809c-c86d114821a5|Application Mail.Send|
|
|
161
|
+
|c40299e0-2107-455f-85dd-6e8862c3a0cc|Application MailboxSettings.Read|
|
|
162
|
+
|459cb245-07c5-44f1-8133-3da40b4b6197|Application MailboxSettings.ReadWrite|
|
|
163
|
+
|a3123d4e-4256-4ad0-bef0-205a00807fae|Application Calendars.Read|
|
|
164
|
+
|b92761c0-5311-4908-92ca-2c1f8c71aa1c|Application Calendars.ReadWrite|
|
|
165
|
+
|9b87c446-d3c1-4146-9d39-45ae63b4eeb7|Application Contacts.Read|
|
|
166
|
+
|265cabb3-13d9-4e05-b2cd-460cfa7ad3cc|Application Contacts.ReadWrite|
|
|
167
|
+
|b49ae303-7a8f-4ba1-aa37-27b40461aabb|Application Mail Full Access|
|
|
168
|
+
|48d6a78c-0681-4d73-acec-9f9ffad56ddb|Application Exchange Full Access|
|
|
169
|
+
|
|
170
|
+
More info about supported application roles: https://learn.microsoft.com/exchange/permissions-exo/application-rbac#supported-application-roles
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# outlook mailbox settings set
|
|
6
|
+
|
|
7
|
+
Updates user mailbox settings
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 outlook mailbox settings set [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-i, --userId [userId]`
|
|
19
|
+
: The ID of the Microsoft Entra user to update mailbox settings for. Either `userId` or `userName` is required when using application permissions.
|
|
20
|
+
|
|
21
|
+
`-n, --userName [userName]`
|
|
22
|
+
: The UPN of the Microsoft Entra user to update mailbox settings for. Either `userId` or `userName` is required when using application permissions.
|
|
23
|
+
|
|
24
|
+
`--dateFormat [dateFormat]`
|
|
25
|
+
: The date format for the user's mailbox. Example: `dd.MM.yyyy`.
|
|
26
|
+
|
|
27
|
+
`--timeFormat [timeFormat]`
|
|
28
|
+
: The time format for the user's mailbox. Example: `H:mm`.
|
|
29
|
+
|
|
30
|
+
`--timeZone [timeZone]`
|
|
31
|
+
: The default time zone for the user's mailbox. Should follow [Windows time zone name](https://learn.microsoft.com/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones) or [IANA time zone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). Example: `Central Europe Standard Time`.
|
|
32
|
+
|
|
33
|
+
`--language [language]`
|
|
34
|
+
: The preferred language for the user. Should follow [ISO 639-1 Code](https://learn.microsoft.com/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a). Example: `en-US`.
|
|
35
|
+
|
|
36
|
+
`--delegateMeetingMessageDeliveryOptions [delegateMeetingMessageDeliveryOptions]`
|
|
37
|
+
: Specifies who can receive meeting messages and meeting responses. Allowed values are `sendToDelegateOnly`, `sendToDelegateAndPrincipal`, or `sendToDelegateAndInformationToPrincipal`.
|
|
38
|
+
|
|
39
|
+
`--workingDays [workingDays]`
|
|
40
|
+
: The days of the week on which the user works, separated by a comma. Allowed values are `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, or `sunday`.
|
|
41
|
+
|
|
42
|
+
`--workingHoursStartTime [workingHoursStartTime]`
|
|
43
|
+
: The time of the day that the user starts working. Example: `09:00`.
|
|
44
|
+
|
|
45
|
+
`--workingHoursEndTime [workingHoursEndTime]`
|
|
46
|
+
: The time of the day that the user stops working. Example: `17:00`.
|
|
47
|
+
|
|
48
|
+
`--workingHoursTimeZone [workingHoursTimeZone]`
|
|
49
|
+
: The name of a time zone to which the working hours apply. Should follow [Windows time zone name](https://learn.microsoft.com/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11#time-zones) or [IANA time zone identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). Example: `Central Europe Standard Time`.
|
|
50
|
+
|
|
51
|
+
`--autoReplyExternalAudience [autoReplyExternalAudience]`
|
|
52
|
+
: Specifies external audience who will receive reply message. Allowed values are `none`, `contactsOnly`, or `all`.
|
|
53
|
+
|
|
54
|
+
`--autoReplyExternalMessage [autoReplyExternalMessage]`
|
|
55
|
+
: The reply message for the external audience.
|
|
56
|
+
|
|
57
|
+
`--autoReplyInternalMessage [autoReplyInternalMessage]`
|
|
58
|
+
: The reply message for the audience from the signed-in user's organization.
|
|
59
|
+
|
|
60
|
+
`--autoReplyStartDateTime [autoReplyStartDateTime]`
|
|
61
|
+
: The date and time that automatic replies are set to begin. Example: `2025-01-06T11:00:00.0000000`.
|
|
62
|
+
|
|
63
|
+
`--autoReplyStartTimeZone [autoReplyStartTimeZone]`
|
|
64
|
+
: The time zone that automatic replies are set to begin.
|
|
65
|
+
|
|
66
|
+
`--autoReplyEndDateTime [autoReplyEndDateTime]`
|
|
67
|
+
: The date and time that automatic replies are set to end. Example: `2025-01-07T11:00:00.0000000`.
|
|
68
|
+
|
|
69
|
+
`--autoReplyEndTimeZone [autoReplyEndTimeZone]`
|
|
70
|
+
: The time zone that automatic replies are set to end.
|
|
71
|
+
|
|
72
|
+
`--autoReplyStatus [autoReplyStatus]`
|
|
73
|
+
: The status for automatic replies. Allowed values are `disabled`, `alwaysEnabled`, or `scheduled`.
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
<Global />
|
|
77
|
+
|
|
78
|
+
## Examples
|
|
79
|
+
|
|
80
|
+
Update date, time format and time zone of the signed-in user.
|
|
81
|
+
|
|
82
|
+
```sh
|
|
83
|
+
m365 outlook mailbox settings set --dateFormat 'dd.MM.yyyy' --timeFormat 'H:mm' --timeZone 'Central Europe Standard Time' --language 'en-US'
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Update working hours of a user specified by id
|
|
87
|
+
|
|
88
|
+
```sh
|
|
89
|
+
m365 outlook mailbox settings set --userId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --workingDays 'monday,tuesday,thursday,friday' --workingHoursStartTime '08:00' --workingHoursEndTime '16:30' --workingHoursTimeZone 'Central Europe Standard Time'
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Set scheduled automatic replies for the internal audience of a user specified by UPN
|
|
93
|
+
|
|
94
|
+
```sh
|
|
95
|
+
m365 outlook mailbox settings set --userName john.doe@contoso.com --autoReplyExternalAudience none --autoReplyInternalMessage 'On vacation' --autoReplyStartDateTime '2024-08-05T08:00:00.0000000' --autoReplyStartTimeZone 'Central Europe Standard Time' --autoReplyEndDateTime '2024-08-09T16:00:00.0000000' --autoReplyEndTimeZone 'Central Europe Standard Time' --autoReplyStatus scheduled
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## Response
|
|
99
|
+
|
|
100
|
+
The command returns the updated properties of the user mailbox settings.
|
|
101
|
+
|
|
102
|
+
<Tabs>
|
|
103
|
+
<TabItem value="JSON">
|
|
104
|
+
|
|
105
|
+
```json
|
|
106
|
+
{
|
|
107
|
+
"timeZone": "Central Europe Standard Time",
|
|
108
|
+
"timeFormat": "H:mm",
|
|
109
|
+
"dateFormat": "dd.MM.yyyy",
|
|
110
|
+
"language": {
|
|
111
|
+
"locale": "en-US",
|
|
112
|
+
"displayName": "English (United States)"
|
|
113
|
+
},
|
|
114
|
+
"workingHours": {
|
|
115
|
+
"daysOfWeek": [
|
|
116
|
+
"monday",
|
|
117
|
+
"tuesday",
|
|
118
|
+
"wednesday",
|
|
119
|
+
"thursday",
|
|
120
|
+
"friday"
|
|
121
|
+
],
|
|
122
|
+
"startTime": "08:00:00.0000000",
|
|
123
|
+
"endTime": "16:30:00.0000000",
|
|
124
|
+
"timeZone": {
|
|
125
|
+
"name": "Central Europe Standard Time"
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
</TabItem>
|
|
132
|
+
<TabItem value="Text">
|
|
133
|
+
|
|
134
|
+
```text
|
|
135
|
+
dateFormat : dd.MM.yyyy
|
|
136
|
+
language : {"locale":"en-US","displayName":"English (United States)"}
|
|
137
|
+
timeFormat : H:mm
|
|
138
|
+
timeZone : Central Europe Standard Time
|
|
139
|
+
workingHours: {"daysOfWeek":["monday","tuesday","wednesday","thursday","friday"],"startTime":"08:00:00.0000000","endTime":"16:30:00.0000000","timeZone":{"name":"Central Europe Standard Time"}}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
</TabItem>
|
|
143
|
+
<TabItem value="CSV">
|
|
144
|
+
|
|
145
|
+
```csv
|
|
146
|
+
dateFormat,timeZone,timeFormat
|
|
147
|
+
dd.MM.yyy,Central Europe Standard Time,H:mm
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
</TabItem>
|
|
151
|
+
<TabItem value="Markdown">
|
|
152
|
+
|
|
153
|
+
```md
|
|
154
|
+
# outlook mailbox settings set --dateFormat "dd.MM.yyyy" --timeFormat "H:mm" --timeZone "Central Europe Standard Time" --language "en-US" --workingDays "monday,tuesday,wednesday,thursday,friday" --workingHoursStartTime "08:00:00.0000000" --workingHoursEndTime "16:30:00.0000000" --workingHoursTimeZone "Central Europe Standard Time"
|
|
155
|
+
|
|
156
|
+
Date: 1/6/2025
|
|
157
|
+
|
|
158
|
+
Property | Value
|
|
159
|
+
---------|-------
|
|
160
|
+
dateFormat | dd.MM.yyyy
|
|
161
|
+
timeZone | Central Europe Standard Time
|
|
162
|
+
timeFormat | H:mm
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
</TabItem>
|
|
166
|
+
</Tabs>
|