CosmosDB
4.5.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
See the version list below for details.
Installation Options
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-CosmosDbResponseHeaderAttribute New-CosmosDbBackoffPolicy New-CosmosDbContext New-CosmosDbContextToken
PSEditions
Dependencies
-
- Az.Accounts (>= 1.0.0)
- Az.Resources (>= 1.0.0)
Release Notes
## [4.5.0-preview0002] - 2021-05-23
### 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).
FileList
- CosmosDB.nuspec
- CosmosDB.psd1
- CosmosDB-help.xml
- CosmosDB.psm1
- CosmosDB.dll
- types\databases.types.ps1xml
- types\userdefinedfunctions.types.ps1xml
- types\attachments.types.ps1xml
- types\storedprocedures.types.ps1xml
- types\users.types.ps1xml
- types\triggers.types.ps1xml
- types\documents.types.ps1xml
- types\collections.types.ps1xml
- types\permissions.types.ps1xml
- types\offers.types.ps1xml
- formats\databases.formats.ps1xml
- formats\triggers.formats.ps1xml
- formats\users.formats.ps1xml
- formats\documents.formats.ps1xml
- formats\collections.formats.ps1xml
- formats\userdefinedfunctions.formats.ps1xml
- formats\attachments.formats.ps1xml
- formats\offers.formats.ps1xml
- formats\storedprocedures.formats.ps1xml
- formats\permissions.formats.ps1xml
- en-US\CosmosDB.strings.psd1
- en-US\about_CosmosDB.help.txt
- classes\CosmosDB\CosmosDB.cs
- classes\CosmosDB\CosmosDB.csproj
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 5.0.1-previe... | 123 | 10/18/2024 |
| 5.0.1-previe... | 219 | 8/12/2024 |
| 5.0.0 | 492,059 | 6/7/2024 |
| 5.0.0-previe... | 112,898 | 5/19/2024 |
| 5.0.0-previe... | 6 | 5/19/2024 |
| 4.7.0 | 1,199,702 | 1/29/2023 |
| 4.7.0-previe... | 16 | 1/22/2023 |
| 4.6.0 | 100,598 | 8/7/2022 |
| 4.6.0-previe... | 32 | 8/7/2022 |
| 4.6.0-previe... | 218 | 5/30/2022 |
| 4.6.0-previe... | 238 | 9/17/2021 |
| 4.6.0-previe... | 32 | 9/2/2021 |
| 4.5.0 | 219,035 | 5/29/2021 |
| 4.5.0-previe... (current version) | 31 | 5/23/2021 |
| 4.5.0-previe... | 32 | 5/23/2021 |
| 4.4.3 | 49,653 | 11/13/2020 |
| 4.4.3-previe... | 31 | 11/12/2020 |
| 4.4.2 | 2,755 | 11/11/2020 |
| 4.4.2-previe... | 31 | 11/11/2020 |
| 4.4.1 | 2,423 | 10/27/2020 |
| 4.4.1-previe... | 31 | 10/27/2020 |
| 4.4.0 | 5,996 | 8/30/2020 |
| 4.4.0-previe... | 32 | 8/30/2020 |
| 4.3.0 | 4,820 | 8/11/2020 |
| 4.3.0-previe... | 34 | 8/10/2020 |
| 4.2.2-previe... | 33 | 8/8/2020 |
| 4.2.2-previe... | 32 | 8/8/2020 |
| 4.2.1 | 12,745 | 6/15/2020 |
| 4.2.1-previe... | 34 | 6/15/2020 |
| 4.2.0 | 3,023 | 6/1/2020 |
| 4.2.0-previe... | 33 | 6/1/2020 |
| 4.2.0-previe... | 33 | 5/31/2020 |
| 4.2.0-previe... | 33 | 5/31/2020 |
| 4.2.0-previe... | 33 | 5/30/2020 |
| 4.1.0 | 7,952 | 5/15/2020 |
| 4.1.0-previe... | 854 | 5/15/2020 |
| 4.0.0 | 1,929 | 5/11/2020 |
| 4.0.0-previe... | 407 | 5/11/2020 |
| 4.0.0-previe... | 408 | 5/11/2020 |
| 3.7.0 | 9,471 | 3/24/2020 |
| 3.7.0-previe... | 415 | 3/24/2020 |
| 3.6.2-previe... | 411 | 3/21/2020 |
| 3.6.2-previe... | 414 | 3/20/2020 |
| 3.6.2-previe... | 412 | 3/20/2020 |
| 3.6.1 | 10,665 | 3/19/2020 |
| 3.6.1-previe... | 413 | 3/19/2020 |
| 3.5.2.487 | 1,159 | 3/14/2020 |
| 3.5.1.458 | 24,961 | 11/12/2019 |
| 3.5.0.426 | 44,118 | 7/20/2019 |
| 3.4.0.411 | 1,500 | 6/29/2019 |
| 3.3.0.405 | 923 | 6/22/2019 |
| 3.2.4.376 | 1,750 | 5/30/2019 |
| 3.2.3.359 | 5,268 | 4/5/2019 |
| 3.2.2.347 | 1,170 | 3/20/2019 |
| 3.2.1.332 | 2,067 | 2/22/2019 |
| 3.2.0.320 | 1,582 | 2/7/2019 |
| 3.1.0.293 | 7,118 | 12/26/2018 |
| 3.0.0.279 | 2,006 | 12/23/2018 |
| 2.1.15.239 | 130,252 | 11/18/2018 |
| 2.1.14.222 | 968 | 11/15/2018 |
| 2.1.13.215 | 1,972 | 11/6/2018 |
| 2.1.12.137 | 1,400 | 10/29/2018 |
| 2.1.11.130 | 499 | 10/27/2018 |
| 2.1.10.104 | 845 | 10/22/2018 |
| 2.1.10.103 | 427 | 10/22/2018 |
| 2.1.9.95 | 478 | 10/21/2018 |
| 2.1.8.59 | 1,863 | 10/3/2018 |
| 2.1.8.58 | 417 | 10/3/2018 |
| 2.1.7.675 | 7,940 | 9/11/2018 |
| 2.1.7.635 | 511 | 9/10/2018 |
| 2.1.6.561 | 21,677 | 8/24/2018 |
| 2.1.5.548 | 1,414 | 8/4/2018 |
| 2.1.4.536 | 944 | 7/25/2018 |
| 2.1.3.528 | 6,891 | 7/12/2018 |
| 2.1.2.514 | 725 | 7/3/2018 |
| 2.1.1.498 | 558 | 6/26/2018 |
| 2.1.0.487 | 465 | 6/24/2018 |
| 2.0.16.465 | 697 | 6/20/2018 |
| 2.0.15.454 | 570 | 6/15/2018 |
| 2.0.14.439 | 567 | 6/12/2018 |
| 2.0.13.427 | 690 | 6/3/2018 |
| 2.0.12.418 | 1,633 | 5/20/2018 |
| 2.0.11.407 | 2,318 | 5/12/2018 |
| 2.0.10.388 | 808 | 4/26/2018 |
| 2.0.10.382 | 443 | 4/25/2018 |
| 2.0.9.364 | 654 | 4/9/2018 |
| 2.0.9.360 | 421 | 4/9/2018 |
| 2.0.8.350 | 493 | 4/5/2018 |
| 2.0.7.288 | 3,311 | 3/11/2018 |
| 2.0.6.247 | 455 | 3/9/2018 |
| 2.0.5.216 | 513 | 3/5/2018 |
| 2.0.4.202 | 832 | 2/27/2018 |
| 2.0.3.190 | 1,754 | 2/24/2018 |
| 2.0.2.184 | 429 | 2/24/2018 |
| 2.0.1.173 | 3,527 | 1/27/2018 |
| 2.0.0.163 | 1,038 | 1/14/2018 |
| 2.0.0.152 | 509 | 12/23/2017 |
| 1.0.12.126 | 448 | 12/8/2017 |
| 1.0.11.117 | 431 | 12/8/2017 |
| 1.0.10.108 | 435 | 12/6/2017 |
| 1.0.9.100 | 445 | 11/5/2017 |
| 1.0.8.91 | 453 | 11/5/2017 |
| 1.0.7.85 | 437 | 11/3/2017 |
| 1.0.6.79 | 433 | 11/2/2017 |