@pnp/cli-microsoft365 6.9.0-beta.289ab69 → 6.9.0-beta.bb31388

package/docs/docs/cmd/outlook/report/report-mailboxusagedetail.mdx

@@ -0,0 +1,102 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailboxusagedetail
+
+Gets details about mailbox usage
+
+## Usage
+
+```sh
+m365 outlook report mailboxusagedetail [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets details about mailbox usage for the last week
+
+```sh
+m365 outlook report mailboxusagedetail --period D7
+```
+
+Gets details about mailbox usage for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailboxusagedetail --period D7 --output text > "mailboxusagedetail.txt"
+```
+
+Gets details about mailbox usage for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailboxusagedetail --period D7 --output json > "mailboxusagedetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-24",
+      "User Principal Name": "john.doe@contoso.com",
+      "Display Name": "John Doe",
+      "Is Deleted": "False",
+      "Deleted Date": "",
+      "Created Date": "2023-01-18",
+      "Last Activity Date": "2023-01-24",
+      "Item Count": "191",
+      "Storage Used (Byte)": "5719031",
+      "Issue Warning Quota (Byte)": "105226698752",
+      "Prohibit Send Quota (Byte)": "106300440576",
+      "Prohibit Send/Receive Quota (Byte)": "107374182400",
+      "Deleted Item Count": "25",
+      "Deleted Item Size (Byte)": "582157",
+      "Deleted Item Quota (Byte)": "32212254720",
+      "Has Archive": "False",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Created Date,Last Activity Date,Item Count,Storage Used (Byte),Issue Warning Quota (Byte),Prohibit Send Quota (Byte),Prohibit Send/Receive Quota (Byte),Deleted Item Count,Deleted Item Size (Byte),Deleted Item Quota (Byte),Has Archive,Report Period
+  2023-01-24,john.doe@contoso.com,John Doe,False,,2023-01-18,2023-01-24,191,5719031,105226698752,106300440576,107374182400,25,582157,32212254720,False,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Created Date,Last Activity Date,Item Count,Storage Used (Byte),Issue Warning Quota (Byte),Prohibit Send Quota (Byte),Prohibit Send/Receive Quota (Byte),Deleted Item Count,Deleted Item Size (Byte),Deleted Item Quota (Byte),Has Archive,Report Period
+  2023-01-24,john.doe@contoso.com,John Doe,False,,2023-01-18,2023-01-24,191,5719031,105226698752,106300440576,107374182400,25,582157,32212254720,False,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,User Principal Name,Display Name,Is Deleted,Deleted Date,Created Date,Last Activity Date,Item Count,Storage Used (Byte),Issue Warning Quota (Byte),Prohibit Send Quota (Byte),Prohibit Send/Receive Quota (Byte),Deleted Item Count,Deleted Item Size (Byte),Deleted Item Quota (Byte),Has Archive,Report Period
+  2023-01-24,john.doe@contoso.com,John Doe,False,,2023-01-18,2023-01-24,191,5719031,105226698752,106300440576,107374182400,25,582157,32212254720,False,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailboxusagemailboxcount.mdx

@@ -0,0 +1,94 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailboxusagemailboxcount
+
+Gets the total number of user mailboxes in your organization and how many are active each day of the reporting period.
+
+## Usage
+
+```sh
+m365 outlook report mailboxusagemailboxcount [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Remarks
+
+A mailbox is considered active if the user sent or read any email.
+
+## Examples
+
+Gets the total number of user mailboxes in your organization and how many are active each day for the last week.
+
+```sh
+m365 outlook report mailboxusagemailboxcount --period D7
+```
+
+Gets the total number of user mailboxes in your organization and how many are active each day for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailboxusagemailboxcount --period D7 --output text > "mailboxusagemailboxcount.txt"
+```
+
+Gets the total number of user mailboxes in your organization and how many are active each day for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailboxusagemailboxcount --period D7 --output json > "mailboxusagemailboxcount.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-24",
+      "Total": "146",
+      "Active": "131",
+      "Report Date": "2023-01-18",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-01-24,146,131,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-01-24,146,131,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-01-24,146,131,2023-01-18,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailboxusagequotastatusmailboxcounts.mdx

