@pnp/cli-microsoft365 6.3.0 → 6.4.0-beta.140530d

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

@@ -37,3 +37,52 @@ Gets details about mailbox usage for the last week and exports the report data i
 ```sh
 m365 outlook report mailboxusagedetail --period D7 --output json > "mailboxusagedetail.json"
 ```
+
+## Response
+
+=== "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"
+      }
+    ]
+    ```
+
+=== "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
+    ```
+
+=== "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
+    ```
+
+=== "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
+    ```

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

@@ -41,3 +41,40 @@ Gets the total number of user mailboxes in your organization and how many are ac
 ```sh
 m365 outlook report mailboxusagemailboxcount --period D7 --output json > "mailboxusagemailboxcount.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2023-01-24",
+        "Total": "146",
+        "Active": "131",
+        "Report Date": "2023-01-18",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```txt
+    Report Refresh Date,Total,Active,Report Date,Report Period
+    2023-01-24,146,131,2023-01-18,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Total,Active,Report Date,Report Period
+    2023-01-24,146,131,2023-01-18,7
+    ```
+
+=== "Markdown"
+
+    ```md
+    Report Refresh Date,Total,Active,Report Date,Report Period
+    2023-01-24,146,131,2023-01-18,7
+    ```

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

@@ -37,3 +37,43 @@ Gets the count of user mailboxes in each quota category for the last week and ex
 ```sh
 m365 outlook report mailboxusagequotastatusmailboxcounts --period D7 --output json > "mailboxusagequotastatusmailboxcounts.json"
 ```
+
+## Response
+
+=== "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"
+      }
+    ]
+    ```
+
+=== "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
+    ```
+
+=== "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
+    ```
+
+=== "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
+    ```

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

@@ -37,3 +37,39 @@ Gets the amount of mailbox storage used in your organization for the last week a
 ```sh
 m365 outlook report mailboxusagestorage --period D7 --output json > "mailboxusagestorage.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2023-01-24",
+        "Storage Used (Byte)": "791481624264",
+        "Report Date": "2023-01-18",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```txt
+    Report Refresh Date,Storage Used (Byte),Report Date,Report Period
+    2023-01-24,791481624264,2023-01-18,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Storage Used (Byte),Report Date,Report Period
+    2023-01-24,791481624264,2023-01-18,7
+    ```
+
+=== "Markdown"
+
+    ```md
+    Report Refresh Date,Storage Used (Byte),Report Date,Report Period
+    2023-01-24,791481624264,2023-01-18,7
+    ```

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

@@ -28,3 +28,84 @@ Get all the rooms of specified roomlist e-mail address
 ```sh
 m365 outlook room list --roomlistEmail "bldg2@contoso.com"
 ```
+
+## Response
+
+=== "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"
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```txt
+    id                                    displayName  phone  emailAddress
+    ------------------------------------  -----------  -----  ---------------------
+    98c40767-158a-44f0-9dda-c95b86f079ca  Large room          Largeroom@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,phone,emailAddress
+    98c40767-158a-44f0-9dda-c95b86f079ca,Large room,,Largeroom@contoso.com
+    ```
+
+=== "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"}
+    ```

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

@@ -19,3 +19,61 @@ Get all roomlists in your tenant
 ```sh
 m365 outlook roomlist list
 ```
+
+## Response
+
+=== "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"
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```txt
+    displayName : Rooms building 1
+    emailAddress: RoomsBuilding1@contoso.com
+    id          : 5502bfbd-83f0-4b31-aa8c-5aebeda06091
+    phone       :
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,phone,emailAddress
+    5502bfbd-83f0-4b31-aa8c-5aebeda06091,Rooms building 1,,RoomsBuilding1@contoso.com
+    ```
+
+=== "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"}
+    ```

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

@@ -68,7 +68,7 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
 
 === "JSON"
 
