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

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 4.5.0

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.6.0-previe... 104 5/30/2022
4.6.0-previe... 209 9/17/2021
4.6.0-previe... 3 9/2/2021
4.5.0 (current version) 89,982 5/29/2021
4.5.0-previe... 2 5/23/2021
4.5.0-previe... 2 5/23/2021
4.4.3 41,446 11/13/2020
4.4.3-previe... 2 11/12/2020
4.4.2 337 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,961 8/30/2020
4.4.0-previe... 3 8/30/2020
4.3.0 4,776 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,712 6/15/2020
4.2.1-previe... 5 6/15/2020
4.2.0 2,669 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 4,631 5/15/2020
4.1.0-previe... 539 5/15/2020
4.0.0 1,597 5/11/2020
4.0.0-previe... 93 5/11/2020
4.0.0-previe... 93 5/11/2020
3.7.0 9,075 3/24/2020
3.7.0-previe... 98 3/24/2020
3.6.2-previe... 97 3/21/2020
3.6.2-previe... 97 3/20/2020
3.6.2-previe... 97 3/20/2020
3.6.1 10,062 3/19/2020
3.6.1-previe... 97 3/19/2020
3.5.2.487 842 3/14/2020
3.5.1.458 24,613 11/12/2019
3.5.0.426 43,418 7/20/2019
3.4.0.411 1,185 6/29/2019
3.3.0.405 606 6/22/2019
3.2.4.376 1,423 5/30/2019
3.2.3.359 4,863 4/5/2019
3.2.2.347 853 3/20/2019
3.2.1.332 1,749 2/22/2019
3.2.0.320 1,266 2/7/2019
3.1.0.293 6,772 12/26/2018
3.0.0.279 1,671 12/23/2018
2.1.15.239 109,606 11/18/2018
2.1.14.222 650 11/15/2018
2.1.13.215 1,653 11/6/2018
2.1.12.137 1,078 10/29/2018
2.1.11.130 181 10/27/2018
2.1.10.104 527 10/22/2018
2.1.10.103 108 10/22/2018
2.1.9.95 158 10/21/2018
2.1.8.59 1,545 10/3/2018
2.1.8.58 100 10/3/2018
2.1.7.675 7,621 9/11/2018
2.1.7.635 195 9/10/2018
2.1.6.561 21,212 8/24/2018
2.1.5.548 1,097 8/4/2018
2.1.4.536 625 7/25/2018
2.1.3.528 5,632 7/12/2018
2.1.2.514 408 7/3/2018
2.1.1.498 237 6/26/2018
2.1.0.487 147 6/24/2018
2.0.16.465 370 6/20/2018
2.0.15.454 243 6/15/2018
2.0.14.439 238 6/12/2018
2.0.13.427 364 6/3/2018
2.0.12.418 1,306 5/20/2018
2.0.11.407 1,991 5/12/2018
2.0.10.388 479 4/26/2018
2.0.10.382 115 4/25/2018
2.0.9.364 333 4/9/2018
2.0.9.360 101 4/9/2018
2.0.8.350 174 4/5/2018
2.0.7.288 2,986 3/11/2018
2.0.6.247 126 3/9/2018
2.0.5.216 183 3/5/2018
2.0.4.202 504 2/27/2018
2.0.3.190 1,426 2/24/2018
2.0.2.184 102 2/24/2018
2.0.1.173 3,200 1/27/2018
2.0.0.163 533 1/14/2018
2.0.0.152 180 12/23/2017
1.0.12.126 119 12/8/2017
1.0.11.117 102 12/8/2017
1.0.10.108 104 12/6/2017
1.0.9.100 114 11/5/2017
1.0.8.91 124 11/5/2017
1.0.7.85 108 11/3/2017
1.0.6.79 103 11/2/2017