azure-devops-extension-api 4.246.0 → 4.247.0

package/src/Locations/LocationsClient.ts

@@ -0,0 +1,220 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+
+import { IVssRestClientOptions } from "../Common/Context";
+import { RestClientBase } from "../Common/RestClientBase";
+
+import * as Locations from "../Locations/Locations";
+import * as WebApi from "../WebApi/WebApi";
+
+export class LocationsRestClient extends RestClientBase {
+    constructor(options: IVssRestClientOptions) {
+        super(options);
+    }
+
+    /**
+     * This was copied and adapted from TeamFoundationConnectionService.Connect()
+     * 
+     * @param connectOptions - 
+     * @param lastChangeId - Obsolete 32-bit LastChangeId
+     * @param lastChangeId64 - Non-truncated 64-bit LastChangeId
+     */
+    public async getConnectionData(
+        connectOptions?: WebApi.ConnectOptions,
+        lastChangeId?: number,
+        lastChangeId64?: number
+        ): Promise<Locations.ConnectionData> {
+
+        const queryValues: any = {
+            connectOptions: connectOptions,
+            lastChangeId: lastChangeId,
+            lastChangeId64: lastChangeId64
+        };
+
+        return this.beginRequest<Locations.ConnectionData>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/ConnectionData",
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * @param areaId - 
+     * @param enterpriseName - 
+     * @param organizationName - 
+     * @param accessMapping - 
+     */
+    public async getResourceArea(
+        areaId: string,
+        enterpriseName?: string,
+        organizationName?: string,
+        accessMapping?: string
+        ): Promise<Locations.ResourceAreaInfo> {
+
+        const queryValues: any = {
+            enterpriseName: enterpriseName,
+            organizationName: organizationName,
+            accessMapping: accessMapping
+        };
+
+        return this.beginRequest<Locations.ResourceAreaInfo>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/ResourceAreas/{areaId}",
+            routeValues: {
+                areaId: areaId
+            },
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * @param areaId - 
+     * @param hostId - 
+     * @param accessMapping - 
+     */
+    public async getResourceAreaByHost(
+        areaId: string,
+        hostId: string,
+        accessMapping?: string
+        ): Promise<Locations.ResourceAreaInfo> {
+
+        const queryValues: any = {
+            hostId: hostId,
+            accessMapping: accessMapping
+        };
+
+        return this.beginRequest<Locations.ResourceAreaInfo>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/ResourceAreas/{areaId}",
+            routeValues: {
+                areaId: areaId
+            },
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * @param enterpriseName - 
+     * @param organizationName - 
+     */
+    public async getResourceAreas(
+        enterpriseName?: string,
+        organizationName?: string
+        ): Promise<Locations.ResourceAreaInfo[]> {
+
+        const queryValues: any = {
+            enterpriseName: enterpriseName,
+            organizationName: organizationName
+        };
+
+        return this.beginRequest<Locations.ResourceAreaInfo[]>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/ResourceAreas/{areaId}",
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * @param hostId - 
+     */
+    public async getResourceAreasByHost(
+        hostId: string
+        ): Promise<Locations.ResourceAreaInfo[]> {
+
+        const queryValues: any = {
+            hostId: hostId
+        };
+
+        return this.beginRequest<Locations.ResourceAreaInfo[]>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/ResourceAreas/{areaId}",
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * @param serviceType - 
+     * @param identifier - 
+     */
+    public async deleteServiceDefinition(
+        serviceType: string,
+        identifier: string
+        ): Promise<void> {
+
+        return this.beginRequest<void>({
+            apiVersion: "7.2-preview.1",
+            method: "DELETE",
+            routeTemplate: "_apis/ServiceDefinitions/{serviceType}/{identifier}",
+            routeValues: {
+                serviceType: serviceType,
+                identifier: identifier
+            }
+        });
+    }
+
+    /**
+     * Finds a given service definition.
+     * 
+     * @param serviceType - 
+     * @param identifier - 
+     * @param allowFaultIn - If true, we will attempt to fault in a host instance mapping if in SPS.
+     * @param previewFaultIn - If true, we will calculate and return a host instance mapping, but not persist it.
+     */
+    public async getServiceDefinition(
+        serviceType: string,
+        identifier: string,
+        allowFaultIn?: boolean,
+        previewFaultIn?: boolean
+        ): Promise<Locations.ServiceDefinition> {
+
+        const queryValues: any = {
+            allowFaultIn: allowFaultIn,
+            previewFaultIn: previewFaultIn
+        };
+
+        return this.beginRequest<Locations.ServiceDefinition>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/ServiceDefinitions/{serviceType}/{identifier}",
+            routeValues: {
+                serviceType: serviceType,
+                identifier: identifier
+            },
+            queryParams: queryValues
+        });
+    }
+
+    /**
+     * @param serviceType - 
+     */
+    public async getServiceDefinitions(
+        serviceType?: string
+        ): Promise<Locations.ServiceDefinition[]> {
+
+        return this.beginRequest<Locations.ServiceDefinition[]>({
+            apiVersion: "7.2-preview.1",
+            routeTemplate: "_apis/ServiceDefinitions/{serviceType}/{identifier}",
+            routeValues: {
+                serviceType: serviceType
+            }
+        });
+    }
+
+    /**
+     * @param serviceDefinitions - 
+     */
+    public async updateServiceDefinitions(
+        serviceDefinitions: WebApi.VssJsonCollectionWrapperV<Locations.ServiceDefinition[]>
+        ): Promise<void> {
+
+        return this.beginRequest<void>({
+            apiVersion: "7.2-preview.1",
+            method: "PATCH",
+            routeTemplate: "_apis/ServiceDefinitions/{serviceType}/{identifier}",
+            body: serviceDefinitions
+        });
+    }
+
+}

package/src/Locations/index.ts

@@ -0,0 +1,2 @@
+export * from "./Locations";
+export * from "./LocationsClient";

package/src/Management/Management.ts

@@ -0,0 +1,172 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+
+import * as WebApi from "../WebApi/WebApi";
+
+export interface AdvSecEnablementFeatures {
+    /**
+     * 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;
+    /**
+     * 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
+ */
+export interface BillableCommitterDetails {
+    /**
+     * ID (SHA-1) of the commit.
+     */
+    commitId: string;
+    /**
+     * Committer email address after parsing.
+     */
+    committerEmail: string;
+    /**
+     * Time reported by the commit.
+     */
+    commitTime: Date;
+    /**
+     * DisplayName of the Pusher.
+     */
+    displayName: string;
+    /**
+     * MailNickName of the Pusher.
+     */
+    mailNickName: string;
+    /**
+     * Project Id commit was pushed to.
+     */
+    projectId: string;
+    /**
+     * Project name commit was pushed to.
+     */
+    projectName: string;
+    /**
+     * Time of the push that contained the commit.
+     */
+    pushedTime: Date;
+    /**
+     * Pusher Id for the push.
+     */
+    pusherId: string;
+    /**
+     * Push Id that contained the commit.
+     */
+    pushId: number;
+    /**
+     * RepositoryId commit was pushed to.
+     */
+    repoId: string;
+    /**
+     * Repository name commit was pushed to.
+     */
+    repoName: string;
+    /**
+     * SamAccountName of the Pusher.
+     */
+    samAccountName: string;
+    /**
+     * Visual Studio ID /Team Foundation ID
+     */
+    vsid: string;
+}
+
+/**
+ * Information related to billed committers using Advanced Security services
+ */
+export interface BilledCommitter {
+    /**
+     * Cuid of the billed committer. CUID is unique across an Azure Subscription.
+     */
+    cuid: string;
+    /**
+     * Identity Reference object of the billed committer
+     */
+    userIdentity: WebApi.IdentityRef;
+}
+
+/**
+ * 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;
+    /**
+     * 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;
+    /**
+     * The Azure subscription
+     */
+    tenantId: string;
+    /**
+     * The number of commiters to repositories that have Advanced Security features enabled
+     */
+    uniqueCommitterCount: number;
+}