azure-devops-extension-api 1.158.0 → 2.220.0

package/Pipelines/Pipelines.d.ts

@@ -0,0 +1,318 @@
+import * as WebApi from "../WebApi/WebApi";
+/**
+ * Artifacts are collections of files produced by a pipeline. Use artifacts to share files between stages in a pipeline or between different pipelines.
+ */
+export interface Artifact {
+    /**
+     * The name of the artifact.
+     */
+    name: string;
+    /**
+     * Signed url for downloading this artifact
+     */
+    signedContent: WebApi.SignedUrl;
+    /**
+     * Self-referential url
+     */
+    url: string;
+}
+export interface BuildResourceParameters {
+    version: string;
+}
+export declare enum ConfigurationType {
+    /**
+     * Unknown type.
+     */
+    Unknown = 0,
+    /**
+     * YAML.
+     */
+    Yaml = 1,
+    /**
+     * Designer JSON.
+     */
+    DesignerJson = 2,
+    /**
+     * Just-in-time.
+     */
+    JustInTime = 3,
+    /**
+     * Designer-JSON.
+     */
+    DesignerHyphenJson = 2
+}
+export interface Container {
+    environment: {
+        [key: string]: string;
+    };
+    image: string;
+    mapDockerSocket: boolean;
+    options: string;
+    ports: string[];
+    volumes: string[];
+}
+export interface ContainerResource {
+    container: Container;
+}
+export interface ContainerResourceParameters {
+    version: string;
+}
+/**
+ * Configuration parameters of the pipeline.
+ */
+export interface CreatePipelineConfigurationParameters {
+    /**
+     * Type of configuration.
+     */
+    type: ConfigurationType;
+}
+/**
+ * Parameters to create a pipeline.
+ */
+export interface CreatePipelineParameters {
+    /**
+     * Configuration parameters of the pipeline.
+     */
+    configuration: CreatePipelineConfigurationParameters;
+    /**
+     * Folder of the pipeline.
+     */
+    folder: string;
+    /**
+     * Name of the pipeline.
+     */
+    name: string;
+}
+/**
+ * Expansion options for GetArtifact and ListArtifacts.
+ */
+export declare enum GetArtifactExpandOptions {
+    /**
+     * No expansion.
+     */
+    None = 0,
+    /**
+     * Include signed content.
+     */
+    SignedContent = 1
+}
+/**
+ * $expand options for GetLog and ListLogs.
+ */
+export declare enum GetLogExpandOptions {
+    None = 0,
+    SignedContent = 1
+}
+/**
+ * Log for a pipeline.
+ */
+export interface Log {
+    /**
+     * The date and time the log was created.
+     */
+    createdOn: Date;
+    /**
+     * The ID of the log.
+     */
+    id: number;
+    /**
+     * The date and time the log was last changed.
+     */
+    lastChangedOn: Date;
+    /**
+     * The number of lines in the log.
+     */
+    lineCount: number;
+    signedContent: WebApi.SignedUrl;
+    url: string;
+}
+/**
+ * A collection of logs.
+ */
+export interface LogCollection {
+    /**
+     * The list of logs.
+     */
+    logs: Log[];
+    signedContent: WebApi.SignedUrl;
+    /**
+     * URL of the log.
+     */
+    url: string;
+}
+export interface PackageResourceParameters {
+    version: string;
+}
+/**
+ * Definition of a pipeline.
+ */
+export interface Pipeline extends PipelineBase {
+    _links: any;
+    configuration: PipelineConfiguration;
+    /**
+     * URL of the pipeline
+     */
+    url: string;
+}
+export interface PipelineBase {
+    /**
+     * Pipeline folder
+     */
+    folder: string;
+    /**
+     * Pipeline ID
+     */
+    id: number;
+    /**
+     * Pipeline name
+     */
+    name: string;
+    /**
+     * Revision number
+     */
+    revision: number;
+}
+export interface PipelineConfiguration {
+    type: ConfigurationType;
+}
+/**
+ * A reference to a Pipeline.
+ */
+export interface PipelineReference extends PipelineBase {
+    url: string;
+}
+export interface PipelineResource {
+    pipeline: PipelineReference;
+    version: string;
+}
+export interface PipelineResourceParameters {
+    version: string;
+}
+export interface PreviewRun {
+    finalYaml: string;
+}
+export interface Repository {
+    type: RepositoryType;
+}
+export interface RepositoryResource {
+    refName: string;
+    repository: Repository;
+    version: string;
+}
+export interface RepositoryResourceParameters {
+    refName: string;
+    /**
+     * This is the security token to use when connecting to the repository.
+     */
+    token: string;
+    /**
+     * Optional. This is the type of the token given. If not provided, a type of "Bearer" is assumed. Note: Use "Basic" for a PAT token.
+     */
+    tokenType: string;
+    version: string;
+}
+export declare enum RepositoryType {
+    Unknown = 0,
+    GitHub = 1,
+    AzureReposGit = 2,
+    GitHubEnterprise = 3,
+    AzureReposGitHyphenated = 2
+}
+export interface Run extends RunReference {
+    _links: any;
+    createdDate: Date;
+    finalYaml: string;
+    finishedDate: Date;
+    pipeline: PipelineReference;
+    resources: RunResources;
+    result: RunResult;
+    state: RunState;
+    templateParameters: {
+        [key: string]: any;
+    };
+    url: string;
+    variables: {
+        [key: string]: Variable;
+    };
+}
+/**
+ * Settings which influence pipeline runs.
+ */
+export interface RunPipelineParameters {
+    /**
+     * If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.
+     */
+    previewRun: boolean;
+    /**
+     * The resources the run requires.
+     */
+    resources: RunResourcesParameters;
+    stagesToSkip: string[];
+    templateParameters: {
+        [key: string]: string;
+    };
+    variables: {
+        [key: string]: Variable;
+    };
+    /**
+     * If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.
+     */
+    yamlOverride: string;
+}
+export interface RunReference {
+    id: number;
+    name: string;
+}
+export interface RunResources {
+    containers: {
+        [key: string]: ContainerResource;
+    };
+    pipelines: {
+        [key: string]: PipelineResource;
+    };
+    repositories: {
+        [key: string]: RepositoryResource;
+    };
+}
+export interface RunResourcesParameters {
+    builds: {
+        [key: string]: BuildResourceParameters;
+    };
+    containers: {
+        [key: string]: ContainerResourceParameters;
+    };
+    packages: {
+        [key: string]: PackageResourceParameters;
+    };
+    pipelines: {
+        [key: string]: PipelineResourceParameters;
+    };
+    repositories: {
+        [key: string]: RepositoryResourceParameters;
+    };
+}
+/**
+ * This is not a Flags enum because we don't want to set multiple results on a build. However, when adding values, please stick to powers of 2 as if it were a Flags enum. This will make it easier to query multiple results.
+ */
+export declare enum RunResult {
+    Unknown = 0,
+    Succeeded = 1,
+    Failed = 2,
+    Canceled = 4
+}
+/**
+ * This is not a Flags enum because we don't want to set multiple states on a build. However, when adding values, please stick to powers of 2 as if it were a Flags enum. This will make it easier to query multiple states.
+ */
+export declare enum RunState {
+    Unknown = 0,
+    InProgress = 1,
+    Canceling = 2,
+    Completed = 4
+}
+export interface SignalRConnection {
+    signedContent: WebApi.SignedUrl;
+}
+export interface Variable {
+    isSecret: boolean;
+    value: string;
+}

