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 

Azure Cosmos DB

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 an Azure Cosmos DB

GraphQL
|
query { 
  queryazureCosmosDb {
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    provisioningState
    documentEndpoint
    databaseAccountOfferType
    createdBy
    createdByType
    createdAt
    lastModifiedBy
    lastModifiedByType
    lastModifiedAt
    isVirtualNetworkFilterEnabled
    enableAutomaticFailover
    enableMultipleWriteLocations
    enableCassandraConnector
    connectorOffer
    disableKeyBasedMetadataWriteAccess
    keyVaultKeyUri
    defaultIdentity
    publicNetworkAccess
    enableFreeTier
    apiServerVersion
    enableAnalyticalStorage
    analyticalStorageConfigurationSchemaType
    instanceId
    createMode
    networkAclBypass
    networkAclBypassResourceIds
    disableLocalAuth
    capacityTotalThroughputLimit
    tags {
      id
      key
      value
    }  
    identity {
      principalId
      type
      tenantId
      userAssignedIdentities {
        id
        key
        value {
          principalId
          clientId
        }
      }
      userAssignedIdentitiesAggregate {
        count
        idMin
        idMax
        keyMin
        keyMax
      }
    }
    ipRules {
      id
      ipAddressOrRange
    }
    consistencyPolicy {
      defaultConsistencyLevel
      maxStalenessPrefix
      maxIntervalInSeconds
    }
    capabilities {
      id
      name
    }
    writeLocations {
      id
      locationName
      documentEndpoint
      provisioningState
      failoverPriority
      isZoneRedundant
    }
    readLocations {
      id
      locationName
      documentEndpoint
      provisioningState
      failoverPriority
      isZoneRedundant
    }
    locations {
      id
      locationName
      documentEndpoint
      provisioningState
      failoverPriority
      isZoneRedundant
    }
    failoverPolicies {
      id
      locationName
      failoverPriority
    }
    virtualNetworkRules {
      id
      ignoreMissingVNetServiceEndpoint
    }
    privateEndpointConnections {
      id
      name
      type
      privateEndpointId
      privateLinkServiceConnectionState {
        status
        description
        actionsRequired
      }
      groupId
      provisioningState
    }
    restoreParameters {
      restoreMode
      restoreSource
      restoreTimestampInUtc
      databasesToRestore {
        id
        databaseName
        collectionNames
      }
      databasesToRestoreAggregate {
        count
        idMin
        idMax
        databaseNameMin
        databaseNameMax
      }
    }
    backupPolicy {
      type
      migrationState {
        status
        targetType
        startTime
      }
      periodicModeProperties {
        backupIntervalInMinutes
        backupRetentionIntervalInHours
        backupStorageRedundancy
      }
    }
    cors {
      id
      allowedOrigins
      allowedMethods
      allowedHeaders
      exposedHeaders
      maxAgeInSeconds
    }
    databases {
      id
      name
      type
      options {
        throughput
        maxThroughput
      }
      resource {
        id
        rid
        ts
        etag
      }
      data {
        id
        name
        type
      }
    }
    azureTables {
      id
      name
      type
      options {
        throughput
        maxThroughput
      }
      resource {
        id
        rid
        ts
        etag
      }
    }
    resourceGroup {
      id
      # Other fields and connections here...
    }
  }
}


Filtering

Get data for a single Azure Cosmos DB key that you know the ID for:

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


Get data for all of the Azure Cosmos DB in a certain region:

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

# Note that in addition to "region" you can
# Filter based on any of the following attributes:

# id
# name
# type
# kind
# subscriptionId
# resourceGroupId
# provisioningState
# documentEndpoint
# databaseAccountOfferType
# createdBy
# createdByType
# createdAt
# lastModifiedBy
# lastModifiedByType
# lastModifiedAt
# isVirtualNetworkFilterEnabled
# enableAutomaticFailover
# enableMultipleWriteLocations
# enableCassandraConnector
# connectorOffer
# disableKeyBasedMetadataWriteAccess
# keyVaultKeyUri
# defaultIdentity
# publicNetworkAccess
# enableFreeTier
# apiServerVersion
# enableAnalyticalStorage
# analyticalStorageConfigurationSchemaType
# instanceId
# createMode
# networkAclBypass
# networkAclBypassResourceIds
# disableLocalAuth
# capacityTotalThroughputLimit

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

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


