@pnp/cli-microsoft365 5.9.0 → 6.0.0-beta.063a75a

package/docs/docs/cmd/yammer/report/report-activitycounts.md

@@ -37,3 +37,34 @@ Gets the trends on the amount of Yammer activity in your organization by how man
 ```sh
 m365 yammer report activitycounts --period D7 --output json > "activitycounts.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-09",
+        "Liked": "12",
+        "Posted": "6",
+        "Read": "435",
+        "Report Date": "2022-11-09",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+    2022-11-09,12,6,435,2022-11-09,90
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+    2022-11-09,12,6,435,2022-11-09,90
+    ```

package/docs/docs/cmd/yammer/report/report-activityusercounts.md

@@ -37,3 +37,34 @@ Gets the trends on the number of unique users who posted, read, and liked Yammer
 ```sh
 m365 yammer report activityusercounts --period D7 --output json > "activityusercounts.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-09",
+        "Liked": "9",
+        "Posted": "5",
+        "Read": "64",
+        "Report Date": "2022-11-09",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+    2022-11-09,9,5,64,2022-11-09,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+    2022-11-09,9,5,64,2022-11-09,7
+    ```

package/docs/docs/cmd/yammer/report/report-activityuserdetail.md

@@ -50,3 +50,39 @@ Gets details about Yammer activity by user for the last week and exports the rep
 ```sh
 m365 yammer report activityuserdetail --period D7 --output json > "activityuserdetail.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-09",
+        "User Principal Name": "0439A166C614C2E8C7B4075DC4752054",
+        "Display Name": "2236A6E43D08F619FE695DF3B163A32F",
+        "User State": "",
+        "State Change Date": "",
+        "Last Activity Date": "",
+        "Posted Count": "0",
+        "Read Count": "0",
+        "Liked Count": "0",
+        "Assigned Products": "MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING)",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,User Principal Name,Display Name,User State,State Change Date,Last Activity Date,Posted Count,Read Count,Liked Count,Assigned Products,Report Period
+    2022-11-09,77E5979DD60BA6EAA53E814DBEEEFA5F,4291DA7C39EE3263E97336B42734A667,,,,0,0,0,MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING),7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,User Principal Name,Display Name,User State,State Change Date,Last Activity Date,Posted Count,Read Count,Liked Count,Assigned Products,Report Period
+    2022-11-09,77E5979DD60BA6EAA53E814DBEEEFA5F,4291DA7C39EE3263E97336B42734A667,,,,0,0,0,MICROSOFT 365 E5 DEVELOPER (WITHOUT WINDOWS AND AUDIO CONFERENCING),7
+    ```

package/docs/docs/cmd/yammer/report/report-deviceusagedistributionusercounts.md

@@ -37,3 +37,36 @@ Gets the number of users by device type for the last week and exports the report
 ```sh
 m365 yammer report deviceusagedistributionusercounts --period D7 --output json > "deviceusagedistributionusercounts.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-09",
+        "Web": "77",
+        "Windows Phone": "5",
+        "Android Phone": "1",
+        "iPhone": "7",
+        "iPad": "6",
+        "Other": "108",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Web,Windows Phone,Android Phone,iPhone,iPad,Other,Report Period
+    2022-11-09,77,5,1,7,6,108,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Web,Windows Phone,Android Phone,iPhone,iPad,Other,Report Period
+    2022-11-09,77,5,1,7,6,108,7
+    ```

package/docs/docs/cmd/yammer/report/report-deviceusageusercounts.md

@@ -37,3 +37,37 @@ Gets the number of daily users by device type for the last week and exports the
 ```sh
 m365 yammer report deviceusageusercounts --period D7 --output json > "deviceusageusercounts.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-09",
+        "Web": "4",
+        "Windows Phone": "5",
+        "Android Phone": "6",
+        "iPhone": "3",
+        "iPad": "3",
+        "Other": "60",
+        "Report Date": "2022-11-09",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Web,Windows Phone,Android Phone,iPhone,iPad,Other,Report Date,Report Period
+    2022-11-09,4,5,6,3,3,60,2022-11-09,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Web,Windows Phone,Android Phone,iPhone,iPad,Other,Report Date,Report Period
+    2022-11-09,4,5,6,3,3,60,2022-11-09,7
+    ```

