website logo
HomeGithubSlack
⌘K
Overview
Quick Start
Supported Services
Running CloudGraph in EKS
Compliance
Rules Engine
AWS
Querying AWS Data
AWS Policy Packs
Billing Data
Services
Azure
Querying Azure Data
Azure Policy Packs
Services
GCP
Querying GCP Data
GCP Policy Packs
Services
K8s
Querying Kubernetes Data
Services
Docs powered by archbee 

Virtual Machine

16min

Note: if you are running CloudGraph locally you can view the interactive, automatically generated documentation in either GraphQL Playground or Altair by clicking the docs button on the right-hand side of the screen. After reading the below information we highly suggest you use one of these tools to test your queries as they will autocomplete fields for you and let you know if your queries are valid before you even submit them.

Overview

You can currently query the following attributes and connections on an Azure Virtual Machine

GraphQL
|
query {
  queryazureVirtualMachine{
    id
    name
    type
    subscriptionId
    region
    resourceGroupId
    vmId
    osProfile{
      computerName
      windowsConfiguration{
        provisionVMAgent
        enableAutomaticUpdates
        timeZone
      }
      linuxConfiguration{
        disablePasswordAuthentication
        provisionVMAgent
      }
      allowExtensionOperations
      requireGuestProvisionSignal
    }
    storageImageReference {
      publisher
      offer
      sku
      version
      exactVersion
    }
    bootDiagnostics
    licenseType
    tags{
      id
      key
      value
    }
    disks{
      id
      # Other fields and connections here...
    }
    networkInterfaces{
      id
      # Other fields and connections here...
    }
    virtualNetworks{
      id
      # Other fields and connections here...
    }
    resourceGroup{
      id
      # Other fields and connections here...
    }
  }
}


Filtering

Get data for a single Azure Virtual Machine key that you know the ID for:

GraphQL
|
query {
  getazureVirtualMachine(id: "12345") {
    id
    # Other fields and connections here...
  }
}


Get data for all of the Virtual Machines in a certain Azure subscription:

GraphQL
|
query {
  queryazureVirtualMachine(filter: { subscriptionId: { eq: "12345" } }) {
    id
    # Other fields and connections here...
  }
}

# Note that in addition to "subscriptionId" you can
# Filter based on any of the following attributes:

# id
# name
# type
# subscriptionId
# region
# resourceGroupId
# vmId
# osProfile
# storageImageReference
# bootDiagnostics
# licenseType

# And the following Dgraph filters can also be applied:

# has
# and
# or
# not
# regexp (regular expressions)

# fulltext filters

# alloftext
# anyoftext


Get data for all of the Virtual Machines that are NOT in a certain Azure subscription:

GraphQL
|
query {
  queryazureVirtualMachine(filter: { not: { subscriptionId: { eq: "12345" } } }) {
    id
    # Other fields and connections here...
  }
}


Advanced Filtering

Get data for all of the Virtual Machines that are connected to a disk:

GraphQL
|
query {
  queryazureVirtualMachine(filter: { has: disks }) {
    id
    # Other fields and connections here...
  }
}

# Note that in addition to "disks" you can filter
# Using "has" based on any of the following attributes:

# tags
# disks
# networkInterfaces
# virtualNetworks


Ordering

You can order the results you get back either asc or desc depending on your preference:

