@pnp/cli-microsoft365 5.9.0-beta.fd24b4e → 5.9.0

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/planner/bucket/bucket-add.md

@@ -46,3 +46,32 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
 ```sh
 m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-get.md

@@ -58,3 +58,32 @@ Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40f
 ```sh
 m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-list.md

@@ -40,3 +40,33 @@ Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Gro
 ```sh
 m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "name": "My Planner Bucket",
+        "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+        "orderHint": "8585363889524958496",
+        "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                            name               planId                        orderHint
+    ----------------------------  -----------------  ----------------------------  -------------------
+    ttEB_Uj690STdR3GC1MIDZgANq1U  My Planner Bucket  xqQg5FS2LkCp935s-FIFm2QAFkHM  8585363889524958496
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-remove.md

@@ -61,3 +61,7 @@ Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_
 ```sh
 m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/bucket/bucket-set.md

@@ -58,3 +58,7 @@ Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ own
 ```sh
 m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/plan/plan-add.md

@@ -50,3 +50,126 @@ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Plan
 ```sh
 m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
 ```
+
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ``` json
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ``` text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ``` text
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+
+### `shareWithUserIds`, `shareWithUserNames` response
+
+When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ. 
+
+=== "JSON"
+
+    ```json
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      },
+      "sharedWith": {
+        "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
+        "6463a5ce-2119-4198-9f2a-628761df4a62": true
+      },
+      "categoryDescriptions": {
+        "category1": null,
+        "category2": null,
+        "category3": null,
+        "category4": null,
+        "category5": null,
+        "category6": null,
+        "category7": null,
+        "category8": null,
+        "category9": null,
+        "category10": null,
+        "category11": null,
+        "category12": null,
+        "category13": null,
+        "category14": null,
+        "category15": null,
+        "category16": null,
+        "category17": null,
+        "category18": null,
+        "category19": null,
+        "category20": null,
+        "category21": null,
+        "category22": null,
+        "category23": null,
+        "category24": null,
+        "category25": null
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```

package/docs/docs/cmd/planner/plan/plan-get.md

@@ -55,3 +55,78 @@ Returns the Microsoft Planner plan with title _MyPlan_ for Group _My Planner Gro
 ```sh
 m365 planner plan get --title "MyPlan" --ownerGroupName "My Planner Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+      "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+      "title": "My Planner Plan",
+      "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "createdBy": {
+        "user": {
+          "displayName": null,
+          "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+        },
+        "application": {
+          "displayName": null,
+          "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      },
+      "container": {
+        "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "type": "group",
+        "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+      },
+      "sharedWith": {
+        "ebf3b108-5234-4e22-b93d-656d7dae5874": true,
+        "6463a5ce-2119-4198-9f2a-628761df4a62": true
+      },
+      "categoryDescriptions": {
+        "category1": null,
+        "category2": null,
+        "category3": null,
+        "category4": null,
+        "category5": null,
+        "category6": null,
+        "category7": null,
+        "category8": null,
+        "category9": null,
+        "category10": null,
+        "category11": null,
+        "category12": null,
+        "category13": null,
+        "category14": null,
+        "category15": null,
+        "category16": null,
+        "category17": null,
+        "category18": null,
+        "category19": null,
+        "category20": null,
+        "category21": null,
+        "category22": null,
+        "category23": null,
+        "category24": null,
+        "category25": null
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    createdDateTime: 2015-03-30T18:36:49.2407981Z
+    id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
+    title          : My Planner Plan
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```

package/docs/docs/cmd/planner/plan/plan-list.md

@@ -31,3 +31,48 @@ Returns a list of Microsoft Planner plans for Group _My Planner Group_
 ```sh
 m365 planner plan list --ownerGroupName "My Planner Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "createdDateTime": "2015-03-30T18:36:49.2407981Z",
+        "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+        "title": "My Planner Plan",
+        "id": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+        "createdBy": {
+          "user": {
+            "displayName": null,
+            "id": "95e27074-6c4a-447a-aa24-9d718a0b86fa"
+          },
+          "application": {
+            "displayName": null,
+            "id": "ebf3b108-5234-4e22-b93d-656d7dae5874"
+          }
+        },
+        "container": {
+          "containerId": "ebf3b108-5234-4e22-b93d-656d7dae5874",
+          "type": "group",
+          "url": "https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                            title            createdDateTime               owner
+    ----------------------------  ---------------  ----------------------------  ------------------------------------
+    xqQg5FS2LkCp935s-FIFm2QAFkHM  My Planner Plan  2015-03-30T18:36:49.2407981Z  ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```

package/docs/docs/cmd/planner/plan/plan-remove.md

@@ -46,3 +46,7 @@ Removes the Microsoft Planner plan with title _My Plan_ in group with name _My P
 ```sh
 m365 planner plan remove --title "My Plan" --ownerGroupName "My Planner Group" --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

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. Specify either `id` or `name` but not both.
+
+`-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

@@ -11,10 +11,10 @@ pp dataverse table list [options]
 ## Options
 
 `-e, --environment <environment>`
-The name of the environment to list all tables for
+: 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.
+: Set, to retrieve the dataverse tables as admin for environments you are not a member of.
 
 --8<-- "docs/cmd/_global.md"
 

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/gateway/gateway-get.md

@@ -0,0 +1,24 @@
+# pp gateway get
+
+Get information about the specified gateway
+
+## Usage
+
+```sh
+m365 pp gateway get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the Gateway.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get information about the specified gateway.
+
+```sh
+m365 pp gateway get --id 1f69e798-5852-4fdd-ab01-33bb14b6e934
+```

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

@@ -11,10 +11,10 @@ m365 pp solution list [options]
 ## Options
 
 `-e, --environment <environment>`
-The name of the environment
+: The name of the environment
 
 `-a, --asAdmin`
-Run the command as admin for environments you do not have explicitly assigned permissions to.
+: Run the command as admin for environments you do not have explicitly assigned permissions to.
 
 --8<-- "docs/cmd/_global.md"