CosmosDB

4.5.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

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

Install-Module -Name CosmosDB

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

Author(s)

Daniel Scott-Raynsford

Copyright

(c) Daniel Scott-Raynsford. All rights reserved.

Owners

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-CosmosDbResponseHeaderAttribute New-CosmosDbBackoffPolicy New-CosmosDbContext New-CosmosDbContextToken

PSEditions

Core Desktop

Dependencies

Release Notes

## [4.5.0] - 2021-05-29

### Changed

- Convert build pipeline to use GitTools Azure DevOps extension tasks
 instead of deprecated GitVersion extension.
- Correct value of `Environment` parameter in context object returned
 by `New-CosmosDbContext` - Fixes [Issue #411](https://github.com/PlagueHO/CosmosDB/issues/411).
- Update `requirements.psd1` to install modules `Az.Accounts`
 2.2.8 - Fixes [Issue #415](https://github.com/PlagueHO/CosmosDB/issues/415).
- Updated `ComsosDB.cs` to add getters and setters to properties - Fixes [Issue #417](https://github.com/PlagueHO/CosmosDB/issues/417).

### Fixed

- Fix CI pipeline deployment stage to ensure correctly detects running
 in Azure DevOps organization.
- Fix CI pipeline release stage by adding Sampler GitHub tasks which
 were moved out of the main sampler module into a new module
 `Sampler.GitHubTasks` - Fixes [Issue #418](https://github.com/PlagueHO/CosmosDB/issues/418).

### Added

- Added `ReturnJson` parameter to `New-CosmosDbDocument`, `Set-CosmosDbDocument`
 and `Get-CosmosDbDocument` functions to allow return of documents that can
 not be converted to objects due to duplicate key names that only differ in
 case - Fixes [Issue #413](https://github.com/PlagueHO/CosmosDB/issues/413).

Version History

Version Downloads Last updated
4.5.0 (current version) 11,417 5/29/2021
4.5.0-previe... 2 5/23/2021
4.5.0-previe... 2 5/23/2021
4.4.3 37,392 11/13/2020
4.4.3-previe... 2 11/12/2020
4.4.2 298 11/11/2020
4.4.2-previe... 2 11/11/2020
4.4.1 2,393 10/27/2020
4.4.1-previe... 2 10/27/2020
4.4.0 5,831 8/30/2020
4.4.0-previe... 3 8/30/2020
4.3.0 4,744 8/11/2020
4.3.0-previe... 5 8/10/2020
4.2.2-previe... 4 8/8/2020
4.2.2-previe... 3 8/8/2020
4.2.1 12,143 6/15/2020
4.2.1-previe... 5 6/15/2020
4.2.0 2,575 6/1/2020
4.2.0-previe... 4 6/1/2020
4.2.0-previe... 4 5/31/2020
4.2.0-previe... 4 5/31/2020
4.2.0-previe... 4 5/30/2020
4.1.0 3,081 5/15/2020
4.1.0-previe... 449 5/15/2020
4.0.0 1,401 5/11/2020
4.0.0-previe... 4 5/11/2020
4.0.0-previe... 4 5/11/2020
3.7.0 8,575 3/24/2020
3.7.0-previe... 8 3/24/2020
3.6.2-previe... 8 3/21/2020
3.6.2-previe... 8 3/20/2020
3.6.2-previe... 8 3/20/2020
3.6.1 5,681 3/19/2020
3.6.1-previe... 8 3/19/2020
3.5.2.487 753 3/14/2020
3.5.1.458 24,475 11/12/2019
3.5.0.426 42,808 7/20/2019
3.4.0.411 1,096 6/29/2019
3.3.0.405 517 6/22/2019
3.2.4.376 1,334 5/30/2019
3.2.3.359 4,360 4/5/2019
3.2.2.347 764 3/20/2019
3.2.1.332 1,659 2/22/2019
3.2.0.320 1,177 2/7/2019
3.1.0.293 6,646 12/26/2018
3.0.0.279 1,571 12/23/2018
2.1.15.239 105,686 11/18/2018
2.1.14.222 560 11/15/2018
2.1.13.215 1,564 11/6/2018
2.1.12.137 978 10/29/2018
2.1.11.130 91 10/27/2018
2.1.10.104 438 10/22/2018
2.1.10.103 19 10/22/2018
2.1.9.95 68 10/21/2018
2.1.8.59 1,456 10/3/2018
2.1.8.58 10 10/3/2018
2.1.7.675 7,224 9/11/2018
2.1.7.635 106 9/10/2018
2.1.6.561 21,006 8/24/2018
2.1.5.548 1,008 8/4/2018
2.1.4.536 536 7/25/2018
2.1.3.528 5,256 7/12/2018
2.1.2.514 318 7/3/2018
2.1.1.498 148 6/26/2018
2.1.0.487 58 6/24/2018
2.0.16.465 279 6/20/2018
2.0.15.454 153 6/15/2018
2.0.14.439 147 6/12/2018
2.0.13.427 273 6/3/2018
2.0.12.418 1,213 5/20/2018
2.0.11.407 1,901 5/12/2018
2.0.10.388 372 4/26/2018
2.0.10.382 22 4/25/2018
2.0.9.364 244 4/9/2018
2.0.9.360 12 4/9/2018
2.0.8.350 84 4/5/2018
2.0.7.288 2,895 3/11/2018
2.0.6.247 35 3/9/2018
2.0.5.216 90 3/5/2018
2.0.4.202 413 2/27/2018
2.0.3.190 1,334 2/24/2018
2.0.2.184 9 2/24/2018
2.0.1.173 3,108 1/27/2018
2.0.0.163 367 1/14/2018
2.0.0.152 89 12/23/2017
1.0.12.126 28 12/8/2017
1.0.11.117 11 12/8/2017
1.0.10.108 11 12/6/2017
1.0.9.100 23 11/5/2017
1.0.8.91 30 11/5/2017
1.0.7.85 16 11/3/2017
1.0.6.79 10 11/2/2017