package/docs/docs/cmd/yammer/report/report-deviceusageuserdetail.md

@@ -50,3 +50,41 @@ Gets details about Yammer device usage by user for the last week and exports the
 ```sh
 m365 yammer report deviceusageuserdetail --period D7 --output json > "deviceusageuserdetail.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-09",
+        "User Principal Name": "0439A166C614C2E8C7B4075DC4752054",
+        "Display Name": "2236A6E43D08F619FE695DF3B163A32F",
+        "User State": "",
+        "State Change Date": "",
+        "Last Activity Date": "",
+        "Used Web": "No",
+        "Used Windows Phone": "No",
+        "Used Android Phone": "No",
+        "Used iPhone": "No",
+        "Used iPad": "No",
+        "Used Others": "No",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,User Principal Name,Display Name,User State,State Change Date,Last Activity Date,Used Web,Used Windows Phone,Used Android Phone,Used iPhone,Used iPad,Used Others,Report Period
+    2022-11-09,77E5979DD60BA6EAA53E814DBEEEFA5F,4291DA7C39EE3263E97336B42734A667,,,,No,No,No,No,No,No,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,User Principal Name,Display Name,User State,State Change Date,Last Activity Date,Used Web,Used Windows Phone,Used Android Phone,Used iPhone,Used iPad,Used Others,Report Period
+    2022-11-09,77E5979DD60BA6EAA53E814DBEEEFA5F,4291DA7C39EE3263E97336B42734A667,,,,No,No,No,No,No,No,7
+    ```

package/docs/docs/cmd/yammer/report/report-groupsactivitycounts.md

@@ -37,3 +37,34 @@ Gets the number of Yammer messages posted, read, and liked in groups for the las
 ```sh
 m365 yammer report groupsactivitycounts --period D7 --output json > "groupsactivitycounts.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-04",
+        "Liked": "5",
+        "Posted": "6",
+        "Read": "7",
+        "Report Date": "2022-11-04",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+    2022-11-10,5,6,7,2022-11-10,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+    2022-11-10,5,6,7,2022-11-10,7
+    ```

package/docs/docs/cmd/yammer/report/report-groupsactivitydetail.md

@@ -50,3 +50,40 @@ Gets details about Yammer groups activity by group for the last week and exports
 ```sh
 m365 yammer report groupsactivitydetail --period D7 --output json > "groupsactivitydetail.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-10",
+        "Group Display Name": "7D3654B07E126BBD0D18174368FC243F",
+        "Is Deleted": "False",
+        "Owner Principal Name": "",
+        "Last Activity Date": "",
+        "Group Type": "public",
+        "Office 365 Connected": "No",
+        "Member Count": "3",
+        "Posted Count": "",
+        "Read Count": "",
+        "Liked Count": "",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Office 365 Connected,Member Count,Posted Count,Read Count,Liked Count,Report Period
+    2022-11-10,7D3654B07E126BBD0D18174368FC243F,False,,,public,No,3,,,,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Office 365 Connected,Member Count,Posted Count,Read Count,Liked Count,Report Period
+    2022-11-10,7D3654B07E126BBD0D18174368FC243F,False,,,public,No,3,,,,7
+    ```

package/docs/docs/cmd/yammer/report/report-groupsactivitygroupcounts.md

@@ -37,3 +37,33 @@ Gets the total number of groups that existed and how many included group convers
 ```sh
 m365 yammer report groupsactivitygroupcounts --period D7 --output json > "groupsactivitygroupcounts.json"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "Report Refresh Date": "2022-11-04",
+        "Total": "1",
+        "Active": "0",
+        "Report Date": "2022-11-04",
+        "Report Period": "7"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Report Refresh Date,Total,Active,Report Date,Report Period
+    2022-11-10,1,0,2022-11-10,7
+    ```
+
+=== "CSV"
+
+    ```csv
+    Report Refresh Date,Total,Active,Report Date,Report Period
+    2022-11-10,1,0,2022-11-10,7
+    ```

package/docs/docs/cmd/yammer/user/user-get.md

