@pnp/cli-microsoft365 5.0.0-beta.2e2ba7d → 5.0.0-beta.30c8613

package/dist/m365/tenant/commands.js

@@ -10,9 +10,15 @@ exports.default = {
     REPORT_OFFICE365ACTIVATIONSUSERDETAIL: `${prefix} report office365activationsuserdetail`,
     REPORT_OFFICE365ACTIVATIONSUSERCOUNTS: `${prefix} report office365activationsusercounts`,
     REPORT_SERVICESUSERCOUNTS: `${prefix} report servicesusercounts`,
+    SERVICEANNOUNCEMENT_HEALTHISSUE_GET: `${prefix} serviceannouncement healthissue get`,
     SERVICE_LIST: `${prefix} service list`,
     SERVICE_MESSAGE_LIST: `${prefix} service message list`,
     SERVICE_REPORT_HISTORICALSERVICESTATUS: `${prefix} service report historicalservicestatus`,
+    SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,
+    SERVICEANNOUNCEMENT_HEALTH_LIST: `${prefix} serviceannouncement health list`,
+    SERVICEANNOUNCEMENT_HEALTHISSUE_LIST: `${prefix} serviceannouncement healthissue list`,
+    SERVICEANNOUNCEMENT_MESSAGE_GET: `${prefix} serviceannouncement message get`,
+    SERVICEANNOUNCEMENT_MESSAGE_LIST: `${prefix} serviceannouncement message list`,
     STATUS_LIST: `${prefix} status list`
 };
 //# sourceMappingURL=commands.js.map

package/dist/request.js

@@ -16,7 +16,9 @@ class Request {
             decompress: true,
             responseType: 'text',
             /* c8 ignore next */
-            transformResponse: [data => data]
+            transformResponse: [data => data],
+            maxBodyLength: Infinity,
+            maxContentLength: Infinity
         });
         // since we're stubbing requests, request interceptor is never called in
         // tests, so let's exclude it from coverage
@@ -64,7 +66,7 @@ class Request {
             });
             // since we're stubbing requests, response interceptor is never called in
             // tests, so let's exclude it from coverage
-            /* c8 ignore next 22 */
+            /* c8 ignore next 26 */
             this.req.interceptors.response.use((response) => {
                 if (this._logger) {
                     this._logger.logToStderr('Response:');
@@ -73,19 +75,22 @@ class Request {
                         response.headers['content-type'].indexOf('json') > -1) {
                         properties.push('data');
                     }
-                    this._logger.logToStderr(JSON.stringify(Utils_1.default.filterObject(response, properties), null, 2));
+                    this._logger.logToStderr(JSON.stringify(Object.assign({ url: response.config.url }, Utils_1.default.filterObject(response, properties)), null, 2));
                 }
                 return response;
             }, (error) => {
                 if (this._logger) {
                     const properties = ['status', 'statusText', 'headers'];
                     this._logger.logToStderr('Request error:');
-                    this._logger.logToStderr(JSON.stringify(Object.assign(Object.assign({}, Utils_1.default.filterObject(error.response, properties)), { error: error.error }), null, 2));
+                    this._logger.logToStderr(JSON.stringify(Object.assign(Object.assign({ url: error.config.url }, Utils_1.default.filterObject(error.response, properties)), { error: error.error }), null, 2));
                 }
                 throw error;
             });
         }
     }
+    get logger() {
+        return this._logger;
+    }
     set logger(logger) {
         this._logger = logger;
     }

package/dist/settingsNames.js

@@ -5,7 +5,12 @@ const settingsNames = {
     errorOutput: 'errorOutput',
     output: 'output',
     printErrorsAsPlainText: 'printErrorsAsPlainText',
-    showHelpOnFailure: 'showHelpOnFailure'
+    showHelpOnFailure: 'showHelpOnFailure',
+    csvHeader: 'csvHeader',
+    csvEscape: 'csvEscape',
+    csvQuote: 'csvQuote',
+    csvQuoted: 'csvQuoted',
+    csvQuotedEmpty: 'csvQuotedEmpty'
 };
 exports.settingsNames = settingsNames;
 //# sourceMappingURL=settingsNames.js.map

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-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

@@ -19,14 +19,19 @@ m365 aad app get [options]
 `--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 update. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+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
@@ -46,3 +51,9 @@ 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-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/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/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
+```

package/docs/docs/cmd/pa/app/app-list.md

@@ -10,6 +10,12 @@ pa app list [options]
 
 ## Options
 