package/Pipelines/Pipelines.js

@@ -0,0 +1,82 @@
+/*
+ * ---------------------------------------------------------
+ * Copyright(C) Microsoft Corporation. All rights reserved.
+ * ---------------------------------------------------------
+ */
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    var ConfigurationType;
+    (function (ConfigurationType) {
+        /**
+         * Unknown type.
+         */
+        ConfigurationType[ConfigurationType["Unknown"] = 0] = "Unknown";
+        /**
+         * YAML.
+         */
+        ConfigurationType[ConfigurationType["Yaml"] = 1] = "Yaml";
+        /**
+         * Designer JSON.
+         */
+        ConfigurationType[ConfigurationType["DesignerJson"] = 2] = "DesignerJson";
+        /**
+         * Just-in-time.
+         */
+        ConfigurationType[ConfigurationType["JustInTime"] = 3] = "JustInTime";
+        /**
+         * Designer-JSON.
+         */
+        ConfigurationType[ConfigurationType["DesignerHyphenJson"] = 2] = "DesignerHyphenJson";
+    })(ConfigurationType = exports.ConfigurationType || (exports.ConfigurationType = {}));
+    /**
+     * Expansion options for GetArtifact and ListArtifacts.
+     */
+    var GetArtifactExpandOptions;
+    (function (GetArtifactExpandOptions) {
+        /**
+         * No expansion.
+         */
+        GetArtifactExpandOptions[GetArtifactExpandOptions["None"] = 0] = "None";
+        /**
+         * Include signed content.
+         */
+        GetArtifactExpandOptions[GetArtifactExpandOptions["SignedContent"] = 1] = "SignedContent";
+    })(GetArtifactExpandOptions = exports.GetArtifactExpandOptions || (exports.GetArtifactExpandOptions = {}));
+    /**
+     * $expand options for GetLog and ListLogs.
+     */
+    var GetLogExpandOptions;
+    (function (GetLogExpandOptions) {
+        GetLogExpandOptions[GetLogExpandOptions["None"] = 0] = "None";
+        GetLogExpandOptions[GetLogExpandOptions["SignedContent"] = 1] = "SignedContent";
+    })(GetLogExpandOptions = exports.GetLogExpandOptions || (exports.GetLogExpandOptions = {}));
+    var RepositoryType;
+    (function (RepositoryType) {
+        RepositoryType[RepositoryType["Unknown"] = 0] = "Unknown";
+        RepositoryType[RepositoryType["GitHub"] = 1] = "GitHub";
+        RepositoryType[RepositoryType["AzureReposGit"] = 2] = "AzureReposGit";
+        RepositoryType[RepositoryType["GitHubEnterprise"] = 3] = "GitHubEnterprise";
+        RepositoryType[RepositoryType["AzureReposGitHyphenated"] = 2] = "AzureReposGitHyphenated";
+    })(RepositoryType = exports.RepositoryType || (exports.RepositoryType = {}));
+    /**
+     * This is not a Flags enum because we don't want to set multiple results on a build. However, when adding values, please stick to powers of 2 as if it were a Flags enum. This will make it easier to query multiple results.
+     */
+    var RunResult;
+    (function (RunResult) {
+        RunResult[RunResult["Unknown"] = 0] = "Unknown";
+        RunResult[RunResult["Succeeded"] = 1] = "Succeeded";
+        RunResult[RunResult["Failed"] = 2] = "Failed";
+        RunResult[RunResult["Canceled"] = 4] = "Canceled";
+    })(RunResult = exports.RunResult || (exports.RunResult = {}));
+    /**
+     * This is not a Flags enum because we don't want to set multiple states on a build. However, when adding values, please stick to powers of 2 as if it were a Flags enum. This will make it easier to query multiple states.
+     */
+    var RunState;
+    (function (RunState) {
+        RunState[RunState["Unknown"] = 0] = "Unknown";
+        RunState[RunState["InProgress"] = 1] = "InProgress";
+        RunState[RunState["Canceling"] = 2] = "Canceling";
+        RunState[RunState["Completed"] = 4] = "Completed";
+    })(RunState = exports.RunState || (exports.RunState = {}));
+});

