@pnp/cli-microsoft365 6.3.0-beta.fee5cdb → 6.4.0-beta.006c079

package/docs/docs/cmd/aad/user/user-license-list.md

@@ -0,0 +1,98 @@
+# aad user license list
+
+Lists the license details for a given user
+
+## Usage
+
+```sh
+m365 aad user license list [options]
+```
+
+## Options
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: User principal name of the user. Specify either `userId` or `userName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! tip
+    If you don't specify any option, the command will list the license details of the current logged in user. This does not work when using application permissions.
+
+## Examples
+
+List license details of the current logged in user.
+
+```sh
+m365 aad user license list
+```
+
+List license details of a specific user by its UPN.
+
+```sh
+m365 aad user license list --userName john.doe@contoso.com
+```
+
+List license details of a specific user by its ID.
+
+```sh
+m365 aad user license list --userId 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "id": "x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw",
+        "skuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",
+        "skuPartNumber": "DEVELOPERPACK_E5",
+        "servicePlans": [
+          {
+            "servicePlanId": "7547a3fe-08ee-4ccb-b430-5077c5041653",
+            "servicePlanName": "YAMMER_ENTERPRISE",
+            "provisioningStatus": "Success",
+            "appliesTo": "User"
+          }
+        ]
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id           : x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+    skuId        : c42b9cae-ea4f-4ab7-9717-81576235ccac
+    skuPartNumber: DEVELOPERPACK_E5
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,skuId,skuPartNumber
+    x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw,c42b9cae-ea4f-4ab7-9717-81576235ccac,DEVELOPERPACK_E5
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user license list --userId "0c9c625f-faa9-4c3b-8cd8-d874b869f78c"
+
+    Date: 2/19/2023
+
+    ## x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+
+    Property | Value
+    ---------|-------
+    id | x4s03usaBkSMs5fbAhyttK6cK8RP6rdKlxeBV2I1zKw
+    skuId | c42b9cae-ea4f-4ab7-9717-81576235ccac
+    skuPartNumber | DEVELOPERPACK\_E5
+    servicePlans | [{"servicePlanId":"7547a3fe-08ee-4ccb-b430-5077c5041653","servicePlanName":"YAMMER\_ENTERPRISE","provisioningStatus":"Success","appliesTo":"User"}]
+    ```

package/docs/docs/cmd/aad/user/user-license-remove.md

@@ -0,0 +1,43 @@
+# aad user license remove
+
+Removes a license from a user
+
+## Usage
+
+```sh
+m365 aad user license remove [options]
+```
+
+## Options
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId` or `userName` but not both.
+
+`--userName [userName]`
+: 	User principal name of the user. Specify either `userId` or `userName` but not both.
+
+`--ids <ids>`
+: A comma separated list of IDs that specify the licenses to remove.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Remove specific licenses from a specific user by UPN
+
+```sh
+m365 user license remove --userName "john.doe@contoso.com" --ids "45715bb8-13f9-4bf6-927f-ef96c102d394,bea13e0c-3828-4daa-a392-28af7ff61a0f"
+```
+
+Remove specific licenses from a specific user by ID
+
+```sh
+m365 user license remove --userId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --ids "45715bb8-13f9-4bf6-927f-ef96c102d394,bea13e0c-3828-4daa-a392-28af7ff61a0f"
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -18,7 +18,7 @@ m365 aad user recyclebinitem clear [options]
 ## Remarks
 
 !!! important
-    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
 
 !!! note
     After running this command, it may take a minute before all deleted users are effectively removed from the tenant.

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

@@ -0,0 +1,82 @@
+# aad user recyclebinitem list
+
+Lists users from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+List all removed users
+
+```sh
+m365 aad user recyclebinitem list
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "businessPhones": [],
+        "displayName": "John Doe",
+        "givenName": "John Doe",
+        "jobTitle": "Developer",
+        "mail": "john@contoso.com",
+        "mobilePhone": "0476345130",
+        "officeLocation": "Washington",
+        "preferredLanguage": "nl-BE",
+        "surname": "John",
+        "userPrincipalName": "7e06b56615f340138bf879874d52e68ajohn@contoso.com",
+        "id": "7e06b566-15f3-4013-8bf8-79874d52e68a"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                                    displayName  userPrincipalName
+    ------------------------------------  -----------  -----------------------------------------------
+    7e06b566-15f3-4013-8bf8-79874d52e68a  John Doe     7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,displayName,userPrincipalName
+    7e06b566-15f3-4013-8bf8-79874d52e68a,John Doe,7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    ```
+
+=== "Markdown"
+
+    ```md
+    # aad user recyclebinitem list
+
+    Date: 14/02/2023
+
+    ## John Doe (7e06b566-15f3-4013-8bf8-79874d52e68a)
+
+    Property | Value
+    ---------|-------
+    businessPhones | []
+    displayName | John Doe
+    givenName | John Doe
+    jobTitle | Developer
+    mail | john@contoso.com
+    mobilePhone | 0476345130
+    officeLocation | Washington
+    preferredLanguage | nl-BE
+    surname | John
+    userPrincipalName | 7e06b56615f340138bf879874d52e68ajohn@contoso.com
+    id | 7e06b566-15f3-4013-8bf8-79874d52e68a
+    ```

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

@@ -0,0 +1,45 @@
+# aad user recyclebinitem remove
+
+Removes a user from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem remove [options]
+```
+
+## Options
+
+`--id <id>`
+: ID of the deleted user.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
+
+!!! note
+    After running this command, it may take a minute before the deleted user is effectively removed from the tenant.
+
+## Examples
+
+Removes a specific user from the recycle bin
+
+```sh
+m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3
+```
+
+Removes a specific user from the recycle bin without confirmation prompt
+
+```sh
+m365 aad user recyclebinitem remove --id 59f80e08-24b1-41f8-8586-16765fd830d3 --confirm
+```
+
+## Response
+
+The command won't return a response on success.

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

