ContainerServiceAgentPoolCollection.GetAsync Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.ContainerService
Assembly:
Azure.ResourceManager.ContainerService.dll
Package:
Azure.ResourceManager.ContainerService v1.2.2
Package:
Azure.ResourceManager.ContainerService v1.2.0-beta.3
Source:
ContainerServiceAgentPoolCollection.cs
Source:
ContainerServiceAgentPoolCollection.cs

Gets the specified managed cluster agent pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}
  • Operation Id: AgentPools_Get
  • Default Api Version: 2023-10-01
  • Resource: ContainerServiceAgentPoolResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolResource>> GetAsync (string agentPoolName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolResource>>
Public Overridable Function GetAsync (agentPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ContainerServiceAgentPoolResource))

Parameters

agentPoolName
String

The name of the agent pool.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Task<Response<ContainerServiceAgentPoolResource>>

Exceptions

ArgumentException

agentPoolName is an empty string, and was expected to be non-empty.

ArgumentNullException

agentPoolName is null.

Applies to