CosmosDB
4.0.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-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 New-CosmosDbBackoffPolicy New-CosmosDbContext New-CosmosDbContextToken
PSEditions
Dependencies
-
- Az.Accounts (>= 1.0.0)
- Az.Resources (>= 1.0.0)
Release Notes
## [4.0.0-preview0002] - 2020-05-11
### Changed
- Change Azure DevOps Pipeline definition to include `source/*` - Fixes [Issue #350](https://github.com/PlagueHO/CosmosDB/issues/350).
- Updated pipeline to use `latest` version of `ModuleBuilder` - Fixes [Issue #350](https://github.com/PlagueHO/CosmosDB/issues/350).
- Merge `HISTORIC_CHANGELOG.md` into `CHANGELOG.md` - Fixes [Issue #351](https://github.com/PlagueHO/CosmosDB/issues/351).
- Added integration tests for executing document queries - Fixes [Issue #356](https://github.com/PlagueHO/CosmosDB/issues/356).
- Added support for composite indexes in indexing policy - Fixes [Issue #357](https://github.com/PlagueHO/CosmosDB/issues/357).
- BREAKING CHANGE: Updated module to default to Cosmos DB REST
API version `2018-09-17`. This results in a change to the default
indexes when custom index paths are not specified. Other changes
in behavior of indexing policy are also expected. See
[this page](https://docs.microsoft.com/en-nz/azure/cosmos-db/index-policy#composite-indexes)
for more information.
- Added `IndexingPolicyJson` parameter to `New-CosmosDbCollection`
and `Set-CosmosDbCollection` functions to enable setting an index policy
using JSON - Fixes [Issue #360](https://github.com/PlagueHO/CosmosDB/issues/360).
- Fixed build pipeline deployment skip function.
- Changed Build.yml to support `ModuleBuilder` version to `1.7.0` by changing
`CopyDirectories` to `CopyPaths`.
- Added `Get-CosmosDbContinuationToken` helper function to get the continuation
token from response headers returned by `Get-CosmosDbCollection` or
`Get-CosmosDbDocument` - Fixes [Issue #355](https://github.com/PlagueHO/CosmosDB/issues/355).
- Added example to `README.md` showing how to loop through a document set
to return more than 4MB of documents - Fixes [Issue #354](https://github.com/PlagueHO/CosmosDB/issues/354).
FileList
- CosmosDB.nuspec
- CosmosDB.psm1
- CosmosDB.dll
- CosmosDB-help.xml
- CosmosDB.psd1
- types\storedprocedures.types.ps1xml
- types\userdefinedfunctions.types.ps1xml
- types\users.types.ps1xml
- types\documents.types.ps1xml
- types\permissions.types.ps1xml
- types\databases.types.ps1xml
- types\triggers.types.ps1xml
- types\offers.types.ps1xml
- types\attachments.types.ps1xml
- types\collections.types.ps1xml
- en-US\CosmosDB.strings.psd1
- en-US\about_CosmosDB.help.txt
- formats\offers.formats.ps1xml
- formats\collections.formats.ps1xml
- formats\userdefinedfunctions.formats.ps1xml
- formats\users.formats.ps1xml
- formats\triggers.formats.ps1xml
- formats\databases.formats.ps1xml
- formats\storedprocedures.formats.ps1xml
- formats\permissions.formats.ps1xml
- formats\documents.formats.ps1xml
- formats\attachments.formats.ps1xml
- classes\CosmosDB\CosmosDB.csproj
- classes\CosmosDB\CosmosDB.cs
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,045 | 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,694 | 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... | 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... (current version) | 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 |