@pnp/cli-microsoft365 6.0.0-beta.566a6b8 → 6.0.0-beta.636d726

package/dist/utils/cache.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cache = void 0;
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const config_1 = require("../config");
+const cacheFolderPath = path.join(os.tmpdir(), config_1.default.configstoreName.replace('config', 'cache'));
+const mkdirOptions = { mode: 0o0700, recursive: true };
+exports.cache = {
+    cacheFolderPath: cacheFolderPath,
+    getValue(key) {
+        this.clearExpired();
+        try {
+            const cacheFilePath = path.join(cacheFolderPath, key);
+            if (!fs.existsSync(cacheFilePath)) {
+                return undefined;
+            }
+            return fs.readFileSync(cacheFilePath, 'utf8');
+        }
+        catch (_a) {
+            return undefined;
+        }
+    },
+    setValue(key, value) {
+        this.clearExpired();
+        try {
+            fs.mkdirSync(cacheFolderPath, mkdirOptions);
+            const cacheFilePath = path.join(cacheFolderPath, key);
+            // we don't need to wait for the file to be written
+            // eslint-disable-next-line @typescript-eslint/no-empty-function
+            fs.writeFile(cacheFilePath, value, () => { });
+        }
+        catch (_a) { }
+    },
+    clearExpired(cb) {
+        // we don't need to wait for this to complete
+        // even if it stops meanwhile, it will be picked up next time
+        fs.readdir(cacheFolderPath, (err, files) => {
+            if (err) {
+                if (cb) {
+                    cb();
+                }
+                return;
+            }
+            const numFiles = files.length;
+            if (numFiles === 0) {
+                if (cb) {
+                    cb();
+                }
+                return;
+            }
+            files.forEach((file, index) => {
+                fs.stat(path.join(cacheFolderPath, file), (err, stats) => {
+                    if (err || stats.isDirectory()) {
+                        if (cb && index === numFiles - 1) {
+                            cb();
+                        }
+                        return;
+                    }
+                    // remove files that haven't been accessed in the last 24 hours
+                    if (stats.atime.getTime() < Date.now() - 24 * 60 * 60 * 1000) {
+                        // we don't need to wait for the file to be deleted
+                        // eslint-disable-next-line @typescript-eslint/no-empty-function
+                        fs.unlink(path.join(cacheFolderPath, file), () => {
+                            if (cb && index === numFiles - 1) {
+                                cb();
+                            }
+                        });
+                    }
+                    else {
+                        if (cb && index === numFiles - 1) {
+                            cb();
+                        }
+                    }
+                });
+            });
+        });
+    }
+};
+//# sourceMappingURL=cache.js.map

package/dist/utils/pid.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pid = void 0;
+const os = require("os");
+const fs = require("fs");
+const child_process_1 = require("child_process");
+const cache_1 = require("./cache");
+function getProcessNameOnMacOs(pid) {
+    const stdout = (0, child_process_1.execSync)(`ps -o comm= ${pid}`, { encoding: 'utf8' });
+    return stdout.trim();
+}
+function getProcessNameOnLinux(pid) {
+    if (!fs.existsSync(`/proc/${pid}/stat`)) {
+        return undefined;
+    }
+    const stat = fs.readFileSync(`/proc/${pid}/stat`, 'utf8');
+    const start = stat.indexOf('(');
+    const procName = stat.substring(start + 1, stat.indexOf(')') - start);
+    return procName;
+}
+function getProcessNameOnWindows(pid) {
+    const stdout = (0, child_process_1.execSync)(`wmic PROCESS where ProcessId=${pid} get Caption | find /V "Caption"`, { encoding: 'utf8' });
+    return stdout.trim();
+}
+exports.pid = {
+    getProcessName(pid) {
+        let processName = cache_1.cache.getValue(pid.toString());
+        if (processName) {
+            return processName;
+        }
+        let getPidName = undefined;
+        const platform = os.platform();
+        if (platform.indexOf('win') === 0) {
+            getPidName = getProcessNameOnWindows;
+        }
+        if (platform === 'darwin') {
+            getPidName = getProcessNameOnMacOs;
+        }
+        if (platform === 'linux') {
+            getPidName = getProcessNameOnLinux;
+        }
+        if (getPidName) {
+            try {
+                processName = getPidName(pid);
+                if (processName) {
+                    cache_1.cache.setValue(pid.toString(), processName);
+                }
+                return processName;
+            }
+            catch (_a) {
+                return undefined;
+            }
+        }
+        return undefined;
+    }
+};
+//# sourceMappingURL=pid.js.map

