AgentPoolsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerServiceClient's

<xref:agent_pools> attribute.

Inheritance

builtins.object

AgentPoolsOperations

Constructor

AgentPoolsOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates an agent pool. Creates or updates an agent pool in the specified managed cluster.
begin_delete	Deletes an agent pool. Deletes the agent pool in the specified managed cluster.
get	Gets the agent pool. Gets the details of the agent pool by managed cluster and resource group.
list	Gets a list of agent pools in the specified managed cluster. Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

begin_create_or_update

Creates or updates an agent pool.

Creates or updates an agent pool in the specified managed cluster.

async begin_create_or_update(resource_group_name: str, managed_cluster_name: str, agent_pool_name: str, parameters: azure.mgmt.containerservice.v2019_02_01.models._models_py3.AgentPool, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerservice.v2019_02_01.models._models_py3.AgentPool]

Parameters

resource_group_name

str

Required

The name of the resource group.

managed_cluster_name

str

Required

The name of the managed cluster resource.

agent_pool_name

str

Required

The name of the agent pool.

parameters

AgentPool

Required

Parameters supplied to the Create or Update an agent pool operation.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either AgentPool or the result of cls(response)

Return type

AsyncLROPoller[AgentPool]

Exceptions

HttpResponseError

begin_delete

Deletes an agent pool.

Deletes the agent pool in the specified managed cluster.

async begin_delete(resource_group_name: str, managed_cluster_name: str, agent_pool_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]

Parameters

resource_group_name

str

Required

The name of the resource group.

managed_cluster_name

str

Required

The name of the managed cluster resource.

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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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 AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

HttpResponseError

get

Gets the agent pool.

Gets the details of the agent pool by managed cluster and resource group.

async get(resource_group_name: str, managed_cluster_name: str, agent_pool_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2019_02_01.models._models_py3.AgentPool

Parameters

resource_group_name

str

Required

The name of the resource group.

managed_cluster_name

str

Required

The name of the managed cluster resource.

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

AgentPool

Exceptions

HttpResponseError

list

Gets a list of agent pools in the specified managed cluster.

Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.

list(resource_group_name: str, managed_cluster_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.containerservice.v2019_02_01.models._models_py3.AgentPoolListResult]

Parameters

resource_group_name

str

Required

The name of the resource group.

managed_cluster_name

str

Required

The name of the managed cluster resource.

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

AsyncItemPaged[AgentPoolListResult]

Exceptions

HttpResponseError

Attributes

models

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