@pnp/cli-microsoft365 7.10.0-beta.172f827 → 7.10.0-beta.ebb7426

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

@@ -430,33 +430,35 @@ class SpoSiteSetCommand extends SpoCommand {
 _SpoSiteSetCommand_instances = new WeakSet(), _SpoSiteSetCommand_initTelemetry = function _SpoSiteSetCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            classification: typeof args.options.classification === 'string',
-            disableFlows: args.options.disableFlows,
-            socialBarOnSitePagesDisabled: args.options.socialBarOnSitePagesDisabled,
-            isPublic: args.options.isPublic,
+            classification: typeof args.options.classification !== 'undefined',
+            disableFlows: !!args.options.disableFlows,
+            socialBarOnSitePagesDisabled: !!args.options.socialBarOnSitePagesDisabled,
+            isPublic: !!args.options.isPublic,
             owners: typeof args.options.owners !== 'undefined',
-            shareByEmailEnabled: args.options.shareByEmailEnabled,
-            title: typeof args.options.title === 'string',
-            description: typeof args.options.description === 'string',
-            siteDesignId: typeof args.options.siteDesignId !== undefined,
-            sharingCapabilities: args.options.sharingCapability,
+            shareByEmailEnabled: !!args.options.shareByEmailEnabled,
+            title: typeof args.options.title !== 'undefined',
+            description: typeof args.options.description !== 'undefined',
+            siteDesignId: typeof args.options.siteDesignId !== 'undefined',
+            sharingCapabilities: typeof args.options.sharingCapability !== 'undefined',
             siteLogoUrl: typeof args.options.siteLogoUrl !== 'undefined',
             siteThumbnailUrl: typeof args.options.siteThumbnailUrl !== 'undefined',
-            resourceQuota: args.options.resourceQuota,
-            resourceQuotaWarningLevel: args.options.resourceQuotaWarningLevel,
-            storageQuota: args.options.storageQuota,
-            storageQuotaWarningLevel: args.options.storageQuotaWarningLevel,
-            allowSelfServiceUpgrade: args.options.allowSelfServiceUpgrade,
-            lockState: args.options.lockState,
-            noScriptSite: args.options.noScriptSite,
-            wait: args.options.wait === true
+            resourceQuota: typeof args.options.resourceQuota !== 'undefined',
+            resourceQuotaWarningLevel: typeof args.options.resourceQuotaWarningLevel !== 'undefined',
+            storageQuota: typeof args.options.storageQuota !== 'undefined',
+            storageQuotaWarningLevel: typeof args.options.storageQuotaWarningLevel !== 'undefined',
+            allowSelfServiceUpgrade: !!args.options.allowSelfServiceUpgrade,
+            lockState: typeof args.options.lockState !== 'undefined',
+            noScriptSite: !!args.options.noScriptSite,
+            wait: !!args.options.wait
         });
     });
 }, _SpoSiteSetCommand_initOptions = function _SpoSiteSetCommand_initOptions() {
     this.options.unshift({
         option: '-u, --url <url>'
     }, {
-        option: '-i, --id [id]'
+        option: '-t, --title [title]'
+    }, {
+        option: '-d, --description [description]'
     }, {
         option: '--classification [classification]'
     }, {
@@ -476,16 +478,12 @@ _SpoSiteSetCommand_instances = new WeakSet(), _SpoSiteSetCommand_initTelemetry =
     }, {
         option: '--siteDesignId [siteDesignId]'
     }, {
-        option: '--title [title]'
-    }, {
-        option: '--description [description]'
+        option: '--sharingCapability [sharingCapability]',
+        autocomplete: this.sharingCapabilities
     }, {
         option: '--siteLogoUrl [siteLogoUrl]'
     }, {
         option: '--siteThumbnailUrl [siteThumbnailUrl]'
-    }, {
-        option: '--sharingCapability [sharingCapability]',
-        autocomplete: this.sharingCapabilities
     }, {
         option: '--resourceQuota [resourceQuota]'
     }, {

package/dist/m365/spo/commands/tenant/tenant-site-archive.js

@@ -0,0 +1,99 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoTenantSiteArchiveCommand_instances, _SpoTenantSiteArchiveCommand_initTelemetry, _SpoTenantSiteArchiveCommand_initOptions, _SpoTenantSiteArchiveCommand_initValidators, _SpoTenantSiteArchiveCommand_initTypes;
+import { cli } from '../../../../cli/cli.js';
+import config from '../../../../config.js';
+import request from '../../../../request.js';
+import { validation } from '../../../../utils/validation.js';
+import { spo } from '../../../../utils/spo.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+class SpoTenantSiteArchiveCommand extends SpoCommand {
+    get name() {
+        return commands.TENANT_SITE_ARCHIVE;
+    }
+    get description() {
+        return 'Archives a site collection';
+    }
+    constructor() {
+        super();
+        _SpoTenantSiteArchiveCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteArchiveCommand_instances, "m", _SpoTenantSiteArchiveCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteArchiveCommand_instances, "m", _SpoTenantSiteArchiveCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteArchiveCommand_instances, "m", _SpoTenantSiteArchiveCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteArchiveCommand_instances, "m", _SpoTenantSiteArchiveCommand_initTypes).call(this);
+    }
+    async commandAction(logger, args) {
+        const archiveSite = async () => {
+            try {
+                if (this.verbose) {
+                    await logger.logToStderr(`Archiving site ${args.options.url}...`);
+                }
+                const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.verbose);
+                const reqDigest = await spo.getRequestDigest(spoAdminUrl);
+                const requestOptions = {
+                    url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+                    headers: {
+                        'X-RequestDigest': reqDigest.FormDigestValue
+                    },
+                    data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009">
+                  <Actions>
+                    <ObjectPath Id="2" ObjectPathId="1" />
+                    <ObjectPath Id="4" ObjectPathId="3" />
+                    <Query Id="5" ObjectPathId="3">
+                      <Query SelectAllProperties="true">
+                        <Properties />
+                      </Query>
+                    </Query>
+                  </Actions>
+                  <ObjectPaths>
+                    <Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" />
+                    <Method Id="3" ParentId="1" Name="ArchiveSiteByUrl">
+                      <Parameters>
+                        <Parameter Type="String">${args.options.url}</Parameter>
+                      </Parameters>
+                    </Method>
+                  </ObjectPaths>
+                  </Request>`
+                };
+                const res = await request.post(requestOptions);
+                const json = JSON.parse(res);
+                const response = json[0];
+                if (response.ErrorInfo) {
+                    throw response.ErrorInfo.ErrorMessage;
+                }
+            }
+            catch (err) {
+                this.handleRejectedPromise(err);
+            }
+        };
+        if (args.options.force) {
+            await archiveSite();
+        }
+        else {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to archive site '${args.options.url}'?` });
+            if (result) {
+                await archiveSite();
+            }
+        }
+    }
+}
+_SpoTenantSiteArchiveCommand_instances = new WeakSet(), _SpoTenantSiteArchiveCommand_initTelemetry = function _SpoTenantSiteArchiveCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            force: !!args.options.force
+        });
+    });
+}, _SpoTenantSiteArchiveCommand_initOptions = function _SpoTenantSiteArchiveCommand_initOptions() {
+    this.options.unshift({ option: '-u, --url <url>' }, { option: '-f, --force' });
+}, _SpoTenantSiteArchiveCommand_initValidators = function _SpoTenantSiteArchiveCommand_initValidators() {
+    this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.url));
+}, _SpoTenantSiteArchiveCommand_initTypes = function _SpoTenantSiteArchiveCommand_initTypes() {
+    this.types.string.push('url');
+    this.types.boolean.push('force');
+};
+export default new SpoTenantSiteArchiveCommand();
+//# sourceMappingURL=tenant-site-archive.js.map