-    ``` json
+    ```json
     {
       "createdDateTime": "2015-03-30T18:36:49.2407981Z",
       "owner": "ebf3b108-5234-4e22-b93d-656d7dae5874",
@@ -94,7 +94,7 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
 
 === "Text"
 
-    ``` text
+    ```text
     createdDateTime: 2015-03-30T18:36:49.2407981Z
     id             : xqQg5FS2LkCp935s-FIFm2QAFkHM
     owner          : ebf3b108-5234-4e22-b93d-656d7dae5874
@@ -103,7 +103,7 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
 
 === "CSV"
 
-    ``` text
+    ```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-set.md

@@ -66,14 +66,74 @@ Updates a Microsoft Planner plan category labels
 m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --category25 'Urgent'
 ```
 
-## More information
+## Response
 
-- Update plannerPlan: [https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http)
-- plannerPlanDetails resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0)
-- plannerCategoryDescriptions resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0)
+### Standard response
 
+=== "JSON"
 
-## Response
+    ```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"
+
+    ```csv
+    id,title,createdDateTime,owner
+    xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
+    ```
+
+=== "Markdown"
+
+    ```md
+    # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
+
+    Date: 30/03/2015
+
+    ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
+
+    Property | Value
+    ---------|-------
+    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"}
+    ```
+
+### `shareWithUserIds`, `shareWithUserNames` response
+
+When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ. 
 
 === "JSON"
 
@@ -151,9 +211,9 @@ m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --
 === "Markdown"
 
     ```md
-    # planner plan set --id "xqQg5FS2LkCp935s-FIFm2QAFkHM" --newTitle "My Planner Plan"
+    # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874" --shareWithUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com"
 
-    Date: 27/12/2022
+    Date: 30/03/2015
 
     ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
 
@@ -168,3 +228,9 @@ m365 planner plan set --id 'gndWOTSK60GfPQfiDDj43JgACDCb' --category21 'ToDo' --
     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}
     ```
+
+## More information
+
+- Update plannerPlan: [https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/en-us/graph/api/plannerplan-update?view=graph-rest-1.0&tabs=http)
+- plannerPlanDetails resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannerplandetails?view=graph-rest-1.0)
+- plannerCategoryDescriptions resource type: [https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0](https://learn.microsoft.com/en-us/graph/api/resources/plannercategorydescriptions?view=graph-rest-1.0)

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

@@ -55,6 +55,21 @@ m365 planner roster add
     id,assignedSensitivityLabel
     e6fmvM_yi0OJgvmepE5uj5cAE6qX,
     ```
-    
+
+=== "Markdown"
+
+    ```md
+    # planner roster add
+
+    Date: 7/2/2023
+
+    ## e6fmvM_yi0OJgvmepE5uj5cAE6qX
+
+    Property | Value
+    ---------|-------
+    id | e6fmvM_yi0OJgvmepE5uj5cAE6qX
+    assignedSensitivityLabel | null
+    ```
+
 ## Additional information
 Rosters are a new type of container for Microsoft Planner plans. This enables users to create a Planner plan without the need to create a new Microsoft 365 group (with a mailbox, SharePoint site, ...). Access to Roster-contained plans is controlled by the members on the Roster. A Planner Roster can contain only 1 plan.

package/docs/docs/cmd/planner/roster/roster-member-get.md

@@ -0,0 +1,87 @@
+# planner roster member get
+
+Gets a member of the specified Microsoft Planner Roster
+
+## Usage
+
+```sh
+m365 planner roster member get [options]
+```
+
+## Options
+
+`--rosterId <rosterId>`
+: ID of the Planner Roster.
+
+`--userId [userId]`
+: User's Azure AD ID. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User's UPN (user principal name, e.g. johndoe@example.com). Specify either `userId` or `userName` but not both.
+
+--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
+
+Gets a specific user by user name as member of the Planner Roster
+
+```sh
+m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userName john.doe@contoso.com
+```
+
+Gets a specific user by ID as member of the Planner Roster
+
+```sh
+m365 planner roster member get --rosterId tYqYlNd6eECmsNhN_fcq85cAGAnd --userId d049a857-f1c3-4fb3-a629-d8cfb3bd7275
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "b3a1be03-54a5-43d2-b4fb-6562fe9bec0b",
+      "userId": "2056d2f6-3257-4253-8cfc-b73393e414e5",
+      "tenantId": "5b7b813c-2339-48cd-8c51-bd4fcb269420",
+      "roles": []
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id      : b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+    roles   : []
+    tenantId: 5b7b813c-2339-48cd-8c51-bd4fcb269420
+    userId  : 2056d2f6-3257-4253-8cfc-b73393e414e5
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,userId,tenantId,roles
+    b3a1be03-54a5-43d2-b4fb-6562fe9bec0b,2056d2f6-3257-4253-8cfc-b73393e414e5,5b7b813c-2339-48cd-8c51-bd4fcb269420,[]
+    ```
+    
+=== "Markdown"
+
+    ```md
+    # planner roster member get --rosterId "tYqYlNd6eECmsNhN_fcq85cAGAnd" --userId "2056d2f6-3257-4253-8cfc-b73393e414e5"
+
+    Date: 18/2/2023
+
+    ## b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+
+    Property | Value
+    ---------|-------
+    id | b3a1be03-54a5-43d2-b4fb-6562fe9bec0b
+    userId | 2056d2f6-3257-4253-8cfc-b73393e414e5
+    tenantId | 5b7b813c-2339-48cd-8c51-bd4fcb269420
+    roles | []
+    ```