@pnp/cli-microsoft365 5.0.0-beta.7e3f917 → 5.0.0-beta.8f5dd30

package/docs/docs/cmd/_global.md

@@ -5,10 +5,10 @@
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text`. Default `text`
+: Output type. `json,text,csv`. Default `json`
 
 `--verbose`
 : Runs command with verbose logging
 
 `--debug`
-: Runs command with debug logging
+: Runs command with debug logging

package/docs/docs/cmd/aad/app/app-add.md

@@ -52,6 +52,9 @@ m365 aad app add [options]
 `--manifest [manifest]`
 : Azure AD app manifest as retrieved from the Azure Portal to create the app registration from
 
+`--save`
+: Use to store the information about the created app in a local file
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -80,6 +83,8 @@ When using the `withSecret` option, this command will automatically generate a s
 
 After creating the Azure AD app registration, this command returns the app ID and object ID of the created app registration. If you used the `withSecret` option, it will also return the generated secret.
 
+If you want to store the information about the created Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you create the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the to it, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
+
 ## Examples
 
 Create new Azure AD app registration with the specified name
@@ -141,3 +146,9 @@ Create new Azure AD app registration with Application ID URI set to a value that
 ```sh
 m365 aad app add --name 'My AAD app' --uri api://caf406b91cd4.ngrok.io/_appId_ --scopeName access_as_user --scopeAdminConsentDescription 'Access as a user' --scopeAdminConsentDisplayName 'Access as a user' --scopeConsentBy adminsAndUsers
 ```
+
+Create new Azure AD app registration with the specified name. Store information about the created app registration in the _.m365rc.json_ file in the current directory.
+
+```sh
+m365 aad app add --name 'My AAD app' --save
+```

package/docs/docs/cmd/aad/app/app-delete.md

@@ -0,0 +1,51 @@
+# aad app delete
+
+Removes an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app delete [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--confirm`:
+: Don't prompt for confirmation to delete the app
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to delete. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Delete the Azure AD application registration by its app (client) ID
+
+```sh
+m365 aad app delete --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its object ID
+
+```sh
+m365 aad app delete --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its name. Will NOT prompt for confirmation before deleting.
+
+```sh
+m365 aad app delete --name "My app" --confirm
+```

package/docs/docs/cmd/aad/app/app-get.md

