CosmosDB

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 165)

PowerShell Module for working with Azure Cosmos DB databases, collections, documents, attachments, offers, users, permissions, triggers, stored procedures and user defined functions.

CosmosDB Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://raw.githubusercontent.com/PlagueHO/CosmosDB/main/LICENSE)
[![Documentation](https://img.shields.io/badge/Docs-CosmosDB-blue.svg)](https://raw.githubusercontent.com/PlagueHO/CosmosDB/main/docs/user-guide.md)
[![PowerShell Gallery](https://img.shields.io/badge/PowerShell%20Gallery-CosmosDB-blue.svg)](https://www.powershellgallery.com/packages/CosmosDB)
[![PowerShell Gallery](https://img.shields.io/powershellgallery/dt/cosmosdb.svg)](https://www.powershellgallery.com/packages/CosmosDB)
[![Minimum Supported Windows PowerShell Version](https://img.shields.io/badge/WindowsPowerShell-5.1-blue.svg)](https://github.com/PlagueHO/CosmosDB)
[![Minimum Supported PowerShell Core Version](https://img.shields.io/badge/PSCore-6.0-blue.svg)](https://github.com/PlagueHO/CosmosDB)
[![Minimum Supported PowerShell Version](https://img.shields.io/badge/PS-7.0-blue.svg)](https://github.com/PlagueHO/CosmosDB)

# CosmosDB PowerShell Module

## Module Build Status

| Branch | GitHub Actions | Automated Tests | Code Quality |
| ------ | -------------- | ----------------| ------------ |
| main   | [![ga-image-main][]][ga-site-main] | [![ts-image-main][]][ts-site-main] | [![cq-image-main][]][cq-site-main] |

## Introduction

This PowerShell module provides cmdlets for accessing Cosmos DB collections via the
[Azure Cosmos DB REST API](https://learn.microsoft.com/rest/api/cosmos-db/).
It makes it easy to perform CRUD operations on Cosmos DB collections and documents
and related entities while also implementing role-based access control or token-based
authentication.

> [!IMPORTANT]
> The _CosmosDB PowerShell module_ is **not** intended to be a replacement for the
> [Az.CosmosDB](https://www.powershellgallery.com/packages/Az.CosmosDB). Although
> there is some cross-over between the two modules, the _CosmosDB PowerShell
> module_ is primarily intended to be used for accessing the documents within
> collections using RBAC and token-based authentication. This is functionality that
> the _Az.CosmosDB_ module does not _currently_ provide.

The _CosmosDB PowerShell module_ enables management of:

- [Attachments](docs/user-guide.md#working-with-attachments)
- [Collections](docs/user-guide.md#working-with-collections)
- [Databases](docs/user-guide.md#working-with-databases)
- [Documents](docs/user-guide.md#working-with-documents)
- [Offers](docs/user-guide.md#working-with-offers)
- [Permissions](docs/user-guide.md#working-with-permissions)
- [Stored Procedures](docs/user-guide.md#working-with-stored-procedures)
- [Triggers](docs/user-guide.md#working-with-triggers)
- [User Defined Functions](docs/user-guide.md#working-with-user-defined-functions)
- [Users](docs/user-guide.md#working-with-users)

The module uses the Cosmos DB (DocumentDB) REST APIs. For more information on
the Cosmos DB REST APIs, see [this link](https://learn.microsoft.com/rest/api/cosmos-db/restful-interactions-with-cosmosdb-resources).

## User Guide

For full usage documentation — contexts, authentication, working with databases,
collections, documents, stored procedures, and more — see the
[**User Guide**](docs/user-guide.md).

## Requirements

This module requires the following:

- Windows PowerShell 5.x, PowerShell Core 6.x or PowerShell 7.x

### PowerShell Module Dependencies

- **Az.Accounts**: 5.0.0 and newer.
- **Az.Resources**: 8.0.0 and newer.

These modules are required if using `New-CosmosDbContext -ResourceGroupName $resourceGroup`
or `*-CosmosDbAccount` functions.

## Installation

To install the module from PowerShell Gallery, use the PowerShell Cmdlet:

```powershell
Install-Module -Name CosmosDB
```

## Compatibility and Testing

This PowerShell module is automatically tested and validated to run
on the following systems:

- Windows Server (using Windows PowerShell 5.1):
  - Windows Server 2022: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).
  - Windows Server 2025: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).
- Windows Server (using Windows PowerShell 7.x):
  - Windows Server 2022: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).
  - Windows Server 2025: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).
- Linux (using PowerShell 7.x):
  - Ubuntu 22.04: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).
  - Ubuntu 24.04: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).
- macOS (using PowerShell 7.x):
  - macOS 14: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).
  - macOS 15: Using [GitHub Actions](https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml).

> This module is no longer tested on PowerShell Core 6.x as PowerShell 7.x
> should be used. It should still work, but will no longer be verified. Issues with
> this module that only exist on PowerShell Core 6.x but not PowerShell 7.x will
> not be fixed.

This module should function correctly on other systems and configurations
but is not automatically tested with them in every change.

## Contributing

If you wish to contribute to this project, please read the [Contributing.md](/.github/CONTRIBUTING.md)
document first. We would be very grateful of any contributions.

## Cmdlets

A list of Cmdlets in the _CosmosDB PowerShell module_ can be found by running the
following PowerShell commands:

```PowerShell
Import-Module -Name CosmosDB
Get-Command -Module CosmosDB
```

Help on individual Cmdlets can be found in the built-in Cmdlet help:

```PowerShell
Get-Help -Name Get-CosmosDBUser
```

The details of the cmdlets contained in this module can also be
found in the [wiki](https://github.com/PlagueHO/CosmosDB/wiki).

## Change Log

For a list of changes to versions, see the [CHANGELOG.md](CHANGELOG.md) file.

## Links

- [GitHub Repository](https://github.com/PlagueHO/CosmosDB/)
- [Blog](https://dscottraynsford.wordpress.com/)

[ga-image-main]: https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml/badge.svg?branch=main
[ga-site-main]: https://github.com/PlagueHO/CosmosDB/actions/workflows/ci.yml
[ts-image-main]: https://img.shields.io/azure-devops/tests/dscottraynsford/GitHub/4/main
[ts-site-main]: https://dev.azure.com/dscottraynsford/GitHub/_build/latest?definitionId=4&branchName=main
[cq-image-main]: https://api.codacy.com/project/badge/Grade/1ee50b5eb15b47c188b3bdf7a5f8ee1d
[cq-site-main]: https://www.codacy.com/app/PlagueHO/CosmosDB?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=PlagueHO/CosmosDB&amp;utm_campaign=Badge_Grade

CosmosDB

CosmosDB Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

CosmosDB

CosmosDB Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README