VirtualMachineCollection.GetIfExists Method

Reference

Definition

Namespace:: Azure.ResourceManager.Compute

Assembly:: Azure.ResourceManager.Compute.dll

Package:: Azure.ResourceManager.Compute v1.5.0

Package:: Azure.ResourceManager.Compute v1.5.0-beta.1

Source:: VirtualMachineCollection.cs

Source:: VirtualMachineCollection.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.

Tries to get details for this resource from the service.

Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}
Operation Id: VirtualMachines_Get
Default Api Version: 2024-03-01
Resource: VirtualMachineResource

public virtual Azure.NullableResponse<Azure.ResourceManager.Compute.VirtualMachineResource> GetIfExists (string vmName, Azure.ResourceManager.Compute.Models.InstanceViewType? expand = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIfExists : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.Compute.VirtualMachineResource>
override this.GetIfExists : string * Nullable<Azure.ResourceManager.Compute.Models.InstanceViewType> * System.Threading.CancellationToken -> Azure.NullableResponse<Azure.ResourceManager.Compute.VirtualMachineResource>

Public Overridable Function GetIfExists (vmName As String, Optional expand As Nullable(Of InstanceViewType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As NullableResponse(Of VirtualMachineResource)

Parameters

vmName: String

The name of the virtual machine.

expand: Nullable<InstanceViewType>

The expand expression to apply on the operation. 'InstanceView' retrieves a snapshot of the runtime properties of the virtual machine that is managed by the platform and can change outside of control plane operations. 'UserData' retrieves the UserData property as part of the VM model view that was provided by the user during the VM Create/Update operation.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

NullableResponse<VirtualMachineResource>

Exceptions

ArgumentException

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

ArgumentNullException

vmName is null.

Applies to

Share via