Labsco
microsoft logo

azure-resource-manager-cosmosdb-dotnet

✓ Official★ 2,700

by microsoft · part of microsoft/skills

Management plane SDK for provisioning and managing Azure Cosmos DB resources via Azure Resource Manager.

🔥🔥🔥✓ VerifiedFreeQuick setup
#automation#database#cloud#git#maps
🧩 One of 7 skills in the microsoft/skills package — works on its own, and pairs well with its siblings.

Management plane SDK for provisioning and managing Azure Cosmos DB resources via Azure Resource Manager.

Inspect the full instructions your agent will receiveExpand

This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.

by microsoft

Management plane SDK for provisioning and managing Azure Cosmos DB resources via Azure Resource Manager. npx skills add https://github.com/microsoft/agent-skills --skill azure-resource-manager-cosmosdb-dotnet Download ZIPGitHub2.7k

Azure.ResourceManager.CosmosDB (.NET)

Management plane SDK for provisioning and managing Azure Cosmos DB resources via Azure Resource Manager.

⚠️ Management vs Data Plane

  • This SDK (Azure.ResourceManager.CosmosDB): Create accounts, databases, containers, configure throughput, manage RBAC

  • Data Plane SDK (Microsoft.Azure.Cosmos): CRUD operations on documents, queries, stored procedures execution

Environment Variables

Copy & paste — that's it
AZURE_SUBSCRIPTION_ID= # Required: Azure subscription ID
AZURE_TOKEN_CREDENTIALS=prod # Required only if DefaultAzureCredential is used in production
AZURE_TENANT_ID= # For service principal auth (optional)
AZURE_CLIENT_ID= # For service principal auth (optional)
AZURE_CLIENT_SECRET= # For service principal auth (optional)

Authentication

Copy & paste — that's it
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.CosmosDB;

// Local dev: DefaultAzureCredential. Production: set AZURE_TOKEN_CREDENTIALS=prod or AZURE_TOKEN_CREDENTIALS= 
var credential = new DefaultAzureCredential(
 DefaultAzureCredential.DefaultEnvironmentVariableName
);
// Or use a specific credential directly in production:
// See https://learn.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet#credential-classes
// var credential = new ManagedIdentityCredential();
var armClient = new ArmClient(credential);

// Get subscription
var subscriptionId = Environment.GetEnvironmentVariable("AZURE_SUBSCRIPTION_ID");
var subscription = armClient.GetSubscriptionResource(
 new ResourceIdentifier($"/subscriptions/{subscriptionId}"));

Resource Hierarchy

Copy & paste — that's it
ArmClient
└── SubscriptionResource
 └── ResourceGroupResource
 └── CosmosDBAccountResource
 ├── CosmosDBSqlDatabaseResource
 │ └── CosmosDBSqlContainerResource
 │ ├── CosmosDBSqlStoredProcedureResource
 │ ├── CosmosDBSqlTriggerResource
 │ └── CosmosDBSqlUserDefinedFunctionResource
 ├── CassandraKeyspaceResource
 ├── GremlinDatabaseResource
 ├── MongoDBDatabaseResource
 └── CosmosDBTableResource

Core Workflow

1. Create Cosmos DB Account

Copy & paste — that's it
using Azure.ResourceManager.CosmosDB;
using Azure.ResourceManager.CosmosDB.Models;

// Get resource group
var resourceGroup = await subscription
 .GetResourceGroupAsync("my-resource-group");

// Define account
var accountData = new CosmosDBAccountCreateOrUpdateContent(
 location: AzureLocation.EastUS,
 locations: new[]
 {
 new CosmosDBAccountLocation
 {
 LocationName = AzureLocation.EastUS,
 FailoverPriority = 0,
 IsZoneRedundant = false
 }
 })
{
 Kind = CosmosDBAccountKind.GlobalDocumentDB,
 ConsistencyPolicy = new ConsistencyPolicy(DefaultConsistencyLevel.Session),
 EnableAutomaticFailover = true
};

// Create account (long-running operation)
var accountCollection = resourceGroup.Value.GetCosmosDBAccounts();
var operation = await accountCollection.CreateOrUpdateAsync(
 WaitUntil.Completed,
 "my-cosmos-account",
 accountData);

CosmosDBAccountResource account = operation.Value;

2. Create SQL Database

