VirtualDesktopCollection.GetIfExistsAsync(String, CancellationToken) Method

Definition

Namespace:

Azure.ResourceManager.DesktopVirtualization

Assembly:

Azure.ResourceManager.DesktopVirtualization.dll

Package:

Azure.ResourceManager.DesktopVirtualization v1.3.0

Source:

VirtualDesktopCollection.cs

Tries to get details for this resource from the service.

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

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

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

Parameters

desktopName

String

The name of the desktop within the specified desktop group.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<NullableResponse<VirtualDesktopResource>>

Exceptions

ArgumentException

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

ArgumentNullException

desktopName is null.