azure-devops-extension-api 4.251.0 → 4.253.0

package/Management/Management.d.ts

@@ -130,6 +130,46 @@ export interface BilledCommitter {
      */
     userIdentity: WebApi.IdentityRef;
 }
+/**
+ * A list of billed committers
+ */
+export interface BilledCommittersList {
+    /**
+     * A list of BilledCommitter objects that contain the identityRef of committers.
+     */
+    billedUsers: BilledCommitter[];
+    /**
+     * Count of billed committers in BilledUsers
+     */
+    uniqueCommitterCount: number;
+}
+export interface CodeScanningFeatures {
+    /**
+     * 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;
+}
+/**
+ * Information related to Code Scanning meter usage
+ */
+export interface CodeScanningMeterUsage {
+    /**
+     * The identityRef of committers that contributed to repositories with Code Scanning enabled
+     */
+    codeScanningBilledUsers: BilledCommittersList;
+    /**
+     * True when Code Scanning plan is enabled in this organization
+     */
+    isCodeScanningEnabled: boolean;
+}
 /**
  * Information related to billing for Advanced Security services
  */
@@ -168,3 +208,163 @@ export interface MeterUsage {
      */
     uniqueCommitterCount: number;
 }
+/**
+ * Information related to meter usage estimate for Code Scanning and Secret Scanning
+ */
+export interface MeterUsageEstimate {
+    /**
+     * Meter usage estimate when enabling Code Scanning
+     */
+    codeScanningMeterUsageEstimate: BilledCommittersList;
+    /**
+     * Meter usage estimate when enabling Secret Scanning
+     */
+    secretScanningMeterUsageEstimate: BilledCommittersList;
+}
+/**
+ * Information related to billing for Advanced Security services
+ */
+export interface MeterUsageSummary {
+    /**
+     * The Azure DevOps account
+     */
+    accountId: string;
+    azureSubscriptionId: string;
+    /**
+     * The date this billing information pertains to
+     */
+    billingDate: Date;
+    /**
+     * Billing Information of repositories where Code Scanning is enabled
+     */
+    codeScanningMeterUsage: CodeScanningMeterUsage;
+    /**
+     * Billing Information of repositories where Secret Scanning is enabled
+     */
+    secretScanningMeterUsage: SecretScanningMeterUsage;
+    /**
+     * The Azure subscription
+     */
+    tenantId: string;
+}
+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.
+     */
+    enableCodeScanningOnCreate: boolean;
+    /**
+     * Automatically enable Secret Scanning on newly created repositories.
+     */
+    enableSecretScanningOnCreate: boolean;
+    /**
+     * A list of enablement statuses for repositories within the specified organization.
+     */
+    reposEnablementStatus: RepoEnablementSettings[];
+    /**
+     * Secret Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
+     */
+    secretScanningEnabled: boolean;
+    /**
+     * Includes secret scanning features that can be enabled.
+     */
+    secretScanningFeatures: SecretScanningFeatures;
+}
+export interface ProjectEnablementSettings {
+    /**
+     * 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.
+     */
+    enableCodeScanningOnCreate: boolean;
+    /**
+     * Automatically enable Secret Scanning on newly created repositories.
+     */
+    enableSecretScanningOnCreate: boolean;
+    /**
+     * A list of enablement statuses for repositories within the specified project.
+     */
+    reposEnablementStatus: RepoEnablementSettings[];
+    /**
+     * Secret Scan enablement status set to False when disabled and True when enabled; Null is never explicitly set.
+     */
+    secretScanningEnabled: boolean;
+    /**
+     * Includes secret scanning features that can be enabled.
+     */
+    secretScanningFeatures: SecretScanningFeatures;
+}
+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.
+     */
+    codeScanningFeatures: CodeScanningFeatures;
+    /**
+     * Indicates whether the repository is part of the bundled SKU (old billing plan) or unbundled SKUs (new billing plan).
+     */
+    isBundledSKU: boolean;
+    /**
+     * The project Id
+     */
+    projectId: string;
+    /**
+     * The repository Id
+     */
+    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.
+     */
+    secretScanningFeatures: SecretScanningFeatures;
+}
+export interface SecretScanningFeatures {
+    /**
+     * 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.
+     */
+    forceRepoSecretScanning: boolean;
+}
+/**
+ * Information related to Secret Scanning meter usage
+ */
+export interface SecretScanningMeterUsage {
+    /**
+     * True when Secret Scanning plan is enabled in this organization
+     */
+    isSecretScanningEnabled: boolean;
+    /**
+     * The identityRef of committers that contributed to repositories with Secret Scanning enabled
+     */
+    secretScanningBilledUsers: BilledCommittersList;
+}