@@ -0,0 +1,99 @@
+# aad user recyclebinitem restore
+
+Restores a user from the recycle bin in the current tenant
+
+## Usage
+
+```sh
+m365 aad user recyclebinitem restore [options]
+```
+
+## Options
+
+`--id <id>`
+: ID of the deleted user.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator
+
+!!! note
+    After running this command, it may take a minute before the user will reappear in the active users.
+
+## Examples
+
+Restore user from the recycle bin
+
+```sh
+m365 aad user recyclebinitem restore --id 990e2425-f595-43bc-85ed-b89a44093793
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "990e2425-f595-43bc-85ed-b89a44093793",
+      "businessPhones": [],
+      "displayName": "John Doe",
+      "givenName": "John",
+      "jobTitle": "Sales Manager",
+      "mail": null,
+      "mobilePhone": null,
+      "officeLocation": null,
+      "preferredLanguage": "nl-BE",
+      "surname": "Doe",
+      "userPrincipalName": "john.doe@contoso.com",
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    businessPhones   : []
+    displayName      : John Doe
+    givenName        : John
+    id               : 990e2425-f595-43bc-85ed-b89a44093793
+    jobTitle         : Sales Manager
+    mail             : null
+    mobilePhone      : null
+    officeLocation   : null
+    preferredLanguage: nl-BE
+    surname          : Doe
+    userPrincipalName: john.doe@contoso.com
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,businessPhones,displayName,givenName,jobTitle,mail,mobilePhone,officeLocation,preferredLanguage,surname,userPrincipalName
+    990e2425-f595-43bc-85ed-b89a44093793,[],John Doe,John,Sales Manager,,,,nl-BE,Doe,john.doe@contoso.com
+    ```
+
+=== "Markdown"
+
+    ```md
+    # user recyclebin restore --id 990e2425-f595-43bc-85ed-b89a44093793
+
+    Date: 16/02/2023
+
+    ## John Doe (990e2425-f595-43bc-85ed-b89a44093793)
+
+    Property | Value
+    ---------|-------
+    id | 990e2425-f595-43bc-85ed-b89a44093793
+    businessPhones | []
+    displayName | John Doe
+    givenName | John
+    jobTitle | Sales Manager
+    mail | null
+    mobilePhone | null
+    officeLocation | null
+    preferredLanguage | nl-BE
+    surname | Doe
+    userPrincipalName | john.doe@contoso.com
+    ```

package/docs/docs/cmd/aad/user/user-remove.md

@@ -0,0 +1,51 @@
+# aad user remove
+
+Removes a specific user
+
+## Usage
+
+```sh
+m365 aad user remove [options]
+```
+
+## Options
+
+`--id [id]`
+: The ID of the user. Specify either `id` or `userName` but not both.
+
+`--userName [userName]`
+:	User principal name of the user. Specify either `id` or `userName` but not both.
+
+`--confirm`
+: Don't prompt for confirmation.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! important
+    If the user with the specified id or user name doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
+
+!!! important
+    To use this command you must be a Global administrator, User administrator or Privileged Authentication administrator.
+
+!!! note
+    After running this command, it may take a minute before the user is effectively moved to the recycle bin.
+
+## Examples
+
+Removes a specific user by id
+
+```sh
+m365 aad user remove --id a33bd401-9117-4e0e-bb7b-3f61c1539e10
+```
+
+Removes a specific user by its UPN
+
+```sh
+m365 aad user remove --userName john.doe@contoso.com
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/aad/user/user-set.md

@@ -74,7 +74,7 @@ m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabl
 Reset password of a given user by userPrincipalName and require the user to change the password on the next sign in
 
 ```sh
