Share via

DockerBuildRequest interface

  • Reference
Package:
@azure/arm-containerregistry

The parameters for a docker quick build.

Extends
RunRequest

Properties

agentConfiguration

The machine configuration of the run agent.
arguments

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

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

The Docker file path relative to the source location.
imageNames

The fully qualified image names including the repository and tag.
isPushEnabled

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

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

The platform properties against which the run has to happen.
sourceLocation

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.
target

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

Run timeout in seconds.
type

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

Inherited Properties

agentPoolName

The dedicated agent pool for the run.
isArchiveEnabled

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

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

Property Details

agentConfiguration

The machine configuration of the run agent.

agentConfiguration?: AgentProperties

Property Value

AgentProperties

arguments

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

arguments?: Argument[]

Property Value

Argument[]

credentials

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

credentials?: Credentials

Property Value

Credentials

dockerFilePath

The Docker file path relative to the source location.

dockerFilePath: string

Property Value

string

imageNames

The fully qualified image names including the repository and tag.

imageNames?: string[]

Property Value

string[]

isPushEnabled

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

isPushEnabled?: boolean

Property Value

boolean

noCache

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

noCache?: boolean

Property Value

boolean

platform

The platform properties against which the run has to happen.

platform: PlatformProperties

Property Value

PlatformProperties

sourceLocation

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.

sourceLocation?: string

Property Value

string

target

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

target?: string

Property Value

string

timeout

Run timeout in seconds.

timeout?: number

Property Value

number

type

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

type: "DockerBuildRequest"

Property Value

"DockerBuildRequest"

Inherited Property Details

agentPoolName

The dedicated agent pool for the run.

agentPoolName?: string

Property Value

string

Inherited From RunRequest.agentPoolName

isArchiveEnabled

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

isArchiveEnabled?: boolean

Property Value

boolean

Inherited From RunRequest.isArchiveEnabled

logTemplate

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

logTemplate?: string

Property Value

string

Inherited From RunRequest.logTemplate