package/dist/utils/powerPlatform.js

@@ -0,0 +1,42 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.powerPlatform = void 0;
+const request_1 = require("../request");
+const powerPlatformResource = 'https://api.bap.microsoft.com';
+exports.powerPlatform = {
+    getDynamicsInstanceApiUrl(environment, asAdmin) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let url = '';
+            if (asAdmin) {
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/scopes/admin/environments/${encodeURIComponent(environment)}`;
+            }
+            else {
+                url = `${powerPlatformResource}/providers/Microsoft.BusinessAppPlatform/environments/${encodeURIComponent(environment)}`;
+            }
+            const requestOptions = {
+                url: `${url}?api-version=2020-10-01&$select=properties.linkedEnvironmentMetadata.instanceApiUrl`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            try {
+                const response = yield request_1.default.get(requestOptions);
+                return Promise.resolve(response.properties.linkedEnvironmentMetadata.instanceApiUrl);
+            }
+            catch (ex) {
+                throw Error(`The environment '${environment}' could not be retrieved. See the inner exception for more details: ${ex.message}`);
+            }
+        });
+    }
+};
+//# sourceMappingURL=powerPlatform.js.map

package/dist/utils/spo.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.spo = void 0;
 const url = require("url");
-const _1 = require(".");
+const urlUtil_1 = require("./urlUtil");
+const validation_1 = require("./validation");
 const Auth_1 = require("../Auth");
 const config_1 = require("../config");
 const base_permissions_1 = require("../m365/spo/base-permissions");
@@ -20,7 +21,7 @@ exports.spo = {
     },
     ensureFormDigest(siteUrl, logger, context, debug) {
         return new Promise((resolve, reject) => {
-            if (_1.validation.isValidFormDigest(context)) {
+            if (validation_1.validation.isValidFormDigest(context)) {
                 if (debug) {
                     logger.logToStderr('Existing form digest still valid');
                 }
@@ -255,7 +256,7 @@ exports.spo = {
             webFullUrl[webFullUrlLastCharPos] === '/') {
             webFullUrl = webFullUrl.substring(0, webFullUrlLastCharPos);
         }
-        folderToEnsure = _1.urlUtil.getWebRelativePath(webFullUrl, folderToEnsure);
+        folderToEnsure = urlUtil_1.urlUtil.getWebRelativePath(webFullUrl, folderToEnsure);
         if (debug) {
             logger.log(`folderToEnsure`);
             logger.log(folderToEnsure);
@@ -282,7 +283,7 @@ exports.spo = {
             // append the next sub-folder to the folder path and check if it exists
             prevFolder = nextFolder;
             nextFolder += `/${folders[folderIndex]}`;
-            const folderServerRelativeUrl = _1.urlUtil.getServerRelativePath(webFullUrl, nextFolder);
+            const folderServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(webFullUrl, nextFolder);
             const requestOptions = {
                 url: `${webFullUrl}/_api/web/GetFolderByServerRelativeUrl('${encodeURIComponent(folderServerRelativeUrl)}')`,
                 headers: {
@@ -296,7 +297,7 @@ exports.spo = {
                 checkOrAddFolder(resolve, reject);
             })
                 .catch(() => {
-                const prevFolderServerRelativeUrl = _1.urlUtil.getServerRelativePath(webFullUrl, prevFolder);
+                const prevFolderServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(webFullUrl, prevFolder);
                 const requestOptions = {
                     url: `${webFullUrl}/_api/web/GetFolderByServerRelativePath(DecodedUrl=@a1)/AddSubFolderUsingPath(DecodedUrl=@a2)?@a1=%27${encodeURIComponent(prevFolderServerRelativeUrl)}%27&@a2=%27${encodeURIComponent(folders[folderIndex])}%27`,
                     headers: {
@@ -402,7 +403,7 @@ exports.spo = {
       * @param formDigestValue formDigestValue
       */
     getFolderIdentity(webObjectIdentity, webUrl, siteRelativeUrl, formDigestValue) {
-        const serverRelativePath = _1.urlUtil.getServerRelativePath(webUrl, siteRelativeUrl);
+        const serverRelativePath = urlUtil_1.urlUtil.getServerRelativePath(webUrl, siteRelativeUrl);
         const requestOptions = {
             url: `${webUrl}/_vti_bin/client.svc/ProcessQuery`,
             headers: {

package/docs/docs/_clisettings.md

@@ -0,0 +1,18 @@
+## Available settings
+
+Following is the list of configuration settings available in CLI for Microsoft 365.
+
+Setting name|Definition|Default value
+------------|----------|-------------
+`autoOpenLinksInBrowser`|Automatically open the browser for all commands which return a url and expect the user to copy paste this to the browser. For example when logging in, using `m365 login` in device code mode.|`false`
+`copyDeviceCodeToClipboard`|Automatically copy the device code to the clipboard when running `m365 login` command in device code mode|`false`
+`csvEscape`|Single character used for escaping; only apply to characters matching the quote and the escape options|`"`
+`csvHeader`|Display the column names on the first line|`true`
+`csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
+`csvQuoted`|Quote all the non-empty fields even if not required|`false`
+`csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
+`errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
+`output`|Defines the default output when issuing a command|`json`
+`printErrorsAsPlainText`|When output mode is set to `json`, print error messages as plain-text rather than JSON|`true`
+`prompt`|Prompts for missing values in required options|`false`
+`showHelpOnFailure`|Automatically display help when executing a command failed|`true`

package/docs/docs/cmd/aad/user/user-guest-add.md

@@ -0,0 +1,107 @@
+# aad user guest add
+
+Invite an external user to the organization
+
+## Usage
+
+```sh
+m365 aad user guest add [options]
+```
+
+## Options
+
+`--emailAddress <emailAddress>`
+: The email address of the user.
+
+`--displayName [displayName]`
+: The display name of the user.
+
+`--inviteRedirectUrl [inviteRedirectUrl]`
+: The URL the user should be redirected to once the invitation is redeemed. If not specified, default URL https://myapplications.microsoft.com will be set.
+
+`--welcomeMessage [welcomeMessage]`
+: Personal welcome message which will be added to the email along with the default email.
+
+`--ccRecipients [ccRecipients]`
+: Additional recipients the invitation message should be sent to. Currently only 1 additional recipient is supported.
+
+`--messageLanguage [messageLanguage]`
+: The language you want to send the default message in. The language format should be in [ISO 639](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oi29500/ed06cf15-306c-43be-9053-ca81ca51e656). The default is `en-US`.
+
+`--sendInvitationMessage`
+: Indicates whether an email should be sent to the user.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Invite a user via email and set the display name
+
+```sh
+m365 aad user guest add --emailAddress john.doe@contoso.com --displayName "John Doe" --sendInvitationMessage
+```
+
+Invite a user with a custom email and custom redirect url
+
+```sh
+m365 aad user guest add --emailAddress john.doe@contoso.com --welcomeMessage "Hi John, welcome to the organization!" --sendInvitationMessage
+```
+
+Invite a user and send an invitation mail in Dutch
+
+```sh
+m365 aad user guest add --emailAddress john.doe@contoso.com --messageLanguage nl-BE --sendInvitationMessage
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "35f7f726-c541-4aef-a64e-a7b6868fe47f",
+      "inviteRedeemUrl": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0",
+      "invitedUserDisplayName": "John Doe",
+      "invitedUserType": "Guest",
+      "invitedUserEmailAddress": "john.doe@contoso.com",
+      "sendInvitationMessage": true,
+      "resetRedemption": false,
+      "inviteRedirectUrl": "https://myapplications.microsoft.com/",
+      "status": "PendingAcceptance",
+      "invitedUserMessageInfo": {
+        "messageLanguage": "en-US",
+        "customizedMessageBody": "Hi John, welcome to the organization!",
+        "ccRecipients": [
+          {
+            "emailAddress": {
+              "name": null,
+              "address": "maria.jones@contoso.com"
+            }
+          }
+        ]
+      },
+      "invitedUser": {
+        "id": "5257b5b2-4056-4a45-a05e-df5c92d53e6e"
+      }
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id                     : 35f7f726-c541-4aef-a64e-a7b6868fe47f
+    inviteRedeemUrl        : https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0
+    invitedUserDisplayName : John Doe
+    invitedUserEmailAddress: liwidit556@adroh.com
+    invitedUserType        : Guest
+    resetRedemption        : false
+    sendInvitationMessage  : true
+    status                 : PendingAcceptance
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,inviteRedeemUrl,invitedUserDisplayName,invitedUserEmailAddress,invitedUserType,resetRedemption,sendInvitationMessage,status
+    35f7f726-c541-4aef-a64e-a7b6868fe47f,https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3db373bc30-03b3-49bc-be72-9dd3e9027da8%26user%3d35f7f726-c541-4aef-a64e-a7b6868fe47f%26ticket%3dCjO3u3ZpQF2uthfZETfZ8gURzod5egvYI0uhaSN1Loo%25253d%26ver%3d2.0,John Doe,liwidit556@adroh.com,Guest,,1,PendingAcceptance
+    ```

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

@@ -78,4 +78,4 @@ Get all user's sign-ins filter by given user's Id and application identifier in
 
 ```sh
 m365 aad user signin list --userId '11111111-1111-1111-1111-111111111111' --appId '00000000-0000-0000-0000-000000000000'
-```
+```

package/docs/docs/cmd/adaptivecard/adaptivecard-send.md

@@ -43,6 +43,9 @@ The predefined card is automatically adjusted based on which options have been s
 
 If your custom card is a card template (card with placeholders like `${title}`), you can fill it with data either by specifying the complete data object using the `cardData` option, or by passing any number of arbitrary options that will be mapped onto the card. The arbitrary properties should not match any of the global options like `output`, `query`, `debug`, etc. Data options like `title`, `description`, `imageUrl` and `actionUrl` will be mapped onto the card as well.
 
+!!! warning "Escaping JSON in PowerShell"
+    When using the `--card` and `--cardData` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
 ## Examples
 
 Send a predefined adaptive card with just title

package/docs/docs/cmd/graph/schemaextension/schemaextension-add.md

@@ -43,26 +43,19 @@ The schema extension owner is the ID of the Azure AD application that is the own
 
 The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list
 
-When specifying the JSON string of properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _properties_ option: `{"Foo":"Bar"}`,
-you should specify the value as <code>\`"{""Foo"":""Bar""}"\`</code>.
-In addition, when using PowerShell, you should use the `--%` argument.
+!!! warning "Escaping JSON in PowerShell"
+    When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
 
 ## Examples
 
 Create a schema extension
 
 ```sh
-m365 graph schemaextension add --id MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
+m365 graph schemaextension add --id MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
 ```
 
 Create a schema extension with a verified domain
 
 ```sh
-m365 graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
-```
-
-Create a schema extension in PowerShell
-
-```PowerShell
-graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner "62375ab9-6b52-47ed-826b-58e47e0e304b" --properties --% \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
+m365 graph schemaextension add --id contoso_MySchemaExtension --description "My Schema Extension" --targetTypes Group --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
 ```

package/docs/docs/cmd/graph/schemaextension/schemaextension-set.md

@@ -35,9 +35,9 @@ m365 graph schemaextension set [options]
 The lifecycle state of the schema extension. The initial state upon creation is `InDevelopment`.
 Possible states transitions are from `InDevelopment` to `Available` and `Available` to `Deprecated`.
 The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list.
-When specifying the JSON string of properties on Windows, you have to escape double quotes in a specific way. Considering the following value for the _properties_ option: `{"Foo":"Bar"}`,
-you should specify the value as <code>\`"{""Foo"":""Bar""}"\`</code>.
-In addition, when using PowerShell, you should use the `--%` argument.
+
+!!! warning "Escaping JSON in PowerShell"
+    When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
 
 ## Examples
 
@@ -50,13 +50,7 @@ m365 graph schemaextension set --id MySchemaExtension --owner 62375ab9-6b52-47ed
 Update the target types and properties of a schema extension
 
 ```sh
-m365 graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --targetTypes "Group,User" --properties \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
-```
-
-Update the properties of a schema extension in PowerShell
-
-```PowerShell
-graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --properties --% \`"[{""name"":""myProp1"",""type"":""Integer""},{""name"":""myProp2"",""type"":""String""}]\`
+m365 graph schemaextension set --id contoso_MySchemaExtension --owner 62375ab9-6b52-47ed-826b-58e47e0e304b --targetTypes "Group,User" --properties '[{"name":"myProp1","type":"Integer"},{"name":"myProp2","type":"String"}]'
 ```
 
 Change the status of a schema extension to 'Available'

package/docs/docs/cmd/onedrive/report/report-activityusercounts.md

@@ -1,4 +1,4 @@
-# onerive report activityusercounts
+# onedrive report activityusercounts
 
 Gets the trend in the number of active OneDrive users
 

package/docs/docs/cmd/outlook/mail/mail-send.md

@@ -37,6 +37,9 @@ m365 outlook mail send [options]
 `--importance [importance]`
 : The importance of the message. Available options: `low`, `normal` or `high`. Default is `normal`.
 
+`--attachment [attachment]`
+: Path to the file that will be added as attachment to the email. This option can be used multiple times to attach multiple attachments.
+
 `--saveToSentItems [saveToSentItems]`
 : Save email in the sent items folder. Default `true`.
 
@@ -44,6 +47,10 @@ m365 outlook mail send [options]
 
 ## Remarks
 
+### Attachments
+
+When using the `attachment` option, note that the total size of all attachment files cannot exceed 3 MB.
+
 ### If you are connected using app only authentication
 
 - Always specify a user id or upn in the `--sender` option. The email will be sent as if it came from the specified user, and can optionally be saved in the sent folder of that user account.
@@ -110,3 +117,9 @@ Send an email with cc and bcc recipients marked as important
 ```sh
 m365 outlook mail send --to chris@contoso.com --cc claire@contoso.com --bcc randy@contoso.com --subject "DG2000 Data Sheets" --bodyContents "The latest data sheets are in the team site" --importance high
 ```
+
+Send an email with multiple attachments
+
+```sh
+m365 outlook mail send --to chris@contoso.com --subject "Monthly reports" --bodyContents "Here are the reports of this month." --attachment "C:/Reports/File1.jpg" --attachment "C:/Reports/File2.docx" --attachment "C:/Reports/File3.xlsx"
+```

package/docs/docs/cmd/outlook/message/message-get.md

@@ -0,0 +1,48 @@
+# outlook message get
+
+Retrieves specified message
+
+## Usage
+
+```sh
+m365 outlook message get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the message
+
+`--userId [userId]`
+: ID of the user from which to retrieve the message. Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
+
+`--userPrincipalName [userPrincipalName]`
+: UPN of the user from which to retrieve the message Specify either `userId` or `userPrincipalName`, but not both. This option is required when using application permissions.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get a specific message using delegated permissions
+
+```sh
+m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA=
+```
+
+Get a specific message using delegated permissions from a shared mailbox
+
+```sh
+m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName sharedmailbox@tenant.com
+```
+
+Get a specific message from a specific user retrieved by user ID using application permissions
+
+```sh
+m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userId 6799fd1a-723b-4eb7-8e52-41ae530274ca
+```
+
+Get a specific message from a specific user retrieved by user principal name using application permissions
+
+```sh
+m365 outlook message get --id AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OABGAAAAAAAiQ8W967B7TKBjgx9rVEURBwAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAAiIsqMbYjsT5e-T7KzowPTAALvuv07AAA= --userPrincipalName user@tenant.com
+```

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

@@ -43,3 +43,32 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
 ```sh
 m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

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

@@ -55,3 +55,32 @@ Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40f
 ```sh
 m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "name": "My Planner Bucket",
+      "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+      "orderHint": "8585363889524958496",
+      "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    id       : ttEB_Uj690STdR3GC1MIDZgANq1U
+    name     : My Planner Bucket
+    orderHint: 8585363889524958496
+    planId   : xqQg5FS2LkCp935s-FIFm2QAFkHM
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

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

@@ -37,3 +37,33 @@ Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Gro
 ```sh
 m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "name": "My Planner Bucket",
+        "planId": "xqQg5FS2LkCp935s-FIFm2QAFkHM",
+        "orderHint": "8585363889524958496",
+        "id": "ttEB_Uj690STdR3GC1MIDZgANq1U"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    id                            name               planId                        orderHint
+    ----------------------------  -----------------  ----------------------------  -------------------
+    ttEB_Uj690STdR3GC1MIDZgANq1U  My Planner Bucket  xqQg5FS2LkCp935s-FIFm2QAFkHM  8585363889524958496
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,name,planId,orderHint
+    ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
+    ```

package/docs/docs/cmd/planner/bucket/bucket-remove.md

@@ -58,3 +58,7 @@ Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_
 ```sh
 m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/planner/bucket/bucket-set.md

@@ -55,3 +55,7 @@ Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ own
 ```sh
 m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
 ```
+
+## Response
+
+The command won't return a response on success.