@@ -0,0 +1,93 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailboxusagequotastatusmailboxcounts
+
+Gets the count of user mailboxes in each quota category
+
+## Usage
+
+```sh
+m365 outlook report mailboxusagequotastatusmailboxcounts [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets the count of user mailboxes in each quota category for the last week
+
+```sh
+m365 outlook report mailboxusagequotastatusmailboxcounts --period D7
+```
+
+Gets the count of user mailboxes in each quota category for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailboxusagequotastatusmailboxcounts --period D7 --output text > "mailboxusagequotastatusmailboxcounts.txt"
+```
+
+Gets the count of user mailboxes in each quota category for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailboxusagequotastatusmailboxcounts --period D7 --output json > "mailboxusagequotastatusmailboxcounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-24",
+      "Under Limit": "146",
+      "Warning Issued": "0",
+      "Send Prohibited": "0",
+      "Send/Receive Prohibited": "0",
+      "Indeterminate": "0",
+      "Report Date": "2023-01-18",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Under Limit,Warning Issued,Send Prohibited,Send/Receive Prohibited,Indeterminate,Report Date,Report Period
+  2023-01-24,146,0,0,0,0,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Under Limit,Warning Issued,Send Prohibited,Send/Receive Prohibited,Indeterminate,Report Date,Report Period
+  2023-01-24,146,0,0,0,0,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Under Limit,Warning Issued,Send Prohibited,Send/Receive Prohibited,Indeterminate,Report Date,Report Period
+  2023-01-24,146,0,0,0,0,2023-01-18,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/report/report-mailboxusagestorage.mdx

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook report mailboxusagestorage
+
+Gets the amount of mailbox storage used in your organization
+
+## Usage
+
+```sh
+m365 outlook report mailboxusagestorage [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --period <period>`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Gets the amount of mailbox storage used in your organization for the last week
+
+```sh
+m365 outlook report mailboxusagestorage --period D7
+```
+
+Gets the amount of mailbox storage used in your organization for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 outlook report mailboxusagestorage --period D7 --output text > "mailboxusagestorage.txt"
+```
+
+Gets the amount of mailbox storage used in your organization for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 outlook report mailboxusagestorage --period D7 --output json > "mailboxusagestorage.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-01-24",
+      "Storage Used (Byte)": "791481624264",
+      "Report Date": "2023-01-18",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  Report Refresh Date,Storage Used (Byte),Report Date,Report Period
+  2023-01-24,791481624264,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Storage Used (Byte),Report Date,Report Period
+  2023-01-24,791481624264,2023-01-18,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Storage Used (Byte),Report Date,Report Period
+  2023-01-24,791481624264,2023-01-18,7
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/room/room-list.mdx

@@ -0,0 +1,125 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook room list
+
+Get a collection of all available rooms
+
+## Usage
+
+```sh
+m365 outlook room list [options]
+```
+
+## Options
+
+```md defintion-list
+`--roomlistEmail [roomlistEmail]`
+: Use to filter returned rooms by their roomlist email (eg. bldg2@contoso.com)
+```
+
+<Global />
+
+## Examples
+
+Get all the rooms
+
+```sh
+m365 outlook room list
+```
+
+Get all the rooms of specified roomlist e-mail address
+
+```sh
+m365 outlook room list --roomlistEmail "bldg2@contoso.com"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "98c40767-158a-44f0-9dda-c95b86f079ca",
+      "emailAddress": "Largeroom@contoso.com",
+      "displayName": "Large room",
+      "geoCoordinates": null,
+      "phone": "",
+      "nickname": "Large room",
+      "building": null,
+      "floorNumber": null,
+      "floorLabel": null,
+      "label": null,
+      "capacity": 25,
+      "bookingType": "standard",
+      "audioDeviceName": null,
+      "videoDeviceName": null,
+      "displayDeviceName": null,
+      "isWheelChairAccessible": false,
+      "tags": [],
+      "address": {
+        "street": "Microsoft Way 1",
+        "city": "Redmond",
+        "state": "Washington",
+        "countryOrRegion": "US",
+        "postalCode": "98053"
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  id                                    displayName  phone  emailAddress
+  ------------------------------------  -----------  -----  ---------------------
+  98c40767-158a-44f0-9dda-c95b86f079ca  Large room          Largeroom@contoso.com
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName,phone,emailAddress
+  98c40767-158a-44f0-9dda-c95b86f079ca,Large room,,Largeroom@contoso.com
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # outlook room list
+
+  Date: 27/1/2023
+
+  ## Large room (98c40767-158a-44f0-9dda-c95b86f079ca)
+
+  Property | Value
+  ---------|-------
+  id | 98c40767-158a-44f0-9dda-c95b86f079ca
+  emailAddress | Largeroom@VanRoeyBeSPDev.onmicrosoft.com
+  displayName | Large room
+  geoCoordinates | null
+  phone |
+  nickname | Large room
+  building | null
+  floorNumber | null
+  floorLabel | null
+  label | null
+  capacity | 25
+  bookingType | standard
+  audioDeviceName | null
+  videoDeviceName | null
+  displayDeviceName | null
+  isWheelChairAccessible | false
+  tags | []
+  address | {"street":"Microsoft Way 1","city":"Redmond","state":"Washington","countryOrRegion":"US","postalCode":"98053"}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/outlook/roomlist/roomlist-list.mdx

@@ -0,0 +1,91 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook roomlist list
+
+Get a collection of available roomlists
+
+## Usage
+
+```sh
+m365 outlook roomlist list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+Get all roomlists in your tenant
+
+```sh
+m365 outlook roomlist list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "5502bfbd-83f0-4b31-aa8c-5aebeda06091",
+      "emailAddress": "RoomsBuilding1@contoso.com",
+      "displayName": "Rooms building 1",
+      "geoCoordinates": null,
+      "phone": "",
+      "address": {
+        "street": "Microsoft Way 1",
+        "city": "Redmond",
+        "state": "Washington",
+        "countryOrRegion": "US",
+        "postalCode": "98053"
+      }
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```txt
+  displayName : Rooms building 1
+  emailAddress: RoomsBuilding1@contoso.com
+  id          : 5502bfbd-83f0-4b31-aa8c-5aebeda06091
+  phone       :
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName,phone,emailAddress
+  5502bfbd-83f0-4b31-aa8c-5aebeda06091,Rooms building 1,,RoomsBuilding1@contoso.com
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # outlook roomlist list
+
+  Date: 27/1/2023
+
+  ## Rooms building 1 (5502bfbd-83f0-4b31-aa8c-5aebeda06091)
+
+  Property | Value
+  ---------|-------
+  id | 5502bfbd-83f0-4b31-aa8c-5aebeda06091
+  emailAddress | RoomsBuilding1@contoso.com
+  displayName | Rooms building 1
+  geoCoordinates | null
+  phone |
+  address | {"street":"Microsoft Way 1","city":"Redmond","state":"Washington","countryOrRegion":"US","postalCode":"98053"}
+  ```
+
+  </TabItem>
+</Tabs>
+

package/docs/docs/cmd/pa/app/app-consent-set.mdx

@@ -0,0 +1,51 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# pa app consent set
+
+Configures if users can bypass the API Consent window for the selected canvas app
+
+## Usage
+
+```sh
+m365 pa app consent set [options]
+```
+
+## Options
+
+```md defintion-list
+`-e, --environment <environment>`
+: The name of the environment.
+
+`-n, --name <name>`
+: The name of the Power App to update
+
+`-b, --bypass <bypass>`
+: Set to `true` to allow users to bypass the API Consent window. Set to `false` to disable the bypass.
+
+`--confirm`
+: Don't prompt for confirmation
+```
+
+<Global />
+
+## Remarks
+
+This command only works for canvas apps.
+
+## Examples
+
+Enables the bypass for the specified canvas app
+
+```sh
+m365 pa app consent set --environment 4be50206-9576-4237-8b17-38d8aadfaa36 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --bypass true
+```
+
+Disables the bypass consent for the specified canvas app
+
+```sh
+m365 pa app consent set --environment 4be50206-9576-4237-8b17-38d8aadfaa36 --name 3989cb59-ce1a-4a5c-bb78-257c5c39381d --bypass false --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pa/app/app-export.mdx

@@ -0,0 +1,56 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# pa app export
+
+Exports the specified Power App
+
+## Usage
+
+```sh
+m365 pa app export [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id <id>`
+: The id of the Power App to export
+
+`-e, --environment <environment>`
+: The name of the environment for which to export the app
+
+`-n, --packageDisplayName [packageDisplayName]`
+: The display name to use in the exported package
+
+`-d, --packageDescription [packageDescription]`
+: The description to use in the exported package
+
+`-c, --packageCreatedBy [packageCreatedBy]`
+: The name of the person to be used as the creator of the exported package
+
+`-s, --packageSourceEnvironment [packageSourceEnvironment]`
+: The name of the source environment from which the exported package was taken
+
+`-p, --path [path]`
+: The path to save the exported package to. If not specified the app will be exported in the current working directory
+```
+
+<Global />
+
+## Examples
+
+Export the specified Power App as a ZIP file
+
+```sh
+m365 pa app export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d 
+```
+
+Export the specified Power App as a ZIP file with the package displayname, package description, the one who created it, the package source environment and the path
+
+```sh
+m365 pa app export --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --id 3989cb59-ce1a-4a5c-bb78-257c5c39381d --packageDisplayName "PowerApp" --packageDescription "Power App Description" --packageCreatedBy "John Doe" --packageSourceEnvironment "Contoso" --path "C:/Users/John/Documents"
+```
+
+## Response
+
+The command won't return a response on success.