@pnp/cli-microsoft365 5.0.0-beta.aff293c → 5.0.0-beta.cdbc898
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/.devcontainer/Dockerfile +2 -2
- package/.devcontainer/devcontainer.json +9 -1
- package/.eslintrc.js +1 -0
- package/README.md +1 -1
- package/dist/Utils.js +7 -0
- package/dist/appInsights.js +5 -2
- package/dist/cli/Cli.js +24 -4
- package/dist/m365/aad/commands/app/app-add.js +58 -5
- package/dist/m365/aad/commands/app/app-get.js +97 -0
- package/dist/m365/aad/commands/group/group-list.js +41 -0
- package/dist/m365/aad/commands/o365group/{GroupUser.js → GroupExtended.js} +1 -1
- package/dist/m365/aad/commands/o365group/o365group-add.js +56 -50
- package/dist/m365/aad/commands/o365group/o365group-user-set.js +3 -3
- package/dist/m365/aad/commands/oauth2grant/oauth2grant-add.js +5 -8
- package/dist/m365/aad/commands/oauth2grant/oauth2grant-list.js +7 -7
- package/dist/m365/aad/commands/oauth2grant/oauth2grant-remove.js +36 -12
- package/dist/m365/aad/commands/oauth2grant/oauth2grant-set.js +3 -3
- package/dist/m365/aad/commands/sp/sp-add.js +107 -0
- package/dist/m365/aad/commands/sp/sp-get.js +44 -21
- package/dist/m365/aad/commands/user/user-get.js +33 -6
- package/dist/m365/aad/commands/user/user-hibp.js +67 -0
- package/dist/m365/aad/commands/user/user-password-validate.js +42 -0
- package/dist/m365/aad/commands.js +5 -0
- package/dist/m365/app/commands/permission/permission-list.js +266 -0
- package/dist/m365/app/commands.js +7 -0
- package/dist/m365/base/AppCommand.js +76 -0
- package/dist/m365/{aad/commands/o365group/Group.js → base/M365RcJson.js} +1 -1
- package/dist/m365/cli/commands/cli-doctor.js +2 -0
- package/dist/m365/cli/commands/config/config-set.js +4 -1
- package/dist/m365/file/commands/file-add.js +32 -13
- package/dist/m365/file/commands/file-list.js +181 -0
- package/dist/m365/file/commands.js +2 -1
- package/dist/m365/pa/cds-project-mutator.js +1 -1
- package/dist/m365/pa/commands/app/app-list.js +28 -1
- package/dist/m365/planner/commands/task/task-add.js +288 -0
- package/dist/m365/planner/commands.js +1 -0
- package/dist/m365/search/commands/externalconnection/externalconnection-add.js +99 -0
- package/dist/m365/search/commands.js +7 -0
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006005_CFG_PS_metadata.js +63 -0
- package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006006_CFG_PS_features.js +60 -0
- package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.13.1.js +53 -0
- package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.14.0-beta.4.js +57 -0
- package/dist/m365/spfx/commands/project/project-upgrade.js +17 -13
- package/dist/m365/spfx/commands/spfx-doctor.js +176 -62
- package/dist/m365/spo/commands/contenttype/contenttype-list.js +52 -0
- package/dist/m365/spo/commands/group/group-user-add.js +64 -13
- package/dist/m365/spo/commands/list/list-get.js +6 -2
- package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +90 -0
- package/dist/m365/spo/commands/page/Page.js +3 -1
- package/dist/m365/spo/commands/page/page-add.js +7 -10
- package/dist/m365/spo/commands/page/page-set.js +7 -10
- package/dist/m365/spo/commands/site/site-ensure.js +1 -1
- package/dist/m365/spo/commands/site/site-recyclebinitem-list.js +76 -0
- package/dist/m365/spo/commands/site/site-remove.js +98 -30
- package/dist/m365/spo/commands/web/web-installedlanguage-list.js +48 -0
- package/dist/m365/spo/commands.js +5 -1
- package/dist/m365/teams/commands/app/app-list.js +9 -6
- package/dist/m365/teams/commands/chat/chat-list.js +43 -0
- package/dist/m365/teams/commands/chat/chat-member-list.js +42 -0
- package/dist/m365/teams/commands/chat/chat-message-list.js +60 -0
- package/dist/m365/teams/commands/message/message-get.js +1 -1
- package/dist/m365/teams/commands/report/report-directroutingcalls.js +1 -1
- package/dist/m365/teams/commands/report/report-pstncalls.js +1 -1
- package/dist/m365/teams/commands/tab/tab-get.js +9 -6
- package/dist/m365/teams/commands.js +3 -0
- package/dist/request.js +9 -4
- package/dist/settingsNames.js +6 -1
- package/docs/docs/cmd/_global.md +2 -2
- package/docs/docs/cmd/aad/app/app-add.md +11 -0
- package/docs/docs/cmd/aad/app/app-get.md +48 -0
- package/docs/docs/cmd/aad/group/group-list.md +21 -0
- package/docs/docs/cmd/aad/o365group/o365group-add.md +1 -0
- package/docs/docs/cmd/aad/oauth2grant/oauth2grant-list.md +4 -3
- package/docs/docs/cmd/aad/oauth2grant/oauth2grant-remove.md +9 -0
- package/docs/docs/cmd/aad/oauth2grant/oauth2grant-set.md +3 -2
- package/docs/docs/cmd/aad/sp/sp-add.md +53 -0
- package/docs/docs/cmd/aad/sp/sp-get.md +2 -1
- package/docs/docs/cmd/aad/user/user-get.md +13 -4
- package/docs/docs/cmd/aad/user/user-hibp.md +46 -0
- package/docs/docs/cmd/aad/user/user-password-validate.md +29 -0
- package/docs/docs/cmd/app/permission/permission-list.md +36 -0
- package/docs/docs/cmd/file/file-add.md +11 -0
- package/docs/docs/cmd/file/file-list.md +46 -0
- package/docs/docs/cmd/pa/app/app-list.md +17 -1
- package/docs/docs/cmd/planner/task/task-add.md +78 -0
- package/docs/docs/cmd/search/externalconnection/externalconnection-add.md +43 -0
- package/docs/docs/cmd/spfx/project/project-externalize.md +1 -1
- package/docs/docs/cmd/spfx/project/project-rename.md +1 -1
- package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
- package/docs/docs/cmd/spfx/spfx-doctor.md +1 -1
- package/docs/docs/cmd/spo/contenttype/contenttype-list.md +33 -0
- package/docs/docs/cmd/spo/group/group-user-add.md +24 -6
- package/docs/docs/cmd/spo/list/list-get.md +9 -0
- package/docs/docs/cmd/spo/listitem/listitem-attachment-list.md +39 -0
- package/docs/docs/cmd/spo/page/page-add.md +2 -2
- package/docs/docs/cmd/spo/page/page-set.md +3 -3
- package/docs/docs/cmd/spo/site/site-recyclebinitem-list.md +40 -0
- package/docs/docs/cmd/spo/site/site-remove.md +3 -1
- package/docs/docs/cmd/spo/web/web-installedlanguage-list.md +24 -0
- package/docs/docs/cmd/teams/chat/chat-list.md +30 -0
- package/docs/docs/cmd/teams/chat/chat-member-list.md +24 -0
- package/docs/docs/cmd/teams/chat/chat-message-list.md +24 -0
- package/docs/docs/cmd/teams/message/message-get.md +0 -3
- package/docs/docs/cmd/teams/report/report-directroutingcalls.md +0 -3
- package/docs/docs/cmd/teams/report/report-pstncalls.md +4 -3
- package/npm-shrinkwrap.json +1137 -1756
- package/package.json +37 -29
|
@@ -11,10 +11,13 @@ m365 aad user get [options]
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
13
|
`-i, --id [id]`
|
|
14
|
-
: The ID of the user to retrieve information for.
|
|
14
|
+
: The ID of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
|
|
15
15
|
|
|
16
16
|
`-n, --userName [userName]`
|
|
17
|
-
: The name of the user to retrieve information for.
|
|
17
|
+
: The name of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
|
|
18
|
+
|
|
19
|
+
`--email [email]`
|
|
20
|
+
: The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
|
|
18
21
|
|
|
19
22
|
`-p, --properties [properties]`
|
|
20
23
|
: Comma-separated list of properties to retrieve
|
|
@@ -23,9 +26,9 @@ m365 aad user get [options]
|
|
|
23
26
|
|
|
24
27
|
## Remarks
|
|
25
28
|
|
|
26
|
-
You can retrieve information about a user, either by specifying that user's id
|
|
29
|
+
You can retrieve information about a user, either by specifying that user's id, user name (`userPrincipalName`), or email (`mail`), but not all.
|
|
27
30
|
|
|
28
|
-
If the user with the specified id
|
|
31
|
+
If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
|
|
29
32
|
|
|
30
33
|
## Examples
|
|
31
34
|
|
|
@@ -41,6 +44,12 @@ Get information about the user with user name _AarifS@contoso.onmicrosoft.com_
|
|
|
41
44
|
m365 aad user get --userName AarifS@contoso.onmicrosoft.com
|
|
42
45
|
```
|
|
43
46
|
|
|
47
|
+
Get information about the user with email _AarifS@contoso.onmicrosoft.com_
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
m365 aad user get --email AarifS@contoso.onmicrosoft.com
|
|
51
|
+
```
|
|
52
|
+
|
|
44
53
|
For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user name, e-mail address and full name
|
|
45
54
|
|
|
46
55
|
```sh
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# aad user hibp
|
|
2
|
+
|
|
3
|
+
Allows you to retrieve all accounts that have been pwned with the specified username
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 aad user hibp [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-n, --userName <userName>`
|
|
14
|
+
: The name of the user to retrieve information for.
|
|
15
|
+
|
|
16
|
+
`--apiKey, <apiKey>`
|
|
17
|
+
: Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
|
|
18
|
+
|
|
19
|
+
`--domain, [domain]`
|
|
20
|
+
: Limit the returned breaches only contain results with the domain specified.
|
|
21
|
+
|
|
22
|
+
--8<-- "docs/cmd/_global.md"
|
|
23
|
+
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
|
|
27
|
+
|
|
28
|
+
If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
|
|
29
|
+
|
|
30
|
+
## Examples
|
|
31
|
+
|
|
32
|
+
Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## More information
|
|
45
|
+
|
|
46
|
+
- Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# aad user password validate
|
|
2
|
+
|
|
3
|
+
Check a user's password against the organization's password validation policy
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 aad user password validate [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-p, --password <password>`
|
|
14
|
+
: The password to be validated.
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Remarks
|
|
19
|
+
|
|
20
|
+
!!! attention
|
|
21
|
+
This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
|
|
22
|
+
|
|
23
|
+
## Examples
|
|
24
|
+
|
|
25
|
+
Validate password _cli365P@ssW0rd_ against the organization's password validation policy
|
|
26
|
+
|
|
27
|
+
```sh
|
|
28
|
+
m365 aad user password validate --password "cli365P@ssW0rd"
|
|
29
|
+
```
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# app permission list
|
|
2
|
+
|
|
3
|
+
Lists API permissions for the current AAD app
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 app permission list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`--appId [appId]`
|
|
14
|
+
: Client ID of the Azure AD app registered in the .m365rc.json file to retrieve API permissions for
|
|
15
|
+
|
|
16
|
+
--8<-- "docs/cmd/_global.md"
|
|
17
|
+
|
|
18
|
+
## Remarks
|
|
19
|
+
|
|
20
|
+
Use this command to quickly look up API permissions for the Azure AD application registration registered in the .m365rc.json file in your current project (folder).
|
|
21
|
+
|
|
22
|
+
If you have multiple apps registered in your .m365rc.json file, you can specify the app for which you'd like to retrieve permissions using the `--appId` option. If you don't specify the app using the `--appId` option, you'll be prompted to select one of the applications from your .m365rc.json file.
|
|
23
|
+
|
|
24
|
+
## Examples
|
|
25
|
+
|
|
26
|
+
Retrieve API permissions for your current Azure AD app
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
m365 app permission list
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Retrieve API permissions for the Azure AD app with client ID _e23d235c-fcdf-45d1-ac5f-24ab2ee0695d_ specified in the _.m365rc.json_ file
|
|
33
|
+
|
|
34
|
+
```sh
|
|
35
|
+
m365 app permission list --appId e23d235c-fcdf-45d1-ac5f-24ab2ee0695d
|
|
36
|
+
```
|
|
@@ -16,12 +16,17 @@ m365 file add [options]
|
|
|
16
16
|
`-p, --filePath <filePath>`
|
|
17
17
|
: Local path to the file to upload
|
|
18
18
|
|
|
19
|
+
`--siteUrl [siteUrl]`
|
|
20
|
+
: URL of the site to which upload the file. Specify to suppress lookup.
|
|
21
|
+
|
|
19
22
|
--8<-- "docs/cmd/_global.md"
|
|
20
23
|
|
|
21
24
|
## Remarks
|
|
22
25
|
|
|
23
26
|
The `folderUrl` must be an absolute URL to the document library where the file should be uploaded. The document library can be located in any site collection in your tenant, including OneDrive for Business. The `folderUrl` can also point to a (sub)folder in the document library.
|
|
24
27
|
|
|
28
|
+
By default, the `file add` command will automatically lookup the ID of the site where you want to upload the file based on the specified `folderUrl`. It will do this, by breaking the URL into chunks and incrementally calling Microsoft Graph to retrieve site information. This is necessary, because there is no other way looking at the URL to distinguish where the site URL ends and the document library URL starts. If you want to speed up uploading files, or you use resource-specific consent and your Azure AD app only has access to the specific site, you can use the `siteUrl` option to specify the URL of the site yourself.
|
|
29
|
+
|
|
25
30
|
## Examples
|
|
26
31
|
|
|
27
32
|
Uploads file from the current folder to the root folder of a document library in the root site collection
|
|
@@ -47,3 +52,9 @@ Uploads file from the current folder to a document library in a non-root site co
|
|
|
47
52
|
```sh
|
|
48
53
|
m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents"
|
|
49
54
|
```
|
|
55
|
+
|
|
56
|
+
Uploads file from the current folder to a document library in the specified site
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents" --siteUrl "https://contoso.sharepoint.com/sites/Contoso"
|
|
60
|
+
```
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# file list
|
|
2
|
+
|
|
3
|
+
Retrieves files from the specified folder and site
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 file list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: The URL of the site where the folder from which to retrieve files is located
|
|
15
|
+
|
|
16
|
+
`-f, --folderUrl <folderUrl>`
|
|
17
|
+
: The server- or site-relative URL of the folder from which to retrieve files
|
|
18
|
+
|
|
19
|
+
`--recursive`
|
|
20
|
+
: Set to retrieve files from subfolders
|
|
21
|
+
|
|
22
|
+
--8<-- "docs/cmd/_global.md"
|
|
23
|
+
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
This command is an improved version of the `spo file list` command. The main difference between the two commands is, that `file list` uses Microsoft Graph and properly supports retrieving files from large folders. Because `file list` uses Microsoft Graph and `spo file list` uses SharePoint REST APIs, the data returned by both commands is different.
|
|
27
|
+
|
|
28
|
+
## Examples
|
|
29
|
+
|
|
30
|
+
Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Return all files from the _Important_ folder in the _Shared Documents_ document library located in site _https://contoso.sharepoint.com/sites/project-x_
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Important'
|
|
46
|
+
```
|
|
@@ -10,6 +10,12 @@ pa app list [options]
|
|
|
10
10
|
|
|
11
11
|
## Options
|
|
12
12
|
|
|
13
|
+
`-e, --environment [environment]`
|
|
14
|
+
: The name of the environment for which to retrieve available apps
|
|
15
|
+
|
|
16
|
+
`--asAdmin`
|
|
17
|
+
: Set, to list all Power Apps as admin. Otherwise will return only your own apps
|
|
18
|
+
|
|
13
19
|
--8<-- "docs/cmd/_global.md"
|
|
14
20
|
|
|
15
21
|
## Remarks
|
|
@@ -17,10 +23,20 @@ pa app list [options]
|
|
|
17
23
|
!!! attention
|
|
18
24
|
This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
|
|
19
25
|
|
|
26
|
+
If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
|
|
27
|
+
|
|
28
|
+
By default, the `app list` command returns only your apps. To list all apps, use the `asAdmin` option and make sure to specify the `environment` option. You cannot specify only one of the options, when specifying the `environment` option the `asAdmin` option has to be present as well.
|
|
29
|
+
|
|
20
30
|
## Examples
|
|
21
31
|
|
|
22
|
-
List all apps
|
|
32
|
+
List all your apps
|
|
23
33
|
|
|
24
34
|
```sh
|
|
25
35
|
m365 pa app list
|
|
26
36
|
```
|
|
37
|
+
|
|
38
|
+
List all apps in a given environment
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
m365 pa app list --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
|
|
42
|
+
```
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# planner task add
|
|
2
|
+
|
|
3
|
+
Adds a new Microsoft Planner task
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 planner task add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-t, --title <title>`
|
|
14
|
+
: Title of the task to add.
|
|
15
|
+
|
|
16
|
+
`--planId [planId]`
|
|
17
|
+
: Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
|
|
18
|
+
|
|
19
|
+
`--planName [planName]`
|
|
20
|
+
: Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
|
|
21
|
+
|
|
22
|
+
`--ownerGroupId [ownerGroupId]`
|
|
23
|
+
: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
24
|
+
|
|
25
|
+
`--ownerGroupName [ownerGroupName]`
|
|
26
|
+
: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
|
|
27
|
+
|
|
28
|
+
`--bucketId [bucketId]`
|
|
29
|
+
: Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
|
|
30
|
+
|
|
31
|
+
`--bucketName [bucketName]`
|
|
32
|
+
: Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
|
|
33
|
+
|
|
34
|
+
`--startDateTime [startDateTime]`
|
|
35
|
+
: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
|
|
36
|
+
|
|
37
|
+
`--dueDateTime [dueDateTime]`
|
|
38
|
+
: The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
|
|
39
|
+
|
|
40
|
+
`--percentComplete [percentComplete]`
|
|
41
|
+
: Percentage of task completion. Number between 0 and 100.
|
|
42
|
+
- When set to 0, the task is considered _Not started_.
|
|
43
|
+
- When set between 1 and 99, the task is considered _In progress_.
|
|
44
|
+
- When set to 100, the task is considered _Completed_.
|
|
45
|
+
|
|
46
|
+
`--assignedToUserIds [assignedToUserIds]`
|
|
47
|
+
: The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
|
|
48
|
+
|
|
49
|
+
`--assignedToUserNames [assignedToUserNames]`
|
|
50
|
+
: The comma-separated UPNs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
|
|
51
|
+
|
|
52
|
+
`--description [description]`
|
|
53
|
+
: Description of the task
|
|
54
|
+
|
|
55
|
+
`--orderHint [orderHint]`
|
|
56
|
+
: Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
|
|
57
|
+
|
|
58
|
+
--8<-- "docs/cmd/_global.md"
|
|
59
|
+
|
|
60
|
+
## Examples
|
|
61
|
+
|
|
62
|
+
Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
|
|
63
|
+
|
|
64
|
+
```sh
|
|
65
|
+
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_ and receive a due date for _2021-12-16_
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
|
|
78
|
+
```
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# search externalconnection add
|
|
2
|
+
|
|
3
|
+
Add a new external connection to be defined for Microsoft Search
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 search externalconnection add [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-i, --id <id>`
|
|
14
|
+
: Developer-provided unique ID of the connection within the Azure Active Directory tenant
|
|
15
|
+
|
|
16
|
+
`-n, --name <name>`
|
|
17
|
+
: The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters
|
|
18
|
+
|
|
19
|
+
`-d, --description <description>`
|
|
20
|
+
: Description of the connection displayed in the Microsoft 365 admin center
|
|
21
|
+
|
|
22
|
+
`--authorizedAppIds [authorizedAppIds]`
|
|
23
|
+
: Comma-separated collection of application IDs for registered Azure Active Directory apps that are allowed to manage the external connection and to index content in the external connection.
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Remarks
|
|
28
|
+
|
|
29
|
+
The `id` must be at least 3 and no more than 32 characters long. It can contain only alphanumeric characters, can't begin with _Microsoft_ and can be any of the following values: *None, Directory, Exchange, ExchangeArchive, LinkedIn, Mailbox, OneDriveBusiness, SharePoint, Teams, Yammer, Connectors, TaskFabric, PowerBI, Assistant, TopicEngine, MSFT_All_Connectors*.
|
|
30
|
+
|
|
31
|
+
## Examples
|
|
32
|
+
|
|
33
|
+
Adds a new external connection with name and description of test
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Adds a new external connection with a limited number of authorized apps
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
|
|
43
|
+
```
|
|
@@ -20,7 +20,7 @@ m365 spfx project externalize [options]
|
|
|
20
20
|
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
|
|
21
21
|
|
|
22
22
|
`-o, --output [output]`
|
|
23
|
-
: Output type. `json,text,md`. Default `
|
|
23
|
+
: Output type. `json,text,csv,md`. Default `json`
|
|
24
24
|
|
|
25
25
|
`--verbose`
|
|
26
26
|
: Runs command with verbose logging
|
|
@@ -23,7 +23,7 @@ m365 spfx project rename [options]
|
|
|
23
23
|
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
|
|
24
24
|
|
|
25
25
|
`-o, --output [output]`
|
|
26
|
-
: Output type. `json,text,md`. Default `
|
|
26
|
+
: Output type. `json,text,csv,md`. Default `json`
|
|
27
27
|
|
|
28
28
|
`--verbose`
|
|
29
29
|
: Runs command with verbose logging
|
|
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
|
|
|
32
32
|
|
|
33
33
|
## Remarks
|
|
34
34
|
|
|
35
|
-
The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.13.
|
|
35
|
+
The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.13.1).
|
|
36
36
|
|
|
37
37
|
This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
|
|
38
38
|
|
|
@@ -20,7 +20,7 @@ m365 spfx doctor [options]
|
|
|
20
20
|
: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
|
|
21
21
|
|
|
22
22
|
`-o, --output [output]`
|
|
23
|
-
: Output type. `json,text,md`. Default `
|
|
23
|
+
: Output type. `json,text,csv,md`. Default `json`
|
|
24
24
|
|
|
25
25
|
`--verbose`
|
|
26
26
|
: Runs command with verbose logging
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# spo contenttype list
|
|
2
|
+
|
|
3
|
+
Lists content types from specified site
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo contenttype list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
: Absolute URL of the site for which to list content types
|
|
15
|
+
|
|
16
|
+
`-c, --category [category]`
|
|
17
|
+
: Category name of content types. When defined will return only content types from specified category
|
|
18
|
+
|
|
19
|
+
--8<-- "docs/cmd/_global.md"
|
|
20
|
+
|
|
21
|
+
## Examples
|
|
22
|
+
|
|
23
|
+
Retrieve site content types
|
|
24
|
+
|
|
25
|
+
```PowerShell
|
|
26
|
+
m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Retrieve site content types from the 'List Content Types' category
|
|
30
|
+
|
|
31
|
+
```PowerShell
|
|
32
|
+
m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types"
|
|
33
|
+
```
|
|
@@ -13,24 +13,42 @@ m365 spo group user add [options]
|
|
|
13
13
|
`-u, --webUrl <webUrl>`
|
|
14
14
|
: URL of the site where the SharePoint group is available
|
|
15
15
|
|
|
16
|
-
`--groupId
|
|
17
|
-
: Id of the SharePoint Group to which user needs to be added
|
|
16
|
+
`--groupId [groupId]`
|
|
17
|
+
: Id of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
|
|
18
18
|
|
|
19
|
-
`--
|
|
20
|
-
:
|
|
19
|
+
`--groupName [groupName]`
|
|
20
|
+
: Name of the SharePoint Group to which user needs to be added, specify either `groupId` or `groupName`
|
|
21
|
+
|
|
22
|
+
`--userName [userName]`
|
|
23
|
+
: User's UPN (user principal name, eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
|
|
24
|
+
|
|
25
|
+
`--email [email]`
|
|
26
|
+
: User's email (eg. megan.bowen@contoso.com). If multiple users needs to be added, they have to be comma separated (ex. megan.bowen@contoso.com,alex.wilber@contoso.com), specify either `userName` or `email`
|
|
21
27
|
|
|
22
28
|
--8<-- "docs/cmd/_global.md"
|
|
23
29
|
|
|
24
30
|
## Examples
|
|
25
31
|
|
|
26
|
-
Add a user to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
32
|
+
Add a user with name _Alex.Wilber@contoso.com_ to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
27
33
|
|
|
28
34
|
```sh
|
|
29
35
|
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com"
|
|
30
36
|
```
|
|
31
37
|
|
|
32
|
-
Add multiple users to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
38
|
+
Add multiple users by name to the SharePoint group with id _5_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
33
39
|
|
|
34
40
|
```sh
|
|
35
41
|
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupId 5 --userName "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
|
|
36
42
|
```
|
|
43
|
+
|
|
44
|
+
Add a user with email _Alex.Wilber@contoso.com_ to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
45
|
+
|
|
46
|
+
```sh
|
|
47
|
+
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Add multiple users by email to the SharePoint group with name _Contoso Site Owners_ available on the web _https://contoso.sharepoint.com/sites/SiteA_
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
m365 spo group user add --webUrl https://contoso.sharepoint.com/sites/SiteA --groupName "Contoso Site Owners" --email "Alex.Wilber@contoso.com, Adele.Vance@contoso.com"
|
|
54
|
+
```
|
|
@@ -22,6 +22,9 @@ m365 spo list get [options]
|
|
|
22
22
|
`-p, --properties [properties]`
|
|
23
23
|
: Comma-separated list of properties to retrieve from the list. Will retrieve all properties possible from default response, if not specified.
|
|
24
24
|
|
|
25
|
+
`--withPermissions`
|
|
26
|
+
: Set if you want to return associated roles and permissions of the list.
|
|
27
|
+
|
|
25
28
|
--8<-- "docs/cmd/_global.md"
|
|
26
29
|
|
|
27
30
|
## Examples
|
|
@@ -44,6 +47,12 @@ Get information about a list returning the specified list properties
|
|
|
44
47
|
m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Id,HasUniqueRoleAssignments,AllowContentTypes"
|
|
45
48
|
```
|
|
46
49
|
|
|
50
|
+
Get information about a list along with the roles and permissions
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --withPermissions
|
|
54
|
+
```
|
|
55
|
+
|
|
47
56
|
## More information
|
|
48
57
|
|
|
49
58
|
- List REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint](https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint)
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# spo listitem attachment list
|
|
2
|
+
|
|
3
|
+
Gets the attachments associated to a list item
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo listitem attachment list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --webUrl <webUrl>`
|
|
14
|
+
URL of the site from which the item should be retrieved
|
|
15
|
+
|
|
16
|
+
`--listId [listId]`
|
|
17
|
+
: ID of the list from which to retrieve the item. Specify listId or listTitle but not both
|
|
18
|
+
|
|
19
|
+
`--listTitle [listTitle]`
|
|
20
|
+
: Title of the list from which to retrieve the item. Specify listId or listTitle but not both
|
|
21
|
+
|
|
22
|
+
`--itemId <itemId>`
|
|
23
|
+
ID of the list item to in question
|
|
24
|
+
|
|
25
|
+
--8<-- "docs/cmd/_global.md"
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
Gets the attachments from list item with itemId _147_ in list with title _Demo List_ in site _https://contoso.sharepoint.com/sites/project-x_
|
|
30
|
+
|
|
31
|
+
```sh
|
|
32
|
+
m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle "Demo List" --itemId 147
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Gets the attachments from list item with itemId _147_ in list with id _0cd891ef-afce-4e55-b836-fce03286cccf_ in site _https://contoso.sharepoint.com/sites/project-x_
|
|
36
|
+
|
|
37
|
+
```sh
|
|
38
|
+
m365 spo listitem attachment list --webUrl https://contoso.sharepoint.com/sites/project-x --listId 0cd891ef-afce-4e55-b836-fce03286cccf --itemId 147
|
|
39
|
+
```
|
|
@@ -20,10 +20,10 @@ m365 spo page add [options]
|
|
|
20
20
|
: Title of the page to create. If not specified, will use the page name as its title
|
|
21
21
|
|
|
22
22
|
`-l, --layoutType [layoutType]`
|
|
23
|
-
: Layout of the page. Allowed values `Article
|
|
23
|
+
: Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`. Default `Article`
|
|
24
24
|
|
|
25
25
|
`-p, --promoteAs [promoteAs]`
|
|
26
|
-
: Create the page for a specific purpose. Allowed values `HomePage
|
|
26
|
+
: Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`
|
|
27
27
|
|
|
28
28
|
`--commentsEnabled`
|
|
29
29
|
: Set to enable comments on the page
|
|
@@ -17,13 +17,13 @@ m365 spo page set [options]
|
|
|
17
17
|
: URL of the site where the page to update is located
|
|
18
18
|
|
|
19
19
|
`-l, --layoutType [layoutType]`
|
|
20
|
-
: Layout of the page. Allowed values `Article
|
|
20
|
+
: Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`
|
|
21
21
|
|
|
22
22
|
`-p, --promoteAs [promoteAs]`
|
|
23
|
-
: Update the page purpose. Allowed values `HomePage
|
|
23
|
+
: Update the page purpose. Allowed values `HomePage`, `NewsPage`
|
|
24
24
|
|
|
25
25
|
`--commentsEnabled [commentsEnabled]`
|
|
26
|
-
: Set to `true`, to enable comments on the page. Allowed values `true
|
|
26
|
+
: Set to `true`, to enable comments on the page. Allowed values `true`, `false`
|
|
27
27
|
|
|
28
28
|
`--publish`
|
|
29
29
|
: Set to publish the page
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# spo site recyclebinitem list
|
|
2
|
+
|
|
3
|
+
Lists items from recycle bin
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
m365 spo site recyclebinitem list [options]
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Options
|
|
12
|
+
|
|
13
|
+
`-u, --siteUrl <siteUrl>`
|
|
14
|
+
: URL of the site for which to retrieve the recycle bin items
|
|
15
|
+
|
|
16
|
+
`--type [type]`
|
|
17
|
+
: Type of items which should be retrieved (listItems, folders, files)
|
|
18
|
+
|
|
19
|
+
`--secondary`
|
|
20
|
+
: Use this switch to retrieve items from secondary recycle bin
|
|
21
|
+
|
|
22
|
+
--8<-- "docs/cmd/_global.md"
|
|
23
|
+
|
|
24
|
+
## Remarks
|
|
25
|
+
|
|
26
|
+
When type is not specified then the command will return all items in the recycle bin
|
|
27
|
+
|
|
28
|
+
## Examples
|
|
29
|
+
|
|
30
|
+
Lists all files, items and folders from recycle bin for site _https://contoso.sharepoint.com/site_
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Lists only files from recycle bin for site _https://contoso.sharepoint.com/site_
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
m365 spo site recyclebinitem list --siteUrl https://contoso.sharepoint.com/site --type files
|
|
40
|
+
```
|
|
@@ -34,7 +34,9 @@ m365 spo site remove [options]
|
|
|
34
34
|
|
|
35
35
|
Deleting a site collection is by default asynchronous and depending on the current state of Microsoft 365, might take up to few minutes. If you're building a script with steps that require the site to be fully deleted, you should use the `--wait` flag. When using this flag, the `spo site remove` command will keep running until it received confirmation from Microsoft 365 that the site has been fully deleted.
|
|
36
36
|
|
|
37
|
-
If the site which you have selected to remove is groupified (Modern Team Site), flags `--
|
|
37
|
+
If the site which you have selected to remove is groupified (Modern Team Site) and group exists, flags `--skipRecycleBin` and `--wait` will not be applicable. If the linked group still exists in the deleted groups, the site won't be removed. If the linked group is permanently deleted, the site will be removed like any classic site (except that flag `--wait` only will still not be applicable).
|
|
38
|
+
|
|
39
|
+
If the argument `--fromRecycleBin` is passed, the selected site will be permanently removed even if it's a groupified one.
|
|
38
40
|
|
|
39
41
|
## Examples
|
|
40
42
|
|