Security Settings

13min
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.
OverviewYou can currently query the following attributes and connections on an Azure Security Setting
GraphQL
|
query {
  queryazureSecuritySetting{
    id
    name
    type
    kind
    enabled
    subscriptionId
    region
  }
}
query {
  queryazureSecuritySetting{
    id
    name
    type
    kind
    enabled
    subscriptionId
    region
  }
}
﻿
FilteringGet data for a single Azure Security Setting key that you know the ID for:
GraphQL
|
query {
  getazureSecuritySetting(id: "12345") {
    id
    # Other fields and connections here...
  }
}
query {
  getazureSecuritySetting(id: "12345") {
    id
    # Other fields and connections here...
  }
}
﻿
Get data for all of the Security Settings in a certain Azure subscription:
GraphQL
|
query {
  queryazureSecuritySetting(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
# enabled
# region

# And the following Dgraph filters can also be applied:

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

# fulltext filters

# alloftext
# anyoftext
query {
  queryazureSecuritySetting(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
# enabled
# region

# 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 Security Settings that are NOT in a certain Azure subscription:
GraphQL
|
query {
  queryazureSecuritySetting(filter: { not: { subscriptionId: { eq: "12345" } } }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureSecuritySetting(filter: { not: { subscriptionId: { eq: "12345" } } }) {
    id
    # Other fields and connections here...
  }
}
﻿
OrderingYou can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query {
  queryazureSecuritySetting(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
# name
# type
# kind
# enabled
# region
# subscriptionId
query {
  queryazureSecuritySetting(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
# name
# type
# kind
# enabled
# region
# subscriptionId
﻿
Only select and return the first two Security Settings that are found:
GraphQL
|
query {
  queryazureSecuritySetting(first: 2, order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureSecuritySetting(first: 2, order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}
﻿
Only select and return the first two Security Settings that are found, but offset by one so keys two & three are returned:
GraphQL
|
query {
  queryazureSecuritySetting(first: 2, order: { desc: name }, offset: 1) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureSecuritySetting(first: 2, order: { desc: name }, offset: 1) {
    id
    # Other fields and connections here...
  }
}
﻿
AggregationCount the number of Security Settings across all scanned Azure subscriptions:
GraphQL
|
query {
  aggregateazureSecuritySetting {
    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 Security Settings:

# idMin
# idMax
# nameMin
# nameMax
# typeMin
# typeMax
# kindMin
# kindMax
# subscriptionIdMin
# subscriptionIdMax
# regionMin
# regionMax
query {
  aggregateazureSecuritySetting {
    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 Security Settings:

# idMin
# idMax
# nameMin
# nameMax
# typeMin
# typeMax
# kindMin
# kindMax
# subscriptionIdMin
# subscriptionIdMax
# regionMin
# regionMax
﻿
Count the number of Security Settings in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query {
  aggregateazureSecuritySetting(filter: { subscriptionId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
query {
  aggregateazureSecuritySetting(filter: { subscriptionId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
﻿
ExamplesFind all of the Security Settings that are in the eastus region across all your accounts:
GraphQL
|
query {
  queryazureSecuritySetting(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureSecuritySetting(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
}
﻿
Kitchen SinkPutting it all together; get all data for all Security Settings across all regions for all scanned Azure subscriptions in a single query:
GraphQL
|
query {
  queryazureSecuritySetting{
    id
    name
    type
    kind
    enabled
    subscriptionId
    region    
  }
}
query {
  queryazureSecuritySetting{
    id
    name
    type
    kind
    enabled
    subscriptionId
    region    
  }
}
﻿
References﻿Dgraph documentation on querying﻿
Updated 03 Mar 2023
Did this page help you?
Yes
Security Pricings
Security Group (Network)
Docs powered by archbee
TABLE OF CONTENTS