CosmosDB
5.0.0-preview0001
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-CosmosDbEntraIdToken Get-CosmosDbResponseHeaderAttribute New-CosmosDbBackoffPolicy New-CosmosDbContext New-CosmosDbContextToken
PSEditions
Dependencies
-
- Az.Accounts (>= 2.19.0)
- Az.Resources (>= 6.16.2)
Release Notes
## [5.0.0-preview0001] - 2024-05-19
### Fixed
- Removed unnecessary quotes from README (works without them in PowerShell and is easier to read)
- Modified README to use splats, which is part of the recommended style guide
- Removed Ubuntu-18.04 testing from build pipeline because it is no longer supported by Microsoft
managed Azure DevOps images - Fixes [Issue #473](https://github.com/PlagueHO/CosmosDB/issues/473).
- Added Ubuntu-22.04 testing to build pipeline - Fixes [Issue #474](https://github.com/PlagueHO/CosmosDB/issues/474).
- Removed MacOS-10.15 testing from build pipeline because it is no longer supported by Microsoft
managed Azure DevOps images - Fixes [Issue #476](https://github.com/PlagueHO/CosmosDB/issues/476).
- Added macOS-12 testing to build pipeline - Fixes [Issue #477](https://github.com/PlagueHO/CosmosDB/issues/477).
- Changed integration tests to deploy Cosmos DB using Bicep.
- Update `requirements.psd1` to install modules `Az.Accounts` 2.19.0 and `Az.Resources` 6.16.2.
- Renamed `New-CosmosDbAuthorizationToken` to `New-CosmosDbAuthorizationHeader` to better indicate
actual function return type.
- Refactored `Invoke-CosmosDbRequest` to support getting the EntraIdToken property from the context object
and using it for authentication if it is provided. If the Key property is provided, the EntraIdToken property
will take precendence and the key will be ignored.
- Updated CI pipeline to use `PublishCodeCoverageResults@2` task rather than `PublishCodeCoverageResults@1`
task to support the latest version of the task.
### Changed
- BREAKING CHANGE: Updated module to require `Az.Accounts` v2.19.0 or newer and `Az.Resources`
v6.16.2 or newer.
- Renamed `New-CosmosDbAuthorizationHeader` to `Get-CosmosDbAuthorizationHeaderFromContext` to better indicate
actual function behaviour.
- Renamed `Get-CosmosDbAuthorizationHeadersFromContext` to `Get-CosmosDbAuthorizationHeaderFromContextResourceToken` to better
indicate actual function behaviour and align naming convention.
- Refactored `Invoke-CosmosDbRequest` to clean up logic to generate the authorization header.
- Added new utillity function `Get-CosmosDbAuthorizationHeaderFromContextEntraId` to generate the authorization
header when an Entra ID Token is provided in the context. This function is used by `Invoke-CosmosDbRequest` to
generate the authorization header when an Entra ID Token is provided.
### Added
- Added support for setting an Entra Id OAuth2 Token in the `New-CosmosDbContext` - Fixes [Issue #479](https://github.com/PlagueHO/CosmosDB/issues/479).
- Added new `Get-CosmosDbEntraIdToken` function that uses `Get-AzAccessToken` to get an Entra Id Token
for use in Cosmos DB requests. This is used by `New-CosmosDbContext` to set the Entra Id Token in the
context object - Fixes [Issue #479](https://github.com/PlagueHO/CosmosDB/issues/479).
FileList
- CosmosDB.nuspec
- CosmosDB.dll
- en-US\about_CosmosDB.help.txt
- CosmosDB.psd1
- en-US\CosmosDB.strings.psd1
- CosmosDB.psm1
- formats\attachments.formats.ps1xml
- formats\permissions.formats.ps1xml
- types\storedprocedures.types.ps1xml
- formats\databases.formats.ps1xml
- types\triggers.types.ps1xml
- formats\users.formats.ps1xml
- types\userdefinedfunctions.types.ps1xml
- formats\triggers.formats.ps1xml
- types\databases.types.ps1xml
- formats\collections.formats.ps1xml
- types\collections.types.ps1xml
- formats\offers.formats.ps1xml
- types\offers.types.ps1xml
- formats\userdefinedfunctions.formats.ps1xml
- types\permissions.types.ps1xml
- formats\documents.formats.ps1xml
- types\users.types.ps1xml
- formats\storedprocedures.formats.ps1xml
- types\documents.types.ps1xml
- classes\CosmosDB\CosmosDB.csproj
- types\attachments.types.ps1xml
- classes\CosmosDB\CosmosDB.cs
Version History
Version | Downloads | Last updated |
---|---|---|
5.0.1-previe... | 68 | 8/12/2024 |
5.0.0 | 238,625 | 6/7/2024 |
5.0.0-previe... | 112,895 | 5/19/2024 |
5.0.0-previe... (current version) | 5 | 5/19/2024 |
4.7.0 | 1,133,578 | 1/29/2023 |
4.7.0-previe... | 15 | 1/22/2023 |
4.6.0 | 95,417 | 8/7/2022 |
4.6.0-previe... | 31 | 8/7/2022 |
4.6.0-previe... | 217 | 5/30/2022 |
4.6.0-previe... | 237 | 9/17/2021 |
4.6.0-previe... | 31 | 9/2/2021 |
4.5.0 | 197,269 | 5/29/2021 |
4.5.0-previe... | 30 | 5/23/2021 |
4.5.0-previe... | 31 | 5/23/2021 |
4.4.3 | 49,208 | 11/13/2020 |
4.4.3-previe... | 30 | 11/12/2020 |
4.4.2 | 2,309 | 11/11/2020 |
4.4.2-previe... | 30 | 11/11/2020 |
4.4.1 | 2,422 | 10/27/2020 |
4.4.1-previe... | 30 | 10/27/2020 |
4.4.0 | 5,995 | 8/30/2020 |
4.4.0-previe... | 31 | 8/30/2020 |
4.3.0 | 4,819 | 8/11/2020 |
4.3.0-previe... | 33 | 8/10/2020 |
4.2.2-previe... | 32 | 8/8/2020 |
4.2.2-previe... | 31 | 8/8/2020 |
4.2.1 | 12,742 | 6/15/2020 |
4.2.1-previe... | 33 | 6/15/2020 |
4.2.0 | 3,022 | 6/1/2020 |
4.2.0-previe... | 32 | 6/1/2020 |
4.2.0-previe... | 32 | 5/31/2020 |
4.2.0-previe... | 32 | 5/31/2020 |
4.2.0-previe... | 32 | 5/30/2020 |
4.1.0 | 7,687 | 5/15/2020 |
4.1.0-previe... | 853 | 5/15/2020 |
4.0.0 | 1,920 | 5/11/2020 |
4.0.0-previe... | 406 | 5/11/2020 |
4.0.0-previe... | 407 | 5/11/2020 |
3.7.0 | 9,470 | 3/24/2020 |
3.7.0-previe... | 414 | 3/24/2020 |
3.6.2-previe... | 410 | 3/21/2020 |
3.6.2-previe... | 413 | 3/20/2020 |
3.6.2-previe... | 411 | 3/20/2020 |
3.6.1 | 10,662 | 3/19/2020 |
3.6.1-previe... | 412 | 3/19/2020 |
3.5.2.487 | 1,158 | 3/14/2020 |
3.5.1.458 | 24,952 | 11/12/2019 |
3.5.0.426 | 44,114 | 7/20/2019 |
3.4.0.411 | 1,499 | 6/29/2019 |
3.3.0.405 | 922 | 6/22/2019 |
3.2.4.376 | 1,749 | 5/30/2019 |
3.2.3.359 | 5,267 | 4/5/2019 |
3.2.2.347 | 1,169 | 3/20/2019 |
3.2.1.332 | 2,066 | 2/22/2019 |
3.2.0.320 | 1,581 | 2/7/2019 |
3.1.0.293 | 7,117 | 12/26/2018 |
3.0.0.279 | 2,005 | 12/23/2018 |
2.1.15.239 | 129,208 | 11/18/2018 |
2.1.14.222 | 967 | 11/15/2018 |
2.1.13.215 | 1,971 | 11/6/2018 |
2.1.12.137 | 1,399 | 10/29/2018 |
2.1.11.130 | 498 | 10/27/2018 |
2.1.10.104 | 844 | 10/22/2018 |
2.1.10.103 | 426 | 10/22/2018 |
2.1.9.95 | 477 | 10/21/2018 |
2.1.8.59 | 1,862 | 10/3/2018 |
2.1.8.58 | 416 | 10/3/2018 |
2.1.7.675 | 7,939 | 9/11/2018 |
2.1.7.635 | 510 | 9/10/2018 |
2.1.6.561 | 21,660 | 8/24/2018 |
2.1.5.548 | 1,413 | 8/4/2018 |
2.1.4.536 | 943 | 7/25/2018 |
2.1.3.528 | 6,890 | 7/12/2018 |
2.1.2.514 | 724 | 7/3/2018 |
2.1.1.498 | 557 | 6/26/2018 |
2.1.0.487 | 464 | 6/24/2018 |
2.0.16.465 | 696 | 6/20/2018 |
2.0.15.454 | 569 | 6/15/2018 |
2.0.14.439 | 566 | 6/12/2018 |
2.0.13.427 | 689 | 6/3/2018 |
2.0.12.418 | 1,632 | 5/20/2018 |
2.0.11.407 | 2,317 | 5/12/2018 |
2.0.10.388 | 807 | 4/26/2018 |
2.0.10.382 | 442 | 4/25/2018 |
2.0.9.364 | 653 | 4/9/2018 |
2.0.9.360 | 420 | 4/9/2018 |
2.0.8.350 | 492 | 4/5/2018 |
2.0.7.288 | 3,310 | 3/11/2018 |
2.0.6.247 | 454 | 3/9/2018 |
2.0.5.216 | 512 | 3/5/2018 |
2.0.4.202 | 831 | 2/27/2018 |
2.0.3.190 | 1,753 | 2/24/2018 |
2.0.2.184 | 428 | 2/24/2018 |
2.0.1.173 | 3,526 | 1/27/2018 |
2.0.0.163 | 1,023 | 1/14/2018 |
2.0.0.152 | 508 | 12/23/2017 |
1.0.12.126 | 447 | 12/8/2017 |
1.0.11.117 | 430 | 12/8/2017 |
1.0.10.108 | 434 | 12/6/2017 |
1.0.9.100 | 444 | 11/5/2017 |
1.0.8.91 | 451 | 11/5/2017 |
1.0.7.85 | 436 | 11/3/2017 |
1.0.6.79 | 432 | 11/2/2017 |