AgentPoolsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:agent_pools> attribute.
- Inheritance
-
builtins.objectAgentPoolsOperations
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. |
| begin_upgrade_node_image_version |
Upgrade node image version of an agent pool to the latest. Upgrade node image version of an agent pool to the latest. |
| get |
Gets the agent pool. Gets the details of the agent pool by managed cluster and resource group. |
| get_available_agent_pool_versions |
Gets a list of supported versions for the specified agent pool. Gets a list of supported versions for the specified agent pool. |
| get_upgrade_profile |
Gets upgrade profile for an agent pool. Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name. |
| 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.
begin_create_or_update(resource_group_name: str, resource_name: str, agent_pool_name: str, parameters: _models.AgentPool, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AgentPool]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
resource_name
Required
|
The name of the managed cluster resource. Required. |
|
agent_pool_name
Required
|
The name of the agent pool. Required. |
|
parameters
Required
|
Parameters supplied to the Create or Update an agent pool operation. Is either a AgentPool type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either AgentPool or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes an agent pool.
Deletes the agent pool in the specified managed cluster.
begin_delete(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
resource_name
Required
|
The name of the managed cluster resource. Required. |
|
agent_pool_name
Required
|
The name of the agent pool. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_upgrade_node_image_version
Upgrade node image version of an agent pool to the latest.
Upgrade node image version of an agent pool to the latest.
begin_upgrade_node_image_version(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> LROPoller[AgentPool]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
resource_name
Required
|
The name of the managed cluster resource. Required. |
|
agent_pool_name
Required
|
The name of the agent pool. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either AgentPool or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets the agent pool.
Gets the details of the agent pool by managed cluster and resource group.
get(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> AgentPoolParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
resource_name
Required
|
The name of the managed cluster resource. Required. |
|
agent_pool_name
Required
|
The name of the agent pool. Required. |
Returns
| Type | Description |
|---|---|
|
AgentPool or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_available_agent_pool_versions
Gets a list of supported versions for the specified agent pool.
Gets a list of supported versions for the specified agent pool.
get_available_agent_pool_versions(resource_group_name: str, resource_name: str, **kwargs: Any) -> AgentPoolAvailableVersionsParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
| Type | Description |
|---|---|
|
AgentPoolAvailableVersions or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get_upgrade_profile
Gets upgrade profile for an agent pool.
Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.
get_upgrade_profile(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> AgentPoolUpgradeProfileParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
resource_name
Required
|
The name of the managed cluster resource. Required. |
|
agent_pool_name
Required
|
The name of the agent pool. Required. |
Returns
| Type | Description |
|---|---|
|
AgentPoolUpgradeProfile or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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, resource_name: str, **kwargs: Any) -> Iterable[AgentPool]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
resource_name
Required
|
The name of the managed cluster resource. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either AgentPool or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.containerservice.v2020_12_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\containerservice\\v2020_12_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for