DockerBuildRequest Class

The parameters for a docker quick build.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.mgmt.containerregistry.v2018_09_01.models._models_py3.RunRequest

DockerBuildRequest

Constructor

DockerBuildRequest(*, docker_file_path: str, platform: _models.PlatformProperties, is_archive_enabled: bool = False, image_names: List[str] | None = None, is_push_enabled: bool = True, no_cache: bool = False, target: str | None = None, arguments: List[_models.Argument] | None = None, timeout: int = 3600, agent_configuration: _models.AgentProperties | None = None, source_location: str | None = None, credentials: _models.Credentials | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
is_archive_enabled	bool The value that indicates whether archiving is enabled for the run or not.
image_names	list[str] The fully qualified image names including the repository and tag.
is_push_enabled	bool The value of this property indicates whether the image built should be pushed to the registry or not. Default value: True
no_cache	bool The value of this property indicates whether the image cache is enabled or not.
docker_file_path	str The Docker file path relative to the source location. Required.
target	str The name of the target build stage for the docker build.
arguments	list[Argument] The collection of override arguments to be used when executing the run.
timeout	int Run timeout in seconds. Default value: 3600
platform	PlatformProperties The platform properties against which the run has to happen. Required.
agent_configuration	AgentProperties The machine configuration of the run agent.
source_location	str 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.
credentials	Credentials The properties that describes a set of credentials that will be used when this run is invoked.

Variables

Name	Description
type	str The type of the run request. Required.
is_archive_enabled	bool The value that indicates whether archiving is enabled for the run or not.
image_names	list[str] The fully qualified image names including the repository and tag.
is_push_enabled	bool The value of this property indicates whether the image built should be pushed to the registry or not.
no_cache	bool The value of this property indicates whether the image cache is enabled or not.
docker_file_path	str The Docker file path relative to the source location. Required.
target	str The name of the target build stage for the docker build.
arguments	list[Argument] The collection of override arguments to be used when executing the run.
timeout	int Run timeout in seconds.
platform	PlatformProperties The platform properties against which the run has to happen. Required.
agent_configuration	AgentProperties The machine configuration of the run agent.
source_location	str 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.
credentials	Credentials The properties that describes a set of credentials that will be used when this run is invoked.