@@ -0,0 +1,59 @@
+# aad app get
+
+Gets an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app get [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--save`
+: Use to store the information about the created app in a local file
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to get. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+If you want to store the information about the Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you get the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the App registration to it if it's not already present, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
+
+## Examples
+
+Get the Azure AD application registration by its app (client) ID
+
+```sh
+m365 aad app get --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get the Azure AD application registration by its object ID
+
+```sh
+m365 aad app get --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get the Azure AD application registration by its name
+
+```sh
+m365 aad app get --name "My app"
+```
+
+Get the Azure AD application registration by its name. Store information about the retrieved app registration in the _.m365rc.json_ file in the current directory.
+
+```sh
+m365 aad app get --name "My app" --save
+```

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

@@ -22,6 +22,15 @@ m365 aad app set [options]
 `-u, --uri [uri]`
 : Application ID URI to update
 
+`-r, --redirectUris [redirectUris]`
+: Comma-separated list of redirect URIs to add to the app registration. Requires `platform` to be specified
+
+`-p, --platform [platform]`
+: Platform for which the `redirectUri` should be configured. Allowed values `spa,web,publicClient`
+
+`--redirectUrisToRemove [redirectUrisToRemove]`
+: Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -49,3 +58,15 @@ Update the app URI of the Azure AD application registration specified by its nam
 ```sh
 m365 aad app set --name "My app" --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
 ```
+
+Add a new redirect URI for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa
+```
+
+Replace one redirect URI with another for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
+```

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

@@ -0,0 +1,30 @@
+# aad group list
+
+Lists Azure AD groups
+
+## Usage
+
+```sh
+m365 aad group list [options]
+```
+
+## Options
+
+`-d, --deleted`
+: Use to retrieve deleted groups
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Lists all groups defined in Azure Active Directory.
+
+```sh
+m365 aad group list
+```
+
+List all recently deleted groups in the tenant
+
+```sh
+m365 aad group list --deleted
+```

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

@@ -36,6 +36,7 @@ m365 aad o365group add [options]
 ## 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 or Owners or Members, the command operation will fail and the Micrsoft 365 Group will not be created.
 
 ## Examples
 

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

@@ -0,0 +1,24 @@
+# aad o365group conversation list
+
+Lists conversations for the specified Microsoft 365 group
+
+## Usage
+
+```sh
+m365 aad o365group conversation list [options]
+```
+
+## Options
+
+`-i, --groupId <groupId>`
+: The ID of the Microsoft 365 group
+
+--8<-- "docs/cmd/_global.md"
+
+## 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/oauth2grant/oauth2grant-list.md

@@ -10,7 +10,7 @@ m365 aad oauth2grant list [options]
 
 ## Options
 
-`-i, --clientId <clientId>`
+`-i, --spObjectId <spObjectId>`
 : objectId of the service principal for which the configured OAuth2 permission grants should be retrieved
 
 --8<-- "docs/cmd/_global.md"
@@ -26,7 +26,7 @@ When using the text output type (default), the command lists only the values of
 List OAuth2 permissions granted to service principal with `objectId` _b2307a39-e878-458b-bc90-03bc578531d6_.
 
 ```sh
-m365 aad oauth2grant list --clientId b2307a39-e878-458b-bc90-03bc578531d6
+m365 aad oauth2grant list --spObjectId b2307a39-e878-458b-bc90-03bc578531d6
 ```
 
 ## More information

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

@@ -13,6 +13,9 @@ m365 aad oauth2grant remove [options]
 `-i, --grantId <grantId>`
 : `objectId` of OAuth2 permission grant to remove
 
+`--confirm`
+: Do not prompt for confirmation before removing OAuth2 permission grant
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -33,6 +36,12 @@ Remove the OAuth2 permission grant with ID _YgA60KYa4UOPSdc-lpxYEnQkr8KVLDpCsOXk
 m365 aad oauth2grant remove --grantId YgA60KYa4UOPSdc-lpxYEnQkr8KVLDpCsOXkiV8i-ek
 ```
 
+Remove the OAuth2 permission grant with ID _YgA60KYa4UOPSdc-lpxYEnQkr8KVLDpCsOXkiV8i-ek_ without being asked for confirmation
+
+```sh
+m365 aad oauth2grant remove --grantId YgA60KYa4UOPSdc-lpxYEnQkr8KVLDpCsOXkiV8i-ek --confirm
+```
+
 ## More information
 
 - Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)

package/docs/docs/cmd/aad/sp/sp-add.md

