azure-devops-extension-api 4.253.0 → 4.255.1

package/Management/Management.d.ts

@@ -143,11 +143,23 @@ export interface BilledCommittersList {
      */
     uniqueCommitterCount: number;
 }
-export interface CodeScanningFeatures {
+export interface CodeSecurityFeatures {
     /**
      * CodeQL enablement status set to False when disabled and True when enabled; Null is never explicitly set.
      */
     codeQLEnabled: boolean;
+    /**
+     * The VSID of the last user who modified the enablement status of Code Security.
+     */
+    codeSecurityChangedBy: string;
+    /**
+     * Code Security enablement status set to False when disabled and True when enabled; Null is never explicitly set.
+     */
+    codeSecurityEnabled: boolean;
+    /**
+     * The last time the status of Code Security for this repository was updated
+     */
+    codeSecurityEnablementLastChangedDate: Date;
     /**
      * Dependabot enablement status set to False when disabled and True when enabled; Null is never explicitly set. \<br /\>When true, Dependabot will open PRs to support security updates for outdated dependencies. \<br /\>Setting Dependabot enablement state is only supported for repo enablement and not org or project enablement at this time.
      */
@@ -157,18 +169,15 @@ export interface CodeScanningFeatures {
      */
     dependencyScanningInjectionEnabled: boolean;
 }
-/**
- * Information related to Code Scanning meter usage
- */
-export interface CodeScanningMeterUsage {
+export interface EnablementOnCreateSettings {
     /**
-     * The identityRef of committers that contributed to repositories with Code Scanning enabled
+     * Automatically enable Code Security on newly created repositories.
      */
-    codeScanningBilledUsers: BilledCommittersList;
+    enableCodeSecurityOnCreate: boolean;
     /**
-     * True when Code Scanning plan is enabled in this organization
+     * Automatically enable Secret Protection on newly created repositories.
      */
-    isCodeScanningEnabled: boolean;
+    enableSecretProtectionOnCreate: boolean;
 }
 /**
  * Information related to billing for Advanced Security services
@@ -191,6 +200,10 @@ export interface MeterUsage {
      * The date this billing information pertains to
      */
     billingDate: Date;
+    /**
+     * A list of BilledCommitter objects that contain the identityRef of committers that have Code Security Plan enabled. This list is populated only for organizations that can enable or disable the Code Security Plan.
+     */
+    codeSecurityBilledUsers: BilledCommitter[];
     /**
      * True when a bill is generated for Advanced Security feature usage in this organziation
      */
@@ -199,6 +212,10 @@ export interface MeterUsage {
      * True when Advanced Security features are enabled in this organization
      */
     isAdvSecEnabled: boolean;
+    /**
+     * A list of BilledCommitter objects that contain the identityRef of committers that have Secret Protection Plan enabled. This list is populated only for organizations that can enable or disable the Secret Protection Plan.
+     */
+    secretProtectionBilledUsers: BilledCommitter[];
     /**
      * The Azure subscription
      */
@@ -209,39 +226,39 @@ export interface MeterUsage {
     uniqueCommitterCount: number;
 }
 /**
- * Information related to meter usage estimate for Code Scanning and Secret Scanning
+ * Information related to meter usage estimate for Code Security plan and/or Secret Protection plan
  */
 export interface MeterUsageEstimate {
     /**
-     * Meter usage estimate when enabling Code Scanning
+     * Meter usage estimate when enabling Code Security plan
      */
-    codeScanningMeterUsageEstimate: BilledCommittersList;
+    codeSecurityMeterUsageEstimate: BilledCommittersList;
     /**
-     * Meter usage estimate when enabling Secret Scanning
+     * Meter usage estimate when enabling Secret Protection plan
      */
-    secretScanningMeterUsageEstimate: BilledCommittersList;
+    secretProtectionMeterUsageEstimate: BilledCommittersList;
 }
 /**
- * Information related to billing for Advanced Security services
+ * Information related to meter usage for a Scanning plan
  */
-export interface MeterUsageSummary {
+export interface MeterUsageForPlan {
     /**
      * The Azure DevOps account
      */
     accountId: string;
     azureSubscriptionId: string;
     /**
-     * The date this billing information pertains to
+     * The identityRef of committers that contributed to repositories with Scanning plan enabled
      */
-    billingDate: Date;
+    billedUsers: BilledCommittersList;
     /**
-     * Billing Information of repositories where Code Scanning is enabled
+     * The date this billing information pertains to
      */
-    codeScanningMeterUsage: CodeScanningMeterUsage;
+    billingDate: Date;
     /**
-     * Billing Information of repositories where Secret Scanning is enabled
+     * True when the Scanning plan is enabled in this organization
      */
-    secretScanningMeterUsage: SecretScanningMeterUsage;
+    isPlanEnabled: boolean;
     /**
      * The Azure subscription
      */
@@ -249,77 +266,63 @@ export interface MeterUsageSummary {
 }
 export interface OrgEnablementSettings {
     /**
-     * Code Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
-     */
-    codeScanningEnabled: boolean;
-    /**
-     * Includes code scanning features that can be enabled.
-     */
-    codeScanningFeatures: CodeScanningFeatures;
-    /**
-     * Automatically enable Code Scanning on newly created repositories.
+     * Includes code security features that can be enabled.
      */
-    enableCodeScanningOnCreate: boolean;
+    codeSecurityFeatures: CodeSecurityFeatures;
     /**
-     * Automatically enable Secret Scanning on newly created repositories.
+     * Auto enablement setting for newly created repositories.
      */
-    enableSecretScanningOnCreate: boolean;
+    enablementOnCreateSettings: EnablementOnCreateSettings;
     /**
-     * A list of enablement statuses for repositories within the specified organization.
+     * A list of enablement statuses for repositories within the specified organization or project.
      */
     reposEnablementStatus: RepoEnablementSettings[];
     /**
-     * Secret Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
+     * Includes secret protection features that can be enabled.
      */
-    secretScanningEnabled: boolean;
+    secretProtectionFeatures: SecretProtectionFeatures;
+}
+export declare enum Plan {
     /**
-     * Includes secret scanning features that can be enabled.
+     * No plan is indicated
      */
-    secretScanningFeatures: SecretScanningFeatures;
-}
-export interface ProjectEnablementSettings {
+    None = 0,
     /**
-     * Code Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
+     * The Code Security plan
      */
-    codeScanningEnabled: boolean;
+    CodeSecurity = 1,
     /**
-     * Includes code scanning features that can be enabled.
+     * The Secret Protection plan
      */
-    codeScanningFeatures: CodeScanningFeatures;
+    SecretProtection = 2,
     /**
-     * Automatically enable Code Scanning on newly created repositories.
+     * Include all plans
      */
-    enableCodeScanningOnCreate: boolean;
+    All = 3
+}
+export interface ProjectEnablementSettings {
     /**
-     * Automatically enable Secret Scanning on newly created repositories.
+     * Includes code security features that can be enabled.
      */
-    enableSecretScanningOnCreate: boolean;
+    codeSecurityFeatures: CodeSecurityFeatures;
     /**
-     * A list of enablement statuses for repositories within the specified project.
+     * Auto enablement setting for newly created repositories.
      */
-    reposEnablementStatus: RepoEnablementSettings[];
+    enablementOnCreateSettings: EnablementOnCreateSettings;
     /**
-     * Secret Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
+     * A list of enablement statuses for repositories within the specified organization or project.
      */
-    secretScanningEnabled: boolean;
+    reposEnablementStatus: RepoEnablementSettings[];
     /**
-     * Includes secret scanning features that can be enabled.
+     * Includes secret protection features that can be enabled.
      */
-    secretScanningFeatures: SecretScanningFeatures;
+    secretProtectionFeatures: SecretProtectionFeatures;
 }
 export interface RepoEnablementSettings {
     /**
-     * Code Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
-     */
-    codeScanningEnabled: boolean;
-    /**
-     * The last time the status of Code Scanning for this repository was updated
-     */
-    codeScanningEnablementLastChangedDate: Date;
-    /**
-     * Includes code scanning features that can be enabled.
+     * Includes Code Security features that can be enabled.
      */
-    codeScanningFeatures: CodeScanningFeatures;
+    codeSecurityFeatures: CodeSecurityFeatures;
     /**
      * Indicates whether the repository is part of the bundled SKU (old billing plan) or unbundled SKUs (new billing plan).
      */
@@ -333,38 +336,25 @@ export interface RepoEnablementSettings {
      */
     repositoryId: string;
     /**
-     * Secret Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
-     */
-    secretScanningEnabled: boolean;
-    /**
-     * The last time the status of Secret Scanning for this repository was updated
-     */
-    secretScanningEnablementLastChangedDate: Date;
-    /**
-     * Includes secret scanning features that can be enabled.
+     * Includes Secret Protection features that can be enabled.
      */
-    secretScanningFeatures: SecretScanningFeatures;
+    secretProtectionFeatures: SecretProtectionFeatures;
 }
-export interface SecretScanningFeatures {
+export interface SecretProtectionFeatures {
     /**
      * When true, pushes containing secrets will be blocked. \<br /\>When false, pushes are scanned for secrets and are not blocked. \<br /\>If includeAllProperties in the request is false, this value will be null.
      */
     blockPushes: boolean;
     /**
-     * ForceRepoSecretScanning will be set to true when Enabled, false when Disabled, and null when not set. \<br /\> If GHAzDO is NOT already enabled, behavior will depend on if GHAzDO is to be enabled/disabled. ForceRepoSecretScanning will not affect anything in this scenario. \<br /\> If GHAzDO is to be disabled, the value of ForceRepoSecretScan will have no effect. \<br /\> If GHAzDO is to be enabled for the first time on a repo, then ForceRepoSecretScanning will have no effect. \<br /\> If GHAzDO is to be enabled and the repo is already enabled, then ForceRepoSecretScanning will force the secret scanning job to be run if it is set to true. \<br /\> In all cases where ForceRepoSecretScanning is not expected to affect behavior, it will be set to false before being sent to Tfs.
+     * The VSID of the last user who modified the enablement status of Secret Protection.
      */
-    forceRepoSecretScanning: boolean;
-}
-/**
- * Information related to Secret Scanning meter usage
- */
-export interface SecretScanningMeterUsage {
+    secretProtectionChangedBy: string;
     /**
-     * True when Secret Scanning plan is enabled in this organization
+     * Secret Protection enablement status set to False when disabled and True when enabled; Null is never explicitly set.
      */
-    isSecretScanningEnabled: boolean;
+    secretProtectionEnabled: boolean;
     /**
-     * The identityRef of committers that contributed to repositories with Secret Scanning enabled
+     * The last time the status of Secret Protection for this repository was updated
      */
-    secretScanningBilledUsers: BilledCommittersList;
+    secretProtectionEnablementLastChangedDate: Date;
 }

package/Management/Management.js

@@ -6,4 +6,23 @@
 define(["require", "exports"], function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
+    var Plan;
+    (function (Plan) {
+        /**
+         * No plan is indicated
+         */
+        Plan[Plan["None"] = 0] = "None";
+        /**
+         * The Code Security plan
+         */
+        Plan[Plan["CodeSecurity"] = 1] = "CodeSecurity";
+        /**
+         * The Secret Protection plan
+         */
+        Plan[Plan["SecretProtection"] = 2] = "SecretProtection";
+        /**
+         * Include all plans
+         */
+        Plan[Plan["All"] = 3] = "All";
+    })(Plan = exports.Plan || (exports.Plan = {}));
 });

package/Management/Management.min.js

@@ -1 +1 @@
-define(["require","exports"],function(e,r){"use strict";Object.defineProperty(r,"__esModule",{value:!0})});
+define(["require","exports"],function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0});!function(e){e[e.None=0]="None",e[e.CodeSecurity=1]="CodeSecurity",e[e.SecretProtection=2]="SecretProtection",e[e.All=3]="All"}(t.Plan||(t.Plan={}))});

package/Management/ManagementClient.d.ts

@@ -4,7 +4,7 @@ import * as Management from "../Management/Management";
 export declare class ManagementRestClient extends RestClientBase {
     constructor(options: IVssRestClientOptions);
     /**
-     * Determine if Advanced Security is enabled for a repository
+     * Determines if Code Security, Secret Protection, and their features are enabled for the repository.
      *
      * @param project - Project ID or project name
      * @param repository - The name or ID of the repository
@@ -12,7 +12,7 @@ export declare class ManagementRestClient extends RestClientBase {
      */
     getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<Management.RepoEnablementSettings>;
     /**
-     * Update the enablement of Advanced Security for a repository
+     * Update the enablement status of Code Security and Secret Protection, along with their respective features, for a given repository.
      *
      * @param savedAdvSecEnablementStatus - new status
      * @param project - Project ID or project name
@@ -44,23 +44,27 @@ export declare class ManagementRestClient extends RestClientBase {
      * During multi-org billing computation in primary scale unit(EUS21), this API is used to create billing snapshot for a specific org. Primary scale unit will call this API for each org in different scsle units to create billing snapshot. Data will be stored in the org specific partition DB -\> billing snapshot table. This is needed as customers will fetch billing data from their org specific partition DB.
      *
      * @param meterUsage -
+     * @param plan -
      */
-    createBillingSnapshot2(meterUsage: Management.MeterUsageSummary): Promise<void>;
+    createBillingSnapshot2(meterUsage: Management.MeterUsageForPlan, plan: Management.Plan): Promise<void>;
     /**
      * Get all billable committers details, including those not matched with a VSID.
      *
+     * @param plan - The plan to query. Plans supported: CodeSecurity and SecretProtection. This is a mandatory parameter.
      * @param billingDate - The date to query, or if not provided, today
      */
-    getBillableCommitterDetails2(billingDate?: Date): Promise<Management.BillableCommitterDetails[]>;
+    getBillableCommitterDetails2(plan: Management.Plan, billingDate?: Date): Promise<Management.BillableCommitterDetails[]>;
     /**
+     * @param plan -
      */
-    getLastMeterUsage2(): Promise<Management.MeterUsageSummary>;
+    getLastMeterUsage2(plan: Management.Plan): Promise<Management.MeterUsageForPlan>;
     /**
      * Get commiters used when calculating billing information.
      *
+     * @param plan - The plan to query. Plans supported: CodeSecurity and SecretProtection. This is a mandatory parameter.
      * @param billingDate - The date to query, or if not provided, today
      */
-    getMeterUsage2(billingDate?: Date): Promise<Management.MeterUsageSummary>;
+    getMeterUsage2(plan: Management.Plan, billingDate?: Date): Promise<Management.MeterUsageForPlan>;
     /**
      * Get the current status of Advanced Security for the organization
      *
@@ -82,9 +86,9 @@ export declare class ManagementRestClient extends RestClientBase {
     /**
      * Update the status of Advanced Security for the organization
      *
-     * @param savedAdvSecEnablementStatus - The new status
+     * @param orgEnablementSettings - The new status
      */
-    updateOrgEnablementStatus2(savedAdvSecEnablementStatus: Management.OrgEnablementSettings): Promise<void>;
+    updateOrgEnablementStatus2(orgEnablementSettings: Management.OrgEnablementSettings): Promise<void>;
     /**
      * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization.
      *
@@ -98,13 +102,9 @@ export declare class ManagementRestClient extends RestClientBase {
     /**
      * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization.
      *
+     * @param plan - The plan to query.
      */
-    getEstimatedBillablePushersDetailsForOrg2(): Promise<Management.MeterUsageEstimate>;
-    /**
-     * Estimate the committers that would be added to the customer's usage if Advanced Security was enabled for this organization.
-     *
-     */
-    getEstimatedOrgBillablePushers2(): Promise<string[]>;
+    getEstimatedBillablePushersDetailsForOrg2(plan: Management.Plan): Promise<Management.MeterUsageEstimate>;
     /**
      * Get the current status of Advanced Security for a project
      *
@@ -129,10 +129,10 @@ export declare class ManagementRestClient extends RestClientBase {
     /**
      * Update the status of Advanced Security for the project
      *
-     * @param savedAdvSecEnablementStatus - The new status
+     * @param projectEnablementSettings - The new status
      * @param project - Project ID or project name
      */
-    updateProjectEnablementStatus2(savedAdvSecEnablementStatus: Management.ProjectEnablementSettings, project: string): Promise<void>;
+    updateProjectEnablementStatus2(projectEnablementSettings: Management.ProjectEnablementSettings, project: string): Promise<void>;
     /**
      * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this project.
      *
@@ -144,19 +144,14 @@ export declare class ManagementRestClient extends RestClientBase {
      *
      * @param project - Project ID or project name
      */
-    getEstimatedProjectBillablePushers(project: string): Promise<string[]>;
+    getEstimatedBillablePushersForProject(project: string): Promise<string[]>;
     /**
      * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this project.
      *
      * @param project - Project ID or project name
+     * @param plan -
      */
-    getEstimatedBillablePushersDetailsForProject2(project: string): Promise<Management.MeterUsageEstimate>;
-    /**
-     * Estimate the number of committers that would be added to the customer's usage if Advanced Security was enabled for this project.
-     *
-     * @param project - Project ID or project name
-     */
-    getEstimatedProjectBillablePushers2(project: string): Promise<string[]>;
+    getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Management.Plan): Promise<Management.MeterUsageEstimate>;
     /**
      * Determine if Advanced Security is enabled for a repository
      *
@@ -177,28 +172,22 @@ export declare class ManagementRestClient extends RestClientBase {
      * Estimate the committers that would be added to the customer's usage if Advanced Security was enabled for this repository.
      *
      * @param project - Project ID or project name
-     * @param repository - The name or ID of the repository
-     */
-    getEstimatedRepoBillableCommitters(project: string, repository: string): Promise<string[]>;
-    /**
-     * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this repository.
-     *
-     * @param project - Project ID or project name
      * @param repository -
      */
-    getEstimatedRepoBillablePushersDetails(project: string, repository: string): Promise<Management.BilledCommitter[]>;
+    getEstimatedBillableCommitersDetailsForRepo(project: string, repository: string): Promise<Management.BilledCommitter[]>;
     /**
      * Estimate the committers that would be added to the customer's usage if Advanced Security was enabled for this repository.
      *
      * @param project - Project ID or project name
      * @param repository - The name or ID of the repository
      */
-    getEstimatedRepoBillableCommitters2(project: string, repository: string): Promise<string[]>;
+    getEstimatedBillableCommittersForRepo(project: string, repository: string): Promise<string[]>;
     /**
      * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this repository.
      *
      * @param project - Project ID or project name
-     * @param repository -
+     * @param repository - The name or ID of the repository
+     * @param plan - The plan to query.
      */
-    getEstimatedRepoBillableCommittersDetails2(project: string, repository: string): Promise<Management.MeterUsageEstimate>;
+    getEstimatedRepoBillableCommittersDetails2(project: string, repository: string, plan?: Management.Plan): Promise<Management.MeterUsageEstimate>;
 }