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

package/docs/docs/cmd/aad/groupsettingtemplate/groupsettingtemplate-list.mdx

@@ -0,0 +1,23 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad groupsettingtemplate list
+
+Lists Azure AD group settings templates
+
+## Usage
+
+```sh
+m365 aad groupsettingtemplate list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+List all group setting templates in the tenant
+
+```sh
+m365 aad groupsettingtemplate list
+```

package/docs/docs/cmd/aad/license/license-list.mdx

@@ -0,0 +1,99 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# aad license list
+
+Lists commercial subscriptions that an organization has acquired
+
+## Usage
+
+```sh
+m365 aad license list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+List all licenses within the tenant
+
+```sh
+m365 aad license list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "capabilityStatus": "Enabled",
+      "consumedUnits": 1,
+      "id": "48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df",
+      "skuId": "c7df2760-2c81-4ef7-b578-5b5392b571df",
+      "skuPartNumber": "ENTERPRISEPREMIUM",
+      "appliesTo": "User",
+      "prepaidUnits": {
+        "enabled": 10000,
+        "suspended": 0,
+        "warning": 0
+      },
+      "servicePlans": [
+          {
+              "servicePlanId": "8c098270-9dd4-4350-9b30-ba4703f3b36b",
+              "servicePlanName": "ADALLOM_S_O365",
+              "provisioningStatus": "Success",
+              "appliesTo": "User"
+          }
+      ]
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                                                         skuId                                 skuPartNumber
+  -------------------------------------------------------------------------  ------------------------------------  ----------------------
+  48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df  c7df2760-2c81-4ef7-b578-5b5392b571df  ENTERPRISEPREMIUM
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,skuId,skuPartNumber
+  48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df,c7df2760-2c81-4ef7-b578-5b5392b571df,ENTERPRISEPREMIUM
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # aad license list
+
+  Date: 14/2/2023
+
+  ## 48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df
+
+  Property | Value
+  ---------|-------
+  capabilityStatus | Enabled
+  consumedUnits | 1
+  id | 48a80680-7326-48cd-9935-b556b81d3a4e_c7df2760-2c81-4ef7-b578-5b5392b571df
+  skuId | c7df2760-2c81-4ef7-b578-5b5392b571df
+  skuPartNumber | ENTERPRISEPREMIUM
+  appliesTo | User
+  prepaidUnits | {"enabled":10000,"suspended":0,"warning":0}
+  servicePlans | [{"servicePlanId":"8c098270-9dd4-4350-9b30-ba4703f3b36b","servicePlanName": "ADALLOM_S_O365","provisioningStatus": "Success","appliesTo": "User"}]
+  ```
+
+  </TabItem>
+</Tabs>
+

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

@@ -0,0 +1,111 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group add
+
+Creates a Microsoft 365 Group
+
+## Usage
+
+```sh
+m365 aad o365group add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --displayName <displayName>`
+: Display name for the Microsoft 365 Group
+
+`-d, --description <description>`
+: Description for the Microsoft 365 Group
+
+`-m, --mailNickname <mailNickname>`
+: Name to use in the group e-mail (part before the `@`)
+
+`--owners [owners]`
+: Comma-separated list of Microsoft 365 Group owners
+
+`--members [members]`
+: Comma-separated list of Microsoft 365 Group members
+
+`--isPrivate`
+: Specify, if the Microsoft 365 Group should be private. If not specified, will create a public group (default)
+
+`--allowMembersToPost [allowMembersToPost]`
+: Set if only group members should be able to post conversations to the group
+
+`--hideGroupInOutlook [hideGroupInOutlook]`
+: Set to hide the group in Outlook experiences
+
+`--subscribeNewGroupMembers [subscribeNewGroupMembers]`
+: Set to subscribe all new group members to receive group conversation emails when new messages are posted in the group
+
+`--welcomeEmailDisabled [welcomeEmailDisabled]`
+: Set to not send welcome emails to new group members
+
+`-l, --logoPath [logoPath]`
+: Local path to the image file to use as group logo
+```
+
+<Global />
+
+## Remarks
+
+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.
+If an invalid user is provided in the comma-separated list of Owners or Members, the command operation will fail and the Microsoft 365 Group will not be created.
+
+## Examples
+
+Create a public Microsoft 365 Group
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance
+```
+
+Create a private Microsoft 365 Group
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --isPrivate
+```
+
+Create a public Microsoft 365 Group and set specified users as its owners
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --owners "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
+```
+
+Create a public Microsoft 365 Group and set specified users as its members
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --members "DebraB@contoso.onmicrosoft.com,DiegoS@contoso.onmicrosoft.com"
+```
+
+Create a public Microsoft 365 Group and allow only group members to be able to post conversations to the group.
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --allowMembersToPost
+```
+
+Create a public Microsoft 365 Group and hide it from the Outlook experiences (web and client).
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --hideGroupInOutlook
+```
+
+Create a public Microsoft 365 Group and subscribe all new group members to receive group conversation emails when new messages are posted in the group.
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --subscribeNewGroupMembers
+```
+
+Create a public Microsoft 365 Group and set to not send welcome emails to new group members.
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --welcomeEmailDisabled
+```
+
+Create a public Microsoft 365 Group and set its logo
+
+```sh
+m365 aad o365group add --displayName Finance --description "This is the Contoso Finance Group. Please come here and check out the latest news, posts, files, and more." --mailNickname finance --logoPath images/logo.png
+```

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

@@ -0,0 +1,28 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group conversation list
+
+Lists conversations for the specified Microsoft 365 group
+
+## Usage
+
+```sh
+m365 aad o365group conversation list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId <groupId>`
+: The ID of the Microsoft 365 group
+```
+
+<Global />
+
+## Examples
+
+Lists conversations for the specified Microsoft 365 group
+
+```sh
+m365 aad o365group conversation list --groupId '00000000-0000-0000-0000-000000000000'
+```

