@pnp/cli-microsoft365 11.0.0-beta.4be9237 → 11.0.0-beta.677f8d3
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/.devproxy/api-specs/sharepoint.yaml +54 -0
- package/.eslintrc.cjs +2 -0
- package/allCommands.json +1 -1
- package/allCommandsFull.json +1 -1
- package/dist/m365/entra/commands/app/app-add.js +14 -2
- package/dist/m365/entra/commands/roleassignment/roleassignment-add.js +146 -0
- package/dist/m365/entra/commands.js +1 -0
- package/dist/m365/flow/commands/environment/environment-get.js +19 -29
- package/dist/m365/outlook/commands/mail/mail-searchfolder-add.js +85 -0
- package/dist/m365/outlook/commands.js +1 -0
- package/dist/m365/pa/commands/environment/environment-get.js +18 -23
- package/dist/m365/pp/commands/copilot/copilot-get.js +0 -4
- package/dist/m365/pp/commands/copilot/copilot-list.js +0 -4
- package/dist/m365/pp/commands/copilot/copilot-remove.js +0 -4
- package/dist/m365/pp/commands/environment/environment-get.js +19 -26
- package/dist/m365/pp/commands.js +0 -3
- package/dist/m365/spfx/commands/project/project-upgrade.js +23 -66
- package/dist/m365/spo/commands/file/file-version-keep.js +78 -0
- package/dist/m365/spo/commands/homesite/homesite-get.js +28 -14
- package/dist/m365/spo/commands/homesite/homesite-list.js +1 -12
- package/dist/m365/spo/commands/homesite/homesite-remove.js +6 -34
- package/dist/m365/spo/commands/list/list-view-add.js +1 -1
- package/dist/m365/spo/commands/serviceprincipal/serviceprincipal-grant-list.js +17 -25
- package/dist/m365/spo/commands.js +1 -1
- package/dist/utils/entraAdministrativeUnit.js +1 -1
- package/dist/utils/entraApp.js +15 -0
- package/docs/docs/cmd/entra/app/app-add.mdx +7 -1
- package/docs/docs/cmd/entra/roleassignment/roleassignment-add.mdx +163 -0
- package/docs/docs/cmd/flow/environment/environment-get.mdx +6 -5
- package/docs/docs/cmd/outlook/mail/mail-searchfolder-add.mdx +147 -0
- package/docs/docs/cmd/pa/environment/environment-get.mdx +5 -2
- package/docs/docs/cmd/pp/copilot/copilot-get.mdx +0 -6
- package/docs/docs/cmd/pp/copilot/copilot-list.mdx +0 -6
- package/docs/docs/cmd/pp/copilot/copilot-remove.mdx +0 -6
- package/docs/docs/cmd/pp/environment/environment-get.mdx +5 -2
- package/docs/docs/cmd/spfx/project/project-upgrade.mdx +18 -5
- package/docs/docs/cmd/spo/file/file-version-keep.mdx +68 -0
- package/docs/docs/cmd/spo/homesite/homesite-get.mdx +44 -23
- package/docs/docs/cmd/spo/homesite/homesite-list.mdx +0 -6
- package/docs/docs/cmd/spo/homesite/homesite-remove.mdx +10 -35
- package/docs/docs/cmd/spo/list/list-view-add.mdx +11 -11
- package/docs/docs/cmd/spo/serviceprincipal/serviceprincipal-grant-list.mdx +18 -18
- package/package.json +1 -1
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# entra roleassignment add
|
|
6
|
+
|
|
7
|
+
Assign a Entra ID role to a user and specify the scope for which the user has been granted access
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 entra roleassignment 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
|
+
`--principal <principal>`
|
|
25
|
+
: Id of a user, group or service principal or user principal name or group mail nickname to which the assignment is granted.
|
|
26
|
+
|
|
27
|
+
`--userId [userId]`
|
|
28
|
+
: Id of a user to which the assignment is scoped.
|
|
29
|
+
|
|
30
|
+
`--userName [userName]`
|
|
31
|
+
: User principal name of a user to which the assignment is scoped.
|
|
32
|
+
|
|
33
|
+
`--administrativeUnitId [administrativeUnitId]`
|
|
34
|
+
: Id of an administrative unit to which the assignment is scoped.
|
|
35
|
+
|
|
36
|
+
`--administrativeUnitName [administrativeUnitName]`
|
|
37
|
+
: Name of an administrative unit to which the assignment is scoped.
|
|
38
|
+
|
|
39
|
+
`--applicationId [applicationId]`
|
|
40
|
+
: Id of an application to which the assignment is scoped.
|
|
41
|
+
|
|
42
|
+
`applicationObjectId [applicationObjectId]`
|
|
43
|
+
: Object Id of an application to which the assignment is scoped.
|
|
44
|
+
|
|
45
|
+
`--applicationName [applicationName]`
|
|
46
|
+
: Name of an application to which the assignment is scoped.
|
|
47
|
+
|
|
48
|
+
`--servicePrincipalId [servicePrincipalId]`
|
|
49
|
+
: Id of a service principal to which the assignment is scoped.
|
|
50
|
+
|
|
51
|
+
`--servicePrincipalName [servicePrincipalName]`
|
|
52
|
+
: Name of a service principal to which the assignment is scoped.
|
|
53
|
+
|
|
54
|
+
`--groupId [groupId]`
|
|
55
|
+
: Id of a group to which the assignment is scoped.
|
|
56
|
+
|
|
57
|
+
`--groupName [groupName]`
|
|
58
|
+
: Name of a group to which the assignment is scoped.
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
<Global />
|
|
62
|
+
|
|
63
|
+
## Permissions
|
|
64
|
+
|
|
65
|
+
<Tabs>
|
|
66
|
+
<TabItem value="Delegated">
|
|
67
|
+
|
|
68
|
+
| Resource | Permissions |
|
|
69
|
+
|-----------------|------------------------------------|
|
|
70
|
+
| Microsoft Graph | RoleManagement.ReadWrite.Directory |
|
|
71
|
+
|
|
72
|
+
</TabItem>
|
|
73
|
+
<TabItem value="Application">
|
|
74
|
+
|
|
75
|
+
| Resource | Permissions |
|
|
76
|
+
|-----------------|------------------------------------|
|
|
77
|
+
| Microsoft Graph | RoleManagement.ReadWrite.Directory |
|
|
78
|
+
|
|
79
|
+
</TabItem>
|
|
80
|
+
</Tabs>
|
|
81
|
+
|
|
82
|
+
## Examples
|
|
83
|
+
|
|
84
|
+
Assign a role specified by name to a user specified by id and scope the assignment to the whole tenant
|
|
85
|
+
|
|
86
|
+
```sh
|
|
87
|
+
m365 entra roleassignment add --roleDefinitionName 'SharePoint Administrator' --principal 7a2ca997-9461-402e-9882-58088a370889
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Assign a role specified by id to a user specified by UPN and scope the assignment to a service principal specified by id
|
|
91
|
+
|
|
92
|
+
```sh
|
|
93
|
+
m365 entra roleassignment add --roleDefinitionId 777b752-f9b7-4205-a2b1-5db0d6a0ccfc --principal john.doe@contoso.com --servicePrincipalId a4738dd8-fc0f-4646-87fb-47539f5c651b
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Assign a role specified by name to a group specified by mail nickname and scope the assignment to an administrative unit specified by name
|
|
97
|
+
|
|
98
|
+
```sh
|
|
99
|
+
m365 entra roleassignment add --roleDefinitionName 'User Administrator' --principal 'contoso-group' --administrativeUnitName 'Marketing'
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Assign a role specified by name to a service principal specified by id and scope the assignment to an application specified by id
|
|
103
|
+
|
|
104
|
+
```sh
|
|
105
|
+
m365 entra roleassignment add --roleDefinitionName 'Application Administrator' --principal ab2ca997-9461-402e-9882-58088a370889 --applicationId 47539fd8-fc0f-4646-87fb-a4738d5c651b
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Response
|
|
109
|
+
|
|
110
|
+
<Tabs>
|
|
111
|
+
<TabItem value="JSON">
|
|
112
|
+
|
|
113
|
+
```json
|
|
114
|
+
{
|
|
115
|
+
"id": "s4awkmfj8k64aR3hKPuYbhaRP4kk4MZLjphUwkUSlIU-1",
|
|
116
|
+
"principalId": "3844129d-f748-4c03-8165-4412ee9b4ceb",
|
|
117
|
+
"directoryScopeId": "/",
|
|
118
|
+
"roleDefinitionId": "92b086b3-e367-4ef2-b869-1de128fb986e"
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
</TabItem>
|
|
123
|
+
<TabItem value="Text">
|
|
124
|
+
|
|
125
|
+
```text
|
|
126
|
+
directoryScopeId: /
|
|
127
|
+
id : s4awkmfj8k64aR3hKPuYbhaRP4kk4MZLjphUwkUSlIU-1
|
|
128
|
+
principalId : 3844129d-f748-4c03-8165-4412ee9b4ceb
|
|
129
|
+
roleDefinitionId: 92b086b3-e367-4ef2-b869-1de128fb986e
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
</TabItem>
|
|
133
|
+
<TabItem value="CSV">
|
|
134
|
+
|
|
135
|
+
```csv
|
|
136
|
+
id,principalId,directoryScopeId,roleDefinitionId
|
|
137
|
+
s4awkmfj8k64aR3hKPuYbhaRP4kk4MZLjphUwkUSlIU-1,3844129d-f748-4c03-8165-4412ee9b4ceb,/,92b086b3-e367-4ef2-b869-1de128fb986e
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
</TabItem>
|
|
141
|
+
<TabItem value="Markdown">
|
|
142
|
+
|
|
143
|
+
```md
|
|
144
|
+
# entra roleassignment add --roleDefinitionId "92b086b3-e367-4ef2-b869-1de128fb986e" --principal "3844129d-f748-4c03-8165-4412ee9b4ceb"
|
|
145
|
+
|
|
146
|
+
Date: 7/3/2025
|
|
147
|
+
|
|
148
|
+
## s4awkmfj8k64aR3hKPuYbhaRP4kk4MZLjphUwkUSlIU-1
|
|
149
|
+
|
|
150
|
+
Property | Value
|
|
151
|
+
---------|-------
|
|
152
|
+
id | s4awkmfj8k64aR3hKPuYbhaRP4kk4MZLjphUwkUSlIU-1
|
|
153
|
+
principalId | 3844129d-f748-4c03-8165-4412ee9b4ceb
|
|
154
|
+
directoryScopeId | /
|
|
155
|
+
roleDefinitionId | 92b086b3-e367-4ef2-b869-1de128fb986e
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
</TabItem>
|
|
159
|
+
</Tabs>
|
|
160
|
+
|
|
161
|
+
## More information
|
|
162
|
+
|
|
163
|
+
- https://learn.microsoft.com/graph/api/rbacapplication-post-roleassignments
|
|
@@ -16,7 +16,10 @@ m365 flow environment get [options]
|
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`-n, --name [name]`
|
|
19
|
-
: The name of the environment to get information about. When not specified, the default environment is retrieved.
|
|
19
|
+
: The name of the environment to get information about. When not specified, the default environment is retrieved. Specify either `name` or `default`, but not both.
|
|
20
|
+
|
|
21
|
+
`--default`
|
|
22
|
+
: Indicates that the default environment should be retrieved. Specify either `name` or `default`, but not both.
|
|
20
23
|
```
|
|
21
24
|
|
|
22
25
|
<Global />
|
|
@@ -42,13 +45,11 @@ m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
|
|
|
42
45
|
Get information about the default Microsoft Flow environment.
|
|
43
46
|
|
|
44
47
|
```sh
|
|
45
|
-
m365 flow environment get
|
|
48
|
+
m365 flow environment get --default
|
|
46
49
|
```
|
|
47
50
|
|
|
48
51
|
## Response
|
|
49
52
|
|
|
50
|
-
### Standard response
|
|
51
|
-
|
|
52
53
|
<Tabs>
|
|
53
54
|
<TabItem value="JSON">
|
|
54
55
|
|
|
@@ -153,7 +154,7 @@ m365 flow environment get
|
|
|
153
154
|
<TabItem value="Markdown">
|
|
154
155
|
|
|
155
156
|
```md
|
|
156
|
-
# flow environment get
|
|
157
|
+
# flow environment get --default
|
|
157
158
|
|
|
158
159
|
Date: 8/2/2023
|
|
159
160
|
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# outlook mail searchfolder add
|
|
6
|
+
|
|
7
|
+
Creates a new mail search folder in the user's mailbox
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 outlook mail searchfolder add [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-i, --userId [userId]`
|
|
19
|
+
: The id of the user in whose mailbox the search folder should be created. Specify either `userId` or `userName`, but not both.
|
|
20
|
+
|
|
21
|
+
`-n, --userName [userName]`
|
|
22
|
+
: The UPN of the user in whose mailbox the search folder should be created. Specify either `userId` or `userName`, but not both.
|
|
23
|
+
|
|
24
|
+
`--folderName <folderName>`
|
|
25
|
+
: The name of the mail search folder.
|
|
26
|
+
|
|
27
|
+
`--sourceFolderIds <sourceFolderIds>`
|
|
28
|
+
: Comma-separated list of mail folders that should be searched.
|
|
29
|
+
|
|
30
|
+
`--includeNestedFolders`
|
|
31
|
+
: The nested mail folders will be searched if specified.
|
|
32
|
+
|
|
33
|
+
`--messageFilter <messageFilter>`
|
|
34
|
+
: The OData query to filter the messages.
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
<Global />
|
|
38
|
+
|
|
39
|
+
## Permissions
|
|
40
|
+
|
|
41
|
+
<Tabs>
|
|
42
|
+
<TabItem value="Delegated">
|
|
43
|
+
|
|
44
|
+
| Resource | Permissions |
|
|
45
|
+
|-----------------|----------------|
|
|
46
|
+
| Microsoft Graph | Mail.ReadWrite |
|
|
47
|
+
|
|
48
|
+
</TabItem>
|
|
49
|
+
<TabItem value="Application">
|
|
50
|
+
|
|
51
|
+
| Resource | Permissions |
|
|
52
|
+
|-----------------|----------------|
|
|
53
|
+
| Microsoft Graph | Mail.ReadWrite |
|
|
54
|
+
|
|
55
|
+
</TabItem>
|
|
56
|
+
</Tabs>
|
|
57
|
+
|
|
58
|
+
## Examples
|
|
59
|
+
|
|
60
|
+
Create a mail search folder in the user's mailbox specified by id for messages from the inbox that contain specific subject
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
m365 outlook mail searchfolder add --userId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --folderName 'CLI m365' --sourceFolderIds 'AQMkADYAAAIBDAAAAA==' --messageFilter "contains(subject, 'CLI for Microsoft 365')"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Create a mail search folder in the user's mailbox specified by UPN for incoming and outgoing messages from a specific year that contain specific text in a message body, search for messages inside all subfolders
|
|
67
|
+
|
|
68
|
+
```sh
|
|
69
|
+
m365 outlook mail searchfolder add --userName john.doe@contoso.com --folderName 'Power Platform Community' --sourceFolderIds 'AQMkADYAAAIBDAAAAA==,AQMkADYAAAIBDBBBBB==' --includeNestedFolders --messageFilter "contains(body/content,'Power Platform') AND receivedDateTime ge 2024-01-01 AND receivedDateTime le 2024-12-31"
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Response
|
|
73
|
+
|
|
74
|
+
<Tabs>
|
|
75
|
+
<TabItem value="JSON">
|
|
76
|
+
|
|
77
|
+
```json
|
|
78
|
+
{
|
|
79
|
+
"id": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco84sgAAAA==",
|
|
80
|
+
"displayName": "Microsoft Entra",
|
|
81
|
+
"parentFolderId": "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA",
|
|
82
|
+
"childFolderCount": 0,
|
|
83
|
+
"unreadItemCount": 27,
|
|
84
|
+
"totalItemCount": 41,
|
|
85
|
+
"sizeInBytes": null,
|
|
86
|
+
"isHidden": false,
|
|
87
|
+
"isSupported": true,
|
|
88
|
+
"includeNestedFolders": false,
|
|
89
|
+
"sourceFolderIds": [
|
|
90
|
+
"AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEMAAAA"
|
|
91
|
+
],
|
|
92
|
+
"filterQuery": "contains(subject,'Microsoft Entra ID')"
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
</TabItem>
|
|
97
|
+
<TabItem value="Text">
|
|
98
|
+
|
|
99
|
+
```text
|
|
100
|
+
childFolderCount : 0
|
|
101
|
+
displayName : Microsoft Entra
|
|
102
|
+
filterQuery : contains(subject,'Microsoft Entra ID')
|
|
103
|
+
id : AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88nAAAAA==
|
|
104
|
+
includeNestedFolders: false
|
|
105
|
+
isHidden : false
|
|
106
|
+
isSupported : true
|
|
107
|
+
parentFolderId : AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA
|
|
108
|
+
sizeInBytes : null
|
|
109
|
+
sourceFolderIds : ["AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEMAAAA"]
|
|
110
|
+
totalItemCount : 41
|
|
111
|
+
unreadItemCount : 27
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
</TabItem>
|
|
115
|
+
<TabItem value="CSV">
|
|
116
|
+
|
|
117
|
+
```csv
|
|
118
|
+
id,displayName,parentFolderId,childFolderCount,unreadItemCount,totalItemCount,sizeInBytes,isHidden,isSupported,includeNestedFolders,filterQuery
|
|
119
|
+
AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88ngAAAA==,Microsoft Entra,AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA,0,27,41,,,1,,"contains(subject,'Microsoft Entra ID')"
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
</TabItem>
|
|
123
|
+
<TabItem value="Markdown">
|
|
124
|
+
|
|
125
|
+
```md
|
|
126
|
+
# outlook mail searchfolder add --debug "false" --verbose "false" --userName "john.doe@contoso.com" --folderName "Microsoft Entra4" --messageFilter "contains(subject,'Microsoft Entra ID')" --sourceFoldersIds "AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEMAAAA"
|
|
127
|
+
|
|
128
|
+
Date: 9/6/2024
|
|
129
|
+
|
|
130
|
+
## Microsoft Entra (AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88oAAAAA==)
|
|
131
|
+
|
|
132
|
+
Property | Value
|
|
133
|
+
---------|-------
|
|
134
|
+
id | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQABco88oAAAAA==
|
|
135
|
+
displayName | Microsoft Entra
|
|
136
|
+
parentFolderId | AQMkAGRlM2Y5YTkzLWI2NzAtNDczOS05YHqjbDnRgQAAAgEEAAAA
|
|
137
|
+
childFolderCount | 0
|
|
138
|
+
unreadItemCount | 27
|
|
139
|
+
totalItemCount | 41
|
|
140
|
+
isHidden | false
|
|
141
|
+
isSupported | true
|
|
142
|
+
includeNestedFolders | false
|
|
143
|
+
filterQuery | contains(subject,'Microsoft Entra ID')
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
</TabItem>
|
|
147
|
+
</Tabs>
|
|
@@ -16,7 +16,10 @@ m365 pa environment get [options]
|
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`-n, --name [name]`
|
|
19
|
-
: The name of the environment. When not specified, the default environment is retrieved.
|
|
19
|
+
: The name of the environment. When not specified, the default environment is retrieved. Specify either `name` or `default`, but not both.
|
|
20
|
+
|
|
21
|
+
`--default`
|
|
22
|
+
: Indicates that the default environment should be retrieved. Specify either `name` or `default`, but not both.
|
|
20
23
|
```
|
|
21
24
|
|
|
22
25
|
<Global />
|
|
@@ -36,7 +39,7 @@ If the environment with the name you specified doesn't exist, you will get the `
|
|
|
36
39
|
Get information about the default Power Apps environment.
|
|
37
40
|
|
|
38
41
|
```sh
|
|
39
|
-
m365 pa environment get
|
|
42
|
+
m365 pa environment get --default
|
|
40
43
|
```
|
|
41
44
|
|
|
42
45
|
Get information about the Power Apps environment with the specified name.
|
|
@@ -16,7 +16,10 @@ m365 pp environment get [options]
|
|
|
16
16
|
|
|
17
17
|
```md definition-list
|
|
18
18
|
`-n, --name [name]`
|
|
19
|
-
: The name of the environment. When not specified, the default environment is retrieved.
|
|
19
|
+
: The name of the environment. When not specified, the default environment is retrieved. Specify either `name` or `default`, but not both.
|
|
20
|
+
|
|
21
|
+
`--default`
|
|
22
|
+
: Indicates that the default environment should be retrieved. Specify either `name` or `default`, but not both.
|
|
20
23
|
|
|
21
24
|
`--asAdmin`
|
|
22
25
|
: Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to.
|
|
@@ -53,7 +56,7 @@ m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --as
|
|
|
53
56
|
Get information about the default Power Platform environment.
|
|
54
57
|
|
|
55
58
|
```sh
|
|
56
|
-
m365 pp environment get
|
|
59
|
+
m365 pp environment get --default
|
|
57
60
|
```
|
|
58
61
|
|
|
59
62
|
## Response
|
|
@@ -22,13 +22,26 @@ m365 spfx project upgrade [options]
|
|
|
22
22
|
: The package manager you use. Supported managers `npm`, `pnpm`, `yarn`. Default `npm`
|
|
23
23
|
|
|
24
24
|
`--shell [shell]`
|
|
25
|
-
: The shell you use. Supported shells `bash`, `powershell`, `cmd`. Default `
|
|
25
|
+
: The shell you use. Supported shells `bash`, `powershell`, `cmd`. Default `powershell`
|
|
26
26
|
|
|
27
27
|
`--preview`
|
|
28
28
|
: Upgrade project to the latest SPFx preview version
|
|
29
|
-
```
|
|
30
29
|
|
|
31
|
-
|
|
30
|
+
`-h, --help [help]`
|
|
31
|
+
: Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are `options`, `examples`, `remarks`, `permissions`, `response`, `full`. Default is `options`.
|
|
32
|
+
|
|
33
|
+
`--query [query]`
|
|
34
|
+
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples.
|
|
35
|
+
|
|
36
|
+
`-o, --output [output]`
|
|
37
|
+
: Output type. `json`, `text`, `csv`, `md`, `tour`, `none`. Default `json`.
|
|
38
|
+
|
|
39
|
+
`--verbose`
|
|
40
|
+
: Runs command with verbose logging.
|
|
41
|
+
|
|
42
|
+
`--debug`
|
|
43
|
+
: Runs command with debug logging.
|
|
44
|
+
```
|
|
32
45
|
|
|
33
46
|
## Remarks
|
|
34
47
|
|
|
@@ -83,7 +96,7 @@ m365 spfx project upgrade --output text
|
|
|
83
96
|
Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using PowerShell
|
|
84
97
|
|
|
85
98
|
```sh
|
|
86
|
-
m365 spfx project upgrade --
|
|
99
|
+
m365 spfx project upgrade --output text
|
|
87
100
|
```
|
|
88
101
|
|
|
89
102
|
Get instructions to upgrade the current SharePoint Framework project to the latest version of SharePoint Framework and save the findings in a [CodeTour](https://aka.ms/codetour) file
|
|
@@ -134,7 +147,7 @@ When upgrading an SPFx project built using version 1.15.0 to SPFx version 1.15.2
|
|
|
134
147
|
<TabItem value="Text">
|
|
135
148
|
|
|
136
149
|
```text
|
|
137
|
-
Execute in
|
|
150
|
+
Execute in powershell
|
|
138
151
|
-----------------------
|
|
139
152
|
npm i -SE @microsoft/sp-core-library@1.15.2
|
|
140
153
|
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import Global from '/docs/cmd/_global.mdx';
|
|
2
|
+
import Tabs from '@theme/Tabs';
|
|
3
|
+
import TabItem from '@theme/TabItem';
|
|
4
|
+
|
|
5
|
+
# spo file version keep
|
|
6
|
+
|
|
7
|
+
Ensure that a specific file version will never expire
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
m365 spo file version keep [options]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Options
|
|
16
|
+
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-u, --webUrl <webUrl>`
|
|
19
|
+
: The URL of the site where the file is located.
|
|
20
|
+
|
|
21
|
+
`--fileUrl [fileUrl]`
|
|
22
|
+
: The server- or site-relative decoded URL. Specify either `fileUrl` or `fileId` but not both.
|
|
23
|
+
|
|
24
|
+
`-i, --fileId [fileId]`
|
|
25
|
+
: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
|
|
26
|
+
|
|
27
|
+
`--label <label>`
|
|
28
|
+
: Label of the version.
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
<Global />
|
|
32
|
+
|
|
33
|
+
## Permissions
|
|
34
|
+
|
|
35
|
+
<Tabs>
|
|
36
|
+
<TabItem value="Delegated">
|
|
37
|
+
|
|
38
|
+
| Resource | Permissions |
|
|
39
|
+
|------------|----------------|
|
|
40
|
+
| SharePoint | AllSites.Write |
|
|
41
|
+
|
|
42
|
+
</TabItem>
|
|
43
|
+
<TabItem value="Application">
|
|
44
|
+
|
|
45
|
+
| Resource | Permissions |
|
|
46
|
+
|------------|---------------------|
|
|
47
|
+
| SharePoint | Sites.ReadWrite.All |
|
|
48
|
+
|
|
49
|
+
</TabItem>
|
|
50
|
+
</Tabs>
|
|
51
|
+
|
|
52
|
+
## Examples
|
|
53
|
+
|
|
54
|
+
Mark a file version as never expiring by file URL.
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
m365 spo file version keep --webUrl "https://contoso.sharepoint.com/sites/marketing" --fileUrl "/sites/marketing/Documents/report.docx" --label "6.0"
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Mark a file version as never expiring by file ID.
|
|
61
|
+
|
|
62
|
+
```sh
|
|
63
|
+
m365 spo file version keep --webUrl "https://contoso.sharepoint.com/sites/marketing" --fileId "12345678-90ab-cdef-1234-567890abcdef" --label "6.0"
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Response
|
|
67
|
+
|
|
68
|
+
The command won't return a response on success.
|
|
@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
|
|
|
4
4
|
|
|
5
5
|
# spo homesite get
|
|
6
6
|
|
|
7
|
-
Gets information about
|
|
7
|
+
Gets information about a home site
|
|
8
8
|
|
|
9
9
|
## Usage
|
|
10
10
|
|
|
@@ -14,14 +14,19 @@ m365 spo homesite get [options]
|
|
|
14
14
|
|
|
15
15
|
## Options
|
|
16
16
|
|
|
17
|
+
```md definition-list
|
|
18
|
+
`-u, --url <url>`
|
|
19
|
+
: URL of the home site.
|
|
20
|
+
```
|
|
21
|
+
|
|
17
22
|
<Global />
|
|
18
23
|
|
|
19
24
|
## Examples
|
|
20
25
|
|
|
21
|
-
Get information about
|
|
26
|
+
Get information about a home site.
|
|
22
27
|
|
|
23
28
|
```sh
|
|
24
|
-
m365 spo homesite get
|
|
29
|
+
m365 spo homesite get --url https://contoso.sharepoint.com/sites/Home
|
|
25
30
|
```
|
|
26
31
|
|
|
27
32
|
## Response
|
|
@@ -31,11 +36,21 @@ m365 spo homesite get
|
|
|
31
36
|
|
|
32
37
|
```json
|
|
33
38
|
{
|
|
34
|
-
"
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
+
"Audiences": [
|
|
40
|
+
{
|
|
41
|
+
"Email": "Marketing@contoso.onmicrosoft.com",
|
|
42
|
+
"Id": "contoso73155a8f-4db7-42e7-baf4-c724d24bf373",
|
|
43
|
+
"Title": "Marketing Members"
|
|
44
|
+
}
|
|
45
|
+
],
|
|
46
|
+
"IsInDraftMode": false,
|
|
47
|
+
"IsVivaBackendSite": false,
|
|
48
|
+
"SiteId": "e16a5a81-67fb-4a5e-a959-1f33ae44c69f",
|
|
49
|
+
"TargetedLicenseType": 0,
|
|
50
|
+
"Title": "Home",
|
|
51
|
+
"Url": "https://contoso.sharepoint.com/",
|
|
52
|
+
"VivaConnectionsDefaultStart": false,
|
|
53
|
+
"WebId": "2779dcbb-fae0-4b0c-a845-89ab4c941fab"
|
|
39
54
|
}
|
|
40
55
|
```
|
|
41
56
|
|
|
@@ -43,39 +58,45 @@ m365 spo homesite get
|
|
|
43
58
|
<TabItem value="Text">
|
|
44
59
|
|
|
45
60
|
```text
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
61
|
+
Audiences : [{"Email":"Marketing@contoso.onmicrosoft.com","Id":"contoso73155a8f-4db7-42e7-baf4-c724d24bf373","Title":"Marketing Members"}]
|
|
62
|
+
IsInDraftMode : false
|
|
63
|
+
IsVivaBackendSite : false
|
|
64
|
+
SiteId : e16a5a81-67fb-4a5e-a959-1f33ae44c69f
|
|
65
|
+
TargetedLicenseType : 0
|
|
66
|
+
Title : Home
|
|
67
|
+
Url : https://contoso.sharepoint.com/
|
|
68
|
+
VivaConnectionsDefaultStart: false
|
|
69
|
+
WebId : 2779dcbb-fae0-4b0c-a845-89ab4c941fab
|
|
51
70
|
```
|
|
52
71
|
|
|
53
72
|
</TabItem>
|
|
54
73
|
<TabItem value="CSV">
|
|
55
74
|
|
|
56
75
|
```csv
|
|
57
|
-
SiteId,
|
|
58
|
-
|
|
76
|
+
IsInDraftMode,IsVivaBackendSite,SiteId,TargetedLicenseType,Title,Url,VivaConnectionsDefaultStart,WebId
|
|
77
|
+
0,0,e16a5a81-67fb-4a5e-a959-1f33ae44c69f,0,Home,https://contoso.sharepoint.com/,0,2779dcbb-fae0-4b0c-a845-89ab4c941fab
|
|
59
78
|
```
|
|
60
79
|
|
|
61
80
|
</TabItem>
|
|
62
81
|
<TabItem value="Markdown">
|
|
63
82
|
|
|
64
83
|
```md
|
|
65
|
-
# spo homesite get
|
|
84
|
+
# spo homesite get --url "https://contoso.sharepoint.com"
|
|
66
85
|
|
|
67
|
-
Date:
|
|
86
|
+
Date: 23/08/2025
|
|
68
87
|
|
|
69
|
-
##
|
|
88
|
+
## Home (https://contoso.sharepoint.com/)
|
|
70
89
|
|
|
71
90
|
Property | Value
|
|
72
91
|
---------|-------
|
|
73
92
|
IsInDraftMode | false
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
Title |
|
|
78
|
-
Url | https://contoso.sharepoint.com/
|
|
93
|
+
IsVivaBackendSite | false
|
|
94
|
+
SiteId | e16a5a81-67fb-4a5e-a959-1f33ae44c69f
|
|
95
|
+
TargetedLicenseType | 0
|
|
96
|
+
Title | Home
|
|
97
|
+
Url | https://contoso.sharepoint.com/
|
|
98
|
+
VivaConnectionsDefaultStart | false
|
|
99
|
+
WebId | 2779dcbb-fae0-4b0c-a845-89ab4c941fab
|
|
79
100
|
```
|
|
80
101
|
|
|
81
102
|
</TabItem>
|