IAgentPoolsOperations.UpgradeNodeImageVersionWithHttpMessagesAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Management.ContainerService
Assembly:
Microsoft.Azure.PowerShell.Aks.Management.Sdk.dll

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

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ContainerService.Models.AgentPool,Microsoft.Azure.Management.ContainerService.Models.AgentPoolsUpgradeNodeImageVersionHeaders>> UpgradeNodeImageVersionWithHttpMessagesAsync (string resourceGroupName, string resourceName, string agentPoolName, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member UpgradeNodeImageVersionWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.ContainerService.Models.AgentPool, Microsoft.Azure.Management.ContainerService.Models.AgentPoolsUpgradeNodeImageVersionHeaders>>
Public Function UpgradeNodeImageVersionWithHttpMessagesAsync (resourceGroupName As String, resourceName As String, agentPoolName As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of AgentPool, AgentPoolsUpgradeNodeImageVersionHeaders))

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.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<AgentPool,AgentPoolsUpgradeNodeImageVersionHeaders>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

Remarks

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

Applies to