VirtualDesktopCollection.GetAsync(String, CancellationToken) Method

Definition

Get a desktop.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
  • Operation Id: Desktops_Get
  • Default Api Version: 2024-04-03
  • Resource: VirtualDesktopResource
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.VirtualDesktopResource>> GetAsync (string desktopName, System.Threading.CancellationToken cancellationToken = default);
abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.VirtualDesktopResource>>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.DesktopVirtualization.VirtualDesktopResource>>
Public Overridable Function GetAsync (desktopName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of VirtualDesktopResource))

Parameters

desktopName
String

The name of the desktop within the specified desktop group.

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Exceptions

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

desktopName is null.

Applies to