@pnp/cli-microsoft365 6.8.0 → 6.9.0-beta.1cd2525

package/docs/docs/cmd/aad/o365group/o365group-report-activitydetail.mdx

@@ -0,0 +1,112 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad o365group report activitydetail
+
+Get details about Microsoft 365 Groups activity by group.
+
+## Usage
+
+```sh
+m365 aad o365group report activitydetail [options]
+```
+
+## Options
+
+```md definition-list
+`-p, --period [period]`
+: The length of time over which the report is aggregated. Supported values `D7`, `D30`, `D90`, `D180`. Specify the `period` or `date`, but not both.
+
+`-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`. Specify the `date` or `period`, but not both.
+
+`-f, --outputFile [outputFile]`
+: Path to the file where the Microsoft 365 Groups activity by group report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Get details about Microsoft 365 Groups activity by group for the last week
+
+```sh
+m365 aad o365group report activitydetail --period D7
+```
+
+Get details about Microsoft 365 Groups activity by group for September 09, 2019
+
+```sh
+m365 aad o365group report activitydetail --date 2019-09-28
+```
+
+Get details about Microsoft 365 Groups activity by group for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 aad o365group report activitydetail --period D7 --output text > "o365groupactivitydetail.txt"
+```
+
+Get details about Microsoft 365 Groups activity by group for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 aad o365group report activitydetail --period D7 --output json > "o365groupactivitydetail.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-05-31",
+      "Group Display Name": "7D3654B07E126BBD0D18174368FC243F",
+      "Is Deleted": "False",
+      "Owner Principal Name": "550802505126139905D733891825A254",
+      "Last Activity Date": "",
+      "Group Type": "Public",
+      "Member Count": "1",
+      "External Member Count": "0",
+      "Exchange Received Email Count": "",
+      "SharePoint Active File Count": "",
+      "Yammer Posted Message Count": "",
+      "Yammer Read Message Count": "",
+      "Yammer Liked Message Count": "",
+      "Exchange Mailbox Total Item Count": "5",
+      "Exchange Mailbox Storage Used (Byte)": "203448",
+      "SharePoint Total File Count": "0",
+      "SharePoint Site Storage Used (Byte)": "1455831",
+      "Group Id": "00000000-0000-0000-0000-000000000000",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Member Count,External Member Count,Exchange Received Email Count,SharePoint Active File Count,Yammer Posted Message Count,Yammer Read Message Count,Yammer Liked Message Count,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period
+  2023-05-31,7D3654B07E126BBD0D18174368FC243F,False,550802505126139905D733891825A254,,Public,1,0,,,,,,5,203448,0,1455831,00000000-0000-0000-0000-000000000000,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Member Count,External Member Count,Exchange Received Email Count,SharePoint Active File Count,Yammer Posted Message Count,Yammer Read Message Count,Yammer Liked Message Count,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period
+  2023-05-31,7D3654B07E126BBD0D18174368FC243F,False,550802505126139905D733891825A254,,Public,1,0,,,,,,5,203448,0,1455831,00000000-0000-0000-0000-000000000000,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Group Display Name,Is Deleted,Owner Principal Name,Last Activity Date,Group Type,Member Count,External Member Count,Exchange Received Email Count,SharePoint Active File Count,Yammer Posted Message Count,Yammer Read Message Count,Yammer Liked Message Count,Exchange Mailbox Total Item Count,Exchange Mailbox Storage Used (Byte),SharePoint Total File Count,SharePoint Site Storage Used (Byte),Group Id,Report Period
+  2023-05-31,7D3654B07E126BBD0D18174368FC243F,False,550802505126139905D733891825A254,,Public,1,0,,,,,,5,203448,0,1455831,00000000-0000-0000-0000-000000000000,7
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/aad/o365group/o365group-report-activityfilecounts.mdx

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad o365group report activityfilecounts
+
+Get the total number of files and how many of them were active across all group sites associated with an Microsoft 365 Group
+
+## Usage
+
+```sh
+m365 aad o365group report activityfilecounts [options]
+```
+
+## Options
+
+```md definition-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 Microsoft 365 Groups activities across group workloads report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Get the total number of files and how many of them were active across all group sites associated with an Microsoft 365 Group for the last week
+
+```sh
+m365 aad o365group report activityfilecounts --period D7
+```
+
+Get the total number of files and how many of them were active across all group sites associated with an Microsoft 365 Group for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 aad o365group report activityfilecounts --period D7 --output text > "o365groupactivityfilecounts.txt"
+```
+
+Get the total number of files and how many of them were active across all group sites associated with an Microsoft 365 Group for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 aad o365group report activityfilecounts --period D7 --output json > "o365groupactivityfilecounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-05-31",
+      "Total": "5647",
+      "Active": "",
+      "Report Date": "2023-05-31",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-05-31,5647,,2023-05-31,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-05-31,5647,,2023-05-31,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-05-31,5647,,2023-05-31,7
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/aad/o365group/o365group-report-activitygroupcounts.mdx

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad o365group report activitygroupcounts
+
+Get the daily total number of groups and how many of them were active based on email conversations, Yammer posts, and SharePoint file activities.
+
+## Usage
+
+```sh
+m365 aad o365group report activitygroupcounts [options]
+```
+
+## Options
+
+```md definition-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 Microsoft 365 Groups activities report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Get the daily total number of groups and how many of them were active based on activities for the last week
+
+```sh
+m365 aad o365group report activitygroupcounts --period D7
+```
+
+Get the daily total number of groups and how many of them were active based on activities for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 aad o365group report activitygroupcounts --period D7 --output text > "o365groupactivitygroupcounts.txt"
+```
+
+Get the daily total number of groups and how many of them were active based on activities for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 aad o365group report activitygroupcounts --period D7 --output json > "o365groupactivitygroupcounts.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-05-31",
+      "Total": "24",
+      "Active": "0",
+      "Report Date": "2023-05-31",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-05-31,24,0,2023-05-31,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-05-31,24,0,2023-05-31,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Total,Active,Report Date,Report Period
+  2023-05-31,24,0,2023-05-31,7
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/aad/o365group/o365group-report-activitystorage.mdx