package/Management/ManagementClient.d.ts

@@ -3,6 +3,22 @@ import { RestClientBase } from "../Common/RestClientBase";
 import * as Management from "../Management/Management";
 export declare class ManagementRestClient extends RestClientBase {
     constructor(options: IVssRestClientOptions);
+    /**
+     * Determine if Advanced Security is enabled for a 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 of Advanced Security for a 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.
      *
@@ -24,6 +40,27 @@ export declare class ManagementRestClient extends RestClientBase {
      * @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 -
+     */
+    createBillingSnapshot2(meterUsage: Management.MeterUsageSummary): 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
+     */
+    getBillableCommitterDetails2(billingDate?: Date): Promise<Management.BillableCommitterDetails[]>;
+    /**
+     */
+    getLastMeterUsage2(): Promise<Management.MeterUsageSummary>;
+    /**
+     * Get commiters used when calculating billing information.
+     *
+     * @param billingDate - The date to query, or if not provided, today
+     */
+    getMeterUsage2(billingDate?: Date): Promise<Management.MeterUsageSummary>;
     /**
      * Get the current status of Advanced Security for the organization
      *
@@ -36,6 +73,18 @@ export declare class ManagementRestClient extends RestClientBase {
      * @param savedAdvSecEnablementStatus - The new status
      */
     updateOrgEnablementStatus(savedAdvSecEnablementStatus: Management.AdvSecEnablementSettingsUpdate): Promise<void>;
+    /**
+     * 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>;
+    /**
+     * Update the status of Advanced Security for the organization
+     *
+     * @param savedAdvSecEnablementStatus - The new status
+     */
+    updateOrgEnablementStatus2(savedAdvSecEnablementStatus: Management.OrgEnablementSettings): Promise<void>;
     /**
      * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization.
      *
@@ -46,6 +95,16 @@ export declare class ManagementRestClient extends RestClientBase {
      *
      */
     getEstimatedOrgBillablePushers(): Promise<string[]>;
+    /**
+     * Estimate the pushers that would be added to the customer's usage if Advanced Security was enabled for this organization.
+     *
+     */
+    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[]>;
     /**
      * Get the current status of Advanced Security for a project
      *
@@ -60,6 +119,20 @@ export declare class ManagementRestClient extends RestClientBase {
      * @param project - Project ID or project name
      */
     updateProjectEnablementStatus(savedAdvSecEnablementStatus: Management.AdvSecEnablementSettingsUpdate, project: string): Promise<void>;
+    /**
+     * 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>;
+    /**
+     * Update the status of Advanced Security for the project
+     *
+     * @param savedAdvSecEnablementStatus - The new status
+     * @param project - Project ID or project name
+     */
+    updateProjectEnablementStatus2(savedAdvSecEnablementStatus: 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.
      *
@@ -72,6 +145,18 @@ export declare class ManagementRestClient extends RestClientBase {
      * @param project - Project ID or project name
      */
     getEstimatedProjectBillablePushers(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
+     */
+    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[]>;
     /**
      * Determine if Advanced Security is enabled for a repository
      *
@@ -102,4 +187,18 @@ export declare class ManagementRestClient extends RestClientBase {
      * @param repository -
      */
     getEstimatedRepoBillablePushersDetails(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[]>;
+    /**
+     * 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 -
+     */
+    getEstimatedRepoBillableCommittersDetails2(project: string, repository: string): Promise<Management.MeterUsageEstimate>;
 }