CosmosDB

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

Package Details

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.6.0] - 2022-08-07

### Fixed

- Fix Azure DevOps build pipeline and update to latest sampler pattern.
- Fix exception being thrown when a 429 is returned by CosmosDB, but the
 `x-ms-retry-after-ms` header is not returned. This may occur in requests
 that follow large (> 1MB) insert or updates - Fixes [Issue #458](https://github.com/PlagueHO/CosmosDB/issues/458).

### Changed

- Update Azure DevOps pipeline Linux agent version for build task
 to be `ubuntu-latest` - Fixes [Issue #422](https://github.com/PlagueHO/CosmosDB/issues/422).
- Updated PSScriptAnalyzer tests to be skipped when PowerShell Core
 version is less than 7.0.3 - Fixes [Issue #431](https://github.com/PlagueHO/CosmosDB/issues/431).
- Updated the New-CosmosDbAccount command to add a new Capability
 parameter - Fixes [Issue #439](https://github.com/PlagueHO/CosmosDB/issues/439).
- Updated tests on PowerShell 6.x for MacOS 10.14 to 10.15 - Fixes [Issue #450](https://github.com/PlagueHO/CosmosDB/issues/450).
- Updated README.md to remove markdown issues.

### Added

- Added tests on PowerShell 7.x on Ubuntu 20.04 - Fixes [Issue #433](https://github.com/PlagueHO/CosmosDB/issues/433).
- Added tests on Windows PowerShell 5.1 on Windows Server 2022 - Fixes [Issue #436](https://github.com/PlagueHO/CosmosDB/issues/436).
- Added tests on PowerShell 6.x on MacOS 11 - Fixes [Issue #450](https://github.com/PlagueHO/CosmosDB/issues/450).

### Removed

- Removed tests against PowerShell Core 6.x as PowerShell 7.x is recommended - Fixes
 [Issue #434](https://github.com/PlagueHO/CosmosDB/issues/431).
- Removed all tests on Ubuntu 16.04 - Fixes [Issue #433](https://github.com/PlagueHO/CosmosDB/issues/433).
- Removed tests against Windows PowerShell 5.1 on Windows Server 2016 - Fixes
 [Issue #451](https://github.com/PlagueHO/CosmosDB/issues/451).

FileList

Version History

Version Downloads Last updated
4.6.0 (current version) 16,418 8/7/2022
4.6.0-previe... 3 8/7/2022
4.6.0-previe... 189 5/30/2022
4.6.0-previe... 209 9/17/2021
4.6.0-previe... 3 9/2/2021
4.5.0 106,691 5/29/2021
4.5.0-previe... 2 5/23/2021
4.5.0-previe... 2 5/23/2021
4.4.3 42,320 11/13/2020
4.4.3-previe... 2 11/12/2020
4.4.2 377 11/11/2020
4.4.2-previe... 2 11/11/2020
4.4.1 2,394 10/27/2020
4.4.1-previe... 2 10/27/2020
4.4.0 5,962 8/30/2020
4.4.0-previe... 3 8/30/2020
4.3.0 4,781 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,714 6/15/2020
4.2.1-previe... 5 6/15/2020
4.2.0 2,817 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 5,361 5/15/2020
4.1.0-previe... 687 5/15/2020
4.0.0 1,745 5/11/2020
4.0.0-previe... 240 5/11/2020
4.0.0-previe... 241 5/11/2020
3.7.0 9,227 3/24/2020
3.7.0-previe... 246 3/24/2020
3.6.2-previe... 244 3/21/2020
3.6.2-previe... 245 3/20/2020
3.6.2-previe... 244 3/20/2020
3.6.1 10,492 3/19/2020
3.6.1-previe... 245 3/19/2020
3.5.2.487 991 3/14/2020
3.5.1.458 24,763 11/12/2019
3.5.0.426 43,678 7/20/2019
3.4.0.411 1,333 6/29/2019
3.3.0.405 755 6/22/2019
3.2.4.376 1,572 5/30/2019
3.2.3.359 5,084 4/5/2019
3.2.2.347 1,001 3/20/2019
3.2.1.332 1,898 2/22/2019
3.2.0.320 1,414 2/7/2019
3.1.0.293 6,926 12/26/2018
3.0.0.279 1,835 12/23/2018
2.1.15.239 110,549 11/18/2018
2.1.14.222 799 11/15/2018
2.1.13.215 1,803 11/6/2018
2.1.12.137 1,229 10/29/2018
2.1.11.130 330 10/27/2018
2.1.10.104 676 10/22/2018
2.1.10.103 257 10/22/2018
2.1.9.95 309 10/21/2018
2.1.8.59 1,695 10/3/2018
2.1.8.58 249 10/3/2018
2.1.7.675 7,770 9/11/2018
2.1.7.635 344 9/10/2018
2.1.6.561 21,381 8/24/2018
2.1.5.548 1,245 8/4/2018
2.1.4.536 774 7/25/2018
2.1.3.528 5,883 7/12/2018
2.1.2.514 557 7/3/2018
2.1.1.498 387 6/26/2018
2.1.0.487 297 6/24/2018
2.0.16.465 522 6/20/2018
2.0.15.454 394 6/15/2018
2.0.14.439 391 6/12/2018
2.0.13.427 515 6/3/2018
2.0.12.418 1,459 5/20/2018
2.0.11.407 2,142 5/12/2018
2.0.10.388 631 4/26/2018
2.0.10.382 265 4/25/2018
2.0.9.364 483 4/9/2018
2.0.9.360 251 4/9/2018
2.0.8.350 323 4/5/2018
2.0.7.288 3,137 3/11/2018
2.0.6.247 278 3/9/2018
2.0.5.216 335 3/5/2018
2.0.4.202 656 2/27/2018
2.0.3.190 1,577 2/24/2018
2.0.2.184 254 2/24/2018
2.0.1.173 3,351 1/27/2018
2.0.0.163 705 1/14/2018
2.0.0.152 332 12/23/2017
1.0.12.126 271 12/8/2017
1.0.11.117 253 12/8/2017
1.0.10.108 256 12/6/2017
1.0.9.100 267 11/5/2017
1.0.8.91 275 11/5/2017
1.0.7.85 260 11/3/2017
1.0.6.79 256 11/2/2017
Show more