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

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

@@ -1,63 +0,0 @@
-# aad user list
-
-Lists users matching specified criteria
-
-## Usage
-
-```sh
-m365 aad user list [options]
-```
-
-## Options
-
-`-p, --properties [properties]`
-: Comma-separated list of properties to retrieve
-
-`-d, --deleted`
-: Use to retrieve deleted users
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-Using the `--properties` option, you can specify a comma-separated list of user properties to retrieve from the Microsoft Graph. If you don't specify any properties, the command will retrieve user's display name and account name.
-
-To filter the list of users, include additional options that match the user property that you want to filter with. For example `--displayName Patt` will return all users whose `displayName` starts with `Patt`. Multiple filters will be combined using the `and` operator.
-
-Certain properties cannot be returned within a user collection. The following properties are only supported when retrieving an single user using: `aboutMe, birthday, hireDate, interests, mySite, pastProjects, preferredName, responsibilities, schools, skills, mailboxSettings`.
-
-## Examples
-
-List all users in the tenant
-
-```sh
-m365 aad user list
-```
-
-List all recently deleted users in the tenant
-
-```sh
-m365 aad user list --deleted
-```
-
-List all users in the tenant. For each one return the display name and e-mail address
-
-```sh
-m365 aad user list --properties "displayName,mail"
-```
-
-Show users whose display name starts with _Patt_
-
-```sh
-m365 aad user list --displayName Patt
-```
-
-Show all account managers whose display name starts with _Patt_
-
-```sh
-m365 aad user list --displayName Patt --jobTitle 'Account manager'
-```
-
-## More information
-
-- Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)

package/docs/docs/cmd/aad/user/user-password-validate.md

@@ -1,29 +0,0 @@
-# aad user password validate
-
-Check a user's password against the organization's password validation policy
-
-## Usage
-
-```sh
-m365 aad user password validate [options]
-```
-
-## Options
-
-`-p, --password <password>`
-: The password to be validated.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-!!! attention
-    This command is based on an API that is currently in preview and is subject to change once the API reached general availability.
-
-## Examples
-
-Validate password _cli365P@ssW0rd_ against the organization's password validation policy
-
-```sh
-m365 aad user password validate --password "cli365P@ssW0rd"
-```

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

@@ -1,42 +0,0 @@
-# aad user recyclebinitem clear
-
-Removes all users from the tenant recycle bin
-
-## Usage
-
-```sh
-m365 aad user recyclebinitem clear [options]
-```
-
-## Options
-
-`--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 all deleted users are effectively removed from the tenant.
-
-## Examples
-
-Removes all users from the tenant recycle bin
-
-```sh
-m365 aad user recyclebinitem clear
-```
-
-Removes all users from the tenant recycle bin without confirmation prompt
-
-```sh
-m365 aad user recyclebinitem clear --confirm
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,82 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-# 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

@@ -1,99 +0,0 @@
-# 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

@@ -1,51 +0,0 @@
-# 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