@@ -10,7 +10,7 @@ m365 yammer user get [options]
 
 ## Options
 
-`-i, --userId [userId]`
+`-i, --id [id]`
 : Retrieve a user by ID
 
 `--email [email]`
@@ -36,7 +36,7 @@ m365 yammer user get
 Returns the user with the ID 1496550697
 
 ```sh
-m365 yammer user get --userId 1496550697
+m365 yammer user get --id 1496550697
 ```
 
 Returns an array of users matching the e-mail john.smith@contoso.com
@@ -50,3 +50,102 @@ Returns an array of users matching the e-mail john.smith@contoso.com in JSON. Th
 ```sh
 m365 yammer user get --email john.smith@contoso.com --output json
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "type": "user",
+      "id": 172006440961,
+      "network_id": 5897756673,
+      "state": "active",
+      "job_title": "",
+      "location": null,
+      "interests": null,
+      "summary": null,
+      "expertise": null,
+      "full_name": "johndoe",
+      "activated_at": "2021/10/08 11:45:32 +0000",
+      "auto_activated": false,
+      "show_ask_for_photo": true,
+      "first_name": "",
+      "last_name": "",
+      "network_name": "Contoso",
+      "network_domains": [
+        "contoso.onmicrosoft.com"
+      ],
+      "url": "https://www.yammer.com/api/v1/users/172006440961",
+      "web_url": "https://www.yammer.com/contoso.onmicrosoft.com/users/172006440961",
+      "name": "admvalo",
+      "mugshot_url": "https://mugshot0eu-1.assets-yammer.com/mugshot/images/no_photo.png?P1=1668205841&P2=104&P3=1&P4=rnM2FPGOQRZja018qxAFshyyDKKH5SoUXkdpCeizRsdD7Ggb9sLSsdEaq-icgk8g-QTHFd0Te4e1gWAZTGEQekSQop6G6zDcipIVbZMJStEzfKKUpSPckcXnRhfiI55yq5AOLhVcH2PP_ZBFF-0KXMaP8Hy4dGDIRzmnUGhFuik0yjNBoGaYL86ltEaDMQdpS6rS3lmIMzLPGEMfr30vethAxRT7SKBbNYxZ9iPxO6TY26cYCfv0VyyMQkGGviPU4__EVjOoklhD_AqFGFGHtRTcsafpKOxCE70Z-nUpIPbYCel3las7w105u4SvPPC00Q5LUMDynUvzPiR4-vbWPg&size=48x48",
+      "mugshot_redirect_url": "https://www.yammer.com/mugshot/images/redirect/48x48/no_photo.png",
+      "mugshot_url_template": "https://mugshot0eu-1.assets-yammer.com/mugshot/images/no_photo.png?P1=1668205841&P2=104&P3=1&P4=rnM2FPGOQRZja018qxAFshyyDKKH5SoUXkdpCeizRsdD7Ggb9sLSsdEaq-icgk8g-QTHFd0Te4e1gWAZTGEQekSQop6G6zDcipIVbZMJStEzfKKUpSPckcXnRhfiI55yq5AOLhVcH2PP_ZBFF-0KXMaP8Hy4dGDIRzmnUGhFuik0yjNBoGaYL86ltEaDMQdpS6rS3lmIMzLPGEMfr30vethAxRT7SKBbNYxZ9iPxO6TY26cYCfv0VyyMQkGGviPU4__EVjOoklhD_AqFGFGHtRTcsafpKOxCE70Z-nUpIPbYCel3las7w105u4SvPPC00Q5LUMDynUvzPiR4-vbWPg&size={width}x{height}",
+      "mugshot_redirect_url_template": "https://www.yammer.com/mugshot/images/redirect/{width}x{height}/no_photo.png",
+      "birth_date": "",
+      "birth_date_complete": "",
+      "timezone": "Pacific Time (US & Canada)",
+      "external_urls": [],
+      "admin": "true",
+      "verified_admin": "true",
+      "m365_yammer_admin": "false",
+      "supervisor_admin": "false",
+      "o365_tenant_admin": "true",
+      "can_broadcast": "true",
+      "department": null,
+      "email": "johndoe@contoso.onmicrosoft.com",
+      "guest": false,
+      "aad_guest": false,
+      "can_view_delegations": false,
+      "can_create_new_network": false,
+      "can_browse_external_networks": false,
+      "reaction_accent_color": "none",
+      "significant_other": "",
+      "kids_names": "",
+      "previous_companies": [],
+      "schools": [],
+      "contact": {
+        "im": {
+          "provider": "",
+          "username": ""
+        },
+        "phone_numbers": [],
+        "email_addresses": [
+          {
+            "type": "primary",
+            "address": "johndoe@contoso.onmicrosoft.com"
+          }
+        ],
+        "has_fake_email": false
+      },
+      "stats": {
+        "updates": 0,
+        "following": 0,
+        "followers": 0
+      },
+      "settings": {
+        "xdr_proxy": ""
+      },
+      "show_invite_lightbox": false,
+      "age_bucket": "notSet"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    email    : johndoe@contoso.onmicrosoft.com
+    full_name: johndoe
+    id       : 172006440961
+    job_title:
+    state    : active
+    url      : https://www.yammer.com/api/v1/users/172006440961
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,full_name,email,job_title,state,url
+    172006440961,admvalo,johndoe@contoso.onmicrosoft.com,,active,https://www.yammer.com/api/v1/users/172006440961
+    ```

