Skip to content

Latest commit

 

History

History
101 lines (78 loc) · 3.37 KB

queries-azureps.md

File metadata and controls

101 lines (78 loc) · 3.37 KB
title description services author ms.author manager ms.product ms.service ms.devlang ms.topic ms.date
Querying for Azure resources and formatting results | Microsoft Docs
How to query for resources in Azure and format the results.
azure
sdwheeler
sewhee
carmonm
azure
azure-powershell
powershell
conceptual
03/30/2017

Querying for Azure resources

Querying in PowerShell can be completed by using built-in cmdlets. In PowerShell, cmdlet names take the form of Verb-Noun. The cmdlets using the verb Get are the query cmdlets. The cmdlet nouns are the types of Azure resources that are acted upon by the cmdlet verbs.

Selecting simple properties

Azure PowerShell has default formatting defined for each cmdlet. The most common properties for each resource type are displayed in a table or list format automatically. For more information about formatting output, see Formatting query results.

Use the Get-AzureRmVM cmdlet to query for a list of VMs in your account.

Get-AzureRmVM

The default output is automatically formatted as a table.

ResourceGroupName          Name   Location          VmSize  OsType              NIC ProvisioningState
-----------------          ----   --------          ------  ------              --- -----------------
MYWESTEURG        MyUnbuntu1610 westeurope Standard_DS1_v2   Linux myunbuntu1610980         Succeeded
MYWESTEURG          MyWin2016VM westeurope Standard_DS1_v2 Windows   mywin2016vm880         Succeeded

The Select-Object cmdlet can be used to select the specific properties that are interesting to you.

Get-AzureRmVM | Select-Object Name,ResourceGroupName,Location
Name          ResourceGroupName Location
----          ----------------- --------
MyUnbuntu1610 MYWESTEURG        westeurope
MyWin2016VM   MYWESTEURG        westeurope

Selecting complex nested properties

If the property you want to select is nested deep in the JSON output you need to supply the full path to that nested property. The following example shows how to select the VM Name and the OS type from the Get-AzureRmVM cmdlet.

Get-AzureRmVM | Select-Object name,@{Name='OSType'; Expression={$_.StorageProfile.OSDisk.OSType}}
Name           OSType
----           ------
MyUnbuntu1610   Linux
MyWin2016VM   Windows

Filter result using the Where-Object cmdlet

The Where-Object cmdlet allows you to filter the result based on any property value. In the following example, the filter selects only VMs that have the text "RGD" in their name.

Get-AzureRmVM | Where-Object ResourceGroupName -like "RGD*" | Select-Object ResourceGroupName,Name
ResourceGroupName  Name
-----------------  ----
RGDEMO001          KBDemo001VM
RGDEMO001          KBDemo020

With the next example, the results will return the VMs that have the vmSize 'Standard_DS1_V2'.

Get-AzureRmVM | Where-Object vmSize -eq 'Standard_DS1_V2'
ResourceGroupName          Name     Location          VmSize  OsType              NIC ProvisioningState
-----------------          ----     --------          ------  ------              --- -----------------
MYWESTEURG        MyUnbuntu1610   westeurope Standard_DS1_v2   Linux myunbuntu1610980         Succeeded
MYWESTEURG          MyWin2016VM   westeurope Standard_DS1_v2 Windows   mywin2016vm880         Succeeded