+`-e, --environment [environment]`
+: The name of the environment for which to retrieve available apps
+
+`--asAdmin`
+: Set, to list all Power Apps as admin. Otherwise will return only your own apps
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -17,10 +23,20 @@ pa app list [options]
 !!! attention
     This command is based on an API that is currently in preview and is subject to change once the API reaches general availability.
 
+If the environment with the name you specified doesn't exist, you will get the `Access to the environment 'xyz' is denied.` error.
+
+By default, the `app list` command returns only your apps. To list all apps, use the `asAdmin` option and make sure to specify the `environment` option. You cannot specify only one of the options, when specifying the `environment` option the `asAdmin` option has to be present as well.
+
 ## Examples
 
-List all apps
+List all your apps
 
 ```sh
 m365 pa app list
 ```
+
+List all apps in a given environment
+
+```sh
+m365 pa app list --environment Default-d87a7535-dd31-4437-bfe1-95340acd55c5 --asAdmin
+```

package/docs/docs/cmd/planner/task/task-add.md

@@ -0,0 +1,78 @@
+# planner task add
+
+Adds a new Microsoft Planner task
+
+## Usage
+
+```sh
+m365 planner task add [options]
+```
+
+## Options
+
+`-t, --title <title>`
+: Title of the task to add.
+
+`--planId [planId]`
+: Plan ID to which the task belongs. Specify either `planId` or `planName` but not both.
+
+`--planName [planName]`
+: Plan Name to which the task belongs. Specify either `planId` or `planName` but not both.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
+
+`--bucketId [bucketId]`
+: Bucket ID to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
+
+`--bucketName [bucketName]`
+: Bucket Name to which the task belongs. The bucket needs to exist in the selected plan. Specify either `bucketId` or `bucketName` but not both.
+
+`--startDateTime [startDateTime]`
+: The date and time when the task started. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--dueDateTime [dueDateTime]`
+: The date and time when the task is due. This should be defined as a valid ISO 8601 string. `2021-12-16T18:28:48.6964197Z`
+
+`--percentComplete [percentComplete]`
+: Percentage of task completion. Number between 0 and 100.
+  - When set to 0, the task is considered _Not started_. 
+  - When set between 1 and 99, the task is considered _In progress_.
+  - When set to 100, the task is considered _Completed_.
+
+`--assignedToUserIds [assignedToUserIds]`
+: The comma-separated IDs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--assignedToUserNames [assignedToUserNames]`
+: The comma-separated UPNs of the assignees the task is assigned to. Specify either `assignedToUserIds` or `assignedToUserNames` but not both.
+
+`--description [description]`
+: Description of the task
+
+`--orderHint [orderHint]`
+: Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkSbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
+
+```sh
+m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna"
+```
+
+Adds a Completed Microsoft Planner task with the name _My Planner Task_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_
+
+```sh
+m365 planner task add --title "My Planner task" --planName "My Planner Plan" --ownerGroupName "My Planner Group" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --percentComplete 100
+```
+
+Adds a Microsoft Planner task with the name _My Planner Task_ for plan with the ID _8QZEH7b3wkbGQobscsM5gADCBa_ and for the bucket with the ID _IK8tuFTwQEa5vTonM7ZMRZgAKdna_. The new task will be assigned to the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_ and receive a due date for _2021-12-16_
+
+```sh
+m365 planner task add --title "My Planner Task" --planId "8QZEH7b3wkSbGQobscsM5gADCBa" --bucketId "IK8tuFTwQEa5vTonM7ZMRZgAKdna" --assignedToUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com" --dueDateTime "2021-12-16"
+```

package/docs/docs/cmd/planner/task/task-details-get.md

@@ -0,0 +1,24 @@
+# planner task details get
+
+Retrieve the details of the specified planner task
+
+## Usage
+
+```sh
+m365 planner task details get [options]
+```
+
+## Options
+
+`-i, --taskId <taskId>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the details of the specified planner task
+
+```sh
+m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

package/docs/docs/cmd/planner/task/task-get.md

@@ -0,0 +1,29 @@
+# planner task get
+
+Retrieve the the specified planner task
+
+## Usage
+
+```sh
+m365 planner task get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command uses an API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
+## Examples
+
+Retrieve the the specified planner task
+
+```sh
+m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

package/docs/docs/cmd/planner/task/task-list.md

@@ -30,6 +30,11 @@ m365 planner task list [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! attention
+    This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
 ## Examples
 
 List tasks for the currently logged in user