package/dist/m365/spo/commands/tenant/tenant-site-unarchive.js

@@ -0,0 +1,98 @@
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoTenantSiteUnarchiveCommand_instances, _SpoTenantSiteUnarchiveCommand_initTelemetry, _SpoTenantSiteUnarchiveCommand_initOptions, _SpoTenantSiteUnarchiveCommand_initValidators, _SpoTenantSiteUnarchiveCommand_initTypes;
+import { cli } from '../../../../cli/cli.js';
+import config from '../../../../config.js';
+import request from '../../../../request.js';
+import { spo } from '../../../../utils/spo.js';
+import { validation } from '../../../../utils/validation.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+class SpoTenantSiteUnarchiveCommand extends SpoCommand {
+    get name() {
+        return commands.TENANT_SITE_UNARCHIVE;
+    }
+    get description() {
+        return 'Unarchives a site collection';
+    }
+    constructor() {
+        super();
+        _SpoTenantSiteUnarchiveCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteUnarchiveCommand_instances, "m", _SpoTenantSiteUnarchiveCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteUnarchiveCommand_instances, "m", _SpoTenantSiteUnarchiveCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteUnarchiveCommand_instances, "m", _SpoTenantSiteUnarchiveCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoTenantSiteUnarchiveCommand_instances, "m", _SpoTenantSiteUnarchiveCommand_initTypes).call(this);
+    }
+    async commandAction(logger, args) {
+        if (args.options.force) {
+            await this.unarchiveSite(logger, args.options.url);
+        }
+        else {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to unarchive site '${args.options.url}'? This may cause additional billing costs.` });
+            if (result) {
+                await this.unarchiveSite(logger, args.options.url);
+            }
+        }
+    }
+    async unarchiveSite(logger, url) {
+        if (this.verbose) {
+            await logger.logToStderr(`Unarchiving site '${url}'...`);
+        }
+        try {
+            const adminCenterUrl = await spo.getSpoAdminUrl(logger, this.verbose);
+            const requestDigest = await spo.getRequestDigest(adminCenterUrl);
+            const requestOptions = {
+                url: `${adminCenterUrl}/_vti_bin/client.svc/ProcessQuery`,
+                headers: {
+                    'X-RequestDigest': requestDigest.FormDigestValue
+                },
+                data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009">
+                <Actions>
+                  <ObjectPath Id="2" ObjectPathId="1" />
+                  <ObjectPath Id="4" ObjectPathId="3" />
+                </Actions>
+                <ObjectPaths>
+                  <Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" />
+                  <Method Id="3" ParentId="1" Name="UnarchiveSiteByUrl">
+                    <Parameters>
+                      <Parameter Type="String">${url}</Parameter>
+                    </Parameters>
+                  </Method>
+                </ObjectPaths>
+              </Request>`
+            };
+            const response = await request.post(requestOptions);
+            const json = JSON.parse(response);
+            const responseContent = json[0];
+            if (responseContent.ErrorInfo) {
+                throw responseContent.ErrorInfo.ErrorMessage;
+            }
+        }
+        catch (err) {
+            this.handleRejectedPromise(err);
+        }
+    }
+}
+_SpoTenantSiteUnarchiveCommand_instances = new WeakSet(), _SpoTenantSiteUnarchiveCommand_initTelemetry = function _SpoTenantSiteUnarchiveCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            force: !!args.options.force
+        });
+    });
+}, _SpoTenantSiteUnarchiveCommand_initOptions = function _SpoTenantSiteUnarchiveCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --url <url>'
+    }, {
+        option: '-f, --force'
+    });
+}, _SpoTenantSiteUnarchiveCommand_initValidators = function _SpoTenantSiteUnarchiveCommand_initValidators() {
+    this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.url));
+}, _SpoTenantSiteUnarchiveCommand_initTypes = function _SpoTenantSiteUnarchiveCommand_initTypes() {
+    this.types.string.push('url');
+    this.types.boolean.push('force');
+};
+export default new SpoTenantSiteUnarchiveCommand();
+//# sourceMappingURL=tenant-site-unarchive.js.map