package/Pipelines/Pipelines.min.js

@@ -0,0 +1 @@
+define(["require","exports"],function(n,e){"use strict";Object.defineProperty(e,"__esModule",{value:!0});!function(n){n[n.Unknown=0]="Unknown",n[n.Yaml=1]="Yaml",n[n.DesignerJson=2]="DesignerJson",n[n.JustInTime=3]="JustInTime",n[n.DesignerHyphenJson=2]="DesignerHyphenJson"}(e.ConfigurationType||(e.ConfigurationType={}));!function(n){n[n.None=0]="None",n[n.SignedContent=1]="SignedContent"}(e.GetArtifactExpandOptions||(e.GetArtifactExpandOptions={}));!function(n){n[n.None=0]="None",n[n.SignedContent=1]="SignedContent"}(e.GetLogExpandOptions||(e.GetLogExpandOptions={}));!function(n){n[n.Unknown=0]="Unknown",n[n.GitHub=1]="GitHub",n[n.AzureReposGit=2]="AzureReposGit",n[n.GitHubEnterprise=3]="GitHubEnterprise",n[n.AzureReposGitHyphenated=2]="AzureReposGitHyphenated"}(e.RepositoryType||(e.RepositoryType={}));!function(n){n[n.Unknown=0]="Unknown",n[n.Succeeded=1]="Succeeded",n[n.Failed=2]="Failed",n[n.Canceled=4]="Canceled"}(e.RunResult||(e.RunResult={}));!function(n){n[n.Unknown=0]="Unknown",n[n.InProgress=1]="InProgress",n[n.Canceling=2]="Canceling",n[n.Completed=4]="Completed"}(e.RunState||(e.RunState={}))});

