azure-devops-extension-api 4.255.1 → 4.256.0

package/Management/Management.d.ts

@@ -1,61 +1,4 @@
 import * as WebApi from "../WebApi/WebApi";
-export interface AdvSecEnablementFeatures {
-    /**
-     * Auto enablement of AdvSec for new projects or repos will be enabled when set to true and will be unchanged when set to false.
-     */
-    autoEnableNewProjectOrRepos: boolean;
-    /**
-     * CodeQL enablement status set to False when disabled and True when enabled; Null is never explicitly set.
-     */
-    codeQLEnabled: boolean;
-    /**
-     * 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.
-     */
-    dependabotEnabled: boolean;
-    /**
-     * Dependency Scanning Injection enablement status set to False when disabled and True when enabled; Null is never explicitly set. \<br /\> If Advanced Security is NOT already enabled, behavior will depend on if Advanced Security is to be enabled/disabled. DependencyScanningInjectionEnabled will not affect anything in this scenario. \<br /\> If Advanced Security is to be disabled, the value of DependencyScanningInjectionEnabled will have no effect. \<br /\> Setting Dependency Scanning enablement state is only supported for repo enablement and not org or project enablement at this time.
-     */
-    dependencyScanningInjectionEnabled: 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.
-     */
-    forceRepoSecretScanning: boolean;
-}
-export interface AdvSecEnablementSettings {
-    /**
-     * Automatically enable Advanced Security on newly created repositories.
-     */
-    enableOnCreate: boolean;
-    reposEnablementStatus: AdvSecEnablementStatus[];
-}
-export interface AdvSecEnablementSettingsUpdate extends AdvSecEnablementStatusUpdate {
-    /**
-     * Automatically enable Advanced Security on newly created repositories.
-     */
-    enableOnCreate: boolean;
-}
-export interface AdvSecEnablementStatus extends AdvSecEnablementStatusUpdate {
-    /**
-     * The last time the status of Advanced Security for this repository was updated
-     */
-    advSecEnablementLastChangedDate: Date;
-    projectId: string;
-    repositoryId: string;
-}
-export interface AdvSecEnablementStatusUpdate {
-    /**
-     * Advanced Security enablement status set to False when disabled and True when enabled; Null is never explicitly set.
-     */
-    advSecEnabled: boolean;
-    /**
-     * Includes additional features that can be enabled alongside Advanced Security.
-     */
-    advSecEnablementFeatures: AdvSecEnablementFeatures;
-    /**
-     * 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;
-}
 /**
  * Billable Committers Details for Advanced Security Services
  */
@@ -179,52 +122,6 @@ export interface EnablementOnCreateSettings {
      */
     enableSecretProtectionOnCreate: boolean;
 }
-/**
- * Information related to billing for Advanced Security services
- */
-export interface MeterUsage {
-    /**
-     * The Azure DevOps account
-     */
-    accountId: string;
-    azureSubscriptionId: string;
-    /**
-     * Deprecated - use BilledCommittersIdentities instead A list of Cuids for the commiters to the repositories that have Advanced Security features enabled
-     */
-    billedCommitters: string[];
-    /**
-     * A list of BilledCommitter objects that contain the identityRef of committers that have AdvSec enabled
-     */
-    billedUsers: BilledCommitter[];
-    /**
-     * 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
-     */
-    isAdvSecBillable: boolean;
-    /**
-     * 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
-     */
-    tenantId: string;
-    /**
-     * The number of commiters to repositories that have Advanced Security features enabled
-     */
-    uniqueCommitterCount: number;
-}
 /**
  * Information related to meter usage estimate for Code Security plan and/or Secret Protection plan
  */

package/Management/ManagementClient.d.ts

@@ -3,185 +3,86 @@ import { RestClientBase } from "../Common/RestClientBase";
 import * as Management from "../Management/Management";
 export declare class ManagementRestClient extends RestClientBase {
     constructor(options: IVssRestClientOptions);
-    /**
-     * 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
-     * @param includeAllProperties - When true, will also determine if pushes are blocked when secrets are detected
-     */
-    getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<Management.RepoEnablementSettings>;
-    /**
-     * 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
-     * @param repository - Name or ID of the repository
-     */
-    updateRepoAdvSecEnablementStatus2(savedAdvSecEnablementStatus: Management.RepoEnablementSettings, project: string, repository: string): Promise<void>;
-    /**
-     * 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 -
-     */
-    createBillingSnapshot(meterUsage: Management.MeterUsage): Promise<void>;
-    /**
-     * Get all billable committers details, including those not matched with a VSID.
-     *
-     * @param billingDate - The date to query, or if not provided, today
-     */
-    getBillableCommitterDetails(billingDate?: Date): Promise<Management.BillableCommitterDetails[]>;
-    /**
-     */
-    getLastMeterUsage(): Promise<Management.MeterUsage>;
-    /**
-     * Get commiters used when calculating billing information.
-     *
-     * @param billingDate - The date to query, or if not provided, today
-     */
-    getMeterUsage(billingDate?: Date): Promise<Management.MeterUsage>;
     /**
      * 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.MeterUsageForPlan, plan: Management.Plan): Promise<void>;
+    createBillingSnapshot3(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(plan: Management.Plan, billingDate?: Date): Promise<Management.BillableCommitterDetails[]>;
+    getBillableCommitterDetails3(plan: Management.Plan, billingDate?: Date): Promise<Management.BillableCommitterDetails[]>;
     /**
      * @param plan -
      */
-    getLastMeterUsage2(plan: Management.Plan): Promise<Management.MeterUsageForPlan>;
+    getLastMeterUsage3(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(plan: Management.Plan, billingDate?: Date): Promise<Management.MeterUsageForPlan>;
-    /**
-     * Get the current status of Advanced Security for the organization
-     *
-     * @param includeAllProperties - When true, also determine if pushes are blocked if they contain secrets
-     */
-    getOrgEnablementStatus(includeAllProperties?: boolean): Promise<Management.AdvSecEnablementSettings>;
-    /**
-     * Update the status of Advanced Security for the organization
-     *
-     * @param savedAdvSecEnablementStatus - The new status
-     */
-    updateOrgEnablementStatus(savedAdvSecEnablementStatus: Management.AdvSecEnablementSettingsUpdate): Promise<void>;
+    getMeterUsage3(plan: Management.Plan, billingDate?: Date): Promise<Management.MeterUsageForPlan>;
     /**
      * Get the current status of Advanced Security for the organization
      *
      * @param includeAllProperties - When true, also determine if pushes are blocked if they contain secrets
      */
-    getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<Management.OrgEnablementSettings>;
+    getOrgEnablementStatus3(includeAllProperties?: boolean): Promise<Management.OrgEnablementSettings>;
     /**
      * Update the status of Advanced Security for the organization
      *
      * @param orgEnablementSettings - The new status
      */
-    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.
-     *
-     */
-    getEstimatedBillablePushersDetailsForOrg(): Promise<Management.BilledCommitter[]>;
-    /**
-     * Estimate the committers that would be added to the customer's usage if Advanced Security was enabled for this organization.
-     *
-     */
-    getEstimatedOrgBillablePushers(): Promise<string[]>;
+    updateOrgEnablementStatus3(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.
      *
      * @param plan - The plan to query.
      */
-    getEstimatedBillablePushersDetailsForOrg2(plan: Management.Plan): Promise<Management.MeterUsageEstimate>;
-    /**
-     * Get the current status of Advanced Security for a project
-     *
-     * @param project - Project ID or project name
-     * @param includeAllProperties - When true, also determine if pushes are blocked if they contain secrets
-     */
-    getProjectEnablementStatus(project: string, includeAllProperties?: boolean): Promise<Management.AdvSecEnablementSettings>;
-    /**
-     * Update the status of Advanced Security for the project
-     *
-     * @param savedAdvSecEnablementStatus - The new status
-     * @param project - Project ID or project name
-     */
-    updateProjectEnablementStatus(savedAdvSecEnablementStatus: Management.AdvSecEnablementSettingsUpdate, project: string): Promise<void>;
+    getEstimatedBillablePushersDetailsForOrg3(plan: Management.Plan): Promise<Management.MeterUsageEstimate>;
     /**
      * Get the current status of Advanced Security for a project
      *
      * @param project - Project ID or project name
      * @param includeAllProperties - When true, also determine if pushes are blocked if they contain secrets
      */
-    getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<Management.ProjectEnablementSettings>;
+    getProjectEnablementStatus3(project: string, includeAllProperties?: boolean): Promise<Management.ProjectEnablementSettings>;
     /**
      * Update the status of Advanced Security for the project
      *
      * @param projectEnablementSettings - The new status
      * @param project - Project ID or project name
      */
-    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.
-     *
-     * @param project - Project ID or project name
-     */
-    getEstimatedBillablePushersDetailsForProject(project: string): Promise<Management.BilledCommitter[]>;
-    /**
-     * 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
-     */
-    getEstimatedBillablePushersForProject(project: string): Promise<string[]>;
+    updateProjectEnablementStatus3(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.
      *
      * @param project - Project ID or project name
      * @param plan -
      */
-    getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Management.Plan): Promise<Management.MeterUsageEstimate>;
+    getEstimatedBillablePushersDetailsForProject3(project: string, plan?: Management.Plan): Promise<Management.MeterUsageEstimate>;
     /**
-     * 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
      * @param includeAllProperties - When true, will also determine if pushes are blocked when secrets are detected
      */
-    getRepoEnablementStatus(project: string, repository: string, includeAllProperties?: boolean): Promise<Management.AdvSecEnablementStatus>;
+    getRepoEnablementStatus3(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
      * @param repository - Name or ID of the repository
      */
-    updateRepoAdvSecEnablementStatus(savedAdvSecEnablementStatus: Management.AdvSecEnablementStatusUpdate, project: string, repository: string): Promise<void>;
-    /**
-     * 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 -
-     */
-    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
-     */
-    getEstimatedBillableCommittersForRepo(project: string, repository: string): Promise<string[]>;
+    updateRepoAdvSecEnablementStatus3(savedAdvSecEnablementStatus: Management.RepoEnablementSettings, project: string, repository: string): Promise<void>;
     /**
      * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this repository.
      *
@@ -189,5 +90,5 @@ export declare class ManagementRestClient extends RestClientBase {
      * @param repository - The name or ID of the repository
      * @param plan - The plan to query.
      */
-    getEstimatedRepoBillableCommittersDetails2(project: string, repository: string, plan?: Management.Plan): Promise<Management.MeterUsageEstimate>;
+    getEstimatedBillableCommittersDetailsForRepo3(project: string, repository: string, plan?: Management.Plan): Promise<Management.MeterUsageEstimate>;
 }