package/docs/docs/cmd/yammer/user/user-list.md

@@ -57,3 +57,100 @@ Returns the first 10 Yammer network users within the group 5785177
 ```sh
 m365 user list --groupId 5785177 --limit 10
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "type": "user",
+        "id": 172006440961,
+        "network_id": 5897756673,
+        "state": "active",
+        "job_title": "",
+        "location": null,
+        "interests": null,
+        "summary": null,
+        "expertise": null,
+        "full_name": "John Doe",
+        "activated_at": "2021/10/08 11:45:32 +0000",
+        "auto_activated": false,
+        "show_ask_for_photo": true,
+        "first_name": "",
+        "last_name": "",
+        "network_name": "Contoso",
+        "network_domains": [
+          "contoso.onmicrosoft.com"
+        ],
+        "url": "https://www.yammer.com/api/v1/users/172006440961",
+        "web_url": "https://www.yammer.com/contoso.onmicrosoft.com/users/172006440961",
+        "name": "johndoe",
+        "mugshot_url": "https://mugshot0eu-1.assets-yammer.com/mugshot/images/no_photo.png?P1=1668205841&P2=104&P3=1&P4=rnM2FPGOQRZja018qxAFshyyDKKH5SoUXkdpCeizRsdD7Ggb9sLSsdEaq-icgk8g-QTHFd0Te4e1gWAZTGEQekSQop6G6zDcipIVbZMJStEzfKKUpSPckcXnRhfiI55yq5AOLhVcH2PP_ZBFF-0KXMaP8Hy4dGDIRzmnUGhFuik0yjNBoGaYL86ltEaDMQdpS6rS3lmIMzLPGEMfr30vethAxRT7SKBbNYxZ9iPxO6TY26cYCfv0VyyMQkGGviPU4__EVjOoklhD_AqFGFGHtRTcsafpKOxCE70Z-nUpIPbYCel3las7w105u4SvPPC00Q5LUMDynUvzPiR4-vbWPg&size=48x48",
+        "mugshot_redirect_url": "https://www.yammer.com/mugshot/images/redirect/48x48/no_photo.png",
+        "mugshot_url_template": "https://mugshot0eu-1.assets-yammer.com/mugshot/images/no_photo.png?P1=1668205841&P2=104&P3=1&P4=rnM2FPGOQRZja018qxAFshyyDKKH5SoUXkdpCeizRsdD7Ggb9sLSsdEaq-icgk8g-QTHFd0Te4e1gWAZTGEQekSQop6G6zDcipIVbZMJStEzfKKUpSPckcXnRhfiI55yq5AOLhVcH2PP_ZBFF-0KXMaP8Hy4dGDIRzmnUGhFuik0yjNBoGaYL86ltEaDMQdpS6rS3lmIMzLPGEMfr30vethAxRT7SKBbNYxZ9iPxO6TY26cYCfv0VyyMQkGGviPU4__EVjOoklhD_AqFGFGHtRTcsafpKOxCE70Z-nUpIPbYCel3las7w105u4SvPPC00Q5LUMDynUvzPiR4-vbWPg&size={width}x{height}",
+        "mugshot_redirect_url_template": "https://www.yammer.com/mugshot/images/redirect/{width}x{height}/no_photo.png",
+        "birth_date": "",
+        "birth_date_complete": "",
+        "timezone": "Pacific Time (US & Canada)",
+        "external_urls": [],
+        "admin": "true",
+        "verified_admin": "true",
+        "m365_yammer_admin": "false",
+        "supervisor_admin": "false",
+        "o365_tenant_admin": "true",
+        "can_broadcast": "true",
+        "department": null,
+        "email": "johndoe@contoso.onmicrosoft.com",
+        "guest": false,
+        "aad_guest": false,
+        "can_view_delegations": false,
+        "can_create_new_network": false,
+        "can_browse_external_networks": false,
+        "reaction_accent_color": "none",
+        "significant_other": "",
+        "kids_names": "",
+        "previous_companies": [],
+        "schools": [],
+        "contact": {
+          "im": {
+            "provider": "",
+            "username": ""
+          },
+          "phone_numbers": [],
+          "email_addresses": [
+            {
+              "type": "primary",
+              "address": "johndoe@contoso.onmicrosoft.com"
+            }
+          ],
+          "has_fake_email": false
+        },
+        "stats": {
+          "updates": 0,
+          "following": 0,
+          "followers": 0
+        },
+        "settings": {
+          "xdr_proxy": ""
+        },
+        "show_invite_lightbox": false
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id            full_name         email
+    ------------  ----------------  -------------------------------
+    36425097217   John Doe          johndoe@contoso.onmicrosoft.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,full_name,email
+    36425097217,John Doe,johndoe@contoso.onmicrosoft.com
+    ```