Copy & paste — that's it
var databaseData = new CosmosDBSqlDatabaseCreateOrUpdateContent(
 new CosmosDBSqlDatabaseResourceInfo("my-database"));

var databaseCollection = account.GetCosmosDBSqlDatabases();
var dbOperation = await databaseCollection.CreateOrUpdateAsync(
 WaitUntil.Completed,
 "my-database",
 databaseData);

CosmosDBSqlDatabaseResource database = dbOperation.Value;

3. Create SQL Container

Copy & paste — that's it
var containerData = new CosmosDBSqlContainerCreateOrUpdateContent(
 new CosmosDBSqlContainerResourceInfo("my-container")
 {
 PartitionKey = new CosmosDBContainerPartitionKey
 {
 Paths = { "/partitionKey" },
 Kind = CosmosDBPartitionKind.Hash
 },
 IndexingPolicy = new CosmosDBIndexingPolicy
 {
 Automatic = true,
 IndexingMode = CosmosDBIndexingMode.Consistent
 },
 DefaultTtl = 86400 // 24 hours
 });

var containerCollection = database.GetCosmosDBSqlContainers();
var containerOperation = await containerCollection.CreateOrUpdateAsync(
 WaitUntil.Completed,
 "my-container",
 containerData);

CosmosDBSqlContainerResource container = containerOperation.Value;

4. Configure Throughput

Copy & paste — that's it
// Manual throughput
var throughputData = new ThroughputSettingsUpdateData(
 new ThroughputSettingsResourceInfo
 {
 Throughput = 400
 });

// Autoscale throughput
var autoscaleData = new ThroughputSettingsUpdateData(
 new ThroughputSettingsResourceInfo
 {
 AutoscaleSettings = new AutoscaleSettingsResourceInfo
 {
 MaxThroughput = 4000
 }
 });

// Apply to database
await database.CreateOrUpdateCosmosDBSqlDatabaseThroughputAsync(
 WaitUntil.Completed,
 throughputData);

5. Get Connection Information

Copy & paste — that's it
// Get keys
var keys = await account.GetKeysAsync();
Console.WriteLine($"Primary Key: {keys.Value.PrimaryMasterKey}");

// Get connection strings
var connectionStrings = await account.GetConnectionStringsAsync();
foreach (var cs in connectionStrings.Value.ConnectionStrings)
{
 Console.WriteLine($"{cs.Description}: {cs.ConnectionString}");
}

Key Types Reference

Type Purpose ArmClient Entry point for all ARM operations CosmosDBAccountResource Represents a Cosmos DB account CosmosDBAccountCollection Collection for account CRUD CosmosDBSqlDatabaseResource SQL API database CosmosDBSqlContainerResource SQL API container CosmosDBAccountCreateOrUpdateContent Account creation payload CosmosDBSqlDatabaseCreateOrUpdateContent Database creation payload CosmosDBSqlContainerCreateOrUpdateContent Container creation payload ThroughputSettingsUpdateData Throughput configuration

Best Practices

  • Use WaitUntil.Completed for operations that must finish before proceeding

  • Use WaitUntil.Started when you want to poll manually or run operations in parallel

  • Use DefaultAzureCredential — never hardcode keys

  • Handle RequestFailedException for ARM API errors

  • Use CreateOrUpdateAsync for idempotent operations

  • Navigate hierarchy via Get* methods (e.g., account.GetCosmosDBSqlDatabases())

Error Handling

Copy & paste — that's it
using Azure;

try
{
 var operation = await accountCollection.CreateOrUpdateAsync(
 WaitUntil.Completed, accountName, accountData);
}
catch (RequestFailedException ex) when (ex.Status == 409)
{
 Console.WriteLine("Account already exists");
}
catch (RequestFailedException ex)
{
 Console.WriteLine($"ARM Error: {ex.Status} - {ex.ErrorCode}: {ex.Message}");
}

Reference Files

File When to Read references/account-management.md Account CRUD, failover, keys, connection strings, networking references/sql-resources.md SQL databases, containers, stored procedures, triggers, UDFs references/throughput.md Manual/autoscale throughput, migration between modes

Related SDKs

SDK Purpose Install Microsoft.Azure.Cosmos Data plane (document CRUD, queries) dotnet add package Microsoft.Azure.Cosmos Azure.ResourceManager.CosmosDB Management plane (this SDK) dotnet add package Azure.ResourceManager.CosmosDB