CosmosDB
3.6.2-preview0003
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-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
Dependencies
-
- Az.Accounts (>= 1.0.0)
- Az.Resources (>= 1.0.0)
Release Notes
## [3.6.2-preview0003] - 2020-03-20
### 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).
## [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).
FileList
- CosmosDB.nuspec
- CosmosDB.psd1
- CosmosDB-help.xml
- CosmosDB.dll
- CosmosDB.psm1
- en-US\CosmosDB.strings.psd1
- en-US\about_CosmosDB.help.txt
- types\databases.types.ps1xml
- types\documents.types.ps1xml
- types\collections.types.ps1xml
- types\attachments.types.ps1xml
- types\triggers.types.ps1xml
- types\storedprocedures.types.ps1xml
- types\userdefinedfunctions.types.ps1xml
- types\users.types.ps1xml
- types\permissions.types.ps1xml
- types\offers.types.ps1xml
- formats\attachments.formats.ps1xml
- formats\storedprocedures.formats.ps1xml
- formats\userdefinedfunctions.formats.ps1xml
- formats\documents.formats.ps1xml
- formats\collections.formats.ps1xml
- formats\offers.formats.ps1xml
- formats\triggers.formats.ps1xml
- formats\permissions.formats.ps1xml
- formats\databases.formats.ps1xml
- formats\users.formats.ps1xml
- classes\CosmosDB\CosmosDB.cs
- classes\CosmosDB\CosmosDB.csproj
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 6.1.1-previe... | 544 | 6/8/2025 |
| 6.1.0 | 1,028,127 | 6/8/2025 |
| 6.1.0-previe... | 8 | 6/8/2025 |
| 6.1.0-previe... | 12 | 6/1/2025 |
| 6.0.2-previe... | 26 | 5/12/2025 |
| 6.0.2-previe... | 8 | 5/10/2025 |
| 6.0.1 | 93,144 | 5/9/2025 |
| 6.0.1-previe... | 6 | 5/9/2025 |
| 6.0.0 | 52,561 | 4/26/2025 |
| 6.0.0-previe... | 5 | 4/26/2025 |
| 5.2.0-previe... | 29 | 4/14/2025 |
| 5.1.0 | 573,608 | 12/15/2024 |
| 5.1.0-previe... | 6 | 12/14/2024 |
| 5.0.1-previe... | 208 | 10/18/2024 |
| 5.0.1-previe... | 222 | 8/12/2024 |
| 5.0.0 | 569,429 | 6/7/2024 |
| 5.0.0-previe... | 112,902 | 5/19/2024 |
| 5.0.0-previe... | 9 | 5/19/2024 |
| 4.7.0 | 1,389,012 | 1/29/2023 |
| 4.7.0-previe... | 20 | 1/22/2023 |
| 4.6.0 | 110,222 | 8/7/2022 |
| 4.6.0-previe... | 34 | 8/7/2022 |
| 4.6.0-previe... | 220 | 5/30/2022 |
| 4.6.0-previe... | 242 | 9/17/2021 |
| 4.6.0-previe... | 35 | 9/2/2021 |
| 4.5.0 | 260,073 | 5/29/2021 |
| 4.5.0-previe... | 33 | 5/23/2021 |
| 4.5.0-previe... | 35 | 5/23/2021 |
| 4.4.3 | 52,756 | 11/13/2020 |
| 4.4.3-previe... | 33 | 11/12/2020 |
| 4.4.2 | 2,761 | 11/11/2020 |
| 4.4.2-previe... | 33 | 11/11/2020 |
| 4.4.1 | 2,425 | 10/27/2020 |
| 4.4.1-previe... | 33 | 10/27/2020 |
| 4.4.0 | 5,999 | 8/30/2020 |
| 4.4.0-previe... | 34 | 8/30/2020 |
| 4.3.0 | 4,823 | 8/11/2020 |
| 4.3.0-previe... | 36 | 8/10/2020 |
| 4.2.2-previe... | 35 | 8/8/2020 |
| 4.2.2-previe... | 34 | 8/8/2020 |
| 4.2.1 | 12,748 | 6/15/2020 |
| 4.2.1-previe... | 37 | 6/15/2020 |
| 4.2.0 | 3,029 | 6/1/2020 |
| 4.2.0-previe... | 35 | 6/1/2020 |
| 4.2.0-previe... | 35 | 5/31/2020 |
| 4.2.0-previe... | 34 | 5/31/2020 |
| 4.2.0-previe... | 35 | 5/30/2020 |
| 4.1.0 | 9,315 | 5/15/2020 |
| 4.1.0-previe... | 856 | 5/15/2020 |
| 4.0.0 | 1,969 | 5/11/2020 |
| 4.0.0-previe... | 409 | 5/11/2020 |
| 4.0.0-previe... | 410 | 5/11/2020 |
| 3.7.0 | 9,485 | 3/24/2020 |
| 3.7.0-previe... | 416 | 3/24/2020 |
| 3.6.2-previe... (current version) | 414 | 3/21/2020 |
| 3.6.2-previe... | 415 | 3/20/2020 |
| 3.6.2-previe... | 414 | 3/20/2020 |
| 3.6.1 | 10,668 | 3/19/2020 |
| 3.6.1-previe... | 415 | 3/19/2020 |
| 3.5.2.487 | 1,161 | 3/14/2020 |
| 3.5.1.458 | 24,967 | 11/12/2019 |
| 3.5.0.426 | 44,120 | 7/20/2019 |
| 3.4.0.411 | 1,502 | 6/29/2019 |
| 3.3.0.405 | 924 | 6/22/2019 |
| 3.2.4.376 | 1,751 | 5/30/2019 |
| 3.2.3.359 | 5,272 | 4/5/2019 |
| 3.2.2.347 | 1,174 | 3/20/2019 |
| 3.2.1.332 | 2,070 | 2/22/2019 |
| 3.2.0.320 | 1,585 | 2/7/2019 |
| 3.1.0.293 | 7,124 | 12/26/2018 |
| 3.0.0.279 | 2,012 | 12/23/2018 |
| 2.1.15.239 | 133,454 | 11/18/2018 |
| 2.1.14.222 | 974 | 11/15/2018 |
| 2.1.13.215 | 1,974 | 11/6/2018 |
| 2.1.12.137 | 1,403 | 10/29/2018 |
| 2.1.11.130 | 502 | 10/27/2018 |
| 2.1.10.104 | 847 | 10/22/2018 |
| 2.1.10.103 | 430 | 10/22/2018 |
| 2.1.9.95 | 481 | 10/21/2018 |
| 2.1.8.59 | 1,867 | 10/3/2018 |
| 2.1.8.58 | 418 | 10/3/2018 |
| 2.1.7.675 | 7,947 | 9/11/2018 |
| 2.1.7.635 | 513 | 9/10/2018 |
| 2.1.6.561 | 21,729 | 8/24/2018 |
| 2.1.5.548 | 1,416 | 8/4/2018 |
| 2.1.4.536 | 946 | 7/25/2018 |
| 2.1.3.528 | 6,906 | 7/12/2018 |
| 2.1.2.514 | 727 | 7/3/2018 |
| 2.1.1.498 | 561 | 6/26/2018 |
| 2.1.0.487 | 469 | 6/24/2018 |
| 2.0.16.465 | 700 | 6/20/2018 |
| 2.0.15.454 | 573 | 6/15/2018 |
| 2.0.14.439 | 570 | 6/12/2018 |
| 2.0.13.427 | 692 | 6/3/2018 |
| 2.0.12.418 | 1,636 | 5/20/2018 |
| 2.0.11.407 | 2,321 | 5/12/2018 |
| 2.0.10.388 | 812 | 4/26/2018 |
| 2.0.10.382 | 445 | 4/25/2018 |
| 2.0.9.364 | 656 | 4/9/2018 |
| 2.0.9.360 | 424 | 4/9/2018 |
| 2.0.8.350 | 497 | 4/5/2018 |
| 2.0.7.288 | 3,314 | 3/11/2018 |
| 2.0.6.247 | 457 | 3/9/2018 |
| 2.0.5.216 | 516 | 3/5/2018 |
| 2.0.4.202 | 835 | 2/27/2018 |
| 2.0.3.190 | 1,756 | 2/24/2018 |
| 2.0.2.184 | 432 | 2/24/2018 |
| 2.0.1.173 | 3,602 | 1/27/2018 |
| 2.0.0.163 | 1,116 | 1/14/2018 |
| 2.0.0.152 | 511 | 12/23/2017 |
| 1.0.12.126 | 455 | 12/8/2017 |
| 1.0.11.117 | 434 | 12/8/2017 |
| 1.0.10.108 | 439 | 12/6/2017 |
| 1.0.9.100 | 448 | 11/5/2017 |
| 1.0.8.91 | 456 | 11/5/2017 |
| 1.0.7.85 | 440 | 11/3/2017 |
| 1.0.6.79 | 436 | 11/2/2017 |