DesktopVirtualizationExtensions.GetHostPoolAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.DesktopVirtualization

Assembly:: Azure.ResourceManager.DesktopVirtualization.dll

Package:: Azure.ResourceManager.DesktopVirtualization v1.3.0

Source:: DesktopVirtualizationExtensions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get a host pool.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
Operation Id: HostPools_Get
Default Api Version: 2024-04-03
Resource: HostPoolResource

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.HostPoolResource>> GetHostPoolAsync (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string hostPoolName, System.Threading.CancellationToken cancellationToken = default);

static member GetHostPoolAsync : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.HostPoolResource>>

<Extension()>
Public Function GetHostPoolAsync (resourceGroupResource As ResourceGroupResource, hostPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of HostPoolResource))

Parameters

resourceGroupResource: ResourceGroupResource

The ResourceGroupResource instance the method will execute against.

hostPoolName: String

The name of the host pool within the specified resource group.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<HostPoolResource>>

Exceptions

ArgumentNullException

resourceGroupResource or hostPoolName is null.

ArgumentException

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

Applies to

Share via