@pnp/cli-microsoft365 5.9.0-beta.005c47a → 5.9.0-beta.09bf387

package/dist/utils/powerPlatform.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.powerPlatform = void 0;
+const request_1 = require("../request");
+const powerPlatformResource = 'https://api.bap.microsoft.com';
+exports.powerPlatform = {
+    getDynamicsInstanceApiUrl(environment, asAdmin) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = '';
+            if (asAdmin) {
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/${encodeURIComponent(environment)}`;
+            }
+            else {
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/environments/${encodeURIComponent(environment)}`;
+            }
+            const requestOptions = {
+                url: `${url}?api-version=2020-10-01&$select=properties.linkedEnvironmentMetadata.instanceApiUrl`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            try {
+                const response = yield request_1.default.get(requestOptions);
+                return Promise.resolve(response.properties.linkedEnvironmentMetadata.instanceApiUrl);
+            }
+            catch (ex) {
+                throw Error(`The environment '${environment}' could not be retrieved. See the inner exception for more details: ${ex.message}`);
+            }
+        });
+    }
+};
+//# sourceMappingURL=powerPlatform.js.map

package/docs/docs/_clisettings.md

@@ -0,0 +1,19 @@
+## Available settings
+
+Following is the list of configuration settings available in CLI for Microsoft 365.
+
+Setting name|Definition|Default value
+------------|----------|-------------
+`autoOpenBrowserOnLogin`|Automatically open the browser to the Azure AD login page after running `m365 login` command in device code mode. This setting will be replaced by `autoOpenLinksInBrowser` in the next major release.|`false`
+`autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode. This setting will replace `autoOpenBrowserOnLogin` in the next major release.|`false`
+`copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
+`csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
+`csvHeader`|Display the column names on the first line|`true`
+`csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
+`csvQuoted`|Quote all the non-empty fields even if not required|`false`
+`csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
+`errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
+`output`|Defines the default output when issuing a command|`json`
+`printErrorsAsPlainText`|When output mode is set to `json`, print error messages as plain-text rather than JSON|`true`
+`prompt`|Prompts for missing values in required options|`false`
+`showHelpOnFailure`|Automatically display help when executing a command failed|`true`

package/docs/docs/cmd/outlook/mail/mail-send.md

@@ -43,6 +43,9 @@ m365 outlook sendmail [options]
 `--importance [importance]`
 : The importance of the message. Available options: `low`, `normal` or `high`. Default is `normal`.
 
+`--attachment [attachment]`
+: Path to the file that will be added as attachment to the email. This option can be used multiple times to attach multiple attachments.
+
 `--saveToSentItems [saveToSentItems]`
 : Save email in the sent items folder. Default `true`.
 
@@ -50,6 +53,10 @@ m365 outlook sendmail [options]
 
 ## Remarks
 
+### Attachments
+
+When using the `attachment` option, note that the total size of all attachment files cannot exceed 3 MB.
+
 ### If you are connected using app only authentication
 
 - Always specify a user id or upn in the `--sender` option. The email will be sent as if it came from the specified user, and can optionally be saved in the sent folder of that user account.
@@ -116,3 +123,9 @@ Send an email with cc and bcc recipients marked as important
 ```sh
 m365 outlook mail send --to chris@contoso.com --cc claire@contoso.com --bcc randy@contoso.com --subject "DG2000 Data Sheets" --bodyContents "The latest data sheets are in the team site" --importance high
 ```
+
+Send an email with multiple attachments
+
+```sh
+m365 outlook mail send --to chris@contoso.com --subject "Monthly reports" --bodyContents "Here are the reports of this month." --attachment "C:/Reports/File1.jpg" --attachment "C:/Reports/File2.docx" --attachment "C:/Reports/File3.xlsx"
+```

package/docs/docs/cmd/pp/card/card-get.md

