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 

Network Interface

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 a Network Interface

GraphQL
|
query {
  queryazureNetworkInterface{
    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...
    }
  }
}


Filtering

Get data for a single Network Interface key that you know the ID for:

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


Get data for all of the Network Interfaces in a certain Azure subscription:

GraphQL
|
query {
  queryazureNetworkInterface(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
# applicationRuleCollections
# natRuleCollections
# networkRuleCollections
# ipConfigurations
# managementIpConfiguration
# provisioningState
# threatIntelMode
# virtualHub
# firewallPolicy
# hubIPAddresses
# ipGroups
# additionalProperties
# zones

# 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 Network Interfaces that are NOT in a certain Azure subscription:

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


Advanced Filtering

Get data for all of the Network Interfaces that are connected to a virtualNetwork:

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

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

# applicationRuleCollections
# natRuleCollections
# networkRuleCollections
# ipConfigurations
# managementIpConfiguration
# provisioningState
# threatIntelMode
# virtualHub
# firewallPolicy
# hubIPAddresses
# ipGroups
# additionalProperties
# zones
# publicIps


Ordering

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

GraphQL
|
query {
  queryazureNetworkInterface(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
# kind
# region
# resourceGroupId
# provisioningState
# threatIntelMode
# virtualHub
# firewallPolicy


Only select and return the first two Network Interfaces that are found:

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


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

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


Aggregation

Count the number of Network Interfaces across all scanned Azure subscriptions:

GraphQL
|
query {
  aggregateazureNetworkInterface {
    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 Disks:

 
# idMin
# idMax
# nameMin
# nameMax
# typeMin
# typeMax
# kindMin
# kindMax
# subscriptionIdMin
# subscriptionIdMax
# regionMin
# regionMax
# resourceGroupIdMin
# resourceGroupIdMax
# macAddressMin
# macAddressMax
# privateIpAddressMin
# privateIpAddressMax
# internalDnsNameLabelMin
# internalDnsNameLabelMax
# virtualMachineIdMin
# virtualMachineIdMax
# internalDomainNameSuffixMin
# internalDomainNameSuffixMax


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

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


Examples

Find all of the Network Interfaces that are in the eastus region across all your accounts:

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


Find all of the Network Interfacesetwork that have a tag of Environment:Production for a single Azure Subscription:

GraphQL
|
query {
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    networkInterfaces(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 {
  queryazureNetworkInterface(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    networkInterfaces(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}


Kitchen Sink

Putting it all together; get all data for all NetworkInterfaces 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, firewall -> virtualNetwork -> networkInterface ...etc:

GraphQL
|
query {
  queryazureNetworkInterface{
    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
    tags{
      id
      key
      value
    }
    resourceGroup{
      id
      name
      type
      kind
      subscriptionId
      region
      managedBy
    }
    virtualNetworks{
      id
      name
      type
      kind
      subscriptionId
      region
      addressSpacePrefixes
      dnsServers
      ddosProtectionPlans {
        id
      }
      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...
      }
    }
    publicIps{
      id
      name
      type
      kind
      subscriptionId
      region
      resourceGroupId
      tier
      allocationMethod
      ipVersion
      dnsSettings{
        domainNameLabel
        fqdn
        reverseFqdn
      }
      ipTags{
        ipTagType
        tag
      }
      ipAddress
      idleTimeoutInMinutes
      resourceGuid
      zones
      firewalls{
        id
        # Other fields and connections here...
      }
      networkInterface{
        id
        # Other fields and connections here...
      }
      resourceGroup{
        id
        # Other fields and connections here...
      }
    }
    securityGroups {
        id
        name
        type
        kind
        subscriptionId
        region
        resourceGroupId
        resourceGuid
        provisioningState
        etag
        securityRules{
          description
          protocol
          sourcePortRange
          destinationPortRange
          sourceAddressPrefix
          sourceAddressPrefixes
          sourceApplicationSecurityGroups{
            provisioningState
            etag
          }
          destinationAddressPrefix
          destinationAddressPrefixes
          destinationApplicationSecurityGroups{
            provisioningState
            etag
          }
          sourcePortRanges
          destinationPortRanges
          access
          priority
          direction
          provisioningState
          name
          etag
          type
        }
        defaultSecurityRules{
          description
          protocol
          sourcePortRange
          destinationPortRange
          sourceAddressPrefix
          sourceAddressPrefixes
          sourceApplicationSecurityGroups{
            provisioningState
            etag
          }
          destinationAddressPrefix
          destinationAddressPrefixes
          destinationApplicationSecurityGroups{
            provisioningState
            etag
          }
          sourcePortRanges
          destinationPortRanges
          access
          priority
          direction
          provisioningState
          name
          etag
          type
        }
        networkInterfaces{
          id
          # Other fields and connections here...
        }
        resourceGroup{
          id
          # Other fields and connections here...
        }
      }
    virtualMachines{
        id
        name
        type
        kind
        subscriptionId
        region
        resourceGroupId
        managedBy
        vmSize
        osProfile{
          computerName
          windowsConfiguration{
            provisionVMAgent
            enableAutomaticUpdates
            timeZone
          }
          linuxConfiguration{
            disablePasswordAuthentication
            provisionVMAgent
          }
          allowExtensionOperations
          requireGuestProvisionSignal
        }
        osType
        storageImageReference{
          publisher
          offer
          sku
          version
          exactVersion
        }
        bootDiagnostics
        licenseType
        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...
        }
      }
  }
}


References

Dgraph documentation on querying

Azure Network Interface Documentation

Updated 03 Mar 2023
Did this page help you?
Yes
No
PREVIOUS
Activity Log Alert
NEXT
Policy Assignment
Docs powered by archbee 
TABLE OF CONTENTS
Overview
Filtering
Advanced Filtering
Ordering
Aggregation
Examples
Kitchen Sink
References