Share via

RunsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerRegistryManagementClient's

<xref:runs> attribute.

Constructor

RunsOperations(*args, **kwargs)

Methods

begin_cancel

Cancel an existing run.
begin_update

Patch the run properties.
get

Gets the detailed information for a given run.
get_log_sas_url

Gets a link to download the run logs.
list

Gets all the runs for a registry.

begin_cancel

Cancel an existing run.

async begin_cancel(resource_group_name: str, registry_name: str, run_id: str, **kwargs: Any) -> AsyncLROPoller[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.
run_id
Required
str

The run ID. Required.

Returns

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Patch the run properties.

async begin_update(resource_group_name: str, registry_name: str, run_id: str, run_update_parameters: _models.RunUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Run]

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.
run_id
Required
str

The run ID. Required.
run_update_parameters
Required
RunUpdateParameters or IO[bytes]

The run update properties. Is either a RunUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
AsyncLROPoller[Run]

An instance of AsyncLROPoller that returns either Run or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the detailed information for a given run.

async get(resource_group_name: str, registry_name: str, run_id: str, **kwargs: Any) -> Run

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.
run_id
Required
str

The run ID. Required.

Returns

Type Description
Run

Run or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get_log_sas_url

Gets a link to download the run logs.

async get_log_sas_url(resource_group_name: str, registry_name: str, run_id: str, **kwargs: Any) -> RunGetLogResult

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.
run_id
Required
str

The run ID. Required.

Returns

Type Description
RunGetLogResult

RunGetLogResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all the runs for a registry.

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

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
str

The runs filter to apply on the operation. Arithmetic operators are not supported. The allowed string function is 'contains'. All logical operators except 'Not', 'Has', 'All' are allowed. Default value is None.

Default value: None
top
int

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

Default value: None

Returns

Type Description
AsyncItemPaged[Run]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.containerregistry.v2019_06_01_preview.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv97\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2019_06_01_preview\\models\\__init__.py'>