Share via


DockerBuildRequest Class

Definition

The parameters for a docker quick build.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.DockerBuildRequestTypeConverter))]
public class DockerBuildRequest : Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.IDockerBuildRequest, Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.DockerBuildRequestTypeConverter))>]
type DockerBuildRequest = class
    interface IDockerBuildRequest
    interface IJsonSerializable
    interface IRunRequest
    interface IValidates
Public Class DockerBuildRequest
Implements IDockerBuildRequest, IValidates
Inheritance
DockerBuildRequest
Attributes
Implements

Constructors

DockerBuildRequest()

Creates an new DockerBuildRequest instance.

Properties

AgentConfigurationCpu

The CPU configuration in terms of number of cores required for the run.

AgentPoolName

The dedicated agent pool for the run.

Argument

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

CredentialsCustomRegistry

Describes the credential parameters for accessing other custom registries. The key for the dictionary item will be the registry login server (myregistry.azurecr.io) and the value of the item will be the registry credentials for accessing the registry.

DockerFilePath

The Docker file path relative to the source location.

ImageName

The fully qualified image names including the repository and tag.

IsArchiveEnabled

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

IsPushEnabled

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

LogTemplate

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

NoCache

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

PlatformArchitecture

The OS architecture.

PlatformOS

The operating system type required for the run.

PlatformVariant

Variant of the CPU.

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.

SourceRegistryLoginMode

The authentication mode which determines the source registry login scope. The credentials for the source registry will be generated using the given scope. These credentials will be used to login to the source registry during the run.

Target

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

Timeout

Run timeout in seconds.

Type

The type of the run request.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of DockerBuildRequest.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of DockerBuildRequest.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ContainerRegistry.Models.Api20190601Preview.IDockerBuildRequest.

FromJsonString(String)

Creates a new instance of DockerBuildRequest, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of DockerBuildRequest into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to