CosmosDB
7.0.0
This module provides cmdlets for working with Azure Cosmos DB databases, collections, documents, attachments, offers, users, permissions, triggers, stored procedures and user defined functions.
Minimum PowerShell version
5.1
Installation Options
Owners
Copyright
(c) Daniel Scott-Raynsford. All rights reserved.
Package Details
Author(s)
- Daniel Scott-Raynsford
Tags
CosmosDB DocumentDb Azure Windows Linux MacOS
Functions
Get-CosmosDbAccount Get-CosmosDbAccountConnectionString Get-CosmosDbAccountMasterKey New-CosmosDbAccount New-CosmosDbAccountMasterKey Remove-CosmosDbAccount Set-CosmosDbAccount Get-CosmosDbAttachment Get-CosmosDbAttachmentResourcePath New-CosmosDbAttachment Remove-CosmosDbAttachment Set-CosmosDbAttachment Get-CosmosDbCollection Get-CosmosDbCollectionResourcePath Get-CosmosDbCollectionSize New-CosmosDbCollection New-CosmosDbCollectionCompositeIndexElement New-CosmosDbCollectionExcludedPath New-CosmosDbCollectionIncludedPath New-CosmosDbCollectionIncludedPathIndex New-CosmosDbCollectionIndexingPolicy New-CosmosDbCollectionUniqueKey New-CosmosDbCollectionUniqueKeyPolicy Remove-CosmosDbCollection Set-CosmosDbCollection Get-CosmosDbDatabase Get-CosmosDbDatabaseResourcePath New-CosmosDbDatabase Remove-CosmosDbDatabase Get-CosmosDbDocument Get-CosmosDbDocumentJson Get-CosmosDbDocumentResourcePath New-CosmosDbDocument Remove-CosmosDbDocument Set-CosmosDbDocument Get-CosmosDbOffer Get-CosmosDbOfferResourcePath Set-CosmosDbOffer Get-CosmosDbPermission Get-CosmosDbPermissionResourcePath New-CosmosDbPermission Remove-CosmosDbPermission Get-CosmosDbStoredProcedure Get-CosmosDbStoredProcedureResourcePath Invoke-CosmosDbStoredProcedure New-CosmosDbStoredProcedure Remove-CosmosDbStoredProcedure Set-CosmosDbStoredProcedure Get-CosmosDbTrigger Get-CosmosDbTriggerResourcePath New-CosmosDbTrigger Remove-CosmosDbTrigger Set-CosmosDbTrigger Get-CosmosDbUserDefinedFunction Get-CosmosDbUserDefinedFunctionResourcePath New-CosmosDbUserDefinedFunction Remove-CosmosDbUserDefinedFunction Set-CosmosDbUserDefinedFunction Get-CosmosDbUser Get-CosmosDbUserResourcePath New-CosmosDbUser Remove-CosmosDbUser Set-CosmosDbUser Set-CosmosDbUserType Get-CosmosDbContinuationToken Get-CosmosDbEntraIdToken Get-CosmosDbResponseHeaderAttribute New-CosmosDbBackoffPolicy New-CosmosDbContext New-CosmosDbContextToken
PSEditions
Dependencies
-
- Az.Accounts (>= 5.0.0)
- Az.Resources (>= 8.0.0)
Release Notes
## [7.0.0] - 2026-06-26
### Changed
- BREAKING CHANGE: Removed support for creating collections without a
partition key. `New-CosmosDbCollection` now requires the `-PartitionKey`
parameter. Collections created without a partition key (legacy
non-partitioned collections) are no longer supported by this module.
Pin to the previous major version if you still require non-partitioned
collection support.
- BREAKING CHANGE: Removed the `-PartitionKeyRangeId` parameter from
`Get-CosmosDbDocument` and `Get-CosmosDbDocumentJson`. This parameter
only applied to legacy non-partitioned collection scenarios.
- BREAKING CHANGE: Removed the `-ApiVersion` parameter from
`Invoke-CosmosDbRequest`. The Cosmos DB REST API version is now
pinned internally to `2020-07-15` and cannot be overridden.
- Updated module to default to Cosmos DB REST API version `2020-07-15`.
### Operational Changes
- Added `AGENTS.md` and `copilot-instructions.md` to optimize the
repository for Agentic development.
- Added `.github/ISSUE_TEMPLATE/operations_task.yml` issue template for
repository operations work such as CI/CD, docs publishing, and
GitHub Pages tasks.
- Removed testing on Windows Server 2019 and MacOS 13.
- Added [Spec-Kit](github.com/GitHub/spec-kit) support.
- Added `specify/memory/constitution.md` to define the module's
governing principles and development standards.
- Added `Configuration` to `RequiredModules.psd1` to satisfy
`ModuleBuilder` required module loading in newer releases.
### Added
- Add support for hierarchical partition keys
### Fixed
- Allow high ports over 32767 for `New-CosmosDbContext`
FileList
- CosmosDB.nuspec
- formats\documents.formats.ps1xml
- formats\offers.formats.ps1xml
- types\offers.types.ps1xml
- CosmosDB.psd1
- formats\permissions.formats.ps1xml
- formats\attachments.formats.ps1xml
- types\collections.types.ps1xml
- CosmosDB.psm1
- formats\storedprocedures.formats.ps1xml
- types\documents.types.ps1xml
- types\users.types.ps1xml
- CosmosDB.dll
- formats\userdefinedfunctions.formats.ps1xml
- types\storedprocedures.types.ps1xml
- types\databases.types.ps1xml
- en-US\about_CosmosDB.help.txt
- formats\collections.formats.ps1xml
- types\attachments.types.ps1xml
- types\permissions.types.ps1xml
- en-US\CosmosDB.strings.psd1
- formats\databases.formats.ps1xml
- types\triggers.types.ps1xml
- classes\CosmosDB\CosmosDB.csproj
- formats\users.formats.ps1xml
- formats\triggers.formats.ps1xml
- types\userdefinedfunctions.types.ps1xml
- classes\CosmosDB\CosmosDB.cs
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 7.0.0 (current version) | 2,345 | 6/26/2026 |
| 7.0.0-previe... | 246 | 4/29/2026 |
| 6.1.1-previe... | 594 | 6/8/2025 |
| 6.1.0 | 1,379,491 | 6/8/2025 |
| 6.1.0-previe... | 9 | 6/8/2025 |
| 6.1.0-previe... | 13 | 6/1/2025 |
| 6.0.2-previe... | 26 | 5/12/2025 |
| 6.0.2-previe... | 8 | 5/10/2025 |
| 6.0.1 | 98,238 | 5/9/2025 |
| 6.0.1-previe... | 7 | 5/9/2025 |
| 6.0.0 | 59,988 | 4/26/2025 |
| 6.0.0-previe... | 6 | 4/26/2025 |
| 5.2.0-previe... | 29 | 4/14/2025 |
| 5.1.0 | 580,033 | 12/15/2024 |
| 5.1.0-previe... | 6 | 12/14/2024 |
| 5.0.1-previe... | 209 | 10/18/2024 |
| 5.0.1-previe... | 223 | 8/12/2024 |
| 5.0.0 | 570,726 | 6/7/2024 |
| 5.0.0-previe... | 112,903 | 5/19/2024 |
| 5.0.0-previe... | 10 | 5/19/2024 |
| 4.7.0 | 1,408,871 | 1/29/2023 |
| 4.7.0-previe... | 21 | 1/22/2023 |
| 4.6.0 | 110,560 | 8/7/2022 |
| 4.6.0-previe... | 35 | 8/7/2022 |
| 4.6.0-previe... | 221 | 5/30/2022 |
| 4.6.0-previe... | 243 | 9/17/2021 |
| 4.6.0-previe... | 36 | 9/2/2021 |
| 4.5.0 | 267,096 | 5/29/2021 |
| 4.5.0-previe... | 34 | 5/23/2021 |
| 4.5.0-previe... | 36 | 5/23/2021 |
| 4.4.3 | 52,939 | 11/13/2020 |
| 4.4.3-previe... | 34 | 11/12/2020 |
| 4.4.2 | 2,762 | 11/11/2020 |
| 4.4.2-previe... | 34 | 11/11/2020 |
| 4.4.1 | 2,430 | 10/27/2020 |
| 4.4.1-previe... | 33 | 10/27/2020 |
| 4.4.0 | 6,000 | 8/30/2020 |
| 4.4.0-previe... | 35 | 8/30/2020 |
| 4.3.0 | 4,824 | 8/11/2020 |
| 4.3.0-previe... | 37 | 8/10/2020 |
| 4.2.2-previe... | 36 | 8/8/2020 |
| 4.2.2-previe... | 35 | 8/8/2020 |
| 4.2.1 | 12,749 | 6/15/2020 |
| 4.2.1-previe... | 38 | 6/15/2020 |
| 4.2.0 | 3,037 | 6/1/2020 |
| 4.2.0-previe... | 36 | 6/1/2020 |
| 4.2.0-previe... | 36 | 5/31/2020 |
| 4.2.0-previe... | 35 | 5/31/2020 |
| 4.2.0-previe... | 35 | 5/30/2020 |
| 4.1.0 | 9,551 | 5/15/2020 |
| 4.1.0-previe... | 857 | 5/15/2020 |
| 4.0.0 | 1,970 | 5/11/2020 |
| 4.0.0-previe... | 410 | 5/11/2020 |
| 4.0.0-previe... | 411 | 5/11/2020 |
| 3.7.0 | 9,487 | 3/24/2020 |
| 3.7.0-previe... | 417 | 3/24/2020 |
| 3.6.2-previe... | 414 | 3/21/2020 |
| 3.6.2-previe... | 415 | 3/20/2020 |
| 3.6.2-previe... | 414 | 3/20/2020 |
| 3.6.1 | 10,669 | 3/19/2020 |
| 3.6.1-previe... | 416 | 3/19/2020 |
| 3.5.2.487 | 1,162 | 3/14/2020 |
| 3.5.1.458 | 24,968 | 11/12/2019 |
| 3.5.0.426 | 44,121 | 7/20/2019 |
| 3.4.0.411 | 1,503 | 6/29/2019 |
| 3.3.0.405 | 925 | 6/22/2019 |
| 3.2.4.376 | 1,752 | 5/30/2019 |
| 3.2.3.359 | 5,273 | 4/5/2019 |
| 3.2.2.347 | 1,175 | 3/20/2019 |
| 3.2.1.332 | 2,070 | 2/22/2019 |
| 3.2.0.320 | 1,585 | 2/7/2019 |
| 3.1.0.293 | 7,124 | 12/26/2018 |
| 3.0.0.279 | 2,013 | 12/23/2018 |
| 2.1.15.239 | 135,254 | 11/18/2018 |
| 2.1.14.222 | 975 | 11/15/2018 |
| 2.1.13.215 | 1,976 | 11/6/2018 |
| 2.1.12.137 | 1,403 | 10/29/2018 |
| 2.1.11.130 | 502 | 10/27/2018 |
| 2.1.10.104 | 848 | 10/22/2018 |
| 2.1.10.103 | 430 | 10/22/2018 |
| 2.1.9.95 | 481 | 10/21/2018 |
| 2.1.8.59 | 1,868 | 10/3/2018 |
| 2.1.8.58 | 419 | 10/3/2018 |
| 2.1.7.675 | 7,949 | 9/11/2018 |
| 2.1.7.635 | 513 | 9/10/2018 |
| 2.1.6.561 | 21,729 | 8/24/2018 |
| 2.1.5.548 | 1,418 | 8/4/2018 |
| 2.1.4.536 | 946 | 7/25/2018 |
| 2.1.3.528 | 6,913 | 7/12/2018 |
| 2.1.2.514 | 728 | 7/3/2018 |
| 2.1.1.498 | 561 | 6/26/2018 |
| 2.1.0.487 | 469 | 6/24/2018 |
| 2.0.16.465 | 701 | 6/20/2018 |
| 2.0.15.454 | 573 | 6/15/2018 |
| 2.0.14.439 | 570 | 6/12/2018 |
| 2.0.13.427 | 693 | 6/3/2018 |
| 2.0.12.418 | 1,636 | 5/20/2018 |
| 2.0.11.407 | 2,321 | 5/12/2018 |
| 2.0.10.388 | 813 | 4/26/2018 |
| 2.0.10.382 | 446 | 4/25/2018 |
| 2.0.9.364 | 657 | 4/9/2018 |
| 2.0.9.360 | 424 | 4/9/2018 |
| 2.0.8.350 | 497 | 4/5/2018 |
| 2.0.7.288 | 3,314 | 3/11/2018 |
| 2.0.6.247 | 457 | 3/9/2018 |
| 2.0.5.216 | 516 | 3/5/2018 |
| 2.0.4.202 | 835 | 2/27/2018 |
| 2.0.3.190 | 1,757 | 2/24/2018 |
| 2.0.2.184 | 433 | 2/24/2018 |
| 2.0.1.173 | 3,602 | 1/27/2018 |
| 2.0.0.163 | 1,195 | 1/14/2018 |
| 2.0.0.152 | 511 | 12/23/2017 |
| 1.0.12.126 | 456 | 12/8/2017 |
| 1.0.11.117 | 435 | 12/8/2017 |
| 1.0.10.108 | 440 | 12/6/2017 |
| 1.0.9.100 | 450 | 11/5/2017 |
| 1.0.8.91 | 458 | 11/5/2017 |
| 1.0.7.85 | 442 | 11/3/2017 |
| 1.0.6.79 | 437 | 11/2/2017 |