AgentPoolsOperations Class

AgentPoolsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
AgentPoolsOperations

Constructor

AgentPoolsOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.containerregistry.v2019_06_01_preview.models._models_py3.AgentPool, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.containerregistry.v2019_06_01_preview.models._models_py3.AgentPool]

Parameters

resource_group_name
str
Required

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

registry_name
str
Required

The name of the container registry.

agent_pool_name
str
Required

The name of the agent pool.

agent_pool
AgentPool
Required

The parameters of an agent pool that needs to scheduled.

cls
callable

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
bool or PollingMethod

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

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

Return type

Exceptions

begin_delete

Deletes a specified agent pool resource.

begin_delete(resource_group_name: str, registry_name: str, agent_pool_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name
str
Required

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

registry_name
str
Required

The name of the container registry.

agent_pool_name
str
Required

The name of the agent pool.

cls
callable

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
bool or PollingMethod

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

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

Return type

Exceptions

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: azure.mgmt.containerregistry.v2019_06_01_preview.models._models_py3.AgentPoolUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.containerregistry.v2019_06_01_preview.models._models_py3.AgentPool]

Parameters

resource_group_name
str
Required

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

registry_name
str
Required

The name of the container registry.

agent_pool_name
str
Required

The name of the agent pool.

update_parameters
AgentPoolUpdateParameters
Required

The parameters for updating an agent pool.

cls
callable

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
bool or PollingMethod

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

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

Return type

Exceptions

get

Gets the detailed information for a given agent pool.

get(resource_group_name: str, registry_name: str, agent_pool_name: str, **kwargs: Any) -> azure.mgmt.containerregistry.v2019_06_01_preview.models._models_py3.AgentPool

Parameters

resource_group_name
str
Required

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

registry_name
str
Required

The name of the container registry.

agent_pool_name
str
Required

The name of the agent pool.

cls
callable

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

Returns

AgentPool, or the result of cls(response)

Return type

Exceptions

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) -> azure.mgmt.containerregistry.v2019_06_01_preview.models._models_py3.AgentPoolQueueStatus

Parameters

resource_group_name
str
Required

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

registry_name
str
Required

The name of the container registry.

agent_pool_name
str
Required

The name of the agent pool.

cls
callable

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

Returns

AgentPoolQueueStatus, or the result of cls(response)

Return type

Exceptions

list

Lists all the agent pools for a specified container registry.

list(resource_group_name: str, registry_name: str, **kwargs: Any) -> Iterable[azure.mgmt.containerregistry.v2019_06_01_preview.models._models_py3.AgentPoolListResult]

Parameters

resource_group_name
str
Required

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

registry_name
str
Required

The name of the container registry.

cls
callable

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

Returns

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

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.containerregistry.v2019_06_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\containerregistry\\v2019_06_01_preview\\models\\__init__.py'>