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 in the specified managed cluster. Creates or updates an agent pool in the specified managed cluster. |
| begin_delete |
Deletes an agent pool in the specified managed cluster. Deletes an agent pool in the specified managed cluster. |
| begin_upgrade_node_image_version |
Upgrades the node image version of an agent pool to the latest. Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade. |
| get |
Gets the specified managed cluster agent pool. Gets the specified managed cluster agent pool. |
| get_available_agent_pool_versions |
Gets a list of supported Kubernetes versions for the specified agent pool. See supported Kubernetes versions for more details about the version lifecycle. |
| get_upgrade_profile |
Gets the upgrade profile for an agent pool. Gets the upgrade profile for an agent pool. |
| list |
Gets a list of agent pools in the specified managed cluster. Gets a list of agent pools in the specified managed cluster. |
begin_create_or_update
Creates or updates an agent pool in the specified managed cluster.
Creates or updates an agent pool in the specified managed cluster.
async begin_create_or_update(resource_group_name: str, resource_name: str, agent_pool_name: str, parameters: azure.mgmt.containerservice.v2021_10_01.models._models_py3.AgentPool, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerservice.v2021_10_01.models._models_py3.AgentPool]Parameters
- 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
Exceptions
begin_delete
Deletes an agent pool in the specified managed cluster.
Deletes an agent pool in the specified managed cluster.
async begin_delete(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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
Exceptions
begin_upgrade_node_image_version
Upgrades the node image version of an agent pool to the latest.
Upgrading the node image version of an agent pool applies the newest OS and runtime updates to the nodes. AKS provides one new image per week with the latest updates. For more details on node image versions, see: https://docs.microsoft.com/azure/aks/node-image-upgrade.
async begin_upgrade_node_image_version(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.containerservice.v2021_10_01.models._models_py3.AgentPool]Parameters
- 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
Exceptions
get
Gets the specified managed cluster agent pool.
Gets the specified managed cluster agent pool.
async get(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_10_01.models._models_py3.AgentPoolParameters
- 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_available_agent_pool_versions
Gets a list of supported Kubernetes versions for the specified agent pool.
See supported Kubernetes versions for more details about the version lifecycle.
async get_available_agent_pool_versions(resource_group_name: str, resource_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_10_01.models._models_py3.AgentPoolAvailableVersionsParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AgentPoolAvailableVersions, or the result of cls(response)
Return type
Exceptions
get_upgrade_profile
Gets the upgrade profile for an agent pool.
Gets the upgrade profile for an agent pool.
async get_upgrade_profile(resource_group_name: str, resource_name: str, agent_pool_name: str, **kwargs: Any) -> azure.mgmt.containerservice.v2021_10_01.models._models_py3.AgentPoolUpgradeProfileParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
AgentPoolUpgradeProfile, or the result of cls(response)
Return type
Exceptions
list
Gets a list of agent pools in the specified managed cluster.
Gets a list of agent pools in the specified managed cluster.
list(resource_group_name: str, resource_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.containerservice.v2021_10_01.models._models_py3.AgentPoolListResult]Parameters
- 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.containerservice.v2021_10_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\containerservice\\v2021_10_01\\models\\__init__.py'>Feedback
Submit and view feedback for