Key Vault

15min
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 Key Vault
GraphQL
|
query {
  queryazureKeyVault{
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    tenantId
    accessPolicies{
      id
      objectId
      applicationId
      permissionKeys
      permissionSecrets
      permissionCertificates
      permissionStorage
    }
    vaultUri
    enabledForDeployment
    enabledForDiskEncryption
    enabledForTemplateDeployment
    enableSoftDelete
    createMode
    enablePurgeProtection
    networkAclBypass
    networkAclDefaultAction
    networkAclIpRules
    networkAclVirtualNetworkRules
    tags{
      id
      key
      value
    }
    resourceGroup{
      id
      # Other fields and connections here...
    }
  }
}
query {
  queryazureKeyVault{
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    tenantId
    accessPolicies{
      id
      objectId
      applicationId
      permissionKeys
      permissionSecrets
      permissionCertificates
      permissionStorage
    }
    vaultUri
    enabledForDeployment
    enabledForDiskEncryption
    enabledForTemplateDeployment
    enableSoftDelete
    createMode
    enablePurgeProtection
    networkAclBypass
    networkAclDefaultAction
    networkAclIpRules
    networkAclVirtualNetworkRules
    tags{
      id
      key
      value
    }
    resourceGroup{
      id
      # Other fields and connections here...
    }
  }
}
﻿
Filtering
Get data for a single Key Vault that you know the ID for:
GraphQL
|
query {
  getazureKeyVault(id: "12345") {
    id
    # Other fields and connections here...
  }
}
query {
  getazureKeyVault(id: "12345") {
    id
    # Other fields and connections here...
  }
}
﻿
Get data for all of the Key Vaults in a certain Azure subscription:
GraphQL
|
query {
  queryazureKeyVault(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
# tenantId
# accessPolicies
# vaultUri
# enabledForDeployment
# enabledForDiskEncryption
# enabledForTemplateDeployment
# enableSoftDelete
# createMode
# enablePurgeProtection
# networkAclBypass
# networkAclDefaultAction
# networkAclIpRules
# networkAclVirtualNetworkRules

# And the following Dgraph filters can also be applied:

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

# fulltext filters

# alloftext
# anyoftext
query {
  queryazureKeyVault(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
# tenantId
# accessPolicies
# vaultUri
# enabledForDeployment
# enabledForDiskEncryption
# enabledForTemplateDeployment
# enableSoftDelete
# createMode
# enablePurgeProtection
# networkAclBypass
# networkAclDefaultAction
# networkAclIpRules
# networkAclVirtualNetworkRules

# 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 Key Vaults that are NOT in a certain Azure subscription:
GraphQL
|
query {
  queryazureKeyVault(filter: { not: { subscriptionId: { eq: "12345" } } }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureKeyVault(filter: { not: { subscriptionId: { eq: "12345" } } }) {
    id
    # Other fields and connections here...
  }
}
﻿
Ordering
You can order the results you get back either asc or desc depending on your preference:
GraphQL
|
query {
  queryazureKeyVault(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:

# tenantId: String @search(by: [hash, regexp])
# vaultUri
# enabledForDeployment
# enabledForDiskEncryption
# enabledForTemplateDeployment
# enableSoftDelete
# createMode
# enablePurgeProtection
# networkAclBypass
# networkAclDefaultAction
query {
  queryazureKeyVault(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:

# tenantId: String @search(by: [hash, regexp])
# vaultUri
# enabledForDeployment
# enabledForDiskEncryption
# enabledForTemplateDeployment
# enableSoftDelete
# createMode
# enablePurgeProtection
# networkAclBypass
# networkAclDefaultAction
﻿
Only select and return the first two Key Vaults that are found:
GraphQL
|
query {
  queryazureKeyVault(first: 2, order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureKeyVault(first: 2, order: { desc: name }) {
    id
    # Other fields and connections here...
  }
}
﻿
Only select and return the first two Key Vaults that are found, but offset by one so keys two & three are returned:
GraphQL
|
query {
  queryazureKeyVault(first: 2, order: { desc: name }, offset: 1) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureKeyVault(first: 2, order: { desc: name }, offset: 1) {
    id
    # Other fields and connections here...
  }
}
﻿
Aggregation
Count the number of Key Vaults across all scanned Azure subscriptions:
GraphQL
|
query {
  aggregateazureKeyVault{
    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
# tenantIdMin
# tenantIdMax
# vaultUriMin
# vaultUriMax
# enabledForDeploymentMin
# enabledForDeploymentMax
# enabledForDiskEncryptionMin
# enabledForDiskEncryptionMax
# enabledForTemplateDeploymentMin
# enabledForTemplateDeploymentMax
# enableSoftDeleteMin
# enableSoftDeleteMax
# createModeMin
# createModeMax
# enablePurgeProtectionMin
# enablePurgeProtectionMax
# networkAclBypassMin
# networkAclBypassMax
# networkAclDefaultActionMin
# networkAclDefaultActionMax
query {
  aggregateazureKeyVault{
    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
# tenantIdMin
# tenantIdMax
# vaultUriMin
# vaultUriMax
# enabledForDeploymentMin
# enabledForDeploymentMax
# enabledForDiskEncryptionMin
# enabledForDiskEncryptionMax
# enabledForTemplateDeploymentMin
# enabledForTemplateDeploymentMax
# enableSoftDeleteMin
# enableSoftDeleteMax
# createModeMin
# createModeMax
# enablePurgeProtectionMin
# enablePurgeProtectionMax
# networkAclBypassMin
# networkAclBypassMax
# networkAclDefaultActionMin
# networkAclDefaultActionMax
﻿
Count the number of Key Vaults in a single account. Note that you can apply all of the same filters that are listed above to aggregate queries:
GraphQL
|
query {
  aggregateazureKeyVault(filter: { subscriptionId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
query {
  aggregateazureKeyVault(filter: { subscriptionId: { eq: "12345" } }) {
    count
    # Other fields and connections here...
  }
}
﻿
Examples
Find all of the Key Vaults that are in the eastus region across all your accounts:
GraphQL
|
query {
  queryazureKeyVault(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
}
query {
  queryazureKeyVault(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
}
﻿
Find all of the Firewalls that have a tag of Environment:Production for a single Azure Subscription:
GraphQL
|
query {
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    keyVaults(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}
query {
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    keyVaults(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 {
  queryazureKeyVault(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    keyVaults(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}
query {
  queryazureKeyVault(filter: { region: { eq: "eastus" } }) {
    id
    # Other fields and connections here...
  }
  queryazureTag(
    filter: { key: { eq: "Environment" }, value: { eq: "Production" } }
  ) {
    keyVaults(filter: { subscriptionId: { eq: "12345" } }) {
      id
      # Other fields and connections here...
    }
  }
}
﻿
Kitchen Sink
Putting it all together; get all data for all Firewalls across all regions for all scanned Azure subscriptions in a single query.
GraphQL
|
query {
  queryazureKeyVault{
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    tenantId
    accessPolicies{
      id
      objectId
      applicationId
      permissionKeys
      permissionSecrets
      permissionCertificates
      permissionStorage
    }
    vaultUri
    enabledForDeployment
    enabledForDiskEncryption
    enabledForTemplateDeployment
    enableSoftDelete
    createMode
    enablePurgeProtection
    networkAclBypass
    networkAclDefaultAction
    networkAclIpRules
    networkAclVirtualNetworkRules
    tags{
      id
      key
      value
    }
    resourceGroup{
      id
      name
      type
      kind
      subscriptionId
      region
      managedBy
    }
  }
}
query {
  queryazureKeyVault{
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    tenantId
    accessPolicies{
      id
      objectId
      applicationId
      permissionKeys
      permissionSecrets
      permissionCertificates
      permissionStorage
    }
    vaultUri
    enabledForDeployment
    enabledForDiskEncryption
    enabledForTemplateDeployment
    enableSoftDelete
    createMode
    enablePurgeProtection
    networkAclBypass
    networkAclDefaultAction
    networkAclIpRules
    networkAclVirtualNetworkRules
    tags{
      id
      key
      value
    }
    resourceGroup{
      id
      name
      type
      kind
      subscriptionId
      region
      managedBy
    }
  }
}
﻿
References
﻿Dgraph documentation on querying﻿
﻿Azure Key Vault Documentation﻿
Updated 03 Mar 2023
Did this page help you?
TABLE OF CONTENTS