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.
You can currently query the following attributes and connections on an Azure Public IP
query {
queryazurePublicIp{
id
name
type
kind
subscriptionId
region
resourceGroupId
tier
allocationMethod
ipVersion
dnsSettings{
domainNameLabel
fqdn
reverseFqdn
}
ipTags {
ipTagType
tag
}
ipAddress
idleTimeoutInMinutes
resourceGuid
zones
firewalls{
id
}
networkInterface{
id
}
resourceGroup{
id
}
tags{
id
key
value
}
}
}
Get data for a single Azure Public IP key that you know the ID for:
query {
getazurePublicIp(id: "12345") {
id
}
}
Get data for all of the Public IPs in a certain Azure subscription:
query {
queryazurePublicIp(filter: { subscriptionId: { eq: "12345" } }) {
id
}
}
Get data for all of the Public IPs that are NOT in a certain Azure subscription:
query {
queryazurePublicIp(filter: { not: { subscriptionId: { eq: "12345" } } }) {
id
}
}
Get data for all of the Public IPs that are connected to a ipTag:
query {
queryazurePublicIp(filter: { has: ipTags }) {
id
}
}
You can order the results you get back either asc or desc depending on your preference:
query {
queryazurePublicIp(order: { desc: name }) {
id
}
}
Only select and return the first two Public IPs that are found:
query {
queryazurePublicIp(first: 2, order: { desc: name }) {
id
}
}
Only select and return the first two Public IPs that are found, but offset by one so keys two & three are returned:
query {
queryazurePublicIp(first: 2, order: { desc: name }, offset: 1) {
id
}
}
Count the number of Public IPs across all scanned Azure subscriptions:
query {
aggregateazurePublicIp {
count
}
}
Count the number of Public IPs in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
query {
aggregateazurePublicIp(filter: { subscriptionId: { eq: "12345" } }) {
count
}
}
Find all of the Public IPs that are in the eastus region across all your accounts:
query {
queryazurePublicIp(filter: { region: { eq: "eastus" } }) {
id
}
}
Find all of the Disks that have a tag of Environment:Production for a single Azure Subscription:
query {
queryazureTag(
filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
) {
publicIps(filter: { subscriptionId: { eq: "12345" } }) {
id
}
}
}
With CloudGraph you can run multiple queries at the same time so you can combine the above two queries if you like:
query {
queryazurePublicIp(filter: { region: { eq: "eastus" } }) {
id
}
queryazureTag(
filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
) {
publicIps(filter: { subscriptionId: { eq: "12345" } }) {
id
}
}
}
Putting it all together; get all data for all Public IPs 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, firewalls -> virtualNetworks -> networkInterface ...etc:
query {
queryazurePublicIp{
id
name
type
kind
subscriptionId
region
resourceGroupId
tier
allocationMethod
ipVersion
dnsSettings{
domainNameLabel
fqdn
reverseFqdn
}
ipTags {
ipTagType
tag
}
ipAddress
idleTimeoutInMinutes
resourceGuid
zones
firewalls {
id
name
type
kind
subscriptionId
region
resourceGroupId
applicationRuleCollections{
id
name
priority
action
rules{
id
name
description
sourceAddresses
protocols{
id
protocolType
port
}
targetFqdns
fqdnTags
sourceIpGroups
}
provisioningState
}
natRuleCollections{
id
name
priority
action
rules{
id
name
description
sourceAddresses
destinationAddresses
destinationPorts
protocols
translatedAddress
translatedPort
translatedFqdn
sourceIpGroups
}
provisioningState
}
networkRuleCollections{
id
name
priority
action
rules{
id
name
description
protocols
sourceAddresses
destinationAddresses
destinationPorts
destinationFqdns
sourceIpGroups
destinationIpGroups
}
provisioningState
}
ipConfigurations{
id
name
privateIPAddress
subnet
publicIPAddress
provisioningState
type
}
managementIpConfiguration{
id
privateIPAddress
subnet
publicIPAddress
provisioningState
name
type
}
provisioningState
threatIntelMode
virtualHub
firewallPolicy
hubIPAddresses{
publicIPs
privateIPAddress
}
ipGroups{
id
changeNumber
}
additionalProperties{
id
key
value
}
zones
region
tags {
id
key
value
}
resourceGroup{
id
}
virtualNetworks{
id
}
publicIps{
id
}
}
networkInterface{
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
}
resourceGroup{
id
}
securityGroups{
id
}
virtualMachines{
id
}
virtualNetworks{
id
}
}
resourceGroup{
id
name
type
kind
subscriptionId
region
managedBy
disks {
id
}
dns {
id
}
firewalls {
id
}
functionApps {
id
}
keyVaults {
id
}
networkInterfaces {
id
}
publicIps {
id
}
securityGroups {
id
}
storageAccounts {
id
}
storageContainers {
id
}
virtualMachines {
id
}
virtualMachineScaleSets{
id
}
virtualNetworks {
id
}
tags{
id
key
value
}
}
tags{
id
key
value
}
}
}
