@pnp/cli-microsoft365 10.8.0 → 10.9.0-beta.3261443

package/docs/docs/cmd/entra/pim/pim-role-request-list.mdx

@@ -34,6 +34,9 @@ m365 entra pim role request list [options]
 : An optional value to filter the list of requests. Allowed values are: `Canceled`, `Denied`, `Failed`, `Granted`, `PendingAdminDecision`, `PendingApproval`, `PendingProvisioning`, `PendingScheduleCreation`, `Provisioned`, `Revoked`, and `ScheduleCreated`.
 
 `--includePrincipalDetails`
+: (deprecated. Use option `withPrincipalDetails` instead) An optional flag to include details of the principals that were assigned a role.
+
+`--withPrincipalDetails`
 : An optional flag to include details of the principals that were assigned a role.
 ```
 
@@ -62,7 +65,7 @@ m365 entra pim role request list --createdDateTime 2024-01-01T00:00:00Z
 Get a list of PIM requests with principal details.
 
 ```sh
-m365 entra pim role request list --includePrincipalDetails
+m365 entra pim role request list --withPrincipalDetails
 ```
 
 Get a list of PIM requests with pending approvals.
@@ -158,9 +161,9 @@ m365 entra pim role request list --status PendingApproval
   </TabItem>
 </Tabs>
 
-### `includePrincipalDetails` response
+### `withPrincipalDetails` response
 
-When we make use of the option `includePrincipalDetails` the response will differ. 
+When we make use of the option `withPrincipalDetails` the response will differ. 
 
 <Tabs>
   <TabItem value="JSON">
@@ -238,7 +241,7 @@ When we make use of the option `includePrincipalDetails` the response will diffe
   <TabItem value="Markdown">
 
   ```md
-  # entra pim role request list --includePrincipalDetails "true"
+  # entra pim role request list --withPrincipalDetails "true"
 
   Date: 5/30/2024
 

package/docs/docs/cmd/flow/flow-list.mdx

@@ -22,6 +22,9 @@ m365 flow list [options]
 : List a specific type of flows. Valid values: `ownedByMe`, `personal`, `sharedWithMe`, `all`. Defaults to `ownedByMe`. Don't specify this option when using asAdmin.
 
 `--includeSolutions`
+: (deprecated. Use option `withSolutions` instead) Include flows from solutions.
+
+`--withSolutions`
 : Include flows from solutions.
 
 `--asAdmin`
@@ -49,28 +52,28 @@ When you specify a value for `sharingStatus`, consider the following:
 
 ## Examples
 
-List all your flows in the given environment
+List all your flows in the given environment.
 
 ```sh
 m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5
 ```
 
-List all flows in the given environment
+List all flows in the given environment.
 
 ```sh
 m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
 ```
 
-List all flows that are shared with the current user
+List all flows that are shared with the current user.
 
 ```sh
 m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus sharedWithMe
 ```
 
-List all personal flows and include flows from solutions
+List all personal flows and include flows from solutions.
 
 ```sh
-m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus personal --includeSolutions
+m365 flow list --environmentName Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --sharingStatus personal --withSolutions
 ```
 
 ## Response

package/docs/docs/cmd/flow/run/run-get.mdx

@@ -22,7 +22,7 @@ m365 flow run get [options]
 : The name of the Power Automate flow for which to retrieve information.
 
 `-e, --environmentName <environmentName>`
-: The name of the environment where the flow is located
+: The name of the environment where the flow is located.
 
 `--includeTriggerInformation`
 : (deprecated. Use option `withTrigger` instead) If specified, include information about the trigger details.

package/docs/docs/cmd/graph/subscription/subscription-add.mdx

@@ -40,13 +40,16 @@ m365 graph subscription add [options]
 : The latest version of TLS that the notification endpoint supports. Allowed values are `v1_0`, `v1_1`, `v1_2`, `v1_3`. Default is `v1_2`.
 
 `--includeResourceData`
+: (deprecated. Use option `withResourceData` instead) When set, the change notifications will include the changed resource data.
+
+`--withResourceData`
 : When set, the change notifications will include the changed resource data.
 
 `--encryptionCertificate [encryptionCertificate]`
