ContainerServiceAgentPoolCollection.GetIfExistsAsync Method

Definition

Namespace:

Azure.ResourceManager.ContainerService

Assembly:

Azure.ResourceManager.ContainerService.dll

Package:

Azure.ResourceManager.ContainerService v1.2.2

Source:

ContainerServiceAgentPoolCollection.cs

Tries to get details for this resource from the service.

• 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.NullableResponse<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolResource>> GetIfExistsAsync (string agentPoolName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolResource>>
override this.GetIfExistsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.NullableResponse<Azure.ResourceManager.ContainerService.ContainerServiceAgentPoolResource>>

Public Overridable Function GetIfExistsAsync (agentPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of NullableResponse(Of ContainerServiceAgentPoolResource))

Parameters

agentPoolName

String

The name of the agent pool.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<ContainerServiceAgentPoolResource>>

Exceptions

ArgumentException

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

ArgumentNullException

agentPoolName is null.