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

package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.mdx

@@ -0,0 +1,46 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group recyclebinitem restore
+
+Restores a deleted Microsoft 365 Group
+
+## Usage
+
+```sh
+m365 aad o365group recyclebinitem restore [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The ID of the Microsoft 365 Group to restore. Specify either `id`, `displayName` or `mailNickname` but not multiple.
+
+`-d, --displayName [displayName]`
+: Display name for the Microsoft 365 Group to restore. Specify either `id`, `displayName` or `mailNickname` but not multiple.
+
+`-m, --mailNickname [mailNickname]`
+: Name of the group e-mail (part before the @). Specify either `id`, `displayName` or `mailNickname` but not multiple.
+```
+
+<Global />
+
+## Examples
+
+Restores the Microsoft 365 Group with specific ID
+
+```sh
+m365 aad o365group recyclebinitem restore --id 28beab62-7540-4db1-a23f-29a6018a3848
+```
+
+Restores the Microsoft 365 Group with specific name
+
+```sh
+m365 aad o365group recyclebinitem restore --displayName "My Group"
+```
+
+Restores the Microsoft 365 Group with specific mail nickname
+
+```sh
+m365 aad o365group recyclebinitem restore --mailNickname "Mygroup"
+```

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

@@ -0,0 +1,50 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group remove
+
+Removes an Microsoft 365 Group
+
+## Usage
+
+```sh
+m365 aad o365group remove [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the Microsoft 365 Group to remove
+
+`--confirm`
+: Don't prompt for confirming removing the group
+
+`--skipRecycleBin`
+: Set to directly remove the group without moving it to the Recycle Bin
+```
+
+<Global />
+
+## Remarks
+
+If the specified _id_ doesn't refer to an existing group, you will get a `Resource does not exist` error.
+
+## Examples
+
+Remove group with id _28beab62-7540-4db1-a23f-29a6018a3848_. Will prompt for confirmation before removing the group
+
+```sh
+m365 aad o365group remove --id 28beab62-7540-4db1-a23f-29a6018a3848
+```
+
+Remove group with id _28beab62-7540-4db1-a23f-29a6018a3848_ without prompting for confirmation
+
+```sh
+m365 aad o365group remove --id 28beab62-7540-4db1-a23f-29a6018a3848 --confirm
+```
+
+Remove group with id _28beab62-7540-4db1-a23f-29a6018a3848_ without prompting for confirmation and without moving it to the Recycle Bin
+
+```sh
+m365 aad o365group remove --id 28beab62-7540-4db1-a23f-29a6018a3848 --confirm --skipRecycleBin
+```

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

@@ -0,0 +1,32 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group renew
+
+Renews Microsoft 365 group's expiration
+
+## Usage
+
+```sh
+m365 aad o365group renew [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the Microsoft 365 group to renew
+```
+
+<Global />
+
+## Remarks
+
+If the specified _id_ doesn't refer to an existing group, you will get a `The remote server returned an error: (404) Not Found.` error.
+
+## Examples
+
+Renew the Microsoft 365 group with id _28beab62-7540-4db1-a23f-29a6018a3848_
+
+```sh
+m365 aad o365group renew --id 28beab62-7540-4db1-a23f-29a6018a3848
+```

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

@@ -0,0 +1,43 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group report activitycounts
+
+Get the number of group activities across group workloads
+
+## Usage
+
+```sh
+m365 aad o365group report activitycounts [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 number of group activities across group workloads for the last week
+
+```sh
+m365 aad o365group report activitycounts --period D7
+```
+
+Get the number of group activities across group workloads for the last week and exports the report data in the specified path in text format
+
+```sh
+m365 aad o365group report activitycounts --period D7 --output text > "o365groupactivitycounts.txt"
+```
+
+Get the number of group activities across group workloads for the last week and exports the report data in the specified path in json format
+
+```sh
+m365 aad o365group report activitycounts --period D7 --output json > "o365groupactivitycounts.json"
+```

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

@@ -0,0 +1,52 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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"
+```

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

@@ -0,0 +1,43 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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"
+```

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

@@ -0,0 +1,43 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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"
+```

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

@@ -0,0 +1,43 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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"
+```

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

@@ -0,0 +1,76 @@
+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
+```

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

@@ -0,0 +1,37 @@
+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
+```

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

@@ -0,0 +1,55 @@
+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'
+```

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

@@ -0,0 +1,43 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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
+```

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

@@ -0,0 +1,59 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group user remove
+
+Removes the specified user from specified Microsoft 365 Group or Microsoft Teams team
+
+## Usage
+
+```sh
+m365 aad o365group user remove [options]
+```
+
+## Alias
+
+```sh
+m365 aad teams user remove
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId [groupId]`
+: The ID of the Microsoft 365 Group from which to remove the user
+
+`--teamId [teamId]`
+: The ID of the Microsoft Teams team from which to remove the user
+
+`-n, --userName <userName>`
+: User's UPN (user principal name), eg. `johndoe@example.com`
+
+`--confirm`
+: Don't prompt for confirming removing the user from the specified Microsoft 365 Group or Microsoft Teams team
+```
+
+<Global />
+
+## Remarks
+
+You can remove users from a Microsoft 365 Group or Microsoft Teams team if you are owner of that group or team.
+
+## Examples
+
+Removes user from the specified Microsoft 365 Group
+
+```sh
+m365 aad o365group user remove --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com'
+```
+
+Removes user from the specified Microsoft 365 Group without confirmation
+
+```sh
+m365 aad o365group user remove --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --confirm
+```
+
+Removes user from the specified Microsoft Teams team
+
+```sh
+m365 aad teams user remove --teamId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com'
+```

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

@@ -0,0 +1,65 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group user set
+
+Updates role of the specified user in the specified Microsoft 365 Group or Microsoft Teams team
+
+## Usage
+
+```sh
+m365 aad o365group user set [options]
+```
+
+## Alias
+
+```sh
+m365 aad teams user set
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId [groupId]`
+: The ID of the Microsoft 365 group for which to update user
+
+`--teamId [teamId]`
+: The ID of the Microsoft Teams team for which to update user
+
+`-n, --userName <userName>`
+: UPN of the user for whom to update the role (eg. johndoe@example.com)
+
+`-r, --role <role>`
+: Role to set for the given user in the specified Microsoft 365 Group or Microsoft Teams team. Allowed values: `Owner`, `Member`
+```
+
+<Global />
+
+## Remarks
+
+The command will return an error if the user already has the specified role in the given Microsoft 365 Group or Microsoft Teams team.
+
+## Examples
+
+Promote the specified user to owner of the given Microsoft 365 Group
+
+```sh
+m365 aad o365group user list --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Owner
+```
+
+Demote the specified user from owner to member in the given Microsoft 365 Group
+
+```sh
+m365 aad o365group user list --groupId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Member
+```
+
+Promote the specified user to owner of the given Microsoft Teams team
+
+```sh
+m365 aad teams user list --teamId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Owner
+```
+
+Demote the specified user from owner to member in the given Microsoft Teams team
+
+```sh
+m365 aad teams user list --teamId '00000000-0000-0000-0000-000000000000' --userName 'anne.matthews@contoso.onmicrosoft.com' --role Member
+```