package/docs/docs/cmd/aad/o365group/o365group-conversation-post-list.mdx

@@ -0,0 +1,40 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group conversation post list
+
+Lists conversation posts of a Microsoft 365 group
+
+## Usage
+
+```sh
+m365 aad o365group conversation post list [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId [groupId]`
+: The Id of the Office 365 Group. You can specify the groupId or groupDisplayName, but not both.
+
+`-d, --groupDisplayName [groupDisplayName]`
+: The Displayname of the Office 365 Group. You can specify the groupId or groupDisplayName, but not both.
+
+`-t, --threadId <threadId>`
+: The ID of the thread to retrieve details for
+```
+
+<Global />
+
+## Examples
+
+Lists the posts of the specific conversation of Microsoft 365 group by groupId
+
+```sh
+m365 aad o365group conversation post list --groupId '00000000-0000-0000-0000-000000000000' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
+```
+
+Lists the posts of the specific conversation of Microsoft 365 group by groupDisplayName
+
+```sh
+m365 aad o365group conversation post list --groupDisplayName 'MyGroup' --threadId 'AAQkADkwN2Q2NDg1LWQ3ZGYtNDViZi1iNGRiLTVhYjJmN2Q5NDkxZQAQAOnRAfDf71lIvrdK85FAn5E='
+```

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

@@ -0,0 +1,37 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group get
+
+Gets information about the specified Microsoft 365 Group or Microsoft Teams team
+
+## Usage
+
+```sh
+m365 aad o365group get [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the Microsoft 365 Group or Microsoft Teams team to retrieve information for
+
+`--includeSiteUrl`
+: Set to retrieve the site URL for the group
+```
+
+<Global />
+
+## Examples
+
+Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
+
+```sh
+m365 aad o365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
+```
+
+Get information about the Microsoft 365 Group with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ and also retrieve the URL of the corresponding SharePoint site
+
+```sh
+m365 aad o365group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --includeSiteUrl
+```

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

@@ -0,0 +1,85 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group list
+
+Lists Microsoft 365 Groups in the current tenant
+
+## Usage
+
+```sh
+m365 aad o365group list [options]
+```
+
+## Options
+
+```md definition-list
+`-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
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,34 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# 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
+
+```md definition-list
+`--confirm`
+: Don't prompt for confirmation to clear the recycle bin items.
+```
+
+<Global />
+
+## 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.mdx

@@ -0,0 +1,49 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# aad o365group recyclebinitem list
+
+Lists Groups from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad o365group recyclebinitem list [options]
+```
+
+## Options
+
+```md definition-list
+`-d, --groupDisplayName [groupDisplayName]`
+: Lists groups with DisplayName starting with the specified value
+
+`-m, --groupMailNickname [groupMailNickname]`
+: Lists groups with MailNickname starting with the specified value
+```
+
+<Global />
+
+## 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.mdx

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