Azure Cosmos DB PowerShell Reference

This section provides detailed reference information for the Azure Cosmos DB PowerShell cmdlets. Use these cmdlets to manage your Azure Cosmos DB resources using PowerShell.

Getting Started with Azure Cosmos DB PowerShell

To use these cmdlets, you first need to install the Azure PowerShell module. If you haven't already, you can install it using the following command:

Install-Module -Name Az.CosmosDB

After installation, you'll need to connect to your Azure account:

Connect-AzAccount

Common Cmdlets

Here are some of the most frequently used cmdlets for managing Azure Cosmos DB:

Account Management

Get-AzCosmosDBAccount: Retrieves one or more Azure Cosmos DB accounts.
New-AzCosmosDBAccount: Creates a new Azure Cosmos DB account.
Remove-AzCosmosDBAccount: Deletes an Azure Cosmos DB account.
Update-AzCosmosDBAccount: Updates properties of an Azure Cosmos DB account.

Database Management

Get-AzCosmosDBDatabase: Retrieves an Azure Cosmos DB database.
New-AzCosmosDBDatabase: Creates a new Azure Cosmos DB database.
Remove-AzCosmosDBDatabase: Deletes an Azure Cosmos DB database.

Container (Collection) Management

Get-AzCosmosDBContainer: Retrieves an Azure Cosmos DB container.
New-AzCosmosDBContainer: Creates a new Azure Cosmos DB container.
Remove-AzCosmosDBContainer: Deletes an Azure Cosmos DB container.
Update-AzCosmosDBContainer: Updates properties of an Azure Cosmos DB container.

Throughput Management

Get-AzCosmosDBThroughput: Retrieves the throughput settings for a database or container.
Update-AzCosmosDBThroughput: Updates the throughput settings for a database or container.

Example: Creating a New Cosmos DB Account and Database

This example demonstrates how to create a new Azure Cosmos DB account and a SQL API database within it.

                    
# Define variables
$resourceGroupName = "MyResourceGroup"
$accountName = "mycosmosdbaccount" + $(Get-Random)
$location = "West US"
$databaseName = "MyDatabase"

# Create a resource group if it doesn't exist
if (-not (Get-AzResourceGroup -Name $resourceGroupName -ErrorAction SilentlyContinue)) {
    New-AzResourceGroup -Name $resourceGroupName -Location $location
}

# Create a new Azure Cosmos DB account
New-AzCosmosDBAccount `
    -ResourceGroupName $resourceGroupName `
    -Name $accountName `
    -Location $location `
    -ApiKind Sql

# Get the created account object
$account = Get-AzCosmosDBAccount -ResourceGroupName $resourceGroupName -Name $accountName

# Create a new database
New-AzCosmosDBDatabase `
    -ResourceGroupName $resourceGroupName `
    -AccountName $accountName `
    -Name $databaseName

Write-Host "Cosmos DB Account '$accountName' and Database '$databaseName' created successfully."
                    
                

Detailed Cmdlet Reference

For a comprehensive list of all cmdlets and their parameters, please refer to the official Microsoft Learn documentation:

Azure.CosmosDB PowerShell Module Documentation

Note: Always refer to the official documentation for the most up-to-date information and parameter details.