CosmosDB

6.1.0-preview0002

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

This is a prerelease version of CosmosDB.
There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name CosmosDB -RequiredVersion 6.1.0-preview0002 -AllowPrerelease

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name CosmosDB -Version 6.1.0-preview0002 -Prerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

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

Core Desktop

Dependencies

Release Notes

## [6.1.0-preview0002] - 2025-06-08

### Fixed

- Fixed `Get-CosmosDbEntraIdToken` to return the `SecureString` from
 the `Get-AzAccessToken` call rather than generating a new `SecureString`
 from the `token` property. This was resulting in a `401 Unauthorized error`
 when calling any of the dataplane functions that used the Entra ID token -
 fixes [Issue #511](https://github.com/PlagueHO/CosmosDB/issues/511)
- Fixed `Convert-CosmosDbSecureStringToString` to include process block so
 that pipelining works correctly.

### Changed

- Changed `Get-CosmosDbEntraIdToken` so that if `Get-AzAccessToken` returns a
 `null` or empty token, it will throw an exception rather than returning a
 `null` or empty string.
- CHORE: Added .Devcontainer and Dependabot configuration files to the repository
 to support development in Visual Studio Code with a Docker container.
- CHORE: Updated Pull Request and Issue templates to use YAML forms in the
 `.github/ISSUE_TEMPLATE` folder.
- CHORE: Updated `Az.Accounts` to `5.0.0` or above `requirements.psd1` and
 `CosmosDB.psd1` - fixes [Issue #509](https://github.com/PlagueHO/CosmosDB/issues/509)
- CHORE: Updated `Az.Resources` to `8.0.0` or above in `requirements.psd1` and
 `CosmosDB.psd1` - fixes [Issue #509](https://github.com/PlagueHO/CosmosDB/issues/509)
- CHORE: Added `copilot-instructions.md` to control Copilot suggestions in the
 repository. This file is used to provide instructions to Copilot on how to
 generate code for the module.
- CHORE: Added `prompts\create-spec.prompt.md` to provide a prompt for creating
 new specifications for the module.
- CHORE: Added `prompts\update-llms.yaml` to provide a prompt for updating the
 `llms.txt` file for the repo.
- Removed testing on `Ubuntu-20.04` from the CI pipeline because it is no longer
 supported by Microsoft managed Azure DevOps images.

FileList

Version History

Version Downloads Last updated
7.0.0 357,183 6/26/2026
7.0.0-previe... 250 4/29/2026
6.1.1-previe... 596 6/8/2025
6.1.0 1,383,413 6/8/2025
6.1.0-previe... (current version) 14 6/8/2025
6.1.0-previe... 15 6/1/2025
6.0.2-previe... 29 5/12/2025
6.0.2-previe... 10 5/10/2025
6.0.1 103,262 5/9/2025
6.0.1-previe... 10 5/9/2025
6.0.0 68,424 4/26/2025
6.0.0-previe... 9 4/26/2025
5.2.0-previe... 31 4/14/2025
5.1.0 582,636 12/15/2024
5.1.0-previe... 10 12/14/2024
5.0.1-previe... 211 10/18/2024
5.0.1-previe... 225 8/12/2024
5.0.0 572,007 6/7/2024
5.0.0-previe... 112,905 5/19/2024
5.0.0-previe... 12 5/19/2024
4.7.0 1,432,180 1/29/2023
4.7.0-previe... 23 1/22/2023
4.6.0 110,902 8/7/2022
4.6.0-previe... 43 8/7/2022
4.6.0-previe... 229 5/30/2022
4.6.0-previe... 253 9/17/2021
4.6.0-previe... 44 9/2/2021
4.5.0 278,185 5/29/2021
4.5.0-previe... 43 5/23/2021
4.5.0-previe... 43 5/23/2021
4.4.3 53,146 11/13/2020
4.4.3-previe... 43 11/12/2020
4.4.2 2,770 11/11/2020
4.4.2-previe... 41 11/11/2020
4.4.1 2,437 10/27/2020
4.4.1-previe... 40 10/27/2020
4.4.0 6,009 8/30/2020
4.4.0-previe... 42 8/30/2020
4.3.0 4,833 8/11/2020
4.3.0-previe... 44 8/10/2020
4.2.2-previe... 43 8/8/2020
4.2.2-previe... 42 8/8/2020
4.2.1 12,759 6/15/2020
4.2.1-previe... 45 6/15/2020
4.2.0 3,055 6/1/2020
4.2.0-previe... 43 6/1/2020
4.2.0-previe... 44 5/31/2020
4.2.0-previe... 43 5/31/2020
4.2.0-previe... 43 5/30/2020
4.1.0 9,713 5/15/2020
4.1.0-previe... 866 5/15/2020
4.0.0 1,979 5/11/2020
4.0.0-previe... 417 5/11/2020
4.0.0-previe... 423 5/11/2020
3.7.0 9,510 3/24/2020
3.7.0-previe... 427 3/24/2020
3.6.2-previe... 421 3/21/2020
3.6.2-previe... 422 3/20/2020
3.6.2-previe... 421 3/20/2020
3.6.1 10,676 3/19/2020
3.6.1-previe... 423 3/19/2020
3.5.2.487 1,172 3/14/2020
3.5.1.458 25,018 11/12/2019
3.5.0.426 44,126 7/20/2019
3.4.0.411 1,506 6/29/2019
3.3.0.405 929 6/22/2019
3.2.4.376 1,754 5/30/2019
3.2.3.359 5,275 4/5/2019
3.2.2.347 1,177 3/20/2019
3.2.1.332 2,072 2/22/2019
3.2.0.320 1,587 2/7/2019
3.1.0.293 7,127 12/26/2018
3.0.0.279 2,015 12/23/2018
2.1.15.239 136,232 11/18/2018
2.1.14.222 977 11/15/2018
2.1.13.215 1,978 11/6/2018
2.1.12.137 1,407 10/29/2018
2.1.11.130 504 10/27/2018
2.1.10.104 850 10/22/2018
2.1.10.103 433 10/22/2018
2.1.9.95 485 10/21/2018
2.1.8.59 1,873 10/3/2018
2.1.8.58 425 10/3/2018
2.1.7.675 7,952 9/11/2018
2.1.7.635 517 9/10/2018
2.1.6.561 21,733 8/24/2018
2.1.5.548 1,424 8/4/2018
2.1.4.536 949 7/25/2018
2.1.3.528 6,915 7/12/2018
2.1.2.514 746 7/3/2018
2.1.1.498 565 6/26/2018
2.1.0.487 473 6/24/2018
2.0.16.465 705 6/20/2018
2.0.15.454 575 6/15/2018
2.0.14.439 576 6/12/2018
2.0.13.427 695 6/3/2018
2.0.12.418 1,638 5/20/2018
2.0.11.407 2,323 5/12/2018
2.0.10.388 815 4/26/2018
2.0.10.382 450 4/25/2018
2.0.9.364 659 4/9/2018
2.0.9.360 428 4/9/2018
2.0.8.350 499 4/5/2018
2.0.7.288 3,318 3/11/2018
2.0.6.247 460 3/9/2018
2.0.5.216 518 3/5/2018
2.0.4.202 837 2/27/2018
2.0.3.190 1,763 2/24/2018
2.0.2.184 437 2/24/2018
2.0.1.173 3,607 1/27/2018
2.0.0.163 1,214 1/14/2018
2.0.0.152 516 12/23/2017
1.0.12.126 459 12/8/2017
1.0.11.117 440 12/8/2017
1.0.10.108 445 12/6/2017
1.0.9.100 453 11/5/2017
1.0.8.91 460 11/5/2017
1.0.7.85 446 11/3/2017
1.0.6.79 442 11/2/2017
Show more