@@ -1,133 +0,0 @@
-# aad user set
-
-Updates information of the specified user
-
-## Usage
-
-```sh
-m365 aad user set [options]
-```
-
-## Options
-
-`-i, --objectId [objectId]`
-: The object ID of the user to update. Specify `objectId` or `userPrincipalName` but not both.
-
-`-n, --userPrincipalName [userPrincipalName]`
-: User principal name of the user to update. Specify `objectId` or `userPrincipalName` but not both.
-
-`--accountEnabled [accountEnabled]`
-: Boolean value specifying whether the account is enabled. Valid values are `true` or `false`.
-
-`--resetPassword`
-: If specified, the password of the user will be reset. This will make the parameter `newPassword` required.
-
-`--forceChangePasswordNextSignIn`
-: If specified, the user will have to change his password the next time they log in. Can only be set in combination with `resetPassword`.
-
-`--forceChangePasswordNextSignInWithMfa`
-: Whether the user should change his/her password on the next login and setup MFA. Can only be set in combination with `resetPassword`.
-
-`--currentPassword [currentPassword]`
-: Current password of the user that is signed in. If this parameter is set, `newPassword` is mandatory. Can't be combined with `resetPassword`.
-
-`--newPassword [newPassword]`
-: New password to be set. Must be set when specifying either `resetPassword` or `currentPassword`.
-
-`--displayName [displayName]`
-: The name to display in the address book for the user.
-
-`--firstName [firstName]`
-: The given name (first name) of the user. Maximum length is 64 characters.
-
-`--lastName [lastName]`
-: The user's surname (family name or last name). Maximum length is 64 characters.
-
-`--usageLocation [usageLocation]`
-: A two letter [country code](https://learn.microsoft.com/en-us/partner-center/commercial-marketplace-co-sell-location-codes#country-and-region-codes) (ISO standard 3166). Required for users that will be assigned licenses.
-
-`--officeLocation [officeLocation]` 
-: The office location in the user's place of business.
-
-`--jobTitle [jobTitle]`
-: The user's job title. Maximum length is 128 characters.
-
-`--companyName [companyName]`
-: The company name which the user is associated. The maximum length is 64 characters.
-
-`--department [department]`
-: The name for the department in which the user works. Maximum length is 64 characters.
-
-`--preferredLanguage [preferredLanguage]`
-: The preferred language for the user. Should follow [ISO 639-1 Code](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a). Example: `en-US`.
-
-`--managerUserId [managerUserId]`
-: User ID of the user's manager. Specify `managerUserId`, `managerUserName` or `removeManager` but not both.
-
-`--managerUserName [managerUserName]`
-: User principal name of the manager. Specify `managerUserId`, `managerUserName` or `removeManager` but not both.
-
-`--removeManager`
-: Remove currently set manager. The user will have no manager when this flag is set. Specify `managerUserId`, `managerUserName` or `removeManager` but not both.
-
---8<-- "docs/cmd/_global.md"
-
-## Remarks
-
-This command allows using unknown options. For a comprehensive list of user properties, please refer to the [Graph documentation page](https://learn.microsoft.com/en-us/graph/api/resources/user?view=graph-rest-1.0#properties).
-
-If the user with the specified ID or username doesn't exist, or if the specified option is not found, you will receive a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
-
-## Examples
-
-Update specific property _department_ of user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
-
-```sh
-m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --Department IT
-```
-
-Update multiple properties of user with name _steve@contoso.onmicrosoft.com_
-
-```sh
-m365 aad user set --userPrincipalName steve@contoso.onmicrosoft.com --firstName John --lastName Doe --jobTitle "Sales Manager" --companyName Contoso --department Sales --officeLocation "New York"
-```
-
-Enable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
-
-```sh
-m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled true
-```
-
-Disable user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_
-
-```sh
-m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --accountEnabled false
-```
-
-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 --newPassword 6NLUId79Lc24 --forceChangePasswordNextSignIn
-```
-
-Change password of the currently logged in user
-
-```sh
-m365 aad user set --objectId 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --currentPassword SLBF5gnRtyYc --newPassword 6NLUId79Lc24
-```
-
-Updates a user with a manager
-
-```sh
-m365 aad user set --displayName "John Doe" --userName "john.doe@contoso.com" --managerUserName "adele@contoso.com"
-```
-
-Updates a user by removing its manager
-
-```sh
-m365 aad user set --userName "john.doe@contoso.com" --removeManager
-```
-
-## Response
-
-The command won't return a response on success.

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

@@ -1,81 +0,0 @@
-# aad user signin list
-
-Retrieves the Azure AD user sign-ins for the tenant
-
-## Usage
-
-```sh
-m365 aad user signin list [options]
-```
-
-## Options
-
-`-n, --userName [userName]`
-: Filter the user sign-ins by given User's UPN (user principal name), eg. `johndoe@example.com`. Specify either userName or userId
-
-`--userId [userId]`
-: Filter the user sign-ins by given User's Id. Specify either userName or userId
-
-`--appDisplayName [appDisplayName]`
-: Filter the user sign-ins by the given application display name. Specify either appDisplayName or appId
-
-`--appId [appId]`
-: Filter the user sign-ins by the given application identifier. Specify either appDisplayName or appId
-
---8<-- "docs/cmd/_global.md"
-
-## Examples
-
-Get all user's sign-ins in your tenant
-
-```sh
-m365 aad user signin list
-```
-
-Get all user's sign-ins filter by given user's UPN in the tenant
-
-```sh
-m365 aad user signin list --userName 'johndoe@example.com'
-```
-
-Get all user's sign-ins filter by given user's Id in the tenant
-
-```sh
-m365 aad user signin list --userId '11111111-1111-1111-1111-111111111111'
-```
-
-Get all user's sign-ins filter by given application display name in the tenant
-
-```sh
-m365 aad user signin list --appDisplayName 'Graph explorer'
-```
-
-Get all user's sign-ins filter by given application identifier in the tenant
-
-```sh
-m365 aad user signin list --appId '00000000-0000-0000-0000-000000000000'
-```
-
-Get all user's sign-ins filter by given user's UPN and application display name in the tenant
-
-```sh
-m365 aad user signin list --userName 'johndoe@example.com' --appDisplayName 'Graph explorer'
-```
-
-Get all user's sign-ins filter by given user's Id and application display name in the tenant
-
-```sh
-m365 aad user signin list --userId '11111111-1111-1111-1111-111111111111' --appDisplayName 'Graph explorer'
-```
-
-Get all user's sign-ins filter by given user's UPN and application identifier in the tenant
-
-```sh
-m365 aad user signin list --userName 'johndoe@example.com' --appId '00000000-0000-0000-0000-000000000000'
-```
-
-Get all user's sign-ins filter by given user's Id and application identifier in the tenant
-
-```sh
-m365 aad user signin list --userId '11111111-1111-1111-1111-111111111111' --appId '00000000-0000-0000-0000-000000000000'
-```