@pnp/cli-microsoft365 6.1.0-beta.f818fbb → 6.1.0

package/dist/m365/spo/commands/page/page-add.js

@@ -24,6 +24,9 @@ const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 const Page_1 = require("./Page");
+const spoFileGetCommand = require("../file/file-get");
+const spoListItemSetCommand = require("../listitem/listitem-set");
+const Cli_1 = require("../../../../cli/Cli");
 class SpoPageAddCommand extends SpoCommand_1.default {
     get name() {
         return commands_1.default.PAGE_ADD;
@@ -52,12 +55,14 @@ class SpoPageAddCommand extends SpoCommand_1.default {
             const pageTitle = args.options.title ? args.options.title : (args.options.name.indexOf('.aspx') > -1 ? args.options.name.substr(0, args.options.name.indexOf('.aspx')) : args.options.name);
             let pageId = null;
             const pageDescription = args.options.description || "";
+            if (!pageName.endsWith('.aspx')) {
+                pageName += '.aspx';
+            }
+            const listServerRelativeUrl = `${urlUtil_1.urlUtil.getServerRelativeSiteUrl(args.options.webUrl)}/sitepages`;
+            const serverRelativeFileUrl = `${listServerRelativeUrl}/${pageName}`;
             try {
                 const reqDigest = yield spo_1.spo.getRequestDigest(args.options.webUrl);
                 requestDigest = reqDigest.FormDigestValue;
-                if (!pageName.endsWith('.aspx')) {
-                    pageName += '.aspx';
-                }
                 let requestOptions = {
                     url: `${args.options.webUrl}/_api/web/getfolderbyserverrelativeurl('${serverRelativeSiteUrl}/sitepages')/files/AddTemplateFile`,
                     headers: {
@@ -73,32 +78,25 @@ class SpoPageAddCommand extends SpoCommand_1.default {
                 };
                 const template = yield request_1.default.post(requestOptions);
                 itemId = template.UniqueId;
+                const listItemId = yield this.getFileListItemId(args.options.webUrl, serverRelativeFileUrl);
                 const layoutType = args.options.layoutType || 'Article';
-                requestOptions = {
-                    url: `${args.options.webUrl}/_api/web/getfilebyid('${itemId}')/ListItemAllFields`,
-                    headers: {
-                        'X-RequestDigest': requestDigest,
-                        'X-HTTP-Method': 'MERGE',
-                        'IF-MATCH': '*',
-                        'content-type': 'application/json;odata=nometadata',
-                        accept: 'application/json;odata=nometadata'
-                    },
-                    data: {
-                        ContentTypeId: '0x0101009D1CB255DA76424F860D91F20E6C4118',
-                        Title: pageTitle,
-                        ClientSideApplicationId: 'b6917cb1-93a0-4b97-a84d-7cf49975d4ec',
-                        PageLayoutType: layoutType
-                    },
-                    responseType: 'json'
+                const listItemSetOptions = {
+                    webUrl: args.options.webUrl,
+                    listUrl: listServerRelativeUrl,
+                    id: listItemId,
+                    systemUpdate: true,
+                    ContentTypeId: '0x0101009D1CB255DA76424F860D91F20E6C4118',
+                    Title: pageTitle,
+                    ClientSideApplicationId: 'b6917cb1-93a0-4b97-a84d-7cf49975d4ec',
+                    PageLayoutType: layoutType,
+                    verbose: this.verbose,
+                    debug: this.debug
                 };
-                if (layoutType === 'Article') {
-                    requestOptions.data.PromotedState = 0;
-                    requestOptions.data.BannerImageUrl = {
-                        Description: '/_layouts/15/images/sitepagethumbnail.png',
-                        Url: `${resource}/_layouts/15/images/sitepagethumbnail.png`
-                    };
+                if (args.options.layoutType === 'Article') {
+                    listItemSetOptions.PromotedState = 0;
+                    listItemSetOptions.BannerImageUrl = `${resource}/_layouts/15/images/sitepagethumbnail.png, /_layouts/15/images/sitepagethumbnail.png`;
                 }
-                yield request_1.default.post(requestOptions);
+                yield Cli_1.Cli.executeCommand(spoListItemSetCommand, { options: Object.assign(Object.assign({}, listItemSetOptions), { _: [] }) });
                 const pageProps = yield Page_1.Page.checkout(pageName, args.options.webUrl, logger, this.debug, this.verbose);
                 if (pageProps) {
                     pageId = pageProps.Id;
@@ -123,58 +121,43 @@ class SpoPageAddCommand extends SpoCommand_1.default {
                             requestOptions.data = {
                                 WelcomePage: `SitePages/${pageName}`
                             };
+                            yield request_1.default.post(requestOptions);
                             break;
                         case 'NewsPage':
-                            requestOptions.url = `${args.options.webUrl}/_api/web/getfilebyid('${itemId}')/ListItemAllFields`;
-                            requestOptions.headers = {
-                                'X-RequestDigest': requestDigest,
-                                'X-HTTP-Method': 'MERGE',
-                                'IF-MATCH': '*',
-                                'content-type': 'application/json;odata=nometadata',
-                                accept: 'application/json;odata=nometadata'
-                            };
-                            requestOptions.data = {
+                            const listItemSetOptions = {
+                                webUrl: args.options.webUrl,
+                                listUrl: listServerRelativeUrl,
+                                id: listItemId,
+                                systemUpdate: true,
                                 PromotedState: 2,
-                                FirstPublishedDate: new Date().toISOString().replace('Z', '')
+                                FirstPublishedDate: new Date().toISOString(),
+                                verbose: this.verbose,
+                                debug: this.debug
                             };
+                            yield Cli_1.Cli.executeCommand(spoListItemSetCommand, { options: Object.assign(Object.assign({}, listItemSetOptions), { _: [] }) });
                             break;
                         case 'Template':
-                            requestOptions.url = `${args.options.webUrl}/_api/web/getfilebyid('${itemId}')/ListItemAllFields`;
+                            requestOptions.url = `${args.options.webUrl}/_api/SitePages/Pages(${listItemId})/SavePageAsTemplate`;
                             requestOptions.headers = {
-                                'X-RequestDigest': requestDigest,
-                                'content-type': 'application/json;odata=nometadata',
-                                accept: 'application/json;odata=nometadata'
-                            };
-                            break;
-                    }
-                    const res = yield request_1.default.post(requestOptions);
-                    if (args.options.promoteAs === 'Template') {
-                        let requestOptions = {
-                            responseType: 'json',
-                            url: `${args.options.webUrl}/_api/SitePages/Pages(${res.Id})/SavePageAsTemplate`,
-                            headers: {
                                 'X-RequestDigest': requestDigest,
                                 'content-type': 'application/json;odata=nometadata',
                                 'X-HTTP-Method': 'POST',
                                 'IF-MATCH': '*',
                                 accept: 'application/json;odata=nometadata'
-                            }
-                        };
-                        const tmpl = yield request_1.default.post(requestOptions);
-                        bannerImageUrl = tmpl.BannerImageUrl;
-                        canvasContent1 = tmpl.CanvasContent1;
-                        layoutWebpartsContent = tmpl.LayoutWebpartsContent;
-                        pageId = tmpl.Id;
-                        requestOptions = {
-                            url: `${args.options.webUrl}/_api/web/getfilebyid('${tmpl.UniqueId}')/ListItemAllFields/SetCommentsDisabled(${!args.options.commentsEnabled})`,
-                            headers: {
+                            };
+                            const tmpl = yield request_1.default.post(requestOptions);
+                            bannerImageUrl = tmpl.BannerImageUrl;
+                            canvasContent1 = tmpl.CanvasContent1;
+                            layoutWebpartsContent = tmpl.LayoutWebpartsContent;
+                            pageId = tmpl.Id;
+                            requestOptions.url = `${args.options.webUrl}/_api/web/getfilebyid('${tmpl.UniqueId}')/ListItemAllFields/SetCommentsDisabled(${!args.options.commentsEnabled})`;
+                            requestOptions.headers = {
                                 'X-RequestDigest': requestDigest,
                                 'content-type': 'application/json;odata=nometadata',
                                 accept: 'application/json;odata=nometadata'
-                            },
-                            responseType: 'json'
-                        };
-                        yield request_1.default.post(requestOptions);
+                            };
+                            yield request_1.default.post(requestOptions);
+                            break;
                     }
                 }
                 requestOptions = {
@@ -263,6 +246,20 @@ class SpoPageAddCommand extends SpoCommand_1.default {
             }
         });
     }
+    getFileListItemId(webUrl, serverRelativeFileUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fileGetOptions = {
+                webUrl: webUrl,
+                url: serverRelativeFileUrl,
+                asListItem: true,
+                verbose: this.verbose,
+                debug: this.debug
+            };
+            const fileGetOutput = yield Cli_1.Cli.executeCommandWithOutput(spoFileGetCommand, { options: Object.assign(Object.assign({}, fileGetOptions), { _: [] }) });
+            const fileGetOutputJson = JSON.parse(fileGetOutput.stdout);
+            return fileGetOutputJson.Id;
+        });
+    }
 }
 _SpoPageAddCommand_instances = new WeakSet(), _SpoPageAddCommand_initTelemetry = function _SpoPageAddCommand_initTelemetry() {
     this.telemetry.push((args) => {

package/dist/m365/spo/commands/page/page-set.js

@@ -77,28 +77,21 @@ class SpoPageSetCommand extends SpoCommand_1.default {
                     authorByline = page.AuthorByline;
                 }
                 if (args.options.layoutType) {
-                    const requestOptions = {
-                        url: `${args.options.webUrl}/_api/web/getfilebyserverrelativeurl('${serverRelativeFileUrl}')/ListItemAllFields`,
-                        headers: {
-                            'X-RequestDigest': requestDigest,
-                            'content-type': 'application/json;odata=nometadata',
-                            'X-HTTP-Method': 'MERGE',
-                            'IF-MATCH': '*',
-                            accept: 'application/json;odata=nometadata'
-                        },
-                        data: {
-                            PageLayoutType: args.options.layoutType
-                        },
-                        responseType: 'json'
+                    const itemId = yield this.getFileListItemId(args.options.webUrl, serverRelativeFileUrl);
+                    const listItemSetOptions = {
+                        webUrl: args.options.webUrl,
+                        listUrl: listServerRelativeUrl,
+                        id: itemId,
+                        systemUpdate: true,
+                        PageLayoutType: args.options.layoutType,
+                        verbose: this.verbose,
+                        debug: this.debug
                     };
                     if (args.options.layoutType === 'Article') {
-                        requestOptions.data.PromotedState = 0;
-                        requestOptions.data.BannerImageUrl = {
-                            Description: '/_layouts/15/images/sitepagethumbnail.png',
-                            Url: `${resource}/_layouts/15/images/sitepagethumbnail.png`
-                        };
+                        listItemSetOptions.PromotedState = 0;
+                        listItemSetOptions.BannerImageUrl = `${resource}/_layouts/15/images/sitepagethumbnail.png, /_layouts/15/images/sitepagethumbnail.png`;
                     }
-                    yield request_1.default.post(requestOptions);
+                    yield Cli_1.Cli.executeCommand(spoListItemSetCommand, { options: Object.assign(Object.assign({}, listItemSetOptions), { _: [] }) });
                 }
                 if (args.options.promoteAs) {
                     const requestOptions = {
@@ -117,60 +110,50 @@ class SpoPageSetCommand extends SpoCommand_1.default {
                             requestOptions.data = {
                                 WelcomePage: `SitePages/${pageName}`
                             };
+                            yield request_1.default.post(requestOptions);
                             break;
                         case 'NewsPage':
-                            requestOptions.url = `${args.options.webUrl}/_api/web/getfilebyserverrelativeurl('${serverRelativeFileUrl}')/ListItemAllFields`;
-                            requestOptions.headers = {
-                                'X-RequestDigest': requestDigest,
-                                'X-HTTP-Method': 'MERGE',
-                                'IF-MATCH': '*',
-                                'content-type': 'application/json;odata=nometadata',
-                                accept: 'application/json;odata=nometadata'
-                            };
-                            requestOptions.data = {
+                            const newsPageItemId = yield this.getFileListItemId(args.options.webUrl, serverRelativeFileUrl);
+                            const listItemSetOptions = {
+                                webUrl: args.options.webUrl,
+                                listUrl: listServerRelativeUrl,
+                                id: newsPageItemId,
+                                systemUpdate: true,
                                 PromotedState: 2,
-                                FirstPublishedDate: new Date().toISOString().replace('Z', '')
+                                FirstPublishedDate: new Date().toISOString(),
+                                verbose: this.verbose,
+                                debug: this.debug
                             };
+                            yield Cli_1.Cli.executeCommand(spoListItemSetCommand, { options: Object.assign(Object.assign({}, listItemSetOptions), { _: [] }) });
                             break;
                         case 'Template':
-                            requestOptions.url = `${args.options.webUrl}/_api/web/getfilebyserverrelativeurl('${serverRelativeFileUrl}')/ListItemAllFields`;
+                            const templateItemId = yield this.getFileListItemId(args.options.webUrl, serverRelativeFileUrl);
                             requestOptions.headers = {
-                                'X-RequestDigest': requestDigest,
-                                'content-type': 'application/json;odata=nometadata',
-                                accept: 'application/json;odata=nometadata'
-                            };
-                            break;
-                    }
-                    const pageRes = yield request_1.default.post(requestOptions);
-                    if (args.options.promoteAs === 'Template') {
-                        const requestOptions = {
-                            responseType: 'json',
-                            url: `${args.options.webUrl}/_api/SitePages/Pages(${pageRes.Id})/SavePageAsTemplate`,
-                            headers: {
                                 'X-RequestDigest': requestDigest,
                                 'content-type': 'application/json;odata=nometadata',
                                 'X-HTTP-Method': 'POST',
                                 'IF-MATCH': '*',
                                 accept: 'application/json;odata=nometadata'
+                            };
+                            requestOptions.url = `${args.options.webUrl}/_api/SitePages/Pages(${templateItemId})/SavePageAsTemplate`;
+                            const res = yield request_1.default.post(requestOptions);
+                            if (fileNameWithoutExtension) {
+                                pageData.Title = fileNameWithoutExtension;
+                            }
+                            if (pageDescription) {
+                                pageData.Description = pageDescription;
                             }
-                        };
-                        const res = yield request_1.default.post(requestOptions);
-                        if (fileNameWithoutExtension) {
-                            pageData.Title = fileNameWithoutExtension;
-                        }
-                        if (pageDescription) {
-                            pageData.Description = pageDescription;
-                        }
-                        if (res.BannerImageUrl) {
-                            pageData.BannerImageUrl = res.BannerImageUrl;
-                        }
-                        if (res.LayoutWebpartsContent) {
-                            pageData.LayoutWebpartsContent = res.LayoutWebpartsContent;
-                        }
-                        if (res.CanvasContent1) {
-                            pageData.CanvasContent1 = res.CanvasContent1;
-                        }
-                        pageId = res.Id;
+                            if (res.BannerImageUrl) {
+                                pageData.BannerImageUrl = res.BannerImageUrl;
+                            }
+                            if (res.LayoutWebpartsContent) {
+                                pageData.LayoutWebpartsContent = res.LayoutWebpartsContent;
+                            }
+                            if (res.CanvasContent1) {
+                                pageData.CanvasContent1 = res.CanvasContent1;
+                            }
+                            pageId = res.Id;
+                            break;
                     }
                 }
                 if (args.options.promoteAs !== 'Template') {
@@ -239,19 +222,11 @@ class SpoPageSetCommand extends SpoCommand_1.default {
                     yield request_1.default.post(requestOptions);
                 }
                 if (args.options.demoteFrom === 'NewsPage') {
-                    const fileGetOptions = {
-                        webUrl: args.options.webUrl,
-                        url: serverRelativeFileUrl,
-                        asListItem: true,
-                        verbose: this.verbose,
-                        debug: this.debug
-                    };
-                    const fileGetOutput = yield Cli_1.Cli.executeCommandWithOutput(spoFileGetCommand, { options: Object.assign(Object.assign({}, fileGetOptions), { _: [] }) });
-                    const fileGetOutputJson = JSON.parse(fileGetOutput.stdout);
+                    const fileId = yield this.getFileListItemId(args.options.webUrl, serverRelativeFileUrl);
                     const listItemSetOptions = {
                         webUrl: args.options.webUrl,
                         listUrl: listServerRelativeUrl,
-                        id: fileGetOutputJson.Id,
+                        id: fileId,
                         systemUpdate: true,
                         PromotedState: 0,
                         verbose: this.verbose,
@@ -292,6 +267,20 @@ class SpoPageSetCommand extends SpoCommand_1.default {
             }
         });
     }
+    getFileListItemId(webUrl, serverRelativeFileUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fileGetOptions = {
+                webUrl: webUrl,
+                url: serverRelativeFileUrl,
+                asListItem: true,
+                verbose: this.verbose,
+                debug: this.debug
+            };
+            const fileGetOutput = yield Cli_1.Cli.executeCommandWithOutput(spoFileGetCommand, { options: Object.assign(Object.assign({}, fileGetOptions), { _: [] }) });
+            const fileGetOutputJson = JSON.parse(fileGetOutput.stdout);
+            return fileGetOutputJson.Id;
+        });
+    }
 }
 _SpoPageSetCommand_instances = new WeakSet(), _SpoPageSetCommand_initTelemetry = function _SpoPageSetCommand_initTelemetry() {
     this.telemetry.push((args) => {

package/dist/m365/spo/commands/site/site-appcatalog-list.js

@@ -0,0 +1,43 @@
+"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 });
+const odata_1 = require("../../../../utils/odata");
+const spo_1 = require("../../../../utils/spo");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoSiteAppCatalogListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.SITE_APPCATALOG_LIST;
+    }
+    get description() {
+        return 'List all site collection app catalogs within the tenant';
+    }
+    defaultProperties() {
+        return ['AbsoluteUrl', 'SiteID'];
+    }
+    commandAction(logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (this.verbose) {
+                    logger.logToStderr('Retrieving site collection app catalogs...');
+                }
+                const spoUrl = yield spo_1.spo.getSpoUrl(logger, this.debug);
+                const appCatalogs = yield odata_1.odata.getAllItems(`${spoUrl}/_api/Web/TenantAppCatalog/SiteCollectionAppCatalogsSites`);
+                logger.log(appCatalogs);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+}
+module.exports = new SpoSiteAppCatalogListCommand();
+//# sourceMappingURL=site-appcatalog-list.js.map

package/dist/m365/spo/commands.js

@@ -115,8 +115,8 @@ exports.default = {
     LIST_LABEL_SET: `${prefix} list label set`,
     LIST_LIST: `${prefix} list list`,
     LIST_REMOVE: `${prefix} list remove`,
+    LIST_RETENTIONLABEL_ENSURE: `${prefix} list retentionlabel ensure`,
     LIST_RETENTIONLABEL_GET: `${prefix} list retentionlabel get`,
-    LIST_RETENTIONLABEL_SET: `${prefix} list retentionlabel set`,
     LIST_ROLEASSIGNMENT_REMOVE: `${prefix} list roleassignment remove`,
     LIST_ROLEASSIGNMENT_ADD: `${prefix} list roleassignment add`,
     LIST_ROLEINHERITANCE_BREAK: `${prefix} list roleinheritance break`,
@@ -145,6 +145,7 @@ exports.default = {
     LISTITEM_RECORD_DECLARE: `${prefix} listitem record declare`,
     LISTITEM_RECORD_UNDECLARE: `${prefix} listitem record undeclare`,
     LISTITEM_REMOVE: `${prefix} listitem remove`,
+    LISTITEM_RETENTIONLABEL_REMOVE: `${prefix} listitem retentionlabel remove`,
     LISTITEM_ROLEASSIGNMENT_ADD: `${prefix} listitem roleassignment add`,
     LISTITEM_ROLEASSIGNMENT_REMOVE: `${prefix} listitem roleassignment remove`,
     LISTITEM_ROLEINHERITANCE_BREAK: `${prefix} listitem roleinheritance break`,
@@ -206,6 +207,7 @@ exports.default = {
     SET: `${prefix} set`,
     SITE_ADD: `${prefix} site add`,
     SITE_APPCATALOG_ADD: `${prefix} site appcatalog add`,
+    SITE_APPCATALOG_LIST: `${prefix} site appcatalog list`,
     SITE_APPCATALOG_REMOVE: `${prefix} site appcatalog remove`,
     SITE_APPPERMISSION_ADD: `${prefix} site apppermission add`,
     SITE_APPPERMISSION_GET: `${prefix} site apppermission get`,

package/dist/request.js

@@ -61,7 +61,8 @@ class Request {
         this.req = axios_1.default.create({
             headers: {
                 'user-agent': `NONISV|SharePointPnP|CLIMicrosoft365/${packageJSON.version}`,
-                'accept-encoding': 'gzip, deflate'
+                'accept-encoding': 'gzip, deflate',
+                'X-ClientService-ClientTag': `M365CLI:${packageJSON.version}`
             },
             decompress: true,
             responseType: 'text',

package/dist/utils/pid.js

@@ -1,13 +1,18 @@
 "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 fs = require("fs");
+const os = require("os");
 const cache_1 = require("./cache");
 function getProcessNameOnMacOs(pid) {
-    const stdout = (0, child_process_1.execSync)(`ps -o comm= ${pid}`, { encoding: 'utf8' });
-    return stdout.trim();
+    const res = (0, child_process_1.spawnSync)('ps', ['-o', 'comm=', pid.toString()], { encoding: 'utf8' });
+    if (res.error || res.stderr) {
+        return undefined;
+    }
+    else {
+        return res.stdout.trim();
+    }
 }
 function getProcessNameOnLinux(pid) {
     if (!fs.existsSync(`/proc/${pid}/stat`)) {
@@ -19,8 +24,24 @@ function getProcessNameOnLinux(pid) {
     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();
+    const findProcess = (0, child_process_1.spawnSync)('wmic', ['PROCESS', 'where', `ProcessId=${pid}`, 'get', 'Caption'], { encoding: 'utf8' });
+    if (findProcess.error || findProcess.stderr) {
+        return undefined;
+    }
+    else {
+        const getPid = (0, child_process_1.spawnSync)('find', ['/V', '"Caption"'], {
+            encoding: 'utf8',
+            input: findProcess.stdout,
+            // must include or passing quoted "Caption" will fail
+            windowsVerbatimArguments: true
+        });
+        if (getPid.error || getPid.stderr) {
+            return undefined;
+        }
+        else {
+            return getPid.stdout.trim();
+        }
+    }
 }
 exports.pid = {
     getProcessName(pid) {
@@ -40,16 +61,11 @@ exports.pid = {
             getPidName = getProcessNameOnLinux;
         }
         if (getPidName) {
-            try {
-                processName = getPidName(pid);
-                if (processName) {
-                    cache_1.cache.setValue(pid.toString(), processName);
-                }
-                return processName;
-            }
-            catch (_a) {
-                return undefined;
+            processName = getPidName(pid);
+            if (processName) {
+                cache_1.cache.setValue(pid.toString(), processName);
             }
+            return processName;
         }
         return undefined;
     }

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

@@ -0,0 +1,127 @@
+# aad group get
+
+Gets information about the specified Azure AD Group
+
+## Usage
+
+```sh
+m365 aad group get [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: The object Id of the Azure AD group. Specify either `id` or `title` but not both
+
+`-t, --title [title]`
+: The display name of the Azure AD group. Specify either `id` or `title` but not both
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get information about an Azure AD Group by id
+
+```sh
+m365 aad group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
+```
+
+Get information about an Azure AD Group by title
+
+```sh
+m365 aad group get --title "Finance"
+```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "id": "c541afac-508e-40c7-8880-5a601b41737b",
+      "deletedDateTime": null,
+      "classification": null,
+      "createdDateTime": "2022-11-13T19:16:32Z",
+      "creationOptions": [
+        "YammerProvisioning"
+      ],
+      "description": "This is the default group for everyone in the network",
+      "displayName": "All Company",
+      "expirationDateTime": null,
+      "groupTypes": [
+        "Unified"
+      ],
+      "isAssignableToRole": null,
+      "mail": "allcompany@contoso.onmicrosoft.com",
+      "mailEnabled": true,
+      "mailNickname": "allcompany",
+      "membershipRule": null,
+      "membershipRuleProcessingState": null,
+      "onPremisesDomainName": null,
+      "onPremisesLastSyncDateTime": null,
+      "onPremisesNetBiosName": null,
+      "onPremisesSamAccountName": null,
+      "onPremisesSecurityIdentifier": null,
+      "onPremisesSyncEnabled": null,
+      "preferredDataLocation": null,
+      "preferredLanguage": null,
+      "proxyAddresses": [
+        "SPO:SPO_c3e7794d-0726-49ac-805b-2d6b0edaefdc@SPO_44744d00-3da0-45e5-9e28-da5ab48c61ac",
+        "SMTP:allcompany@contoso.onmicrosoft.com"
+      ],
+      "renewedDateTime": "2022-11-13T19:16:32Z",
+      "resourceBehaviorOptions": [
+        "CalendarMemberReadOnly"
+      ],
+      "resourceProvisioningOptions": [],
+      "securityEnabled": false,
+      "securityIdentifier": "S-1-12-1-4076547856-1079300050-1399127439-2879739702",
+      "theme": null,
+      "visibility": "Public",
+      "onPremisesProvisioningErrors": []
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    classification               : null
+    createdDateTime              : 2022-11-13T19:16:32Z
+    creationOptions              : ["YammerProvisioning"]
+    deletedDateTime              : null
+    description                  : This is the default group for everyone in the network
+    displayName                  : All Company
+    expirationDateTime           : null
+    groupTypes                   : ["Unified"]
+    id                           : c541afac-508e-40c7-8880-5a601b41737b
+    isAssignableToRole           : null
+    mail                         : allcompany@contoso.onmicrosoft.com
+    mailEnabled                  : true
+    mailNickname                 : allcompany
+    membershipRule               : null
+    membershipRuleProcessingState: null
+    onPremisesDomainName         : null
+    onPremisesLastSyncDateTime   : null
+    onPremisesNetBiosName        : null
+    onPremisesProvisioningErrors : []
+    onPremisesSamAccountName     : null
+    onPremisesSecurityIdentifier : null
+    onPremisesSyncEnabled        : null
+    preferredDataLocation        : null
+    preferredLanguage            : null
+    proxyAddresses               : ["SPO:SPO_c3e7794d-0726-49ac-805b-2d6b0edaefdc@SPO_44744d00-3da0-45e5-9e28-da5ab48c61ac","SMTP:allcompany@contoso.onmicrosoft.com"]
+    renewedDateTime              : 2022-11-13T19:16:32Z
+    resourceBehaviorOptions      : ["CalendarMemberReadOnly"]
+    resourceProvisioningOptions  : []
+    securityEnabled              : false
+    securityIdentifier           : S-1-12-1-4076547856-1079300050-1399127439-2879739702
+    theme                        : null
+    visibility                   : Public
+    ```
+
+=== "CSV"
+
+    ```csv
+    id,deletedDateTime,classification,createdDateTime,creationOptions,description,displayName,expirationDateTime,groupTypes,isAssignableToRole,mail,mailEnabled,mailNickname,membershipRule,membershipRuleProcessingState,onPremisesDomainName,onPremisesLastSyncDateTime,onPremisesNetBiosName,onPremisesSamAccountName,onPremisesSecurityIdentifier,onPremisesSyncEnabled,preferredDataLocation,preferredLanguage,proxyAddresses,renewedDateTime,resourceBehaviorOptions,resourceProvisioningOptions,securityEnabled,securityIdentifier,theme,visibility,onPremisesProvisioningErrors
+    c541afac-508e-40c7-8880-5a601b41737b,,,2022-11-13T19:16:32Z,"[""YammerProvisioning""]",This is the default group for everyone in the network,All Company,,"[""Unified""]",,allcompany@contoso.onmicrosoft.com,1,allcompany,,,,,,,,,,,"[""SPO:SPO_c3e7794d-0726-49ac-805b-2d6b0edaefdc@SPO_44744d00-3da0-45e5-9e28-da5ab48c61ac"",""SMTP:allcompany@contoso.onmicrosoft.com""]",2022-11-13T19:16:32Z,"[""CalendarMemberReadOnly""]",[],,S-1-12-1-4076547856-1079300050-1399127439-2879739702,,Public,[]
+    ```