Virtual Machine Scale Set

12min
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 Scale Set
GraphQL
query {
  queryazureVirtualMachineScaleSet{
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    provisioningState
    overprovision
    doNotRunExtensionsOnOverprovisionedVMs
    singlePlacementGroup
    platformFaultDomainCount
    uniqueId
    virtualMachineProfile{
      osProfile{
        computerNamePrefix
        adminUsername
        allowExtensionOperations
        requireGuestProvisionSignal
        linuxConfiguration{
          disablePasswordAuthentication
          provisionVMAgent
          ssh{
            publicKeys {
              path
              keyData
            }
          }
        }
        windowsConfiguration{
          provisionVMAgent
          enableAutomaticUpdates
          timeZone
          ssh{
            publicKeys {
              path
              keyData
            }
          }
        }
        secrets{
          sourceVault{
            id
          }
          vaultCertificates {
            certificateUrl
            certificateStore
          }
        }
      }
      storageProfile{
        imageReference{
          id
          sku
          offer
          version
          publisher
        }
        osDisk{
          caching
          createOption
          osType
          diskSizeGB
          writeAcceleratorEnabled
          managedDisk{
            storageAccountType
          }
        }
      }
      networkProfile{
        networkInterfaceConfigurations{
          id
          name
          primary
          enableAcceleratedNetworking
          enableFpga
          enableIPForwarding
          deleteOption
          networkSecurityGroup{
            id
          }
          dnsSettings{
            dnsServers
          }
          ipConfigurations{
            id
            name
            privateIPAddressVersion
            primary
            subnetId
            applicationGatewayBackendAddressPools{
              id
            }
            applicationSecurityGroups{
              id
            }
            loadBalancerBackendAddressPools{
              id
            }
            loadBalancerInboundNatPools{
              id
            }
          }
        }
      }
      diagnosticsProfile{
        bootDiagnostics{
          enabled
        }
      }
      extensionProfile{
        extensions{
          id
          name
          forceUpdateTag
          type
          type1
          typeHandlerVersion
          publisher
          provisioningState
          provisionAfterExtensions
          autoUpgradeMinorVersion
          enableAutomaticUpgrade
          settings
        }
      }
    }
    scaleInPolicy{
      rules
    }
    resourceGroup{
      id
      # Other fields and connections here...
    }
    tags{
      id
      key
      value
    }
  }
}
query {
  queryazureVirtualMachineScaleSet{
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    provisioningState
    overprovision
    doNotRunExtensionsOnOverprovisionedVMs
    singlePlacementGroup
    platformFaultDomainCount
    uniqueId
    virtualMachineProfile{
      osProfile{
        computerNamePrefix
        adminUsername
        allowExtensionOperations
        requireGuestProvisionSignal
        linuxConfiguration{
          disablePasswordAuthentication
          provisionVMAgent
          ssh{
            publicKeys {
              path
              keyData
            }
          }
        }
        windowsConfiguration{
          provisionVMAgent
          enableAutomaticUpdates
          timeZone
          ssh{
            publicKeys {
              path
              keyData
            }
          }
        }
        secrets{
          sourceVault{
            id
          }
          vaultCertificates {
            certificateUrl
            certificateStore
          }
        }
      }
      storageProfile{
        imageReference{
          id
          sku
          offer
          version
          publisher
        }
        osDisk{
          caching
          createOption
          osType
          diskSizeGB
          writeAcceleratorEnabled
          managedDisk{
            storageAccountType
          }
        }
      }
      networkProfile{
        networkInterfaceConfigurations{
          id
          name
          primary
          enableAcceleratedNetworking
          enableFpga
          enableIPForwarding
          deleteOption
          networkSecurityGroup{
            id
          }
          dnsSettings{
            dnsServers
          }
          ipConfigurations{
            id
            name
            privateIPAddressVersion
            primary
            subnetId
            applicationGatewayBackendAddressPools{
              id
            }
            applicationSecurityGroups{
              id
            }
            loadBalancerBackendAddressPools{
              id
            }
            loadBalancerInboundNatPools{
              id
            }
          }
        }
      }
      diagnosticsProfile{
        bootDiagnostics{
          enabled
        }
      }
      extensionProfile{
        extensions{
          id
          name
          forceUpdateTag
          type
          type1
          typeHandlerVersion
          publisher
          provisioningState
          provisionAfterExtensions
          autoUpgradeMinorVersion
          enableAutomaticUpgrade
          settings
        }
      }
    }
    scaleInPolicy{
      rules
    }
    resourceGroup{
      id
      # Other fields and connections here...
    }
    tags{
      id
      key
      value
    }
  }
}
﻿
Filtering
Get data for a single Azure Virtual Machine Scale Set key that you know the ID for:
GraphQL
query {
  getazureVirtualMachineScaleSet(id: "12345") {
    id
    # Other fields and connections here...
  }
}
query {
  getazureVirtualMachineScaleSet(id: "12345") {
    id
    # Other fields and connections here...
  }
}
﻿
Get data for all of the Virtual Machine Scale Sets in a certain Azure subscription:
GraphQL
query {
  queryazureVirtualMachineScaleSet(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
# kind
# region
# resourceGroupId
# provisioningState
# overprovision
# doNotRunExtensionsOnOverprovisionedVMs
# singlePlacementGroup
# platformFaultDomainCount
# uniqueId

# And the following Dgraph filters can also be applied:

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

# fulltext filters

# alloftext
# anyoftext
query {
  queryazureVirtualMachineScaleSet(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
# kind
# region
# resourceGroupId
# provisioningState
# overprovision
# doNotRunExtensionsOnOverprovisionedVMs
# singlePlacementGroup
# platformFaultDomainCount
# uniqueId

# 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 Machine Scale Sets that are NOT in a certain Azure subscription:
GraphQL
query {
  queryazureVirtualMachineScaleSet(filter: { not: { subscriptionId: { eq: "12345" } } }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureVirtualMachineScaleSet(filter: { not: { subscriptionId: { eq: "12345" } } }) {
    id
    # Other fields and connections here...
  }
}
﻿
Advanced Filtering
Get data for all of the Virtual Machine Scale Sets that are connected to a resourceGroup:
GraphQL
query {
  queryazureVirtualMachineScaleSet(filter: { has: resourceGroup }) {
    id
    # Other fields and connections here...
  }
}

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

# id
# name
# type
# kind
# region
# resourceGroupId
# provisioningState
# overprovision
# doNotRunExtensionsOnOverprovisionedVMs
# singlePlacementGroup
# platformFaultDomainCount
# uniqueId
# tags
query {
  queryazureVirtualMachineScaleSet(filter: { has: resourceGroup }) {
    id
    # Other fields and connections here...
  }
}

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

# id
# name
# type
# kind
# region
# resourceGroupId
# provisioningState
# overprovision
# doNotRunExtensionsOnOverprovisionedVMs
# singlePlacementGroup
# platformFaultDomainCount
# uniqueId
# tags
﻿
Ordering
You can order the results you get back either asc or desc depending on your preference:
GraphQL
query {
  queryazureVirtualMachineScaleSet(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
# subscriptionId
# type
# kind
# region
# resourceGroupId
# provisioningState
# overprovision
# doNotRunExtensionsOnOverprovisionedVMs
# singlePlacementGroup
# platformFaultDomainCount
# uniqueId
query {
  queryazureVirtualMachineScaleSet(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
# subscriptionId
# type
# kind
# region
# resourceGroupId
# provisioningState
# overprovision
# doNotRunExtensionsOnOverprovisionedVMs
# singlePlacementGroup
# platformFaultDomainCount
# uniqueId
﻿
Only select and return the first two Virtual Machine Scale Sets that are found:
GraphQL
query {
  queryazureVirtualMachineScaleSet(first: 2, order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureVirtualMachineScaleSet(first: 2, order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}
﻿
Only select and return the first two Virtual Machine Scale Sets that are found, but offset by one so keys two & three are returned:
GraphQL
query {
  queryazureVirtualMachineScaleSet(first: 2, order: { desc: name }, offset: 1) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureVirtualMachineScaleSet(first: 2, order: { desc: name }, offset: 1) {
    id
    # Other fields and connections here...
  }
}
﻿
Aggregation
Count the number of Virtual Machine Scale Sets across all scanned Azure subscriptions:
GraphQL
query {
  aggregateazureVirtualMachineScaleSet {
    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 Scale Sets:

# idMin
# idMax
# nameMin
# nameMax
# typeMin
# typeMax
# kindMin
# kindMax
# subscriptionIdMin
# subscriptionIdMax
# regionMin
# regionMax
# resourceGroupIdMin
# resourceGroupIdMax
# provisioningStateMin
# provisioningStateMax
# platformFaultDomainCountMin
# platformFaultDomainCountMax
# platformFaultDomainCountSum
# platformFaultDomainCountAvg
# uniqueIdMin
# uniqueIdMax
query {
  aggregateazureVirtualMachineScaleSet {
    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 Scale Sets:

# idMin
# idMax
# nameMin
# nameMax
# typeMin
# typeMax
# kindMin
# kindMax
# subscriptionIdMin
# subscriptionIdMax
# regionMin
# regionMax
# resourceGroupIdMin
# resourceGroupIdMax
# provisioningStateMin
# provisioningStateMax
# platformFaultDomainCountMin
# platformFaultDomainCountMax
# platformFaultDomainCountSum
# platformFaultDomainCountAvg
# uniqueIdMin
# uniqueIdMax
﻿
Count the number of Virtual Machine Scale Sets in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
query {
  aggregateazureVirtualMachineScaleSet(filter: { subscriptionId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
query {
  aggregateazureVirtualMachineScaleSet(filter: { subscriptionId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
﻿
Examples
Find all of the Virtual Machine Scale Sets that are in the eastus region across all your accounts:
GraphQL
query {
  queryazureVirtualMachineScaleSet(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureVirtualMachineScaleSet(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
}
﻿
Find all of the Virtual Machine Scale Sets that have a tag of Environment:Production for a single Azure Subscription:
GraphQL
query {
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    virtualMachineScaleSets(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}
query {
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    virtualMachineScaleSets(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" } }
  ) {
    virtualMachineScaleSets(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}
query {
  queryazureVirtualMachine(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    virtualMachineScaleSets(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}
﻿
Kitchen Sink
Putting it all together; get all data for all Virtual Machine Scale Sets 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 {
  queryazureVirtualMachineScaleSet {
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    provisioningState
    overprovision
    doNotRunExtensionsOnOverprovisionedVMs
    singlePlacementGroup
    platformFaultDomainCount
    uniqueId
    virtualMachineProfile {
      osProfile {
        computerNamePrefix
        adminUsername
        allowExtensionOperations
        requireGuestProvisionSignal
        linuxConfiguration {
          disablePasswordAuthentication
          provisionVMAgent
          ssh {
            publicKeys {
              path
              keyData
            }
          }
        }
        windowsConfiguration {
          provisionVMAgent
          enableAutomaticUpdates
          timeZone
          ssh {
            publicKeys {
              path
              keyData
            }
          }
        }
        secrets {
          sourceVault {
            id
          }
          vaultCertificates {
            certificateUrl
            certificateStore
          }
        }
      }
      storageProfile {
        imageReference {
          id
          sku
          offer
          version
          publisher
        }
        osDisk {
          caching
          createOption
          osType
          diskSizeGB
          writeAcceleratorEnabled
          managedDisk {
            storageAccountType
          }
        }
      }
      networkProfile {
        networkInterfaceConfigurations {
          id
          name
          primary
          enableAcceleratedNetworking
          enableFpga
          enableIPForwarding
          deleteOption
          networkSecurityGroup {
            id
          }
          dnsSettings {
            dnsServers
          }
          ipConfigurations {
            id
            name
            privateIPAddressVersion
            primary
            subnetId
            applicationGatewayBackendAddressPools {
              id
            }
            applicationSecurityGroups {
              id
            }
            loadBalancerBackendAddressPools {
              id
            }
            loadBalancerInboundNatPools {
              id
            }
          }
        }
      }
      diagnosticsProfile {
        bootDiagnostics {
          enabled
        }
      }
      extensionProfile {
        extensions {
          id
          name
          forceUpdateTag
          type
          type1
          typeHandlerVersion
          publisher
          provisioningState
          provisionAfterExtensions
          autoUpgradeMinorVersion
          enableAutomaticUpgrade
          settings
        }
      }
    }
    scaleInPolicy {
      rules
    }

    resourceGroup {
      id
      name
      type
      kind
      subscriptionId
      region
      managedBy
      disks {
        id
        # Other fields and connections here...
      }
      appServicePlans {
        id
        # Other fields and connections here...
      }
      appServiceWebApps {
        id
        # Other fields and connections here...
      }
      disks {
        id
        # Other fields and connections here...
      }
      dns {
        id
        # Other fields and connections here...
      }
      eventGrids {
        id
        # Other fields and connections here...
      }
      eventHubs {
        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...
      }
      storageBlobs {
        id
        # Other fields and connections here...
      }
      storageContainers {
        id
        # Other fields and connections here...
      }
      virtualMachines {
        id
        # Other fields and connections here...
      }
      virtualMachineScaleSets {
        id
        # Other fields and connections here...
      }
      virtualNetworks {
        id
        # Other fields and connections here...
      }
      privateDns {
        id
        # Other fields and connections here...
      }
      tags {
        id
        key
        value
      }
    }
    tags {
      id
      key
      value
    }
  }
}

query {
  queryazureVirtualMachineScaleSet {
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    provisioningState
    overprovision
    doNotRunExtensionsOnOverprovisionedVMs
    singlePlacementGroup
    platformFaultDomainCount
    uniqueId
    virtualMachineProfile {
      osProfile {
        computerNamePrefix
        adminUsername
        allowExtensionOperations
        requireGuestProvisionSignal
        linuxConfiguration {
          disablePasswordAuthentication
          provisionVMAgent
          ssh {
            publicKeys {
              path
              keyData
            }
          }
        }
        windowsConfiguration {
          provisionVMAgent
          enableAutomaticUpdates
          timeZone
          ssh {
            publicKeys {
              path
              keyData
            }
          }
        }
        secrets {
          sourceVault {
            id
          }
          vaultCertificates {
            certificateUrl
            certificateStore
          }
        }
      }
      storageProfile {
        imageReference {
          id
          sku
          offer
          version
          publisher
        }
        osDisk {
          caching
          createOption
          osType
          diskSizeGB
          writeAcceleratorEnabled
          managedDisk {
            storageAccountType
          }
        }
      }
      networkProfile {
        networkInterfaceConfigurations {
          id
          name
          primary
          enableAcceleratedNetworking
          enableFpga
          enableIPForwarding
          deleteOption
          networkSecurityGroup {
            id
          }
          dnsSettings {
            dnsServers
          }
          ipConfigurations {
            id
            name
            privateIPAddressVersion
            primary
            subnetId
            applicationGatewayBackendAddressPools {
              id
            }
            applicationSecurityGroups {
              id
            }
            loadBalancerBackendAddressPools {
              id
            }
            loadBalancerInboundNatPools {
              id
            }
          }
        }
      }
      diagnosticsProfile {
        bootDiagnostics {
          enabled
        }
      }
      extensionProfile {
        extensions {
          id
          name
          forceUpdateTag
          type
          type1
          typeHandlerVersion
          publisher
          provisioningState
          provisionAfterExtensions
          autoUpgradeMinorVersion
          enableAutomaticUpgrade
          settings
        }
      }
    }
    scaleInPolicy {
      rules
    }

    resourceGroup {
      id
      name
      type
      kind
      subscriptionId
      region
      managedBy
      disks {
        id
        # Other fields and connections here...
      }
      appServicePlans {
        id
        # Other fields and connections here...
      }
      appServiceWebApps {
        id
        # Other fields and connections here...
      }
      disks {
        id
        # Other fields and connections here...
      }
      dns {
        id
        # Other fields and connections here...
      }
      eventGrids {
        id
        # Other fields and connections here...
      }
      eventHubs {
        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...
      }
      storageBlobs {
        id
        # Other fields and connections here...
      }
      storageContainers {
        id
        # Other fields and connections here...
      }
      virtualMachines {
        id
        # Other fields and connections here...
      }
      virtualMachineScaleSets {
        id
        # Other fields and connections here...
      }
      virtualNetworks {
        id
        # Other fields and connections here...
      }
      privateDns {
        id
        # Other fields and connections here...
      }
      tags {
        id
        key
        value
      }
    }
    tags {
      id
      key
      value
    }
  }
}
﻿
References
﻿Dgraph documentation on querying﻿
﻿Azure Virtual Machine Scale Set Documentation﻿
Updated 03 Mar 2023
Did this page help you?
Virtual Machine
Virtual Network
Docs powered by Archbee
TABLE OF CONTENTS