ComputeExtensions.GetVirtualMachinesAsync Method
Definition
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.
Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.
- Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines
- Operation Id: VirtualMachines_ListAll
- Default Api Version: 2024-07-01
- Resource: VirtualMachineResource
public static Azure.AsyncPageable<Azure.ResourceManager.Compute.VirtualMachineResource> GetVirtualMachinesAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, string statusOnly = default, string filter = default, Azure.ResourceManager.Compute.Models.ExpandTypesForListVm? expand = default, System.Threading.CancellationToken cancellationToken = default);static member GetVirtualMachinesAsync : Azure.ResourceManager.Resources.SubscriptionResource * string * string * Nullable<Azure.ResourceManager.Compute.Models.ExpandTypesForListVm> * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.ResourceManager.Compute.VirtualMachineResource><Extension()>
Public Function GetVirtualMachinesAsync (subscriptionResource As SubscriptionResource, Optional statusOnly As String = Nothing, Optional filter As String = Nothing, Optional expand As Nullable(Of ExpandTypesForListVm) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of VirtualMachineResource)Parameters
- subscriptionResource
- SubscriptionResource
The SubscriptionResource instance the method will execute against.
- statusOnly
- String
statusOnly=true enables fetching run time status of all Virtual Machines in the subscription.
- filter
- String
The system query option to filter VMs returned in the response. Allowed value is 'virtualMachineScaleSet/id' eq /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmssName}'.
- expand
- Nullable<ExpandTypesForListVm>
The expand expression to apply on operation. 'instanceView' enables fetching run time status of all Virtual Machines, this can only be specified if a valid $filter option is specified.
- cancellationToken
- CancellationToken
The cancellation token to use.
Returns
An async collection of VirtualMachineResource that may take multiple service requests to iterate over.
Exceptions
subscriptionResource is null.
