AgentPools interface
Interface representing a AgentPools.
Methods
| begin |
Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned. |
| begin |
Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned. |
| begin |
Creates or updates an agent pool in the specified managed cluster. |
| begin |
Creates or updates an agent pool in the specified managed cluster. |
| begin |
Deletes an agent pool in the specified managed cluster. |
| begin |
Deletes an agent pool in the specified managed cluster. |
| begin |
Deletes specific machines in an agent pool. |
| begin |
Deletes specific machines in an agent pool. |
| begin |
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 |
| begin |
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(string, string, string, Agent |
Gets the specified managed cluster agent pool. |
| get |
See supported Kubernetes versions for more details about the version lifecycle. |
| get |
Gets the upgrade profile for an agent pool. |
| list(string, string, Agent |
Gets a list of agent pools in the specified managed cluster. |
Method Details
beginAbortLatestOperation(string, string, string, AgentPoolsAbortLatestOperationOptionalParams)
Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.
function beginAbortLatestOperation(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsAbortLatestOperationOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsAbortLatestOperationHeaders>, AgentPoolsAbortLatestOperationHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolsAbortLatestOperationHeaders>, AgentPoolsAbortLatestOperationHeaders>>
beginAbortLatestOperationAndWait(string, string, string, AgentPoolsAbortLatestOperationOptionalParams)
Aborts the currently running operation on the agent pool. The Agent Pool will be moved to a Canceling state and eventually to a Canceled state when cancellation finishes. If the operation completes before cancellation can take place, a 409 error code is returned.
function beginAbortLatestOperationAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsAbortLatestOperationOptionalParams): Promise<AgentPoolsAbortLatestOperationHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
The options parameters.
Returns
beginCreateOrUpdate(string, string, string, AgentPool, AgentPoolsCreateOrUpdateOptionalParams)
Creates or updates an agent pool in the specified managed cluster.
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, agentPoolName: string, parameters: AgentPool, options?: AgentPoolsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AgentPool>, AgentPool>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- parameters
- AgentPool
The agent pool to create or update.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPool>, AgentPool>>
beginCreateOrUpdateAndWait(string, string, string, AgentPool, AgentPoolsCreateOrUpdateOptionalParams)
Creates or updates an agent pool in the specified managed cluster.
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, parameters: AgentPool, options?: AgentPoolsCreateOrUpdateOptionalParams): Promise<AgentPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- parameters
- AgentPool
The agent pool to create or update.
The options parameters.
Returns
Promise<AgentPool>
beginDelete(string, string, string, AgentPoolsDeleteOptionalParams)
Deletes an agent pool in the specified managed cluster.
function beginDelete(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsDeleteHeaders>, AgentPoolsDeleteHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- options
- AgentPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolsDeleteHeaders>, AgentPoolsDeleteHeaders>>
beginDeleteAndWait(string, string, string, AgentPoolsDeleteOptionalParams)
Deletes an agent pool in the specified managed cluster.
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsDeleteOptionalParams): Promise<AgentPoolsDeleteHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- options
- AgentPoolsDeleteOptionalParams
The options parameters.
Returns
Promise<AgentPoolsDeleteHeaders>
beginDeleteMachines(string, string, string, AgentPoolDeleteMachinesParameter, AgentPoolsDeleteMachinesOptionalParams)
Deletes specific machines in an agent pool.
function beginDeleteMachines(resourceGroupName: string, resourceName: string, agentPoolName: string, machines: AgentPoolDeleteMachinesParameter, options?: AgentPoolsDeleteMachinesOptionalParams): Promise<SimplePollerLike<OperationState<AgentPoolsDeleteMachinesHeaders>, AgentPoolsDeleteMachinesHeaders>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- machines
- AgentPoolDeleteMachinesParameter
A list of machines from the agent pool to be deleted.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AgentPoolsDeleteMachinesHeaders>, AgentPoolsDeleteMachinesHeaders>>
beginDeleteMachinesAndWait(string, string, string, AgentPoolDeleteMachinesParameter, AgentPoolsDeleteMachinesOptionalParams)
Deletes specific machines in an agent pool.
function beginDeleteMachinesAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, machines: AgentPoolDeleteMachinesParameter, options?: AgentPoolsDeleteMachinesOptionalParams): Promise<AgentPoolsDeleteMachinesHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- machines
- AgentPoolDeleteMachinesParameter
A list of machines from the agent pool to be deleted.
The options parameters.
Returns
Promise<AgentPoolsDeleteMachinesHeaders>
beginUpgradeNodeImageVersion(string, string, string, AgentPoolsUpgradeNodeImageVersionOptionalParams)
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
function beginUpgradeNodeImageVersion(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsUpgradeNodeImageVersionOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginUpgradeNodeImageVersionAndWait(string, string, string, AgentPoolsUpgradeNodeImageVersionOptionalParams)
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
function beginUpgradeNodeImageVersionAndWait(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsUpgradeNodeImageVersionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
The options parameters.
Returns
Promise<void>
get(string, string, string, AgentPoolsGetOptionalParams)
Gets the specified managed cluster agent pool.
function get(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsGetOptionalParams): Promise<AgentPool>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
- options
- AgentPoolsGetOptionalParams
The options parameters.
Returns
Promise<AgentPool>
getAvailableAgentPoolVersions(string, string, AgentPoolsGetAvailableAgentPoolVersionsOptionalParams)
See supported Kubernetes versions for more details about the version lifecycle.
function getAvailableAgentPoolVersions(resourceGroupName: string, resourceName: string, options?: AgentPoolsGetAvailableAgentPoolVersionsOptionalParams): Promise<AgentPoolAvailableVersions>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
The options parameters.
Returns
Promise<AgentPoolAvailableVersions>
getUpgradeProfile(string, string, string, AgentPoolsGetUpgradeProfileOptionalParams)
Gets the upgrade profile for an agent pool.
function getUpgradeProfile(resourceGroupName: string, resourceName: string, agentPoolName: string, options?: AgentPoolsGetUpgradeProfileOptionalParams): Promise<AgentPoolUpgradeProfile>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- agentPoolName
-
string
The name of the agent pool.
The options parameters.
Returns
Promise<AgentPoolUpgradeProfile>
list(string, string, AgentPoolsListOptionalParams)
Gets a list of agent pools in the specified managed cluster.
function list(resourceGroupName: string, resourceName: string, options?: AgentPoolsListOptionalParams): PagedAsyncIterableIterator<AgentPool, AgentPool[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- resourceName
-
string
The name of the managed cluster resource.
- options
- AgentPoolsListOptionalParams
The options parameters.