@@ -0,0 +1,89 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad o365group report activitystorage
+
+Get the total storage used across all group mailboxes and group sites
+
+## Usage
+
+```sh
+m365 aad o365group report activitystorage  [options]
+```
+
+## Options
+
+```md definition-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 Microsoft 365 Groups activities report should be stored in
+```
+
+<Global />
+
+## Examples
+
+Get the total storage used across all group mailboxes and group sites for the last week
+
+```sh
+m365 aad o365group report activitystorage --period D7
+```
+
+Get the total storage used across all group mailboxes and group sites for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 aad o365group report activitystorage --period D7 --output text > "o365groupactivitystorage.txt"
+```
+
+Get the total storage used across all group mailboxes and group sites for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 aad o365group report activitystorage --period D7 --output json > "o365groupactivitystorage.json"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Report Refresh Date": "2023-05-31",
+      "Mailbox Storage Used (Byte)": "37070516",
+      "Site Storage Used (Byte)": "6521772595",
+      "Report Date": "2023-05-31",
+      "Report Period": "7"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  Report Refresh Date,Mailbox Storage Used (Byte),Site Storage Used (Byte),Report Date,Report Period
+  2023-05-31,37070516,6521772595,2023-05-31,7
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Report Refresh Date,Mailbox Storage Used (Byte),Site Storage Used (Byte),Report Date,Report Period
+  2023-05-31,37070516,6521772595,2023-05-31,7
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  Report Refresh Date,Mailbox Storage Used (Byte),Site Storage Used (Byte),Report Date,Report Period
+  2023-05-31,37070516,6521772595,2023-05-31,7
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/aad/o365group/o365group-set.mdx

@@ -0,0 +1,80 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group set
+
+Updates Microsoft 365 Group properties
+
+## Usage
+
+```sh
+m365 aad o365group set [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the Microsoft 365 Group to update
+
+`-n, --displayName [displayName]`
+: Display name for the Microsoft 365 Group
+
+`-d, --description [description]`
+: Description for the Microsoft 365 Group
+
+`--owners [owners]`
+: Comma-separated list of Microsoft 365 Group owners to add
+
+`--members [members]`
+: Comma-separated list of Microsoft 365 Group members to add
+
+`--isPrivate [isPrivate]`
+: Set to true if the Microsoft 365 Group should be private and to false if it should be public (default)
+
+`-l, --logoPath [logoPath]`
+: Local path to the image file to use as group logo
+```
+
+<Global />
+
+## Remarks
+
+When updating group's owners and members, the command will add newly specified users to the previously set owners and members. The previously set users will not be replaced.
+
+When specifying the path to the logo image you can use both relative and absolute paths. Note, that ~ in the path, will not be resolved and will most likely result in an error.
+
+## Examples
+
+Update Microsoft 365 Group display name
+
+```sh
+m365 aad o365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --displayName Finance
+```
+
+Change Microsoft 365 Group visibility to public
+
+```sh
+m365 aad o365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --isPrivate false
+```
+
+Add new Microsoft 365 Group owners
+
+```sh
+m365 aad o365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --owners "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
+```
+
+Add new Microsoft 365 Group members
+
+```sh
+m365 aad o365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --members "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
+```
+
+Update Microsoft 365 Group logo
+
+```sh
+m365 aad o365group set --id 28beab62-7540-4db1-a23f-29a6018a3848 --logoPath images/logo.png
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/o365group/o365group-teamify.mdx

@@ -0,0 +1,41 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group teamify
+
+Creates a new Microsoft Teams team under existing Microsoft 365 group
+
+## Usage
+
+```sh
+m365 aad o365group teamify [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The ID of the Microsoft 365 Group to connect to Microsoft Teams. Specify either id or mailNickname but not both
+
+`--mailNickname [mailNickname]`
+: The mail alias of the Microsoft 365 Group to connect to Microsoft Teams. Specify either id or mailNickname but not both
+```
+
+<Global />
+
+## Examples
+
+Creates a new Microsoft Teams team under existing Microsoft 365 group with id _e3f60f99-0bad-481f-9e9f-ff0f572fbd03_
+
+```sh
+m365 aad o365group teamify --id e3f60f99-0bad-481f-9e9f-ff0f572fbd03
+```
+
+Creates a new Microsoft Teams team under existing Microsoft 365 group with mailNickname _GroupName_
+
+```sh
+m365 aad o365group teamify --mailNickname GroupName
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/o365group/o365group-user-add.mdx

@@ -0,0 +1,59 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group user add
+
+Adds user to specified Microsoft 365 Group or Microsoft Teams team
+
+## Usage
+
+```sh
+m365 aad o365group user add [options]
+```
+
+## Alias
+
+```sh
+m365 teams user add
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId [groupId]`
+: The ID of the Microsoft 365 Group to which to add the user
+
+`--teamId [teamId]`
+: The ID of the Teams team to which to add the user
+
+`-n, --userName <userName>`
+: User's UPN (user principal name, eg. johndoe@example.com)
+
+`-r, --role [role]`
+: The role to be assigned to the new user: `Owner,Member`. Default `Member`
+```
+
+<Global />
+
+## Examples
+
+Add a new member to the specified Microsoft 365 Group
+
+```sh
+m365 aad o365group user add --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com'
+```
+
+Add a new owner to the specified Microsoft 365 Group
+
+```sh
+m365 aad o365group user add --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Owner
+```
+
+Add a new member to the specified Microsoft Teams team
+
+```sh
+m365 teams user add --teamId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com'
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/o365group/o365group-user-list.mdx

@@ -0,0 +1,99 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad o365group user list
+
+Lists users for the specified Microsoft 365 group
+
+## Usage
+
+```sh
+m365 aad o365group user list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId <groupId>`
+: The ID of the Microsoft 365 group for which to list users
+
+`-r, --role [role]`
+: Filter the results to only users with the given role: `Owner`, `Member`, `Guest`
+```
+
+<Global />
+
+## Examples
+
+List all users and their role in the specified Microsoft 365 group
+
+```sh
+m365 aad o365group user list --groupId '00000000-0000-0000-0000-000000000000'
+```
+
+List all owners and their role in the specified Microsoft 365 group
+
+```sh
+m365 aad o365group user list --groupId '00000000-0000-0000-0000-000000000000' --role Owner
+```
+
+ List all guests and their role in the specified Microsoft 365 group
+
+```sh
+m365 aad o365group user list --groupId '00000000-0000-0000-0000-000000000000' --role Guest
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "da52218e-4822-4ac6-b41d-255e2059655e",
+      "displayName": "Adele Vance",
+      "userPrincipalName": "AdeleV@contoso.OnMicrosoft.com",
+      "userType": "Member"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                    displayName           userPrincipalName                     userType
+  ------------------------------------  --------------------  ------------------------------------  --------
+  da52218e-4822-4ac6-b41d-255e2059655e  Adele Vance           AdeleV@contoso.OnMicrosoft.com  Member
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName,userPrincipalName,userType
+  da52218e-4822-4ac6-b41d-255e2059655e,Adele Vance,AdeleV@contoso.OnMicrosoft.com,Member
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad o365group user list --groupId "1deaa428-8dde-4043-b028-5492226d6114"
+
+  Date: 2023-06-02
+
+  ## Adele Vance (da52218e-4822-4ac6-b41d-255e2059655e)
+
+  Property | Value
+  ---------|-------
+  id | da52218e-4822-4ac6-b41d-255e2059655e
+  displayName | Adele Vance
+  userPrincipalName | AdeleV@contoso.OnMicrosoft.com
+  userType | Member
+  ```
+
+  </TabItem>
+</Tabs>