New command: spo site versionpolicy get. Closes #6750

.devproxy/api-specs/sharepoint.yaml

@@ -79,6 +79,29 @@ paths:
       responses:
         200:
           description: OK
+  /_api/site/VersionPolicyForNewLibrariesTemplate:
+    get:
+      parameters:
+        - name: $expand
+          in: query
+          required: false
+          schema:
+            type: string
+          example: VersionPolicies
+      security:
+        - delegated:
+          - AllSites.Read
+          - AllSites.Write
+          - AllSites.Manage
+          - AllSites.FullControl
+        - application:
+          - Sites.Read.All
+          - Sites.ReadWrite.All
+          - Sites.Manage.All
+          - Sites.FullControl.All
+      responses:
+        200:
+          description: OK
   /_api/web:
     get:
       security:
@@ -119,15 +142,15 @@ paths:
           example: "'19bbfec4-4425-4660-95cb-da1887baa7b9'"
       security:
         - delegated:
-            - AllSites.Read
-            - AllSites.Write
-            - AllSites.Manage
-            - AllSites.FullControl
+          - AllSites.Read
+          - AllSites.Write
+          - AllSites.Manage
+          - AllSites.FullControl
         - application:
-            - Sites.Read.All
-            - Sites.ReadWrite.All
-            - Sites.Manage.All
-            - Sites.FullControl.All
+          - Sites.Read.All
+          - Sites.ReadWrite.All
+          - Sites.Manage.All
+          - Sites.FullControl.All
       responses:
         200:
           description: OK
@@ -148,13 +171,13 @@ paths:
           example: 1030
       security:
         - delegated:
-            - AllSites.Write
-            - AllSites.Manage
-            - AllSites.FullControl
+          - AllSites.Write
+          - AllSites.Manage
+          - AllSites.FullControl
         - application:
-            - Sites.ReadWrite.All
-            - Sites.Manage.All
-            - Sites.FullControl.All
+          - Sites.ReadWrite.All
+          - Sites.Manage.All
+          - Sites.FullControl.All
       responses:
         200:
           description: OK
@@ -281,4 +304,4 @@ paths:
           description: OK
 x-ms-generated-by:
   toolName: Dev Proxy
-  toolVersion: 0.25.0
+  toolVersion: 0.25.0

docs/docs/cmd/spo/site/site-versionpolicy-get.mdx

@@ -0,0 +1,97 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo site versionpolicy get
+
+Retrieves the version policy settings of a specific site.
+
+## Usage
+
+```sh
+m365 spo site versionpolicy get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --siteUrl <siteUrl>`
+: URL of the site.
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource   | Permissions   |
+  |------------|---------------|
+  | SharePoint | AllSites.Read |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource   | Permissions    |
+  |------------|----------------|
+  | SharePoint | Sites.Read.All |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Retrieve the version policy settings of a specific site.
+
+```sh
+m365 spo site versionpolicy get --siteUrl "https://contoso.sharepoint.com/sites/Marketing"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "defaultTrimMode": "automatic",
+    "defaultExpireAfterDays": 30,
+    "majorVersionLimit": 500
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  defaultExpireAfterDays: 30
+  defaultTrimMode       : automatic
+  majorVersionLimit     : 500
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  defaultTrimMode,defaultExpireAfterDays,majorVersionLimit
+  automatic,30,500
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo site versionpolicy get --debug "false" --verbose "false" --siteUrl "https://contoso.sharepoint.com/"
+
+  Date: 8/23/2025
+
+  Property | Value
+  ---------|-------
+  defaultTrimMode | automatic
+  defaultExpireAfterDays | 30
+  majorVersionLimit | 500
+  ```
+
+  </TabItem>
+</Tabs>

docs/src/config/sidebars.ts

@@ -3808,6 +3808,11 @@ const sidebars: SidebarsConfig = {
               type: 'doc',
               label: 'site sharingpermission set',
               id: 'cmd/spo/site/site-sharingpermission-set'
+            },
+            {
+              type: 'doc',
+              label: 'site versionpolicy get',
+              id: 'cmd/spo/site/site-versionpolicy-get'
             }
           ]
         },

src/m365/spo/commands.ts