-m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --password 6NLUId79Lc24 --forceChangePasswordNextSignIn
+m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --resetPassword --newPassword 6NLUId79Lc24 --forceChangePasswordNextSignIn
 ```
 
 Change password of the currently logged in user

package/docs/docs/cmd/cli/completion/completion-clink-update.md

@@ -12,16 +12,16 @@ m365 cli completion clink update [options]
 
 --8<-- "docs/cmd/_global.md"
 
-!!! important
-    Before running this command, change the working directory to where your shell stores completion plugins. For cmder, it's `%CMDER_ROOT%\vendor\clink-completions`, where `%CMDER_ROOT%` is the folder where you installed cmder. After running this command, restart your terminal to load the completion.
-
 ## Remarks
 
 This commands updates the list of commands and their options used by command completion in Clink (cmder). You should run this command each time after upgrading the CLI for Microsoft 365.
 
+!!! important
+    Before running this command, change the working directory to where your shell stores completion plugins. For cmder, it's `%CMDER_ROOT%\vendor\clink-completions`, where `%CMDER_ROOT%` is the folder where you installed cmder. After running this command, restart your terminal to load the completion.
+
 ## Examples
 
-Write the list of commands for Clink (cmder) command completion to a file named `m365.lua` in the current directory
+Write the list of commands for Clink (cmder) command completion to a file named `m365.lua` in the current directory.
 
 ```powershell
 m365 cli completion clink update > m365.lua

package/docs/docs/cmd/flow/environment/environment-get.md

@@ -10,8 +10,8 @@ m365 flow environment get [options]
 
 ## Options
 
-`-n, --name <name>`
-: The name of the environment to get information about
+`-n, --name [name]`
+: The name of the environment to get information about. When not specified, the default environment is retrieved.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -24,12 +24,17 @@ If the environment with the name you specified doesn't exist, you will get the `
 
 ## Examples
 
-Get information about the Microsoft Flow environment named _Default-d87a7535-dd31-4437-bfe1-95340acd55c5_
+Get information about a Microsoft Flow environment specified by name
 
 ```sh
 m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
 ```
 
+Get information about the default Microsoft Flow environment
+```sh
+m365 flow environment get
+```
+
 ## Response
 
 ### Standard response
