DesktopVirtualizationExtensions.GetHostPool Method

Definition

Get a host pool.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
  • Operation Id: HostPools_Get
public static Azure.Response<Azure.ResourceManager.DesktopVirtualization.HostPoolResource> GetHostPool (this Azure.ResourceManager.Resources.ResourceGroupResource resourceGroupResource, string hostPoolName, System.Threading.CancellationToken cancellationToken = default);
static member GetHostPool : Azure.ResourceManager.Resources.ResourceGroupResource * string * System.Threading.CancellationToken -> Azure.Response<Azure.ResourceManager.DesktopVirtualization.HostPoolResource>
<Extension()>
Public Function GetHostPool (resourceGroupResource As ResourceGroupResource, hostPoolName As String, Optional cancellationToken As CancellationToken = Nothing) As 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

Exceptions

resourceGroupResource or hostPoolName is null.

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

Applies to