package/dist/m365/spo/commands.js

@@ -312,6 +312,8 @@ export default {
     TENANT_RECYCLEBINITEM_RESTORE: `${prefix} tenant recyclebinitem restore`,
     TENANT_SETTINGS_LIST: `${prefix} tenant settings list`,
     TENANT_SETTINGS_SET: `${prefix} tenant settings set`,
+    TENANT_SITE_ARCHIVE: `${prefix} tenant site archive`,
+    TENANT_SITE_UNARCHIVE: `${prefix} tenant site unarchive`,
     TERM_ADD: `${prefix} term add`,
     TERM_GET: `${prefix} term get`,
     TERM_LIST: `${prefix} term list`,

package/docs/docs/cmd/spo/tenant/tenant-site-archive.mdx

@@ -0,0 +1,63 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo tenant site archive
+
+Archives a site collection
+
+## Usage
+
+```sh
+m365 spo tenant site archive [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: URL of the site collection.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command, you must be a Global or SharePoint administrator.
+
+:::
+
+:::note
+
+After running this command, it may take a few minutes for the site to be fully archived.
+
+:::
+
+
+## Examples
+
+Archive a specific SharePoint site collection
+
+```sh
+m365 spo tenant site archive --url "https://contoso.sharepoint.com/sites/Marketing"
+```
+
+Archive a specific SharePoint site collection without confirmation prompt
+
+```sh
+m365 spo tenant site archive --url "https://contoso.sharepoint.com/sites/Marketing" --force
+```
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+- Pricing model for Microsoft 365 Archive: [https://learn.microsoft.com/microsoft-365/archive/archive-pricing](https://learn.microsoft.com/microsoft-365/archive/archive-pricing)
+- Set up Microsoft 365 Archive: [https://learn.microsoft.com/microsoft-365/archive/archive-setup](https://learn.microsoft.com/microsoft-365/archive/archive-setup)

package/docs/docs/cmd/spo/tenant/tenant-site-unarchive.mdx

@@ -0,0 +1,67 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo tenant site unarchive
+
+Unarchives a site collection
+
+## Usage
+
+```sh
+m365 spo tenant site unarchive [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: URL of the site collection.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command, you must be a Global or SharePoint administrator.
+
+:::
+
+:::warning
+
+If a site remains archived for more than **seven days**, the reactivation fee will be calculated based on the entire storage capacity of the site.
+
+:::
+
+:::note
+
+After running this command, it may take a few minutes for the site to be fully restored.
+
+:::
+
+## Examples
+
+Unarchive a specific site collection.
+
+```sh
+m365 spo tenant site unarchive --url "https://contoso.sharepoint.com/sites/Marketing"
+```
+
+Unarchive a specific site collection without confirmation prompt.
+
+```sh
+m365 spo tenant site unarchive --url "https://contoso.sharepoint.com/sites/Marketing" --force
+```
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+- Pricing model for Microsoft 365 Archive: [https://learn.microsoft.com/microsoft-365/archive/archive-pricing](https://learn.microsoft.com/microsoft-365/archive/archive-pricing)