@@ -286,6 +286,7 @@ export default {
   SITE_RENAME: `${prefix} site rename`,
   SITE_SET: `${prefix} site set`,
   SITE_SHARINGPERMISSION_SET: `${prefix} site sharingpermission set`,
+  SITE_VERSIONPOLICY_GET: `${prefix} site versionpolicy get`,
   SITE_CHROME_SET: `${prefix} site chrome set`,
   SITE_UNARCHIVE: `${prefix} site unarchive`,
   SITEDESIGN_ADD: `${prefix} sitedesign add`,

src/m365/spo/commands/site/site-versionpolicy-get.spec.ts

@@ -0,0 +1,174 @@
+import assert from 'assert';
+import sinon from 'sinon';
+import auth from '../../../../Auth.js';
+import { cli } from '../../../../cli/cli.js';
+import { CommandInfo } from '../../../../cli/CommandInfo.js';
+import { Logger } from '../../../../cli/Logger.js';
+import { CommandError } from '../../../../Command.js';
+import request from '../../../../request.js';
+import { telemetry } from '../../../../telemetry.js';
+import { pid } from '../../../../utils/pid.js';
+import { session } from '../../../../utils/session.js';
+import { sinonUtil } from '../../../../utils/sinonUtil.js';
+import { z } from 'zod';
+import commands from '../../commands.js';
+import command from './site-versionpolicy-get.js';
+
+describe(commands.SITE_VERSIONPOLICY_GET, () => {
+  let log: any[];
+  let logger: Logger;
+  let loggerLogSpy: sinon.SinonSpy;
+  let commandInfo: CommandInfo;
+  let commandOptionsSchema: z.ZodTypeAny;
+  const validSiteUrl = "https://contoso.sharepoint.com";
+
+  before(() => {
+    sinon.stub(auth, 'restoreAuth').resolves();
+    sinon.stub(telemetry, 'trackEvent').resolves();
+    sinon.stub(pid, 'getProcessName').returns('');
+    sinon.stub(session, 'getId').returns('');
+    commandInfo = cli.getCommandInfo(command);
+    commandOptionsSchema = commandInfo.command.getSchemaToParse()!;
+    auth.connection.active = true;
+  });
+
+  beforeEach(() => {
+    log = [];
+    logger = {
+      log: async (msg: string) => {
+        log.push(msg);
+      },
+      logRaw: async (msg: string) => {
+        log.push(msg);
+      },
+      logToStderr: async (msg: string) => {
+        log.push(msg);
+      }
+    };
+    loggerLogSpy = sinon.spy(logger, 'log');
+  });
+
+  afterEach(() => {
+    sinonUtil.restore([
+      request.get
+    ]);
+  });
+
+  after(() => {
+    sinon.restore();
+    auth.connection.active = false;
+  });
+
+  it('has correct name', () => {
+    assert.strictEqual(command.name, commands.SITE_VERSIONPOLICY_GET);
+  });
+
+  it('has a description', () => {
+    assert.notStrictEqual(command.description, null);
+  });
+
+  it('fails validation if site URL is not a valid URL', async () => {
+    const actual = commandOptionsSchema.safeParse({ siteUrl: 'foo' });
+    assert.strictEqual(actual.success, false);
+  });
+
+  it('passes validation if valid site URL is specified', async () => {
+    const actual = commandOptionsSchema.safeParse({ siteUrl: validSiteUrl });
+    assert.strictEqual(actual.success, true);
+  });
+
+  it('retrieves "age" version policy settings for the specified site', async () => {
+    sinon.stub(request, 'get').callsFake(async (opts) => {
+      if (opts.url === `${validSiteUrl}/_api/site/VersionPolicyForNewLibrariesTemplate?$expand=VersionPolicies`) {
+        return {
+          VersionPolicies: {
+            DefaultTrimMode: 1,
+            DefaultExpireAfterDays: 200
+          },
+          MajorVersionLimit: 100
+        };
+      }
+
+      throw 'Invalid request';
+    });
+
+    await command.action(logger, { options: commandOptionsSchema.parse({ siteUrl: validSiteUrl }) });
+    assert(loggerLogSpy.calledWith({
+      defaultTrimMode: 'age',
+      defaultExpireAfterDays: 200,
+      majorVersionLimit: 100
+    }));
+  });
+
+  it('retrieves "automatic" version policy settings for the specified site', async () => {
+    sinon.stub(request, 'get').callsFake(async (opts) => {
+      if (opts.url === `${validSiteUrl}/_api/site/VersionPolicyForNewLibrariesTemplate?$expand=VersionPolicies`) {
+        return {
+          VersionPolicies: {
+            DefaultTrimMode: 2,
+            DefaultExpireAfterDays: 30
+          },
+          MajorVersionLimit: 500
+        };
+      }
+
+      throw 'Invalid request';
+    });
+
+    await command.action(logger, { options: commandOptionsSchema.parse({ siteUrl: validSiteUrl }) });
+    assert(loggerLogSpy.calledWith({
+      defaultTrimMode: 'automatic',
+      defaultExpireAfterDays: 30,
+      majorVersionLimit: 500
+    }));
+  });
+
+  it('retrieves "number" version policy settings for the specified site', async () => {
+    sinon.stub(request, 'get').callsFake(async (opts) => {
+      if (opts.url === `${validSiteUrl}/_api/site/VersionPolicyForNewLibrariesTemplate?$expand=VersionPolicies`) {
+        return {
+          VersionPolicies: {
+            DefaultTrimMode: 0,
+            DefaultExpireAfterDays: 0
+          },
+          MajorVersionLimit: 300
+        };
+      }
+
+      throw 'Invalid request';
+    });
+
+    await command.action(logger, { options: commandOptionsSchema.parse({ siteUrl: validSiteUrl, verbose: true }) });
+    assert(loggerLogSpy.calledWith({
+      defaultTrimMode: 'number',
+      defaultExpireAfterDays: 0,
+      majorVersionLimit: 300
+    }));
+  });
+
+  it('retrieves "inheritTenant" version policy settings for the specified site', async () => {
+    sinon.stub(request, 'get').callsFake(async (opts) => {
+      if (opts.url === `${validSiteUrl}/_api/site/VersionPolicyForNewLibrariesTemplate?$expand=VersionPolicies`) {
+        return {
+          MajorVersionLimit: -1
+        };
+      }
+
+      throw 'Invalid request';
+    });
+
+    await command.action(logger, { options: commandOptionsSchema.parse({ siteUrl: validSiteUrl, verbose: true }) });
+    assert(loggerLogSpy.calledWith({
+      defaultTrimMode: 'inheritTenant',
+      defaultExpireAfterDays: null,
+      majorVersionLimit: -1
+    }));
+  });
+
+  it('correctly handles API OData error', async () => {
+    sinon.stub(request, 'get').rejects(new Error('An error has occurred'));
+
+    await assert.rejects(command.action(logger, { options: commandOptionsSchema.parse({ siteUrl: validSiteUrl }) }),
+      new CommandError('An error has occurred'));
+  });
+});