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

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

@@ -0,0 +1,111 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# yammer report deviceusageuserdetail
+
+Gets details about Yammer device usage by user
+
+## Usage
+
+```sh
+m365 yammer report deviceusageuserdetail [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --period [period]`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-d, --date [date]`
+: The date for which you would like to view the users who performed any activity. Supported date format is `YYYY-MM-DD`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Remarks
+
+As this report is only available for the past 28 days, date parameter value should be a date from that range.
+
+## Examples
+
+Gets details about Yammer device usage by user for the last week
+
+```sh
+m365 yammer report deviceusageuserdetail --period D7
+```
+
+Gets details about Yammer device usage by user for July 1, 2019
+
+```sh
+m365 yammer report deviceusageuserdetail --date 2019-07-01
+```
+
+Gets details about Yammer device usage by user for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 yammer report deviceusageuserdetail --period D7 --output text > "deviceusageuserdetail.txt"
+```
+
+Gets details about Yammer device usage by user for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 yammer report deviceusageuserdetail --period D7 --output json > "deviceusageuserdetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="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"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  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
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,91 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# yammer report groupsactivitycounts
+
+Gets the number of Yammer messages posted, read, and liked in groups
+
+## Usage
+
+```sh
+m365 yammer report groupsactivitycounts [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 number of Yammer messages posted, read, and liked in groups for the last week
+
+```sh
+m365 yammer report groupsactivitycounts --period D7
+```
+
+Gets the number of Yammer messages posted, read, and liked in groups for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 yammer report groupsactivitycounts --period D7 --output text > "groupsactivitycounts.txt"
+```
+
+Gets the number of Yammer messages posted, read, and liked in groups for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 yammer report groupsactivitycounts --period D7 --output json > "groupsactivitycounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-04",
+      "Liked": "5",
+      "Posted": "6",
+      "Read": "7",
+      "Report Date": "2022-11-04",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+  2022-11-10,5,6,7,2022-11-10,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+  2022-11-10,5,6,7,2022-11-10,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Liked,Posted,Read,Report Date,Report Period
+  2022-11-10,5,6,7,2022-11-10,7
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,110 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# yammer report groupsactivitydetail
+
+Gets details about Yammer groups activity by group
+
+## Usage
+
+```sh
+m365 yammer report groupsactivitydetail [options]
+```
+
+## Options
+
+```md defintion-list
+`-p, --period [period]`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`.
+
+`-d, --date [date]`
+: The date for which you would like to view the users who performed any activity. Supported date format is `YYYY-MM-DD`.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the report should be stored in
+```
+
+<Global />
+
+## Remarks
+
+As this report is only available for the past 28 days, date parameter value should be a date from that range.
+
+## Examples
+
+Gets details about Yammer groups activity by group for the last week
+
+```sh
+m365 yammer report groupsactivitydetail --period D7
+```
+
+Gets details about Yammer groups activity by group for July 1, 2019
+
+```sh
+m365 yammer report groupsactivitydetail --date 2019-07-01
+```
+
+Gets details about Yammer groups activity by group for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 yammer report groupsactivitydetail --period D7 --output text > "groupsactivitydetail.txt"
+```
+
+Gets details about Yammer groups activity by group for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 yammer report groupsactivitydetail --period D7 --output json > "groupsactivitydetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="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"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  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
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,90 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# yammer report groupsactivitygroupcounts
+
+Gets the total number of groups that existed and how many included group conversation activity
+
+## Usage
+
+```sh
+m365 yammer report groupsactivitygroupcounts [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 total number of groups that existed and how many included group conversation activity for the last week
+
+```sh
+m365 yammer report groupsactivitygroupcounts --period D7
+```
+
+Gets the total number of groups that existed and how many included group conversation activity for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 yammer report groupsactivitygroupcounts --period D7 --output text > "groupsactivitygroupcounts.txt"
+```
+
+Gets the total number of groups that existed and how many included group conversation activity for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 yammer report groupsactivitygroupcounts --period D7 --output json > "groupsactivitygroupcounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2022-11-04",
+      "Total": "1",
+      "Active": "0",
+      "Report Date": "2022-11-04",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2022-11-10,1,0,2022-11-10,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2022-11-10,1,0,2022-11-10,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2022-11-10,1,0,2022-11-10,7
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,223 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# yammer user get
+
+Retrieves the current user or searches for a user by ID or e-mail
+
+## Usage
+
+```sh
+m365 yammer user get [options]
+```
+
+## Options
+
+```md defintion-list
+`-i, --id [id]`
+: Retrieve a user by ID
+
+`--email [email]`
+: Retrieve a user by e-mail
+```
+
+<Global />
+
+## Remarks
+
+:::caution
+
+In order to use this command, you need to grant the Azure AD application used by the CLI for Microsoft 365 the permission to the Yammer API. To do this, execute the `cli consent --service yammer` command.
+
+:::
+
+All operations return a single user object. Operations executed with the `email` parameter return an array of user objects.
+
+## Examples
+  
+Returns the current user
+
+```sh
+m365 yammer user get
+```
+
+Returns the user with the ID 1496550697
+
+```sh
+m365 yammer user get --id 1496550697
+```
+
+Returns an array of users matching the e-mail
+
+```sh
+m365 yammer user get --email john.smith@contoso.com
+```
+
+Returns an array of users matching the e-mail in JSON. The JSON output returns a full user object
+
+```sh
+m365 yammer user get --email john.smith@contoso.com --output json
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="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"
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="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
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # yammer user get --email "johndoe@contoso.onmicrosoft.com"
+
+  Date: 2023-05-16
+
+  ## john (172006440961)
+
+  Property | Value
+  ---------|-------
+  type | user
+  id | 172006440961
+  network\_id | 98327945216
+  state | active
+  job\_title |
+  location |
+  summary |
+  full\_name | john doe
+  activated\_at | 2022/12/12 12:48:58 +0000
+  auto\_activated | false
+  show\_ask\_for\_photo | false
+  first\_name | john
+  last\_name | doe
+  network\_name | Contoso
+  url | https://www.yammer.com/api/v1/users/172006440961
+  web\_url | https://www.yammer.com/contoso.onmicrosoft.com/users/172006440961
+  name | john
+  mugshot\_url | https://mugshot0.assets-yammer.com/mugshot/images/j3vWbMtXbkp952gqLQlDqKj8s3Fw42Xc\_5306d18a-4133-48a7-b568-a47af1bab178?P1=1684269373&P2=104&P3=1&P4=fnQKCoHkdFGwue-NUtuMDHzqeFOZF0\_4qq0S0-H58C-98YH7QMJ51UBeJTbQduTeM5\_68DNW3eS-BsuYL1dS1fogpRYtLuZBhbYm4hW0D7ZeSbbEGPLnbEDSb6yjAN6ATTCHp2erTw5apasxyO3UcnTTJKBrIp56KfW0nxoFIrIYsqscpHXDHAhAqQ3eD8qfGyShNL1ZMlQBeTjm4qNMlI7qLM4lomhrKIHwjJsmczchlCBRX26HxNx6hWt4apWZi41dxAvJxYVht36kShq0W4WCAqwUEFbyPPJBdeFHB7nGkdYq6x3ab9W-\_CcptsxiOp1tP1jxZbE5x79STjUKaA&size=48x48
+  mugshot\_redirect\_url | https://www.yammer.com/mugshot/images/redirect/48x48/j3vWbMtXbkp952gqLQlDqKj8s3Fw42Xc\_5306d18a-4133-48a7-b568-a47af1bab178
+  mugshot\_url\_template | https://mugshot0.assets-yammer.com/mugshot/images/j3vWbMtXbkp952gqLQlDqKj8s3Fw42Xc\_5306d18a-4133-48a7-b568-a47af1bab178?P1=1684269373&P2=104&P3=1&P4=fnQKCoHkdFGwue-NUtuMDHzqeFOZF0\_4qq0S0-H58C-98YH7QMJ51UBeJTbQduTeM5\_68DNW3eS-BsuYL1dS1fogpRYtLuZBhbYm4hW0D7ZeSbbEGPLnbEDSb6yjAN6ATTCHp2erTw5apasxyO3UcnTTJKBrIp56KfW0nxoFIrIYsqscpHXDHAhAqQ3eD8qfGyShNL1ZMlQBeTjm4qNMlI7qLM4lomhrKIHwjJsmczchlCBRX26HxNx6hWt4apWZi41dxAvJxYVht36kShq0W4WCAqwUEFbyPPJBdeFHB7nGkdYq6x3ab9W-\_CcptsxiOp1tP1jxZbE5x79STjUKaA&size={width}x{height}
+  mugshot\_redirect\_url\_template | https://www.yammer.com/mugshot/images/redirect/{width}x{height}/j3vWbMtXbkp952gqLQlDqKj8s3Fw42Xc\_5306d18a-4133-48a7-b568-a47af1bab178
+  birth\_date |
+  birth\_date\_complete |
+  timezone | Pacific Time (US & Canada)
+  admin | true
+  verified\_admin | true
+  m365\_yammer\_admin | false
+  supervisor\_admin | false
+  o365\_tenant\_admin | true
+  answers\_admin | false
+  corporate\_communicator | false
+  can\_broadcast | true
+  email | johndoe@contoso.onmicrosoft.com
+  guest | false
+  aad\_guest | false
+  can\_view\_delegations | false
+  can\_create\_new\_network | true
+  can\_browse\_external\_networks | true
+  reaction\_accent\_color | none
+  significant\_other |
+  kids\_names |
+  show\_invite\_lightbox | false
+  ```
+
+  </TabItem>
+</Tabs>
+