@@ -129,3 +134,26 @@ m365 flow environment get --name Default-d87a7535-dd31-4437-bfe1-95340acd55c5
     name,id,location,displayName,provisioningState,environmentSku,azureRegionHint,isDefault
     Default-d87a7535-dd31-4437-bfe1-95340acd55c5,/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5,india,contoso (default),Succeeded,Default,centralindia,1  
     ```
+
+=== "Markdown"
+
+    ```md
+    # flow environment get
+
+    Date: 8/2/2023
+
+    ## contoso (default) (/providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5)
+
+    Property | Value
+    ---------|-------
+    name | Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+    location | india
+    type | Microsoft.ProcessSimple/environments
+    id | /providers/Microsoft.ProcessSimple/environments/Default-d87a7535-dd31-4437-bfe1-95340acd55c5
+    properties | {"displayName":"contoso (default)","createdTime":"2019-12-21T18:32:11.8708704Z","createdBy":{"id":"SYSTEM","displayName": "SYSTEM","type": "NotSpecified"},"provisioningState":"Succeeded","creationType":"DefaultTenant","environmentSku":"Default","environmentType":"NotSpecified","states":{"management":{"id":"NotSpecified"},"runtime":{"runtimeReasonCode":"NotSpecified","requestedBy":{"displayName":"SYSTEM","type":"NotSpecified"},"id":"Enabled"}},"isDefault":true,"isPayAsYouGoEnabled":false,"azureRegionHint":"centralindia","runtimeEndpoints":{"microsoft.BusinessAppPlatform":"https://india.api.bap.microsoft.com","microsoft.CommonDataModel":"https://india.api.cds.microsoft.com","microsoft.PowerApps":"https://india.api.powerapps.com",microsoft.PowerAppsAdvisor":"https://india.api.advisor.powerapps.com","microsoft.PowerVirtualAgents":"https://powervamg.in-il101.gateway.prod.island.powerapps.com","microsoft.ApiManagement":"https://management.INDIA.azure-apihub.net","microsoft.Flow":"https://india.api.flow.microsoft.com"},"linkedEnvironmentMetadata":{"type":"NotSpecified","resourceId":"3aa550bf-52ac-42fc-98f7-5d1833c1501c","friendlyName":"contoso (default)","uniqueName":"orgfc80770f","domainName":"orgfc80770f","version":"9.2.22105.00154","instanceUrl":"https://orgfc80770f.crm8.dynamics.com/","instanceApiUrl":"https://orgfc80770f.api.crm8.dynamics.com","baseLanguage":1033,"instanceState":"Ready","createdTime":"2019-12-25T15:46:14.433Z"},"environmentFeatures":{"isOpenApiEnabled":false},"cluster":{"category":"Prod","number":"101","uriSuffix":"in-il101.gateway.prod.island","geoShortName":"IN","environment":"Prod"},"governanceConfiguration":{"protectionLevel":"Basic"}}
+    displayName | contoso (default)
+    provisioningState | Succeeded
+    environmentSku | Default
+    azureRegionHint | centralindia
+    isDefault | true
+    ```

package/docs/docs/cmd/flow/owner/owner-ensure.md

@@ -0,0 +1,61 @@
+# flow owner ensure
+
+Assigns/updates permissions to a Power Automate flow
+
+## Usage
+
+```sh
+m365 flow owner ensure [options]
+```
+
+## Options
+
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+
+`-f, --flowName <flowName>`
+: The name of the Power Automate flow.
+
+`--userId [userId]`
+: The ID of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--userName [userName]`
+: User principal name of the user. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--groupId [groupId]`
+: The ID of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--groupName [groupName]`
+: The name of the group. Specify either `userId`, `userName`, `groupId` or `groupName`.
+
+`--roleName <roleName>`
+: Access level for the user on the flow. Valid options are `CanView` or `CanEdit`.
+
+`--asAdmin`
+: Run the command as admin.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Assign owner permissions to a specific Power Automate flow for a user with ID
+
+```sh
+m365 flow owner ensure --userId 5c241023-2ba5-4ea8-a516-a2481a3e6c51 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
+```
+
+Assign owner permissions to a specific Power Automate flow for a user with UPN
+
+```sh
+m365 flow owner ensure --userName "john.doe@contoso.com" --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
+```
+
+Assign owner permissions to a specific Power Automate flow for a group
+
+```sh
+m365 flow owner ensure --groupId 8d4d9f32-1ab0-4f81-9054-efbb1759e8e6 --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --roleName CanEdit
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/flow/owner/owner-list.md

@@ -0,0 +1,90 @@
+# flow owner list
+
+Lists all owners of a Power Automate flow
+
+## Usage
+
+```sh
+m365 flow owner list [options]
+```
+
+## Options
+
+`-e, --environmentName <environmentName>`
+: The name of the environment.
+
+`-f, --flowName <flowName>`
+: The name of the Power Automate flow.
+
+`--asAdmin`
+: Run the command as admin.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Gets the owners by the name of the Power Automate flow within a specified environment
+
+```sh
+m365 flow owner list --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72
+```
+
+Gets the owners by the name of the Power Automate flow within a specified environment with admin privileges
+
+```sh
+m365 flow owner list --environmentName Default-c5a5d746-3520-453f-8a69-780f8e44917e --flowName 72f2be4a-78c1-4220-a048-dbf557296a72 --asAdmin
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "name": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+        "id": "/providers/Microsoft.ProcessSimple/environments/Default-c5a5d746-3520-453f-8a69-780f8e44917e/flows/72f2be4a-78c1-4220-a048-dbf557296a72/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+        "type": "/providers/Microsoft.ProcessSimple/environments/flows/permissions",
+        "properties": {
+          "roleName": "Owner",
+          "permissionType": "Principal",
+          "principal": {
+            "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+            "type": "User"
+          }
+        }
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    roleName  id                                    type
+    --------  ------------------------------------  ----
+    Owner     fe36f75e-c103-410b-a18a-2bf6df06ac3a  User
+    ```
+
+=== "CSV"
+
+    ```csv
+    roleName,id,type
+    Owner,fe36f75e-c103-410b-a18a-2bf6df06ac3a,User
+    ```
+
+=== "Markdown"
+
+    ```md
+    # flow owner list --environmentName "Default-c5a5d746-3520-453f-8a69-780f8e44917e" --flowName "72f2be4a-78c1-4220-a048-dbf557296a72"
+
+    Date: 25/02/2023
+
+    ## fe36f75e-c103-410b-a18a-2bf6df06ac3a (/providers/Microsoft.ProcessSimple/environments/Default-c5a5d746-3520-453f-8a69-780f8e44917e/flows/72f2be4a-78c1-4220-a048-dbf557296a72/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a)
+
+    Property | Value
+    ---------|-------
+    name | fe36f75e-c103-410b-a18a-2bf6df06ac3a
+    id | /providers/Microsoft.ProcessSimple/environments/Default-c5a5d746-3520-453f-8a69-780f8e44917e/flows/72f2be4a-78c1-4220-a048-dbf557296a72/permissions/fe36f75e-c103-410b-a18a-2bf6df06ac3a
+    type | /providers/Microsoft.ProcessSimple/environments/flows/permissions
+    properties | {"roleName":"Owner","permissionType":"Principal","principal":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","type":"User"}}
+    ```