package/docs/docs/cmd/yammer/yammer-search.md

@@ -65,3 +65,80 @@ Returns the search results for the query `community` and limits the results to t
 ```sh
 m365 yammer search --queryText "community" --output json --limit 50
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "summary": {
+        "messages": 1,
+        "topics": 0,
+        "users": 0,
+        "groups": 0
+      },
+      "messages": [
+        {
+          "id": 2000337648877569,
+          "sender_id": 36425097217,
+          "delegate_id": null,
+          "replied_to_id": null,
+          "created_at": "2022/11/11 21:00:14 +0000",
+          "network_id": 5897756673,
+          "message_type": "update",
+          "sender_type": "user",
+          "url": "https://www.yammer.com/api/v1/messages/2000337648877569",
+          "web_url": "https://www.yammer.com/contoso.onmicrosoft.com/messages/2000337648877569",
+          "group_id": 31158067201,
+          "body": {
+            "parsed": "Hello everyone!",
+            "plain": "Hello everyone!",
+            "rich": "Hello everyone!"
+          },
+          "thread_id": 2000337648877569,
+          "client_type": "O365 Api Auth",
+          "client_url": "https://api.yammer.com",
+          "system_message": false,
+          "direct_message": false,
+          "chat_client_sequence": null,
+          "language": "no",
+          "notified_user_ids": [],
+          "privacy": "public",
+          "attachments": [],
+          "liked_by": {
+            "count": 1,
+            "names": [
+              {
+                "full_name": "johndoe",
+                "permalink": "JohnDoe",
+                "user_id": 36425097217,
+                "network_id": 5897756673
+              }
+            ]
+          },
+          "supplemental_reply": false,
+          "content_excerpt": "Hello everyone!",
+          "group_created_id": 31158067201
+        }
+      ],
+      "users": [],
+      "topics": [],
+      "groups": []
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id                description      type     web_url
+    ----------------  ---------------  -------  ----------------------------------------------------------------------------
+    2000337648877569  Hello everyone!  message  https://www.yammer.com/contoso.onmicrosoft.com/messages/2000337648877569
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,description,type,web_url
+    2000337648877569,Hello everyone!,message,https://www.yammer.com/contoso.onmicrosoft.com/messages/2000337648877569
+    ```