-: A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `includeResourceData`.
+: A base64-encoded representation of a certificate with a public key used to encrypt resource data in change notifications. Required when using `withResourceData`.
 
 `--encryptionCertificateId [encryptionCertificateId]`
-: A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `includeResourceData`.
+: A custom app-provided identifier to help identify the certificate needed to decrypt resource data. Required when using `withResourceData`.
 ```
 
 <Global />
@@ -83,7 +86,7 @@ m365 graph subscription add --resource "me/mailFolders('Inbox')/messages" --chan
 Create a subscription on multiple change types and include resource data
 
 ```sh
-m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --includeResourceData --encryptionCertificate 'Q0xJIGZvciBNaWNyb3NvZnQgMzY1' --encryptionCertificateId 'myCert' --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
+m365 graph subscription add --resource "me/messages" --changeTypes "updated,deleted" --withResourceData --encryptionCertificate 'Q0xJIGZvciBNaWNyb3NvZnQgMzY1' --encryptionCertificateId 'myCert' --notificationUrl "https://webhook.azurewebsites.net/api/send/myNotifyClient" --expirationDateTime "2016-11-20T18:23:45.935Z" --clientState "secretClientState"
 ```
 
 Create a subscription using the maximum allowed expiration for Group resources

package/docs/docs/cmd/pp/solution/solution-publisher-list.mdx

@@ -16,10 +16,13 @@ m365 pp solution publisher list [options]
 
 ```md definition-list
 `-e, --environmentName <environmentName>`
-: The name of the environment
+: The name of the environment.
 
 `--includeMicrosoftPublishers`
-: Include the Microsoft Publishers
+: (deprecated. Use option `withMicrosoftPublishers` instead) Include the Microsoft Publishers.
+
+`--withMicrosoftPublishers`
+: Include the Microsoft Publishers.
 
 `--asAdmin`
 : Run the command as admin for environments you do not have explicitly assigned permissions to.
@@ -29,13 +32,13 @@ m365 pp solution publisher list [options]
 
 ## Examples
 
-List all publishers in a specific environment
+List all publishers in a specific environment.
 
 ```sh
 m365 pp solution publisher list --environmentName "Default-2ca3eaa5-140f-4175-8261-3272edf9f339"
 ```
 
-List all publishers in a specific environment as Admin
+List all publishers in a specific environment as Admin.
 
 ```sh
 m365 pp solution publisher list --environmentName "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --asAdmin

package/docs/docs/cmd/purview/threatassessment/threatassessment-get.mdx

@@ -19,6 +19,9 @@ m365 purview threatassessment get [options]
 : The Id of the threat assessment.
 
 `--includeResults`
+: (deprecated. Use option `withResults` instead) Include the threat assessment results.
+
+`--withResults`
 : Include the threat assessment results.
 ```
 
@@ -35,7 +38,7 @@ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e
 Get a threat assessment including results.
 
 ```sh
-m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --includeResults
+m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --withResults
 ```
 
 ## Response
@@ -118,9 +121,9 @@ m365 purview threatassessment get --id c37d695e-d581-4ae9-82a0-9364eba4291e --in
   </TabItem>
 </Tabs>
 
-### `includeResults` response
+### `withResults` response
 
-When we make use of the option `includeResults` the response will differ. 
+When we make use of the option `withResults` the response will differ. 
 
 <Tabs>
   <TabItem value="JSON">
@@ -184,7 +187,7 @@ When we make use of the option `includeResults` the response will differ.
   <TabItem value="Markdown">
 
   ```md
-  # purview threatassessment get --id "8aaba0ac-ec4d-4e62-5774-08db16c68731" --includeResults "true"
+  # purview threatassessment get --id "8aaba0ac-ec4d-4e62-5774-08db16c68731" --withResults "true"
 
   Date: 25/02/2023
 

package/docs/docs/cmd/spo/file/file-move.mdx

@@ -34,6 +34,9 @@ m365 spo file move [options]
 : Behavior when a file or folder with the same name is already present at the destination. Allowed values: `fail`, `replace`, `rename`. Defaults to `fail`.
 
 `--includeItemPermissions`
+: (deprecated. Use option `withItemPermissions` instead) Ensure that item-level permissions are preserved during the move.
+
+`--withItemPermissions`
 : Ensure that item-level permissions are preserved during the move.
 
 `--bypassSharedLock`
@@ -75,7 +78,7 @@ m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sou
 Move a file referenced by its ID to another document library and retain item-level permissions.
 
 ```sh