Advanced Filtering

Get data for all of the Azure Cosmos DB that

GraphQL
|
query {
  queryazureCosmosDb(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
# subscriptionId
# resourceGroupId
# provisioningState
# documentEndpoint
# databaseAccountOfferType
# createdBy
# createdByType
# createdAt
# lastModifiedBy
# lastModifiedByType
# lastModifiedAt
# isVirtualNetworkFilterEnabled
# enableAutomaticFailover
# enableMultipleWriteLocations
# enableCassandraConnector
# connectorOffer
# disableKeyBasedMetadataWriteAccess
# keyVaultKeyUri
# defaultIdentity
# publicNetworkAccess
# enableFreeTier
# apiServerVersion
# enableAnalyticalStorage
# analyticalStorageConfigurationSchemaType
# instanceId
# createMode
# networkAclBypass
# networkAclBypassResourceIds
# disableLocalAuth
# capacityTotalThroughputLimit
# tags
# identity
# ipRules
# consistencyPolicy
# capabilities
# writeLocations
# readLocations
# locations
# failoverPolicies
# virtualNetworkRules
# privateEndpointConnections
# restoreParameters
# backupPolicy
# cors
# databases
# azureTables


Ordering

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

GraphQL
|
query {
  queryazureCosmosDb(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
# subscriptionId
# resourceGroupId
# provisioningState
# documentEndpoint
# databaseAccountOfferType
# createdBy
# createdByType
# createdAt
# lastModifiedBy
# lastModifiedByType
# lastModifiedAt
# isVirtualNetworkFilterEnabled
# enableAutomaticFailover
# enableMultipleWriteLocations
# enableCassandraConnector
# connectorOffer
# disableKeyBasedMetadataWriteAccess
# keyVaultKeyUri
# defaultIdentity
# publicNetworkAccess
# enableFreeTier
# apiServerVersion
# enableAnalyticalStorage
# analyticalStorageConfigurationSchemaType
# instanceId
# createMode
# networkAclBypass
# disableLocalAuth
# capacityTotalThroughputLimit


Only select and return the first two Azure Cosmos DB that are found:

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


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

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


Aggregation

Count the number of Azure Cosmos DB across all scanned Azure subscriptions:

GraphQL
|
query {
  aggregateazureCosmosDb {
    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 Azure Cosmos DB:

# idMin
# idMax
# typeMin
# typeMax
# kindMin
# kindMax
# subscriptionIdMin
# subscriptionIdMax
# resourceGroupIdMin
# resourceGroupIdMax
# provisioningStateMin
# provisioningStateMax
# documentEndpointMin
# documentEndpointMax
# databaseAccountOfferTypeMin
# databaseAccountOfferTypeMax
# createdByMin
# createdByMax
# createdByTypeMin
# createdByTypeMax
# createdAtMin
# createdAtMax
# lastModifiedByMin
# lastModifiedByMax
# lastModifiedByTypeMin
# lastModifiedByTypeMax
# lastModifiedAtMin
# lastModifiedAtMax
# connectorOfferMin
# connectorOfferMax
# keyVaultKeyUriMin
# keyVaultKeyUriMax
# defaultIdentityMin
# defaultIdentityMax
# publicNetworkAccessMin
# publicNetworkAccessMax
# apiServerVersionMin
# apiServerVersionMax
# analyticalStorageConfigurationSchemaTypeMin
# analyticalStorageConfigurationSchemaTypeMax
# instanceIdMin
# instanceIdMax
# createModeMin
# createModeMax
# networkAclBypassMin
# networkAclBypassMax
# capacityTotalThroughputLimitMin
# capacityTotalThroughputLimitMax


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

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


Examples

Find all of the Azure Cosmos DB that are in the eastus region across all your accounts:

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


Find all of the Azure Cosmos DB that have a tag of Environment:Production for a single Azure Subscription:

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


Kitchen Sink

Putting it all together; get all data for all Azure Cosmos DB 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, cosmosDb -> resourceGroup -> securityGroups ...etc:

GraphQL
|
query { 
  queryazureCosmosDb {
    id
    name
    type
    kind
    subscriptionId
    region
    resourceGroupId
    provisioningState
    documentEndpoint
    databaseAccountOfferType
    createdBy
    createdByType
    createdAt
    lastModifiedBy
    lastModifiedByType
    lastModifiedAt
    isVirtualNetworkFilterEnabled
    enableAutomaticFailover
    enableMultipleWriteLocations
    enableCassandraConnector
    connectorOffer
    disableKeyBasedMetadataWriteAccess
    keyVaultKeyUri
    defaultIdentity
    publicNetworkAccess
    enableFreeTier
    apiServerVersion
    enableAnalyticalStorage
    analyticalStorageConfigurationSchemaType
    instanceId
    createMode
    networkAclBypass
    networkAclBypassResourceIds
    disableLocalAuth
    capacityTotalThroughputLimit
    tags {
      id
      key
      value
    }  
    identity {
      principalId
      type
      tenantId
      userAssignedIdentities {
        id
        key
        value {
          principalId
          clientId
        }
      }
      userAssignedIdentitiesAggregate {
        count
        idMin
        idMax
        keyMin
        keyMax
      }
    }
    ipRules {
      id
      ipAddressOrRange
    }
    consistencyPolicy {
      defaultConsistencyLevel
      maxStalenessPrefix
      maxIntervalInSeconds
    }
    capabilities {
      id
      name
    }
    writeLocations {
      id
      locationName
      documentEndpoint
      provisioningState
      failoverPriority
      isZoneRedundant
    }
    readLocations {
      id
      locationName
      documentEndpoint
      provisioningState
      failoverPriority
      isZoneRedundant
    }
    locations {
      id
      locationName
      documentEndpoint
      provisioningState
      failoverPriority
      isZoneRedundant
    }
    failoverPolicies {
      id
      locationName
      failoverPriority
    }
    virtualNetworkRules {
      id
      ignoreMissingVNetServiceEndpoint
    }
    privateEndpointConnections {
      id
      name
      type
      privateEndpointId
      privateLinkServiceConnectionState {
        status
        description
        actionsRequired
      }
      groupId
      provisioningState
    }
    restoreParameters {
      restoreMode
      restoreSource
      restoreTimestampInUtc
      databasesToRestore {
        id
        databaseName
        collectionNames
      }
      databasesToRestoreAggregate {
        count
        idMin
        idMax
        databaseNameMin
        databaseNameMax
      }
    }
    backupPolicy {
      type
      migrationState {
        status
        targetType
        startTime
      }
      periodicModeProperties {
        backupIntervalInMinutes
        backupRetentionIntervalInHours
        backupStorageRedundancy
      }
    }
    cors {
      id
      allowedOrigins
      allowedMethods
      allowedHeaders
      exposedHeaders
      maxAgeInSeconds
    }
    databases {
      id
      name
      type
      options {
        throughput
        maxThroughput
      }
      resource {
        id
        rid
        ts
        etag
      }
      data {
        id
        name
        type
      }
    }
    azureTables {
      id
      name
      type
      options {
        throughput
        maxThroughput
      }
      resource {
        id
        rid
        ts
        etag
      }
    }
    resourceGroup {
      id
      name
      type
      kind
      subscriptionId
      region
      managedBy
      disks {
        id
        # Other fields and connections here...
      }
      dns {
        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...
      }
      storageContainers {
        id
        # Other fields and connections here...
      }
      virtualMachines {
        id
        # Other fields and connections here...
      }
      virtualNetworks {
        id
        # Other fields and connections here...
      }
      tags{
        id
        key
        value
      }
    }
  }
}


References

Dgraph documentation on querying

Azure Cosmos DB Documentation

Updated 03 Mar 2023
Did this page help you?
Yes
No
PREVIOUS
AuthRoleDefinition
NEXT
CDN Custom Domains
Docs powered by archbee 
TABLE OF CONTENTS
Overview
Filtering
Advanced Filtering
Ordering
Aggregation
Examples
Kitchen Sink
References