GraphQL
|
query {
  queryazureVirtualMachine(order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}

# Note that in addition to "name" you can filter
# Using "asc" or "desc" based on any of the following attributes:

# id
# type
# subscriptionId
# region
# resourceGroupId
# vmId
# osProfile
# storageImageReference
# bootDiagnostics
# licenseType


Only select and return the first two Virtual Machines that are found:

GraphQL
|
query {
  queryazureVirtualMachine(first: 2, order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}


Only select and return the first two Virtual Machines that are found, but offset by one so keys two & three are returned:

GraphQL
|
query {
  queryazureVirtualMachine(first: 2, order: { desc: name }, offset: 1) {
    id
    # Other fields and connections here...
  }
}


Aggregation

Count the number of Virtual Machines across all scanned Azure subscriptions:

GraphQL
|
query {
  aggregateazureVirtualMachine {
    count
    # Other fields and connections here...
  }
}

# Note that in addition to "count" you can request the
# Following min and max values based on attributes of your Virtual Machines:

# idMin
# idMax
# nameMin
# nameMax
# typeMin
# typeMax
# subscriptionIdMin
# subscriptionIdMax
# regionMin
# regionMax
# resourceGroupIdMin
# resourceGroupIdMax
# managedByMin
# managedByMax
# vmIdMin
# vmIdMax
# licenseTypeMin
# licenseTypeMax


Count the number of Virtual Machines in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:

GraphQL
|
query {
  aggregateazureVirtualMachine(filter: { subscriptionId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}


Examples

Find all of the Virtual Machines that are in the eastus region across all your accounts:

GraphQL
|
query {
  queryazureVirtualMachine(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
}


Find all of the Virtual Machines that have a tag of Environment:Production for a single Azure Subscription:

GraphQL
|
query {
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    virtualMachines(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}


With CloudGraph you can run multiple queries at the same time so you can combine the above two queries if you like:

GraphQL
|
query {
  queryazureVirtualMachine(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    virtualMachines(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}


Kitchen Sink

Putting it all together; get all data for all Virtual Machines across all regions for all scanned Azure subscriptions in a single query. For the purposes of this example, we will only get direct children of the keys but if you want to it's easy to go from say, disk -> virtualMachine -> networkInterface ...etc:

GraphQL
|
query {
  queryazureVirtualMachine {
    id
    name
    type
    subscriptionId
    region
    resourceGroupId
    managedBy
    vmId
    osProfile{
      computerName
      windowsConfiguration{
        provisionVMAgent
        enableAutomaticUpdates
        timeZone
      }
      linuxConfiguration{
        disablePasswordAuthentication
        provisionVMAgent
      }
      allowExtensionOperations
      requireGuestProvisionSignal
    }
    storageImageReference {
      publisher
      offer
      sku
      version
      exactVersion
    }
    bootDiagnostics
    licenseType
    disks{
      id
      name
      type
      kind
      subscriptionId
      region
      resourceGroupId
      managedBy
      zones
      timeCreated
      osType
      hyperVGeneration
      createOption
      imageReferenceId
      diskSizeGb
      diskSizeBytes
      uniqueId
      diskIopsReadWrite
      diskMbpsReadWrite
      diskState
      networkAccessPolicy
      tier
      encryptionSettings
      tags{
        id
        key
        value
      }
      resourceGroup{
        id
        # Other fields and connections here...
      }
      virtualMachine{
        id
        # Other fields and connections here...
      }
    }
    networkInterfaces{
      id
      name
      type
      kind
      subscriptionId
      region
      resourceGroupId
      macAddress
      privateIpAddress
      internalDnsNameLabel
      enableIpForwarding
      virtualMachineId
      enableAcceleratedNetworking
      internalDomainNameSuffix
      ipConfiguration{
        gatewayLoadBalancer{
          id
        }
        privateIPAddress
        privateIPAllocationMethod
        privateIPAddressVersion
        subnetId
        primary
        provisioningState
        id
        name
        etag
        type
      }
      appliedDnsServers
      dnsServers
      publicIps{
        id
        # Other fields and connections here...
      }
      resourceGroup{
        id
        # Other fields and connections here...
      }
      securityGroups{
        id
        # Other fields and connections here...
      }
      virtualMachines{
        id
        # Other fields and connections here...
      }
      virtualNetworks{
        id
        # Other fields and connections here...
      }
    }
    virtualNetworks{
      id
      name
      type
      kind
      subscriptionId
      region
      resourceGroupId
      addressSpacePrefixes
      dnsServers
      ddosProtectionPlans{
        id
        name
        type
        resourceGuid
        etag
      }
      enableDdosProtection
      enableVmProtection
      flowTimeoutInMinutes
      provisioningState
      resourceGuid
      firewalls{
        id
        # Other fields and connections here...
      }
      networkInterfaces{
        id
        # Other fields and connections here...
      }
      virtualMachines{
        id
        # Other fields and connections here...
      }
      resourceGroup{
        id
        # Other fields and connections here...
      }
      tags{
        id
        key
        value
      }
    }
    resourceGroup{
      id
      name
      type
      kind
      subscriptionId
      region
      managedBy
      disks {
        id
        # Other fields and connections here...
      }
      dns {
        id
        # Other fields and connections here...
      }
      firewalls {
        id
        # Other fields and connections here...
      }
      functionApps {
        id
        # Other fields and connections here...
      }
      keyVaults {
        id
        # Other fields and connections here...
      }
      networkInterfaces {
        id
        # Other fields and connections here...
      }
      publicIps {
        id
        # Other fields and connections here...
      }
      securityGroups {
        id
        # Other fields and connections here...
      }
      storageAccounts {
        id
        # Other fields and connections here...
      }
      storageContainers {
        id
        # Other fields and connections here...
      }
      virtualMachines {
        id
        # Other fields and connections here...
      }
      virtualNetworks {
        id
        # Other fields and connections here...
      }
      tags{
        id
        key
        value
      }
    }
    tags{
      id
      key
      value
    }
  }
}


References

Dgraph documentation on querying

Azure Virtual Machines Documentation

Updated 03 Mar 2023
Did this page help you?
Yes
No
PREVIOUS
Storage Container
NEXT
Virtual Machine Scale Set
Docs powered by archbee 
TABLE OF CONTENTS
Overview
Filtering
Advanced Filtering
Ordering
Aggregation
Examples
Kitchen Sink
References