CosmosDB

3.7.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 deloy 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-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-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 New-CosmosDbBackoffPolicy New-CosmosDbContext New-CosmosDbContextToken

PSEditions

Core Desktop

Dependencies

Release Notes

## [3.7.0] - 2020-03-24

### Changed

- Add warning to `New-CosmosDbCollection` to show when creating a collection
 without a partition key.
- Updated `README.MD` to documentation to reduce focus on collections without
 partition keys - fixes [Issue #342](https://github.com/PlagueHO/CosmosDB/issues/342).

### Added

- Added support for `Environment` parameter in `New-CosmosDbContext` to allow
 using Azure US Government Cloud - fixes [Issue #322](https://github.com/PlagueHO/CosmosDB/issues/322).

## [3.6.1] - 2020-03-19

### Changed

- Improved badge layout in README.MD and removed CodeCov.io badge - fixes [Issue #336](https://github.com/PlagueHO/CosmosDB/issues/336).
- Removed references to Gitter and Gitter badge - fixes [Issue #337](https://github.com/PlagueHO/CosmosDB/issues/337).
- Removed Azure Pipeline daily build YAML because the main
 pipeline build YAML will be used instead.
- Fix build badges in README.MD by correcting BuildID - [Issue #340](https://github.com/PlagueHO/CosmosDB/issues/340).

### Removed

- Remove AppVeyor CI pipeline - fixes [Issue #329](https://github.com/PlagueHO/CosmosDB/issues/329).

### Changed

- Restructure Azure Pipeline:
 - Add testing on Windows Server 2019 and separate module build process.
 - Convert to multi stage pipeline.

### Fixed

- Fix default culture case to fix error on module load in PS7
 on Ubuntu 18.04 - fixes [Issue #332](https://github.com/PlagueHO/CosmosDB/issues/332).

## [3.5.2.487] - 2020-03-14

### Changed

- Update `BuildHelpers` to version 2.0.11.
- Update `Psake` to version 4.9.0.
- Update `Pester` to version 4.10.1.
- Update `PSScriptAnalyzer` to version 1.18.3.
- Change Azure Pipeline Linux build to test PowerShell Core 6.2.3-1.
- Change TravisCI Linux build to test PowerShell Core 6.2.3-1.
- Change TravisCI MacOS build to test PowerShell Core 6.2.3-1.
- Add PowerShell 7 test to Azure Pipeline - fixes [Issue #325](https://github.com/PlagueHO/CosmosDB/issues/325).
- Fix bug converting Secure String in PowerShell 7 on Linux - fixes [Issue #323](https://github.com/PlagueHO/CosmosDB/issues/323).
- Fix issue in Azure Pipeline in MacOS build job - fixes [Issue #326](https://github.com/PlagueHO/CosmosDB/issues/326).
- Remove TravisCI Pipeline - fixes [Issue #327](https://github.com/PlagueHO/CosmosDB/issues/327).

Version History

Version Downloads Last updated
3.7.0 (current version) 1,034 3/24/2020
3.7.0-previe... 5 3/24/2020
3.6.2-previe... 5 3/21/2020
3.6.2-previe... 5 3/20/2020
3.6.2-previe... 5 3/20/2020
3.6.1 926 3/19/2020
3.6.1-previe... 5 3/19/2020
3.5.2.487 742 3/14/2020
3.5.1.458 21,657 11/12/2019
3.5.0.426 14,124 7/20/2019
3.4.0.411 1,090 6/29/2019
3.3.0.405 512 6/22/2019
3.2.4.376 1,315 5/30/2019
3.2.3.359 3,939 4/5/2019
3.2.2.347 759 3/20/2019
3.2.1.332 1,654 2/22/2019
3.2.0.320 1,172 2/7/2019
3.1.0.293 3,247 12/26/2018
3.0.0.279 1,431 12/23/2018
2.1.15.239 96,200 11/18/2018
2.1.14.222 554 11/15/2018
2.1.13.215 1,558 11/6/2018
2.1.12.137 854 10/29/2018
2.1.11.130 86 10/27/2018
2.1.10.104 433 10/22/2018
2.1.10.103 14 10/22/2018
2.1.9.95 63 10/21/2018
2.1.8.59 1,422 10/3/2018
2.1.8.58 5 10/3/2018
2.1.7.675 5,511 9/11/2018
2.1.7.635 101 9/10/2018
2.1.6.561 19,492 8/24/2018
2.1.5.548 1,003 8/4/2018
2.1.4.536 531 7/25/2018
2.1.3.528 4,323 7/12/2018
2.1.2.514 313 7/3/2018
2.1.1.498 143 6/26/2018
2.1.0.487 53 6/24/2018
2.0.16.465 274 6/20/2018
2.0.15.454 148 6/15/2018
2.0.14.439 138 6/12/2018
2.0.13.427 268 6/3/2018
2.0.12.418 1,194 5/20/2018
2.0.11.407 1,896 5/12/2018
2.0.10.388 366 4/26/2018
2.0.10.382 17 4/25/2018
2.0.9.364 239 4/9/2018
2.0.9.360 7 4/9/2018
2.0.8.350 79 4/5/2018
2.0.7.288 2,885 3/11/2018
2.0.6.247 30 3/9/2018
2.0.5.216 85 3/5/2018
2.0.4.202 408 2/27/2018
2.0.3.190 1,329 2/24/2018
2.0.2.184 4 2/24/2018
2.0.1.173 3,036 1/27/2018
2.0.0.163 234 1/14/2018
2.0.0.152 82 12/23/2017
1.0.12.126 23 12/8/2017
1.0.11.117 6 12/8/2017
1.0.10.108 6 12/6/2017
1.0.9.100 18 11/5/2017
1.0.8.91 19 11/5/2017
1.0.7.85 11 11/3/2017
1.0.6.79 5 11/2/2017