-m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/My Documents" --includeItemPermissions
+m365 spo file move --webUrl https://contoso.sharepoint.com/sites/project-x --sourceId b8cc341b-9c11-4f2d-aa2b-0ce9c18bcba2 --targetUrl "/sites/project-x/My Documents" --withItemPermissions
 ```
 
 ## Response

package/docs/docs/cmd/spo/hubsite/hubsite-get.mdx

@@ -25,6 +25,9 @@ m365 spo hubsite get [options]
 : URL of the hub site. Specify either `id`, `title`, or `url` but not multiple.
 
 `--includeAssociatedSites`
+: (deprecated. Use option `withAssociatedSites` instead) Include the associated sites in the result (only in JSON output).
+
+`--withAssociatedSites`
 : Include the associated sites in the result (only in JSON output)
 ```
 
@@ -53,7 +56,7 @@ m365 spo hubsite get --url 'https://contoso.sharepoint.com/sites/HubSite'
 Get information about the hub site with specific ID, including its associated sites. Associated site info is only shown in JSON output.
 
 ```sh
-m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociatedSites --output json
+m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --withAssociatedSites --output json
 ```
 
 ## Response
@@ -147,9 +150,9 @@ m365 spo hubsite get --id 2c1ba4c4-cd9b-4417-832f-92a34bc34b2a --includeAssociat
   </TabItem>
 </Tabs>
 
-### `includeAssociatedSites` response
+### `withAssociatedSites` response
 
-When we make use of the option `includeAssociatedSites` the response will differ. This command can only be executed using --output json or an error will be thrown.
+When we make use of the option `withAssociatedSites` the response will differ. This command can only be executed using --output json or an error will be thrown.
 
 <Tabs>
   <TabItem value="JSON">

package/docs/docs/cmd/spo/hubsite/hubsite-list.mdx

@@ -16,6 +16,9 @@ m365 spo hubsite list [options]
 
 ```md definition-list
 `-i, --includeAssociatedSites`
+: (deprecated. Use option `withAssociatedSites` instead) Include the associated sites in the result (only in JSON output).
+
+`--withAssociatedSites`
 : Include the associated sites in the result (only in JSON output).
 ```
 
@@ -36,7 +39,7 @@ m365 spo hubsite list
 List hub sites, including their associated sites, in the current tenant. Associated site info is only shown in JSON output.
 
 ```sh
-m365 spo hubsite list --includeAssociatedSites --output json
+m365 spo hubsite list --withAssociatedSites --output json
 ```
 
 ## Response
@@ -119,9 +122,9 @@ m365 spo hubsite list --includeAssociatedSites --output json
   </TabItem>
 </Tabs>
 
-### `includeAssociatedSites` response
+### `withAssociatedSites` response
 
-When we make use of the option `includeAssociatedSites` the response will differ. 
+When we make use of the option `withAssociatedSites` the response will differ. 
 
 <Tabs>
   <TabItem value="JSON">
@@ -176,7 +179,7 @@ When we make use of the option `includeAssociatedSites` the response will differ
   <TabItem value="Markdown">
 
   ```md
-  # spo hubsite list --includeAssociatedSites "true"
+  # spo hubsite list --withAssociatedSites "true"
 
   Date: 2/20/2023
 

package/docs/docs/cmd/spo/list/list-add.mdx

@@ -127,7 +127,7 @@ m365 spo list add [options]
 : Boolean value that specifies whether the list is hidden. Valid values are `true`, `false`.
 
 `--includedInMyFilesScope [includedInMyFilesScope]`
-: Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string “myfiles” by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
+: Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string "myfiles" by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
 
 `--irmEnabled [irmEnabled]`
 : Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list.

package/docs/docs/cmd/spo/list/list-set.mdx

@@ -14,7 +14,7 @@ m365 spo list set [options]
 
 ```md definition-list
 `-u, --webUrl <webUrl>`
