azure-devops-extension-api 4.270.0 → 5.272.0

package/esm/Management/ManagementClient.js

@@ -0,0 +1,358 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+import { RestClientBase } from "../Common/RestClientBase";
+export class ManagementRestClient extends RestClientBase {
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Base URL for getting All Available Agent Pools + Currently Selected Agent Pool This is a read-only operation that does not require manage permissions.
+     *
+     */
+    async getAdvancedSecurityAgentPoolSelection() {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/Management/pools/{agentPoolName}"
+        });
+    }
+    /**
+     * Updates Agent Pool Registry Value For the Selected Agent Pool This automatically uses the underlying http client for agent pools to validate that the user has permissions to use that pool
+     *
+     * @param agentPoolName -
+     */
+    async updateAdvancedSecurityAgentPoolSelection(agentPoolName) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/Management/pools/{agentPoolName}",
+            routeValues: {
+                agentPoolName: agentPoolName
+            }
+        });
+    }
+    /**
+     * Cancels all running and queued CodeQL jobs and in-flight Dynamic Pipeline runs for the organization.
+     *
+     */
+    async cancelCodeQLJobs() {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",
+            routeValues: {
+                action: "Cancel"
+            }
+        });
+    }
+    /**
+     * Gets the count of running and queued CodeQL jobs and in-flight Dynamic Pipeline runs for the organization.
+     *
+     */
+    async getCodeQLJobCount() {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",
+            routeValues: {
+                action: "Count"
+            }
+        });
+    }
+    /**
+     * Gets the current CodeQL default setup schedule configuration for the organization.
+     *
+     */
+    async getCodeQLSchedule() {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",
+            routeValues: {
+                action: "Schedule"
+            }
+        });
+    }
+    /**
+     * Sets the day of the week when the CodeQL default setup scan should run for the organization.
+     *
+     * @param scheduleDayOfWeek - Day of week as an integer: 0=Sunday, 1=Monday, ..., 6=Saturday.
+     */
+    async updateCodeQLSchedule(scheduleDayOfWeek) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",
+            routeValues: {
+                scheduleDayOfWeek: scheduleDayOfWeek,
+                action: "Schedule"
+            }
+        });
+    }
+    /**
+     * Gets the current CodeQL default setup schedule configuration for the organization.
+     *
+     */
+    async getCodeQLScheduleLegacy() {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/Management/codeQLSchedule/{scheduleDayOfWeek}"
+        });
+    }
+    /**
+     * Sets the day of the week when the CodeQL default setup scan should run for the organization.
+     *
+     * @param scheduleDayOfWeek - Day of week as an integer: 0=Sunday, 1=Monday, ..., 6=Saturday.
+     */
+    async updateCodeQLScheduleLegacy(scheduleDayOfWeek) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.1",
+            method: "POST",
+            routeTemplate: "_apis/Management/codeQLSchedule/{scheduleDayOfWeek}",
+            routeValues: {
+                scheduleDayOfWeek: scheduleDayOfWeek
+            }
+        });
+    }
+    /**
+     * 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 -
+     */
+    async createBillingSnapshot2(meterUsage, plan) {
+        const queryValues = {
+            plan: plan
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "POST",
+            routeTemplate: "_apis/Management/MeterUsage/{action}",
+            routeValues: {
+                action: "Default"
+            },
+            queryParams: queryValues,
+            body: meterUsage
+        });
+    }
+    /**
+     * 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
+     */
+    async getBillableCommitterDetails2(plan, billingDate) {
+        const queryValues = {
+            plan: plan,
+            billingDate: billingDate
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "_apis/Management/MeterUsage/{action}",
+            routeValues: {
+                action: "Details"
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * @param plan -
+     */
+    async getLastMeterUsage2(plan) {
+        const queryValues = {
+            plan: plan
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "_apis/Management/MeterUsage/{action}",
+            routeValues: {
+                action: "Last"
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * 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
+     */
+    async getMeterUsage2(plan, billingDate) {
+        const queryValues = {
+            plan: plan,
+            billingDate: billingDate
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "_apis/Management/MeterUsage/{action}",
+            routeValues: {
+                action: "Default"
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Get the current status of Advanced Security for the organization
+     *
+     * @param includeAllProperties - When true, also determine if pushes are blocked if they contain secrets
+     */
+    async getOrgEnablementStatus2(includeAllProperties) {
+        const queryValues = {
+            includeAllProperties: includeAllProperties
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "_apis/Management/enablement",
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update the status of Advanced Security for the organization
+     *
+     * @param orgEnablementSettings - The new status
+     */
+    async updateOrgEnablementStatus2(orgEnablementSettings) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "PATCH",
+            routeTemplate: "_apis/Management/enablement",
+            body: orgEnablementSettings
+        });
+    }
+    /**
+     * 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.
+     */
+    async getEstimatedBillablePushersDetailsForOrg2(plan) {
+        const queryValues = {
+            plan: plan
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "_apis/Management/meterUsageEstimate/{action}",
+            routeValues: {
+                action: "Default"
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * 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
+     */
+    async getProjectEnablementStatus2(project, includeAllProperties) {
+        const queryValues = {
+            includeAllProperties: includeAllProperties
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "{project}/_apis/Management/enablement",
+            routeValues: {
+                project: project
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update the status of Advanced Security for the project
+     *
+     * @param projectEnablementSettings - The new status
+     * @param project - Project ID or project name
+     */
+    async updateProjectEnablementStatus2(projectEnablementSettings, project) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/Management/enablement",
+            routeValues: {
+                project: project
+            },
+            body: projectEnablementSettings
+        });
+    }
+    /**
+     * 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 -
+     */
+    async getEstimatedBillablePushersDetailsForProject2(project, plan) {
+        const queryValues = {
+            plan: plan
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "{project}/_apis/Management/meterUsageEstimate/{action}",
+            routeValues: {
+                project: project,
+                action: "Default"
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * 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
+     */
+    async getRepoEnablementStatus2(project, repository, includeAllProperties) {
+        const queryValues = {
+            includeAllProperties: includeAllProperties
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "{project}/_apis/Management/repositories/{repository}/enablement",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            queryParams: queryValues
+        });
+    }
+    /**
+     * Update the enablement status of Code Security and Secret Protection, along with their respective features, for a given repository.
+     *
+     * @param repoEnablementSettings - new status
+     * @param project - Project ID or project name
+     * @param repository - Name or ID of the repository
+     */
+    async updateRepoAdvSecEnablementStatus2(repoEnablementSettings, project, repository) {
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            method: "PATCH",
+            routeTemplate: "{project}/_apis/Management/repositories/{repository}/enablement",
+            routeValues: {
+                project: project,
+                repository: repository
+            },
+            body: repoEnablementSettings
+        });
+    }
+    /**
+     * 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 - The name or ID of the repository
+     * @param plan - The plan to query.
+     */
+    async getEstimatedBillableCommittersDetailsForRepo2(project, repository, plan) {
+        const queryValues = {
+            plan: plan
+        };
+        return this.beginRequest({
+            apiVersion: "7.2-preview.3",
+            routeTemplate: "{project}/_apis/Management/repositories/{repository}/meterUsageEstimate/{action}",
+            routeValues: {
+                project: project,
+                repository: repository,
+                action: "Default"
+            },
+            queryParams: queryValues
+        });
+    }
+}

package/esm/Management/ManagementClient.min.js

@@ -0,0 +1 @@
+import{RestClientBase}from"../Common/RestClientBase";export class ManagementRestClient extends RestClientBase{constructor(e){super(e)}async getAdvancedSecurityAgentPoolSelection(){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/Management/pools/{agentPoolName}"})}async updateAdvancedSecurityAgentPoolSelection(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/Management/pools/{agentPoolName}",routeValues:{agentPoolName:e}})}async cancelCodeQLJobs(){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",routeValues:{action:"Cancel"}})}async getCodeQLJobCount(){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",routeValues:{action:"Count"}})}async getCodeQLSchedule(){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",routeValues:{action:"Schedule"}})}async updateCodeQLSchedule(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/Management/codeQLJobs/{action}/{scheduleDayOfWeek}",routeValues:{scheduleDayOfWeek:e,action:"Schedule"}})}async getCodeQLScheduleLegacy(){return this.beginRequest({apiVersion:"7.2-preview.1",routeTemplate:"_apis/Management/codeQLSchedule/{scheduleDayOfWeek}"})}async updateCodeQLScheduleLegacy(e){return this.beginRequest({apiVersion:"7.2-preview.1",method:"POST",routeTemplate:"_apis/Management/codeQLSchedule/{scheduleDayOfWeek}",routeValues:{scheduleDayOfWeek:e}})}async createBillingSnapshot2(e,t){const a={plan:t};return this.beginRequest({apiVersion:"7.2-preview.3",method:"POST",routeTemplate:"_apis/Management/MeterUsage/{action}",routeValues:{action:"Default"},queryParams:a,body:e})}async getBillableCommitterDetails2(e,t){const a={plan:e,billingDate:t};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"_apis/Management/MeterUsage/{action}",routeValues:{action:"Details"},queryParams:a})}async getLastMeterUsage2(e){const t={plan:e};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"_apis/Management/MeterUsage/{action}",routeValues:{action:"Last"},queryParams:t})}async getMeterUsage2(e,t){const a={plan:e,billingDate:t};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"_apis/Management/MeterUsage/{action}",routeValues:{action:"Default"},queryParams:a})}async getOrgEnablementStatus2(e){const t={includeAllProperties:e};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"_apis/Management/enablement",queryParams:t})}async updateOrgEnablementStatus2(e){return this.beginRequest({apiVersion:"7.2-preview.3",method:"PATCH",routeTemplate:"_apis/Management/enablement",body:e})}async getEstimatedBillablePushersDetailsForOrg2(e){const t={plan:e};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"_apis/Management/meterUsageEstimate/{action}",routeValues:{action:"Default"},queryParams:t})}async getProjectEnablementStatus2(e,t){const a={includeAllProperties:t};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/_apis/Management/enablement",routeValues:{project:e},queryParams:a})}async updateProjectEnablementStatus2(e,t){return this.beginRequest({apiVersion:"7.2-preview.3",method:"PATCH",routeTemplate:"{project}/_apis/Management/enablement",routeValues:{project:t},body:e})}async getEstimatedBillablePushersDetailsForProject2(e,t){const a={plan:t};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/_apis/Management/meterUsageEstimate/{action}",routeValues:{project:e,action:"Default"},queryParams:a})}async getRepoEnablementStatus2(e,t,a){const n={includeAllProperties:a};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/_apis/Management/repositories/{repository}/enablement",routeValues:{project:e,repository:t},queryParams:n})}async updateRepoAdvSecEnablementStatus2(e,t,a){return this.beginRequest({apiVersion:"7.2-preview.3",method:"PATCH",routeTemplate:"{project}/_apis/Management/repositories/{repository}/enablement",routeValues:{project:t,repository:a},body:e})}async getEstimatedBillableCommittersDetailsForRepo2(e,t,a){const n={plan:a};return this.beginRequest({apiVersion:"7.2-preview.3",routeTemplate:"{project}/_apis/Management/repositories/{repository}/meterUsageEstimate/{action}",routeValues:{project:e,repository:t,action:"Default"},queryParams:n})}};