@@ -0,0 +1,51 @@
+# pp card get
+
+Gets a specific Microsoft Power Platform card in the specified Power Platform environment
+
+## Usage
+
+```sh
+pp card get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i, --id [id]`
+: The id of the card.
+
+`-n, --name [name]`
+: The name of the card. Specify either `id` or `name` but not both.
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a specific card in a specific environment based on name
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card"
+```
+
+Get a specific card in a specific environment based on name as admin
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --name "CLI 365 Card" --asAdmin
+```
+
+Get a specific card in a specific environment based on id
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa"
+```
+
+Get a specific card in a specific environment based on id as admin
+
+```sh
+m365 pp card get --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --id "408e3f42-4c9e-4c93-8aaf-3cbdea9179aa" --asAdmin
+```

package/docs/docs/cmd/pp/card/card-list.md

@@ -0,0 +1,33 @@
+# pp card list
+
+Lists Microsoft Power Platform cards in the specified Power Platform environment.
+
+## Usage
+
+```sh
+pp card list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List cards in a specific environment.
+
+```sh
+m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5"
+```
+
+List cards in a specific environment as admin.
+
+```sh
+m365 pp card list --environment "Default-d87a7535-dd31-4437-bfe1-95340acd55c5" --asAdmin
+```

package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md

@@ -0,0 +1,33 @@
+# pp dataverse table list
+
+Lists dataverse tables in a given environment
+
+## Usage
+
+```sh
+pp dataverse table list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment to list all tables for
+
+`-a, --asAdmin`
+: Set, to retrieve the dataverse tables as admin for environments you are not a member of.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all tables for the given environment
+
+```sh
+m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
+```
+
+List all tables for the given environment as Admin
+
+```sh
+m365 pp dataverse table list -e "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
+```

package/docs/docs/cmd/pp/environment/environment-get.md

@@ -0,0 +1,38 @@
+# pp environment get
+
+Gets information about the specified Power Platform environment
+
+## Usage
+
+```sh
+m365 pp environment get [options]
+```
+
+## Options
+
+`-n, --name <name>`
+: The name of the environment to get information about
+
+`-a, --asAdmin`
+: Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+    Register CLI for Microsoft 365 or Azure AD application as a management application for the Power Platform using 
+    m365 pp managementapp add [options] 
+
+## Examples
+
+Get information about the Power Platform environment by name
+
+```sh
+m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+```
+
+Get information as admin about the Power Platform environment by name 
+
+```sh
+m365 pp environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
+```

package/docs/docs/cmd/pp/environment/environment-list.md

@@ -11,7 +11,7 @@ m365 pp environment list [options]
 ## Options
 
 `-a, --asAdmin`
-Run the command as admin and retrieve all environments. Lists only environments you have explicitly are assigned permissions to by default.
+: Run the command as admin and retrieve all environments. Lists only environments you have explicitly are assigned permissions to by default.
 
 --8<-- "docs/cmd/_global.md"
 

package/docs/docs/cmd/pp/solution/solution-get.md

@@ -0,0 +1,51 @@
+# pp solution get
+
+Gets a specific solution in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution get [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-i --id [id]`
+: The ID of the solution. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: The unique name (not the display name) of the solution. Specify either `id` or `name` but not both.
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets a specific solution in a specific environment based on name
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default"
+```
+
+Gets a specific solution in a specific environment based on name as Admin
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --name "Default" --asAdmin
+```
+
+Gets a specific solution in a specific environment based on id
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e"
+```
+
+Gets a specific solution in a specific environment based on id as Admin
+
+```sh
+m365 pp solution get --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --id "ee62fd63-e49e-4c09-80de-8fae1b9a427e" --asAdmin
+```

package/docs/docs/cmd/pp/solution/solution-list.md

@@ -0,0 +1,33 @@
+# pp solution list
+
+Lists solutions in a given environment.
+
+## Usage
+
+```sh
+m365 pp solution list [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment
+
+`-a, --asAdmin`
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all solutions in a specific environment
+
+```sh
+m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
+```
+
+List all solutions in a specific environment as Admin
+
+```sh
+m365 pp solution list --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin
+```

package/docs/docs/cmd/pp/tenant/tenant-settings-list.md

@@ -0,0 +1,26 @@
+# pp tenant settings list
+
+Lists the global Power Platform tenant settings
+
+## Usage
+
+```sh
+m365 pp tenant settings list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+## Examples
+
+Lists the global Power Platform settings of the tenant
+
+```sh
+m365 pp tenant settings list
+```

package/docs/docs/cmd/spfx/spfx-doctor.md

@@ -13,6 +13,9 @@ m365 spfx doctor [options]
 `-e, --env [env]`
 : Version of SharePoint for which to check compatibility: `sp2016|sp2019|spo`
 
+`-v, --spfxVersion [spfxVersion]`
+: Version of the SharePoint Framework Yeoman generator to check compatibility for without `v`, eg. `1.11.0`
+
 `-h, --help`
 : output usage information
 
@@ -48,7 +51,7 @@ Next to verifying the readiness of your environment to use a particular version
 
 ## Examples
 
-Verify if your environment meets the requirements to work with the SharePoint Framework
+Verify if your environment meets the requirements to work with SharePoint Framework based on the globally installed version of the SharePoint Framework Yeoman generator or the current project
 
 ```sh
 m365 spfx doctor --output text
@@ -59,3 +62,9 @@ Verify if your environment meets the requirements to work with the SharePoint Fr
 ```sh
 m365 spfx doctor --env sp2019 --output text
 ```
+
+Verify if your environment meets the requirements to work with SharePoint Framework v1.11.0
+
+```sh
+m365 spfx doctor --spfxVersion 1.11.0 --output text
+```

package/docs/docs/cmd/spo/eventreceiver/eventreceiver-get.md

@@ -26,10 +26,10 @@ Specify either `listTitle`, `listId` or `listUrl`.
 Specify either `listTitle`, `listId` or `listUrl`.
 
 `-n, --name [name]`
-The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
+: The name of the event receiver to retrieve. Specify either `name` or `id` but not both.
 
 `-i, --id [id]`
-The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
+: The id of the event receiver to retrieve. Specify either `name` or `id` but not both.
 
 `-s, --scope [scope]`
 : The scope of which to retrieve the Event Receivers.

package/docs/docs/cmd/spo/eventreceiver/eventreceiver-remove.md

@@ -0,0 +1,69 @@
+# spo eventreceiver remove
+
+Removes event receivers for the specified web, site, or list.
+
+## Usage
+
+```sh
+m365 spo eventreceiver remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the web.
+
+`--listTitle [listTitle]`
+: The title of the list, _if the event receiver should be removed from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listId [listId]`
+: The id of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`--listUrl [listUrl]`
+: The url of the list, _if the event receiver should be retrieved from a list_. Specify either `listTitle`, `listId` or `listUrl`.
+
+`-n, --name [name]`
+: The name. Specify either `name` or `id` but not both.
+
+`-i, --id [id]`
+: The id. Specify either `name` or `id` but not both.
+
+`-s, --scope [scope]`
+: The scope. Can be either "site" or "web". Defaults to "web". Only applicable when not specifying any of the list properties.
+
+`--confirm`
+: Don't prompt for confirming removing the event receiver
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove event receiver in a specific web by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --name 'PnP Test Receiver'
+```
+
+Remove event receiver in a specific site by id.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --scope site --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Remove event receiver in a specific list retrieved by title by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listTitle Events --name 'PnP Test Receiver'
+```
+
+Remove event receiver in a specific list retrieved by list id by id.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listId '202b8199-b9de-43fd-9737-7f213f51c991' --id c5a6444a-9c7f-4a0d-9e29-fc6fe30e34ec
+```
+
+Remove event receiver in a specific list retrieved by list url by name.
+
+```sh
+m365 spo eventreceiver remove --webUrl https://contoso.sharepoint.com/sites/contoso-sales --listUrl '/sites/contoso-sales/lists/Events' --name 'PnP Test Receiver'
+```

package/docs/docs/cmd/spo/file/file-roleassignment-add.md

@@ -0,0 +1,57 @@
+# spo file roleassignment add
+
+Adds a role assignment to the specified file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment add [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`i, --fileId [fileId]`
+: The UniqueId (GUID) of the file to retrieve. Specify either `fileUrl` or `fileId` but not both
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id to add a role assignment for. Specify either upn, groupName or principalId.
+
+`--upn [upn]`
+: upn/email of user to assign role to. Specify either upn, groupName or principalId.
+
+`--groupName [groupName]`
+: The group name of Azure AD or SharePoint group. Specify either upn, groupName or principalId.
+
+`--roleDefinitionId [roleDefinitionId]`
+: ID of role definition. Specify either roleDefinitionId or roleDefinitionName but not both
+
+`--roleDefinitionName [roleDefinitionName]`
+: Enter the name of a role definition, like 'Contribute', 'Read', etc. Specify either roleDefinitionId or roleDefinitionName but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a role assignment to a file with a specified id. It will use a principal id and a specific role definition id.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 11 --roleDefinitionId 1073741829
+```
+
+Adds a role assignment to a file with a specified site-relative URL for a specific upn and a role definition name.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "Shared Documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Full Control"
+```
+
+Adds a role assignment to a file with a specified server-relative URL the for a specific group  and a role definition name.
+
+```sh
+m365 spo file roleassignment add --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --upn "testuser@tenant.onmicrosoft.com" --roleDefinitionName "Read"
+```

package/docs/docs/cmd/spo/file/file-roleassignment-remove.md

@@ -0,0 +1,54 @@
+# spo file roleassignment remove
+
+Removes a role assignment from a file.
+
+## Usage
+
+```sh
+m365 spo file roleassignment remove [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located.
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`-i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both.
+
+`--principalId [principalId]`
+: The SharePoint Id of the principal. It may be either a user id or group id. Specify either `upn`, `groupName`, or `principalId`.
+
+`--upn [upn]`
+: Upn/email of the user. Specify either `upn`, `groupName`, or `principalId`.
+
+`--groupName [groupName]`
+: The group name of an Azure AD or SharePoint group. Specify either `upn`, `groupName`, or `principalId`.
+
+`--confirm [confirm]`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove a role assignment by principal id from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --principalId 2
+```
+
+Remove a role assignment by upn from a file by url
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileUrl "/sites/contoso-sales/documents/Test1.docx" --upn "user1@contoso.onmicrosoft.com"
+```
+
+Remove a role assignment by group name from a file by id
+
+```sh
+m365 spo file roleassignment remove --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --groupName "saleGroup"
+```

package/docs/docs/cmd/spo/file/file-roleinheritance-break.md

@@ -0,0 +1,54 @@
+# spo file roleinheritance break
+
+Breaks inheritance of a file. Keeping existing permissions is the default behavior.
+
+## Usage
+
+```sh
+m365 spo file roleinheritance break [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site where the file is located
+
+`--fileUrl [fileUrl]`
+: The server-relative URL of the file. Specify either `fileUrl` or `fileId` but not both
+
+`i, --fileId [fileId]`
+: The UniqueId (GUID) of the file. Specify either `fileUrl` or `fileId` but not both
+
+`-c, --clearExistingPermissions`
+: Clear all existing permissions from the file
+
+`--confirm`
+: Don't prompt for confirmation
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Break the inheritance of a file with a specific id (UniqueId).
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6"
+```
+
+Break the inheritance of a file with a specific id (UniqueId) and clear all existing permissions.
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileId "b2307a39-e878-458b-bc90-03bc578531d6" --clearExistingPermissions
+```
+
+Break the inheritance of a file with a specific server-relative URL.
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx"
+```
+
+Break the inheritance of a file with a specific server-relative URL and clear all existing permissions.
+
+```sh
+m365 spo file roleinheritance break --webUrl "https://contoso.sharepoint.com/sites/project-x" --fileUrl "/sites/project-x/documents/Test1.docx" --clearExistingPermissions
+```