-: URL of the site
+: URL of the site.
 
 `--id [id]`
 : ID of the list. Specify either `id`, `title`, or `url` but not multiple.
@@ -128,7 +128,7 @@ m365 spo list set [options]
 : Boolean value that specifies whether the list is hidden. Valid values are `true`, `false`.
 
 `--includedInMyFilesScope [includedInMyFilesScope]`
-: Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string “myfiles” by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
+: Specifies whether this list is accessible to an app principal that has been granted an OAuth scope that contains the string "myfiles" by a case-insensitive comparison when the current user is a site collection administrator of the personal site that contains the list.
 
 `--irmEnabled [irmEnabled]`
 : Gets or sets a Boolean value that specifies whether Information Rights Management (IRM) is enabled for the list.

package/docs/docs/cmd/spo/tenant/tenant-site-list.mdx

@@ -28,9 +28,12 @@ m365 spo site list
 : type of sites to list. To be used with values like `GROUP#0` and `SITEPAGEPUBLISHING#0`. Specify either `type` or `webTemplate`, but not both.  
 
 `--filter [filter]`
-: filter to apply when retrieving sites
+: filter to apply when retrieving sites.
 
 `--includeOneDriveSites`
+: (deprecated. Use option `withOneDriveSites` instead) use this switch to include OneDrive sites in the result when retrieving sites. Do not specify the `type` or `webTemplate` options when using this.
+
+`--withOneDriveSites`
 : use this switch to include OneDrive sites in the result when retrieving sites. Do not specify the `type` or `webTemplate` options when using this.
 ```
 
@@ -52,34 +55,34 @@ To use this command you have to have permissions to access the tenant admin site
 
 ## Examples
 
-List all sites in the currently connected tenant
+List all sites in the currently connected tenant.
 
 ```sh
 m365 spo tenant site list
 ```
 
-List all group connected team sites in the currently connected tenant
+List all group connected team sites in the currently connected tenant.
 
 ```sh
 m365 spo tenant site list --type TeamSite
 ```
 
-List all communication sites in the currently connected tenant
+List all communication sites in the currently connected tenant.
 
 ```sh
 m365 spo tenant site list --type CommunicationSite
 ```
 
-List all group connected team sites that contain _project_ in the URL
+List all group connected team sites that contain _project_ in the URL.
 
 ```sh
 m365 spo tenant site list --type TeamSite --filter "Url -like 'project'"
 ```
 
-List all sites in the currently connected tenant including OneDrive sites
+List all sites in the currently connected tenant including OneDrive sites.
 
 ```sh
-m365 spo tenant site list --includeOneDriveSites
+m365 spo tenant site list --withOneDriveSites
 ```
 
 ## Response

package/docs/docs/cmd/spo/term/term-list.mdx

@@ -31,6 +31,9 @@ m365 spo term list [options]
 : Name of the term set for which to retrieve terms. Specify `termSetId` or `termSetName` but not both.
 
 `--includeChildTerms`
+: (deprecated. Use option `withChildTerms` instead) If specified, child terms are loaded as well.
+
+`--withChildTerms`
 : If specified, child terms are loaded as well.
 ```
 
@@ -69,7 +72,7 @@ m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetI
 List taxonomy terms from the term group and term set with the given ID including child terms if any are found.
 
 ```sh
-m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --includeChildTerms
+m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetId 0e8f395e-ff58-4d45-9ff7-e331ab728bec --withChildTerms
 ```
 
 ## Response
@@ -162,9 +165,9 @@ m365 spo term list --termGroupId 0e8f395e-ff58-4d45-9ff7-e331ab728beb --termSetI
   </TabItem>
 </Tabs>
 
-### `includeChildTerms` response
+### `withChildTerms` response
 
-When we make use of the option `includeChildTerms` the response will differ. 
+When we make use of the option `withChildTerms` the response will differ. 
 
 <Tabs>
   <TabItem value="JSON">
