AgentPoolsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerRegistryManagementClient's

<xref:agent_pools> attribute.

Constructor

AgentPoolsOperations(*args, **kwargs)

Methods

begin_create	Creates an agent pool for a container registry with the specified parameters.
begin_delete	Deletes a specified agent pool resource.
begin_update	Updates an agent pool with the specified parameters.
get	Gets the detailed information for a given agent pool.
get_queue_status	Gets the count of queued runs for a given agent pool.
list	Lists all the agent pools for a specified container registry.

begin_create

Creates an agent pool for a container registry with the specified parameters.

begin_create(resource_group_name: str, registry_name: str, agent_pool_name: str, agent_pool: _models.AgentPool, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AgentPool]

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.
agent_pool_name Required	str The name of the agent pool. Required.
agent_pool Required	AgentPool or IO[bytes] The parameters of an agent pool that needs to scheduled. Is either a AgentPool type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AgentPool]	An instance of LROPoller that returns either AgentPool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes a specified agent pool resource.

begin_delete(resource_group_name: str, registry_name: str, agent_pool_name: 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.
agent_pool_name Required	str The name of the agent pool. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an agent pool with the specified parameters.

begin_update(resource_group_name: str, registry_name: str, agent_pool_name: str, update_parameters: _models.AgentPoolUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AgentPool]

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.
agent_pool_name Required	str The name of the agent pool. Required.
update_parameters Required	AgentPoolUpdateParameters or IO[bytes] The parameters for updating an agent pool. Is either a AgentPoolUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AgentPool]	An instance of LROPoller that returns either AgentPool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the detailed information for a given agent pool.

get(resource_group_name: str, registry_name: str, agent_pool_name: str, **kwargs: Any) -> AgentPool

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.
agent_pool_name Required	str The name of the agent pool. Required.

Returns

Type	Description
AgentPool	AgentPool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_queue_status

Gets the count of queued runs for a given agent pool.

get_queue_status(resource_group_name: str, registry_name: str, agent_pool_name: str, **kwargs: Any) -> AgentPoolQueueStatus

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.
agent_pool_name Required	str The name of the agent pool. Required.

Returns

Type	Description
AgentPoolQueueStatus	AgentPoolQueueStatus or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Lists all the agent pools for a specified container registry.

list(resource_group_name: str, registry_name: str, **kwargs: Any) -> Iterable[AgentPool]

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.

Returns

Type	Description
ItemPaged[AgentPool]	An iterator like instance of either AgentPool or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.containerregistry.v2019_06_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv91\\Lib\\site-packages\\azure\\mgmt\\containerregistry\\v2019_06_01_preview\\models\\__init__.py'>