steampipe plugin install azure

Table: azure_cosmosdb_sql_database - Query Azure Cosmos DB SQL Databases using SQL

Azure Cosmos DB is a globally distributed, multi-model database service designed for scalable and high-performance modern applications. It is a fully managed NoSQL database for modern app development with guaranteed single-digit millisecond response times and 99.999-percent availability backed by SLAs, automatic and instant scalability, and open source APIs for MongoDB and Cassandra. A SQL Database in Azure Cosmos DB is a schema-less JSON database engine with SQL querying capabilities.

Table Usage Guide

The azure_cosmosdb_sql_database table provides detailed insights into SQL Databases within Azure Cosmos DB. As a database administrator or developer, you can explore database-specific details through this table, including throughput settings, indexing policies, and associated metadata. Utilize it to monitor database performance, manage configurations, and ensure optimal resource utilization.

Examples

Basic info

Explore which Azure CosmosDB SQL databases are tied to specific accounts and regions. This can be helpful in managing resources and understanding the distribution of databases across different regions and accounts.

select
name,
account_name,
database_users,
region,
resource_group
from
azure_cosmosdb_sql_database;
select
name,
account_name,
database_users,
region,
resource_group
from
azure_cosmosdb_sql_database;

Database count per cosmosdb accounts

Determine the number of databases associated with each CosmosDB account to better manage resources and plan for scaling needs.

select
account_name,
count(name) as database_count
from
azure_cosmosdb_sql_database
group by
account_name;
select
account_name,
count(name) as database_count
from
azure_cosmosdb_sql_database
group by
account_name;

List of sql databases without application tag key

Identify Azure Cosmos DB SQL databases that have not been tagged with an 'application' key. This can be useful in managing and organizing databases, particularly in larger systems where proper tagging can streamline operations and maintenance.

select
name,
tags
from
azure_cosmosdb_sql_database
where
not tags :: JSONB ? 'application';
select
name,
tags
from
azure_cosmosdb_sql_database
where
json_extract(tags, '$.application') is null;

Schema for azure_cosmosdb_sql_database

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
account_nametext=The friendly name that identifies the database account in which the database is created.
akasjsonbArray of globally unique identifier strings (also known as) for the resource.
autoscale_settings_max_throughputbigintContains maximum throughput, the resource can scale up to.
cloud_environmenttextThe Azure Cloud Environment.
database_collstextA system generated property that specified the addressable path of the collections resource.
database_etagtextA system generated property representing the resource etag required for optimistic concurrency control.
database_idtextName of the Cosmos DB SQL database.
database_ridtextA system generated unique identifier for database.
database_tsbigintA system generated property that denotes the last updated timestamp of the resource.
database_userstextA system generated property that specifies the addressable path of the users resource.
idtextContains ID to identify a sql database uniquely.
nametext=The friendly name that identifies the sql database.
regiontextThe Azure region/location in which the resource is located.
resource_grouptext=The resource group which holds this resource.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
subscription_idtext=, !=, ~~, ~~*, !~~, !~~*The Azure Subscription ID in which the resource is located.
tagsjsonbA map of tags for the resource.
throughputbigintContains the value of the Cosmos DB resource throughput or autoscaleSettings.
titletextTitle of the resource.
typetextType of the resource.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- azure

You can pass the configuration to the command with the --config argument:

steampipe_export_azure --config '<your_config>' azure_cosmosdb_sql_database