@@ -0,0 +1,53 @@
+# aad sp add
+
+Adds a service principal to a registered Azure AD app
+
+## Usage
+
+```sh
+m365 aad sp add [options]
+```
+
+## Options
+
+`--appId [appId]`
+: ID of the application to which the service principal should be added
+
+`--appName [appName]`
+: Display name of the application to which the service principal should be added
+
+`--objectId [objectId]`
+: ObjectId of the application to which the service principal should be added
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+Specify either the `appId`, `appName` or `objectId`. If you specify more than one option value, the command will fail with an error.
+
+If you register an application in the portal, an application object as well as a service principal object are automatically created in your home tenant. If you register an application using CLI for Microsoft 365 or the Microsoft Graph, you'll need to create the service principal separately. To register/create an application using the CLI for Microsoft 365, use the [m365 aad app add](../app/app-add.md) command.
+
+## Examples
+
+Adds a service principal to a registered Azure AD app with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
+
+```sh
+m365 aad sp add --appId b2307a39-e878-458b-bc90-03bc578531d6
+```
+
+Adds a service principal to a registered Azure AD app with appName _Microsoft Graph_.
+
+```sh
+m365 aad sp add --appName "Microsoft Graph"
+```
+
+Adds a service principal to a registered Azure AD app with objectId _b2307a39-e878-458b-bc90-03bc578531d6_.
+
+```sh
+m365 aad sp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
+```
+
+## More information
+
+- Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)
+- Create servicePrincipal: [https://docs.microsoft.com/en-us/graph/api/serviceprincipal-post-serviceprincipals?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/serviceprincipal-post-serviceprincipals?view=graph-rest-1.0)

package/docs/docs/cmd/aad/sp/sp-get.md

@@ -47,4 +47,5 @@ m365 aad sp get --objectId b2307a39-e878-458b-bc90-03bc578531dd
 
 ## More information
 
-- Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)
+- Application and service principal objects in Azure Active Directory (Azure AD): [https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-application-objects)
+- Get servicePrincipal: [https://docs.microsoft.com/en-us/graph/api/serviceprincipal-get?view=graph-rest-1.0](https://docs.microsoft.com/en-us/graph/api/serviceprincipal-get?view=graph-rest-1.0)

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

@@ -11,10 +11,13 @@ m365 aad user get [options]
 ## Options
 
 `-i, --id [id]`
-: The ID of the user to retrieve information for. Specify `id` or `userName` but not both
+: The ID of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
 
 `-n, --userName [userName]`
-: The name of the user to retrieve information for. Specify `id` or `userName` but not both
+: The name of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
+
+`--email [email]`
+: The email of the user to retrieve information for. Use either `id`, `userName` or `email`, but not all.
 
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve
@@ -23,9 +26,9 @@ m365 aad user get [options]
 
 ## Remarks
 
-You can retrieve information about a user, either by specifying that user's id or user name (`userPrincipalName`), but not both.
+You can retrieve information about a user, either by specifying that user's id, user name (`userPrincipalName`), or email (`mail`), but not all.
 
-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.
+If the user with the specified id, user name, or email doesn't exist, you will get a `Resource 'xyz' does not exist or one of its queried reference-property objects are not present.` error.
 
 ## Examples
 
@@ -41,6 +44,12 @@ Get information about the user with user name _AarifS@contoso.onmicrosoft.com_
 m365 aad user get --userName AarifS@contoso.onmicrosoft.com
 ```
 
+Get information about the user with email _AarifS@contoso.onmicrosoft.com_
+
+```sh
+m365 aad user get --email AarifS@contoso.onmicrosoft.com
+```
+
 For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user name, e-mail address and full name
 
 ```sh

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

@@ -0,0 +1,46 @@
+# aad user hibp
+
+Allows you to retrieve all accounts that have been pwned with the specified username
+
+## Usage
+
+```sh
+m365 aad user hibp [options]
+```
+
+## Options
+
+`-n, --userName <userName>`
+: The name of the user to retrieve information for.
+
+`--apiKey, <apiKey>`
+: Have I been pwned `API Key`. You can buy it from [https://haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key)
+
+`--domain, [domain]`
+: Limit the returned breaches only contain results with the domain specified.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the user with the specified user name doesn't involved in any breach, you will get a `No pwnage found` message when running in debug or verbose mode.
+
+If `API Key` is invalid, you will get a `Required option apiKey not specified` error.
+
+## Examples
+
+Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach
+
+```sh
+m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_
+```
+
+Check if user with user name _account-exists@hibp-integration-tests.com_ is in a data breach against the domain specified
+
+```sh
+m365 aad user hibp --userName account-exists@hibp-integration-tests.com --apiKey _YOUR-API-KEY_ --domain adobe.com
+```
+
+## More information
+
+- Have I been pwned API documentation: [https://haveibeenpwned.com/API/v3](https://haveibeenpwned.com/API/v3)

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

@@ -13,6 +13,9 @@ m365 aad user list [options]
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve
 
+`-d, --deleted`
+: Use to retrieve deleted users
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -31,6 +34,12 @@ List all users in the tenant
 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

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

@@ -0,0 +1,29 @@
+# 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/app/permission/permission-list.md

@@ -0,0 +1,36 @@
+# app permission list
+
+Lists API permissions for the current AAD app
+
+## Usage
+
+```sh
+m365 app permission list [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Client ID of the Azure AD app registered in the .m365rc.json file to retrieve API permissions for
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+Use this command to quickly look up API permissions for the Azure AD application registration registered in the .m365rc.json file in your current project (folder).
+
+If you have multiple apps registered in your .m365rc.json file, you can specify the app for which you'd like to retrieve permissions using the `--appId` option. If you don't specify the app using the `--appId` option, you'll be prompted to select one of the applications from your .m365rc.json file.
+
+## Examples
+
+Retrieve API permissions for your current Azure AD app
+
+```sh
+m365 app permission list
+```
+
+Retrieve API permissions for the Azure AD app with client ID _e23d235c-fcdf-45d1-ac5f-24ab2ee0695d_ specified in the _.m365rc.json_ file
+
+```sh
+m365 app permission list --appId e23d235c-fcdf-45d1-ac5f-24ab2ee0695d
+```

package/docs/docs/cmd/file/file-add.md

@@ -16,12 +16,17 @@ m365 file add [options]
 `-p, --filePath <filePath>`
 : Local path to the file to upload
 
+`--siteUrl [siteUrl]`
+: URL of the site to which upload the file. Specify to suppress lookup.
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
 The `folderUrl` must be an absolute URL to the document library where the file should be uploaded. The document library can be located in any site collection in your tenant, including OneDrive for Business. The `folderUrl` can also point to a (sub)folder in the document library.
 
+By default, the `file add` command will automatically lookup the ID of the site where you want to upload the file based on the specified `folderUrl`. It will do this, by breaking the URL into chunks and incrementally calling Microsoft Graph to retrieve site information. This is necessary, because there is no other way looking at the URL to distinguish where the site URL ends and the document library URL starts. If you want to speed up uploading files, or you use resource-specific consent and your Azure AD app only has access to the specific site, you can use the `siteUrl` option to specify the URL of the site yourself.
+
 ## Examples
 
 Uploads file from the current folder to the root folder of a document library in the root site collection
@@ -47,3 +52,9 @@ Uploads file from the current folder to a document library in a non-root site co
 ```sh
 m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents"
 ```
+
+Uploads file from the current folder to a document library in the specified site
+
+```sh
+m365 file add --filePath file.pdf --folderUrl "https://contoso.sharepoint.com/sites/Contoso/Shared Documents" --siteUrl "https://contoso.sharepoint.com/sites/Contoso"
+```

package/docs/docs/cmd/file/file-list.md

@@ -0,0 +1,46 @@
+# file list
+
+Retrieves files from the specified folder and site
+
+## Usage
+
+```sh
+m365 file list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the folder from which to retrieve files is located
+
+`-f, --folderUrl <folderUrl>`
+: The server- or site-relative URL of the folder from which to retrieve files
+
+`--recursive`
+: Set to retrieve files from subfolders
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+This command is an improved version of the `spo file list` command. The main difference between the two commands is, that `file list` uses Microsoft Graph and properly supports retrieving files from large folders. Because `file list` uses Microsoft Graph and `spo file list` uses SharePoint REST APIs, the data returned by both commands is different.
+
+## Examples
+
+Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
+```
+
+Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
+```
+
+Return all files from the _Important_ folder in the _Shared Documents_ document library located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Important'
+```

package/docs/docs/cmd/outlook/room/room-list.md

@@ -0,0 +1,30 @@
+# outlook room list
+
+Get a collection of all available rooms
+
+## Usage
+
+```sh
+m365 outlook room list [options]
+```
+
+## Options
+
+`--roomlistEmail [roomlistEmail]`
+: Use to filter returned rooms by their roomlist email (eg. bldg2@contoso.com)
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all the rooms
+
+```sh
+m365 outlook room list
+```
+
+Get all the rooms of specified roomlist e-mail address
+
+```sh
+m365 outlook room list --roomlistEmail "bldg2@contoso.com"
+```

package/docs/docs/cmd/outlook/roomlist/roomlist-list.md

@@ -0,0 +1,21 @@
+# outlook roomlist list
+
+Get a collection of available roomlists
+
+## Usage
+
+```sh
+m365 outlook roomlist list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all roomlists in your tenant
+
+```sh
+m365 outlook roomlist list
+```