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

package/docs/docs/cmd/aad/o365group/o365group-list.md

@@ -1,81 +0,0 @@
-# aad o365group list
-
-Lists Microsoft 365 Groups in the current tenant
-
-## Usage
-
-```sh
-m365 aad o365group list [options]
-```
-
-## Options
-
-`-d, --displayName [displayName]`
-: Retrieve only groups with displayName starting with the specified value
-
-`-m, --mailNickname [displayName]`
-: Retrieve only groups with mailNickname starting with the specified value
-
-`--includeSiteUrl`
-: Set to retrieve the site URL for each group
-
-`--deleted`
-: Set to only retrieve deleted groups
-
-`--orphaned`
-: Set to only retrieve groups without owners
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Using the `--includeSiteUrl` option, you can retrieve the URL of the site associated with the particular Microsoft 365 Group. If you however retrieve too many groups and will try to get their site URLs, you will most likely get an error as the command will get throttled, issuing too many requests, too frequently. If you get an error, consider narrowing down the result set using the `--displayName` and `--mailNickname` filters.
-
-Retrieving the URL of the site associated with the particular Microsoft 365 Group is not possible when retrieving deleted groups.
-
-Using the `--orphaned` option, you can retrieve Microsoft 365 Groups without owners.
-
-## Examples
-
-List all Microsoft 365 Groups in the tenant
-
-```sh
-m365 aad o365group list
-```
-
-List Microsoft 365 Groups with display name starting with _Project_
-
-```sh
-m365 aad o365group list --displayName Project
-```
-
-List Microsoft 365 Groups mail nick name starting with _team_
-
-```sh
-m365 aad o365group list --mailNickname team
-```
-
-List deleted Microsoft 365 Groups with display name starting with _Project_
-
-```sh
-m365 aad o365group list --displayName Project --deleted
-```
-
-List deleted Microsoft 365 Groups mail nick name starting with _team_
-
-```sh
-m365 aad o365group list --mailNickname team --deleted
-```
-
-List Microsoft 365 Groups with display name starting with _Project_ including
-the URL of the corresponding SharePoint site
-
-```sh
-m365 aad o365group list --displayName Project --includeSiteUrl
-```
-
-List Microsoft 365 Groups without owners
-
-```sh
-m365 aad o365group list --orphaned
-```

package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-clear.md

@@ -1,30 +0,0 @@
-# aad o365group recyclebinitem clear
-
-Clears Microsoft 365 Groups from the recycle bin in the current tenant
-
-## Usage
-
-```sh
-m365 aad o365group recyclebinitem clear [options]
-```
-
-## Options
-
-`--confirm`
-: Don't prompt for confirmation to clear the recycle bin items.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Removes all deleted Microsoft 365 Groups in the tenant. Will prompt for confirmation before permanently removing groups.
-
-```sh
-m365 aad o365group recyclebinitem clear
-```
-
-Removes all deleted Microsoft 365 Groups in the tenant. Will NOT prompt for confirmation before permanently removing groups.
-
-```sh
-m365 aad o365group recyclebinitem clear --confirm
-```

package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-list.md

@@ -1,45 +0,0 @@
-# aad o365group recyclebinitem list
-
-Lists Groups from the recycle bin in the current tenant
-
-## Usage
-
-```sh
-m365 aad o365group recyclebinitem list [options]
-```
-
-## Options
-
-`-d, --groupDisplayName [groupDisplayName]`
-: Lists groups with DisplayName starting with the specified value
-
-`-m, --groupMailNickname [groupMailNickname]`
-: Lists groups with MailNickname starting with the specified value
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-List all deleted Microsoft 365 Groups in the tenant
-
-```sh
-m365 aad o365group recyclebinitem list
-```
-
-List deleted Microsoft 365 Groups with display name starting with _Project_
-
-```sh
-m365 aad o365group recyclebinitem list --groupDisplayName Project
-```
-
-List deleted Microsoft 365 Groups mail nick name starting with _team_
-
-```sh
-m365 aad o365group recyclebinitem list --groupMailNickname team
-```
-
-List deleted Microsoft 365 Groups mail nick name starting with _team_ and with display name starting with _Project_
-
-```sh
-m365 aad o365group recyclebinitem list --groupMailNickname team --groupDisplayName Project
-```

package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-remove.md

@@ -1,45 +0,0 @@
-# aad o365group recyclebinitem remove
-
-Permanently deletes a Microsoft 365 Group from the recycle bin in the current tenant
-
-## Usage
-
-```sh
-m365 aad o365group recyclebinitem remove [options]
-```
-
-## Options
-
-`-i, --id [id]`
-: The ID of the Microsoft 365 Group to remove. Specify either `id`, `displayName` or `mailNickname` but not multiple.
-
-`-d, --displayName [displayName]`
-: Display name for the Microsoft 365 Group to remove. 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.
-
-`--confirm`
-: Don't prompt for confirmation.
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Removes the Microsoft 365 Group with specific ID
-
-```sh
-m365 aad o365group recyclebinitem remove --id "00000000-0000-0000-0000-000000000000"
-```
-
-Removes the Microsoft 365 Group with specific name
-
-```sh
-m365 aad o365group recyclebinitem remove --displayName "My Group"
-```
-
-Remove the Microsoft 365 Group with specific mail nickname without confirmation
-
-```sh
-m365 aad o365group recyclebinitem remove --mailNickname "Mygroup" --confirm
-```

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

@@ -1,42 +0,0 @@
-# aad o365group recyclebinitem restore
-
-Restores a deleted Microsoft 365 Group
-
-## Usage
-
-```sh
-m365 aad o365group recyclebinitem restore [options]
-```
-
-## Options
-
-`-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.
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,46 +0,0 @@
-# aad o365group remove
-
-Removes an Microsoft 365 Group
-
-## Usage
-
-```sh
-m365 aad o365group remove [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,28 +0,0 @@
-# aad o365group renew
-
-Renews Microsoft 365 group's expiration
-
-## Usage
-
-```sh
-m365 aad o365group renew [options]
-```
-
-## Options
-
-`-i, --id <id>`
-: The ID of the Microsoft 365 group to renew
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,39 +0,0 @@
-# aad o365group report activitycounts
-
-Get the number of group activities across group workloads
-
-## Usage
-
-```sh
-m365 aad o365group report activitycounts [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,48 +0,0 @@
-# aad o365group report activitydetail
-
-Get details about Microsoft 365 Groups activity by group.
-
-## Usage
-
-```sh
-m365 aad o365group report activitydetail [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,39 +0,0 @@
-# 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
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,39 +0,0 @@
-# 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
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,39 +0,0 @@
-# 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
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,72 +0,0 @@
-# aad o365group set
-
-Updates Microsoft 365 Group properties
-
-## Usage
-
-```sh
-m365 aad o365group set [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,33 +0,0 @@
-# aad o365group teamify
-
-Creates a new Microsoft Teams team under existing Microsoft 365 group
-
-## Usage
-
-```sh
-m365 aad o365group teamify [options]
-```
-
-## Options
-
-`-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
-
---8<-- "docs/cmd/_global.md"
-
-## 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.md

@@ -1,51 +0,0 @@
-# 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
-
-`-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`
-
---8<-- "docs/cmd/_global.md"
-
-## 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'
-```