package/Pipelines/PipelinesClient.d.ts

@@ -0,0 +1,92 @@
+import { IVssRestClientOptions } from "../Common/Context";
+import { RestClientBase } from "../Common/RestClientBase";
+import * as Pipelines from "../Pipelines/Pipelines";
+export declare class PipelinesRestClient extends RestClientBase {
+    constructor(options: IVssRestClientOptions);
+    /**
+     * Get a specific artifact from a pipeline run
+     *
+     * @param project - Project ID or project name
+     * @param pipelineId - ID of the pipeline.
+     * @param runId - ID of the run of that pipeline.
+     * @param artifactName - Name of the artifact.
+     * @param expand - Expand options. Default is None.
+     */
+    getArtifact(project: string, pipelineId: number, runId: number, artifactName: string, expand?: Pipelines.GetArtifactExpandOptions): Promise<Pipelines.Artifact>;
+    /**
+     * Get a specific log from a pipeline run
+     *
+     * @param project - Project ID or project name
+     * @param pipelineId - ID of the pipeline.
+     * @param runId - ID of the run of that pipeline.
+     * @param logId - ID of the log.
+     * @param expand - Expand options. Default is None.
+     */
+    getLog(project: string, pipelineId: number, runId: number, logId: number, expand?: Pipelines.GetLogExpandOptions): Promise<Pipelines.Log>;
+    /**
+     * Get a list of logs from a pipeline run.
+     *
+     * @param project - Project ID or project name
+     * @param pipelineId - ID of the pipeline.
+     * @param runId - ID of the run of that pipeline.
+     * @param expand - Expand options. Default is None.
+     */
+    listLogs(project: string, pipelineId: number, runId: number, expand?: Pipelines.GetLogExpandOptions): Promise<Pipelines.LogCollection>;
+    /**
+     * Create a pipeline.
+     *
+     * @param inputParameters - Input parameters.
+     * @param project - Project ID or project name
+     */
+    createPipeline(inputParameters: Pipelines.CreatePipelineParameters, project: string): Promise<Pipelines.Pipeline>;
+    /**
+     * Gets a pipeline, optionally at the specified version
+     *
+     * @param project - Project ID or project name
+     * @param pipelineId - The pipeline ID
+     * @param pipelineVersion - The pipeline version
+     */
+    getPipeline(project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipelines.Pipeline>;
+    /**
+     * Get a list of pipelines.
+     *
+     * @param project - Project ID or project name
+     * @param orderBy - A sort expression. Defaults to "name asc"
+     * @param top - The maximum number of pipelines to return
+     * @param continuationToken - A continuation token from a previous request, to retrieve the next page of results
+     */
+    listPipelines(project: string, orderBy?: string, top?: number, continuationToken?: string): Promise<Pipelines.Pipeline[]>;
+    /**
+     * Queues a dry run of the pipeline and returns an object containing the final yaml.
+     *
+     * @param runParameters - Optional additional parameters for this run.
+     * @param project - Project ID or project name
+     * @param pipelineId - The pipeline ID.
+     * @param pipelineVersion - The pipeline version.
+     */
+    preview(runParameters: Pipelines.RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipelines.PreviewRun>;
+    /**
+     * Gets a run for a particular pipeline.
+     *
+     * @param project - Project ID or project name
+     * @param pipelineId - The pipeline id
+     * @param runId - The run id
+     */
+    getRun(project: string, pipelineId: number, runId: number): Promise<Pipelines.Run>;
+    /**
+     * Gets top 10000 runs for a particular pipeline.
+     *
+     * @param project - Project ID or project name
+     * @param pipelineId - The pipeline id
+     */
+    listRuns(project: string, pipelineId: number): Promise<Pipelines.Run[]>;
+    /**
+     * Runs a pipeline.
+     *
+     * @param runParameters - Optional additional parameters for this run.
+     * @param project - Project ID or project name
+     * @param pipelineId - The pipeline ID.
+     * @param pipelineVersion - The pipeline version.
+     */
+    runPipeline(runParameters: Pipelines.RunPipelineParameters, project: string, pipelineId: number, pipelineVersion?: number): Promise<Pipelines.Run>;
+}