BuildsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerRegistryManagementClient's

<xref:builds> attribute.

Inheritance
builtins.object
BuildsOperations

Constructor

BuildsOperations(*args, **kwargs)

Methods

begin_cancel

Cancel an existing build.

begin_update

Patch the build properties.

get

Gets the detailed information for a given build.

get_log_link

Gets a link to download the build logs.

list

Gets all the builds for a registry.

begin_cancel

Cancel an existing build.

begin_cancel(resource_group_name: str, registry_name: str, build_id: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to which the container registry belongs. Required.

registry_name
Required
str

The name of the container registry. Required.

build_id
Required
str

The build ID. Required.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description

begin_update

Patch the build properties.

begin_update(resource_group_name: str, registry_name: str, build_id: str, build_update_parameters: _models.BuildUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Build]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to which the container registry belongs. Required.

registry_name
Required
str

The name of the container registry. Required.

build_id
Required
str

The build ID. Required.

build_update_parameters
Required

The build update properties. Is either a BuildUpdateParameters type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.

cls

A custom type or function that will be passed the direct response

continuation_token
str

A continuation token to restart a poller from a saved state.

polling

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description

An instance of LROPoller that returns either Build or the result of cls(response)

Exceptions

Type Description

get

Gets the detailed information for a given build.

get(resource_group_name: str, registry_name: str, build_id: str, **kwargs: Any) -> Build

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to which the container registry belongs. Required.

registry_name
Required
str

The name of the container registry. Required.

build_id
Required
str

The build ID. Required.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

Build or the result of cls(response)

Exceptions

Type Description

Gets a link to download the build logs.

get_log_link(resource_group_name: str, registry_name: str, build_id: str, **kwargs: Any) -> BuildGetLogResult

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to which the container registry belongs. Required.

registry_name
Required
str

The name of the container registry. Required.

build_id
Required
str

The build ID. Required.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

BuildGetLogResult or the result of cls(response)

Exceptions

Type Description

list

Gets all the builds for a registry.

list(resource_group_name: str, registry_name: str, filter: str | None = None, top: int | None = None, skip_token: str | None = None, **kwargs: Any) -> Iterable[Build]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group to which the container registry belongs. Required.

registry_name
Required
str

The name of the container registry. Required.

filter
Required
str

The builds filter to apply on the operation. Default value is None.

top
Required
int

$top is supported for get list of builds, which limits the maximum number of builds to return. Default value is None.

skip_token
Required
str

$skipToken is supported on get list of builds, which provides the next page in the list of builds. Default value is None.

Keyword-Only Parameters

Name Description
cls

A custom type or function that will be passed the direct response

Returns

Type Description

An iterator like instance of either Build or the result of cls(response)

Exceptions

Type Description

Attributes

models

models = <module 'azure.mgmt.containerregistry.v2018_02_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2018_02_01_preview\\models\\__init__.py'>