Package version:

Interface DockerBuildRequest

The parameters for a docker quick build.

interface DockerBuildRequest {
    agentConfiguration?: AgentProperties;
    agentPoolName?: string;
    arguments?: Argument[];
    credentials?: Credentials;
    dockerFilePath: string;
    imageNames?: string[];
    isArchiveEnabled?: boolean;
    isPushEnabled?: boolean;
    logTemplate?: string;
    noCache?: boolean;
    platform: PlatformProperties;
    sourceLocation?: string;
    target?: string;
    timeout?: number;
    type: "DockerBuildRequest";
}

Hierarchy (view full)

Properties

agentConfiguration? agentPoolName? arguments? credentials? dockerFilePath imageNames? isArchiveEnabled? isPushEnabled? logTemplate? noCache? platform sourceLocation? target? timeout? type

Properties

OptionalagentConfiguration

agentConfiguration?: AgentProperties

The machine configuration of the run agent.

OptionalagentPoolName

agentPoolName?: string

The dedicated agent pool for the run.

Optionalarguments

arguments?: Argument[]

The collection of override arguments to be used when executing the run.

Optionalcredentials

credentials?: Credentials

The properties that describes a set of credentials that will be used when this run is invoked.

dockerFilePath

dockerFilePath: string

The Docker file path relative to the source location.

OptionalimageNames

imageNames?: string[]

The fully qualified image names including the repository and tag.

OptionalisArchiveEnabled

isArchiveEnabled?: boolean

The value that indicates whether archiving is enabled for the run or not.

OptionalisPushEnabled

isPushEnabled?: boolean

The value of this property indicates whether the image built should be pushed to the registry or not.

OptionallogTemplate

logTemplate?: string

The template that describes the repository and tag information for run log artifact.

OptionalnoCache

noCache?: boolean

The value of this property indicates whether the image cache is enabled or not.

platform

platform: PlatformProperties

The platform properties against which the run has to happen.

OptionalsourceLocation

sourceLocation?: string

The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.

Optionaltarget

target?: string

The name of the target build stage for the docker build.

Optionaltimeout

timeout?: number

Run timeout in seconds.

type

type

Polymorphic discriminator, which specifies the different types this object can be

Settings

Member Visibility