@@ -245,7 +248,7 @@ When we make use of the option `includeChildTerms` the response will differ.
   <TabItem value="Markdown">
 
   ```md
-  # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations" --includeChildTerms "true"
+  # spo term list --termGroupName "PnPTermSets" --termSetName "PnP-Organizations" --withChildTerms "true"
 
   Date: 5/8/2023
 

package/docs/docs/cmd/teams/chat/chat-member-add.mdx

@@ -26,10 +26,13 @@ m365 teams chat member add [options]
 : The role for the user to add. Valid values are: `owner`, `guest`. Defaults to `owner`.
 
 `--visibleHistoryStartDateTime [visibleHistoryStartDateTime]`
-: Include chat history until a certain point in time. Specify either `visibleHistoryStartDateTime`, `includeAllHistory`, or neither.
+: Include chat history until a certain point in time. Specify either `visibleHistoryStartDateTime`, `includeAllHistory`, `withAllHistory` or neither.
 
 `--includeAllHistory`
-: Include all chat history. Specify either `visibleHistoryStartDateTime`, `includeAllHistory`, or neither.
+: (deprecated. Use option `withChildTerms` instead) Include all chat history. Specify either `visibleHistoryStartDateTime`, `includeAllHistory`, `withAllHistory` or neither.
+
+`--withAllHistory`
+: Include all chat history. Specify either `visibleHistoryStartDateTime`, `includeAllHistory`, `withAllHistory` or neither.
 ```
 
 <Global />
@@ -58,7 +61,7 @@ m365 teams chat member add --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031
 Add a guest member by UPN to a Teams chat and share all chat history.
 
 ```sh
-m365 teams chat member add --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces --userName nelson.wilke@fabrikam.com --role guest --includeAllHistory
+m365 teams chat member add --chatId 19:8b081ef6-4792-4def-b2c9-c363a1bf41d5_5031bb31-22c0-4f6f-9f73-91d34ab2b32d@unq.gbl.spaces --userName nelson.wilke@fabrikam.com --role guest --withAllHistory
 ```
 
 ## Response

package/docs/docs/cmd/viva/engage/engage-community-remove.mdx

@@ -0,0 +1,61 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# viva engage community remove
+
+Removes a Viva Engage community
+
+## Usage
+
+```sh
+m365 viva engage community remove [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id [id]`
+: The id of the community. Specify either `id`, `displayName` or `entraGroupId`, but not multiple.
+
+`-n, --displayName [displayName]`
+: The name of the community. Specify either `id`, `displayName` or `entraGroupId`, but not multiple.
+
+`--entraGroupId [entraGroupId]`
+: The id of the Microsoft 365 group associated with the community. Specify either `id`, `displayName` or `entraGroupId`, but not multiple.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+When the Viva Engage community is removed, all the associated Microsoft 365 content, including the M365 group, the document library, OneNote notebook, and Planner plan is deleted.
+
+:::
+
+## Examples
+
+Remove a community specified by id without prompting
+
+```sh
+m365 viva engage community remove --id eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0NzY5MTM1ODIwOSJ9 --force
+```
+
+Remove a community specified by name and prompt for confirmation
+
+```sh
+m365 viva engage community remove --displayName 'Software Engineers'
+```
+
+Remove a community specified by Entra group id and prompt for confirmation
+
+```sh
+m365 viva engage community remove --entraGroupId '0bed8b86-5026-4a93-ac7d-56750cc099f1'
+```
+
+## Response
+
+The command won't return a response on success

package/docs/docs/cmd/viva/engage/engage-network-list.mdx

@@ -16,7 +16,10 @@ m365 viva engage network list [options]
 
 ```md definition-list
 `--includeSuspended`
-: Include the networks in which the user is suspended
+: (deprecated. Use option `withSuspended` instead) Include the networks in which the user is suspended.
+
+`--withSuspended`
+: Include the networks in which the user is suspended.
 ```
 
 <Global />
@@ -31,16 +34,16 @@ In order to use this command, you need to grant the Microsoft Entra application
 
 ## Examples
 
-Returns the current user's networks
+Returns the current user's networks.
 
 ```sh
 m365 viva engage network list
 ```
 
-Returns the current user's networks including the networks in which the user is suspended
+Returns the current user's networks including the networks in which the user is suspended.
 
 ```sh
-m365 viva engage network list --includeSuspended
+m365 viva engage network list --withSuspended
 ```
 
 ## Response