CosmosDB

2.1.11.130

This module provides cmdlets for working with Azure Cosmos DB databases, collections, documents, attachments, offers, users, permissions, triggers, stored procedures and user defined functions.

There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name CosmosDB -RequiredVersion 2.1.11.130

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name CosmosDB -Version 2.1.11.130

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy 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

Owners

Copyright

(c) 2018 Daniel Scott-Raynsford. All rights reserved.

Package Details

Author(s)

  • Daniel Scott-Raynsford

Tags

CosmosDB DocumentDb Azure

Functions

Get-CosmosDbAccount Get-CosmosDbAccountConnectionString Get-CosmosDbAccountMasterKey Get-CosmosDbAttachment Get-CosmosDbAttachmentResourcePath Get-CosmosDbCollection Get-CosmosDbCollectionResourcePath Get-CosmosDbCollectionSize Get-CosmosDBDatabase Get-CosmosDBDatabaseResourcePath Get-CosmosDBDocument Get-CosmosDBDocumentResourcePath Get-CosmosDBOffer Get-CosmosDBOfferResourcePath Get-CosmosDbPermission Get-CosmosDbPermissionResourcePath Get-CosmosDbStoredProcedure Get-CosmosDbStoredProcedureResourcePath Get-CosmosDbTrigger Get-CosmosDbTriggerResourcePath Get-CosmosDbUser Get-CosmosDbUserResourcePath Get-CosmosDbUserDefinedFunction Get-CosmosDbUserDefinedFunctionResourcePath Invoke-CosmosDbStoredProcedure New-CosmosDbAccount New-CosmosDbAccountMasterKey New-CosmosDbAttachment New-CosmosDbBackoffPolicy New-CosmosDbCollection New-CosmosDbCollectionIncludedPathIndex New-CosmosDbCollectionIncludedPath New-CosmosDbCollectionExcludedPath New-CosmosDbCollectionIndexingPolicy New-CosmosDbDatabase New-CosmosDbDocument New-CosmosDbContext New-CosmosDbContextToken New-CosmosDbPermission New-CosmosDbStoredProcedure New-CosmosDbTrigger New-CosmosDbUser New-CosmosDbUserDefinedFunction Remove-CosmosDbAccount Remove-CosmosDbAttachment Remove-CosmosDbCollection Remove-CosmosDbDatabase Remove-CosmosDbDocument Remove-CosmosDbPermission Remove-CosmosDbStoredProcedure Remove-CosmosDbTrigger Remove-CosmosDbUser Remove-CosmosDbUserDefinedFunction Set-CosmosDbAccount Set-CosmosDbAttachment Set-CosmosDbCollection Set-CosmosDbDocument Set-CosmosDbOffer Set-CosmosDbStoredProcedure Set-CosmosDbTrigger Set-CosmosDbUser Set-CosmosDbUserDefinedFunction

PSEditions

Core Desktop

Dependencies

This module has no dependencies.

Release Notes


## What is New in CosmosDB 2.1.11.130

October 27, 2018

- Renamed `ResourceGroup` parameter to `ResourceGroupName` in
   `New-CosmosDbContext` function - fixes [Issue #158](https://github.com/PlagueHO/CosmosDB/issues/158).
- Correct `*-CosmosDbAccount` functions examples in README.MD to show
   `ResourceGroupName` parameter.
- Added `Get-CosmosDbAccountMasterKey` function for retrieving the keys
   of an existing account in Azure - fixes [Issue #162](https://github.com/PlagueHO/CosmosDB/issues/162).
- Added `New-CosmosDbAccountMasterKey` function for regenerating the keys
   of an existing account in Azure - fixes [Issue #164](https://github.com/PlagueHO/CosmosDB/issues/164).

## What is New in CosmosDB 2.1.10.103

October 22, 2018

- Added support for creating and updating documents containing
   non-ASCII characters by adding Encoding parameter to `New-CosmosDbDocument`
   and `Set-CosmosDbDocument` functions - fixes [Issue #151](https://github.com/PlagueHO/CosmosDB/issues/151).
- Fix table of contents link in README.MD.

## What is New in CosmosDB 2.1.9.92

October 20, 2018

- Improved unit test reliability on MacOS and Linux.
- Improved unit tests for account functions to include parameter filters on mock assertions.
- Added `Get-CosmosDbAccountConnectionString` function for retrieving the connection strings
   of an existing account in Azure - fixes [Issue #163](https://github.com/PlagueHO/CosmosDB/issues/163).
   This function is not currently working due to an issue with the Microsoft\DocumentDB provider
   in Azure - see [this issue](https://github.com/Azure/azure-powershell/issues/3650) for more information.
- Fixed 'Unable to find type \[Microsoft.PowerShell.Commands.HttpResponseException\]' exception
   being thrown in `Invoke-CosmosDbRequest` when error is returned by Cosmos DB in PowerShell 5.x
   or earlier - fixes [Issue #186](https://github.com/PlagueHO/CosmosDB/issues/186).
- Split unit and integration test execution in CI process so that integration tests do
   not run when unit tests fail - fixes [Issue #184](https://github.com/PlagueHO/CosmosDB/issues/184).

## What is New in CosmosDB 2.1.8.59

October 3, 2018

- Fixed RU display - fixes [Issue #168](https://github.com/PlagueHO/CosmosDB/issues/168)
- Fixed Powershell Core `Invoke-WebRequest` error handling.
- Fixed retry logic bug (`$fatal` initially set to `$true` instead of `$false`).
- Fixed stored procedure debug logging output.
- Rework CI process to simplify code.
- Enabled integration test execution in Azure DevOps Pipelines - fixes [Issue #179](https://github.com/PlagueHO/CosmosDB/issues/179)
- Added artifact publish tasks for Azure Pipeline.
- Refactored module deployment process to occur in Azure DevOps pipeline - fixes [Issue #181](https://github.com/PlagueHO/CosmosDB/issues/181)

## What is New in CosmosDB 2.1.7.675

September 11, 2018

- Added support for running CI in Azure DevOps Pipelines - fixes [Issue #174](https://github.com/PlagueHO/CosmosDB/issues/174)

## What is New in CosmosDB 2.1.7.635

September 3, 2018

- Added `New-CosmosDbAccount` function for creating a new Cosmos DB
 account in Azure - fixes [Issue #111](https://github.com/PlagueHO/CosmosDB/issues/111)
- Added `Get-CosmosDbAccount` function for retrieving the properties
 of an existing account in Azure - fixes [Issue #159](https://github.com/PlagueHO/CosmosDB/issues/159)
- Added `Set-CosmosDbAccount` function for updating an existing Cosmos DB
 account in Azure - fixes [Issue #160](https://github.com/PlagueHO/CosmosDB/issues/160)
- Added `Remove-CosmosDbAccount` function for removing an existing Cosmos DB
 account in Azure - fixes [Issue #161](https://github.com/PlagueHO/CosmosDB/issues/161)
- Added OSx and Linux PowerShell Core continuous integration using
 TravisCI.
- Improved CI/CodeCoverage badges in README.MD.
- Improved build process to handle build environments that do not
 have Administrator/Root access.
- Skip test for `Convert-CosmosDbRequestBody` when run in Linux/OSx using
 PowerShell Core due to behavior difference - see [PowerShell Core #Issue](https://github.com/PowerShell/PowerShell/issues/7693)

## What is New in CosmosDB 2.1.6.561

August 24, 2018

- Updated partition key handling when creating collections to allow for
 leading '/' characters in the partition key - fixes [Issue #153](https://github.com/PlagueHO/CosmosDB/issues/153)
- Add support for setting URI and Key when using with a Cosmos DB
 Emulator - fixes [Issue #155](https://github.com/PlagueHO/CosmosDB/issues/155)

 ## What is New in CosmosDB 2.1.5.548

August 4, 2018

- Changed references to `CosmosDB` to `Cosmos DB` in documentation - fixes [Issue #147](https://github.com/PlagueHO/CosmosDB/issues/147)

## What is New in CosmosDB 2.1.4.536

July 25, 2018

- Added `RemoveDefaultTimeToLive` switch parameter to `Set-CosmosDbCollection`
 to allow removal of a default time to live setting on a collection - fixes [Issue #144](https://github.com/PlagueHO/CosmosDB/issues/144)

## What is New in CosmosDB 2.1.3.528

July 12, 2018

- Changed `New-CosmosDbStoredProcedure` & `Set-CosmosDbStoredProcedure` to use serialization
 instead of tricky request body conversion - fixes
 [Issue #137](https://github.com/PlagueHO/CosmosDB/issues/137)
- Added parameter `DefaultTimeToLive` to `New-CosmosDbCollection` and
 `Set-CosmosDbCollection` - fixes [Issue #139](https://github.com/PlagueHO/CosmosDB/issues/139)
- Changed the `IndexingPolicy` parameter on`Set-CosmosDbCollection`
 to be optional - fixes [Issue #140](https://github.com/PlagueHO/CosmosDB/issues/140)

## What is New in CosmosDB 2.1.2.514

July 3, 2018

- Changed `New-CosmosDBContext` so that Read Only keys will use the
 `readonlykeys` action endpoint instead of the `listKeys` action - fixes
 [Issue #133](https://github.com/PlagueHO/CosmosDB/issues/133)
- Fixed freeze occuring in functions when `-ErrorAction SilentlyContinue`
 parameter was used and error is returned - fixes [Issue #132](https://github.com/PlagueHO/CosmosDB/issues/132)

## What is New in CosmosDB 2.1.1.498

June 26, 2018

- Changed trigger operation type `Insert` to `Create` in `New-CosmosDBTrigger`
 and `Set-CosmosDBTrigger` functions - fixes [Issue #129](https://github.com/PlagueHO/CosmosDB/issues/129)

## What is New in CosmosDB 2.1.0.487

June 23, 2018

- Removed `UseWebRequest` parameter from `Invoke-CosmosDbReuest` function
 to refactor out the use of `Invoke-RestMethod`. This is because most
 Cosmos DB REST requests return additional header information that is
 lost if using `Invoke-RestMethod`. `Invoke-WebRequest` is used instead
 so that additional headers can always be retured - See [Issue #125](https://github.com/PlagueHO/CosmosDB/issues/125)
- Added integration tests for attachments.
- Added integration tests for stored procedures.
- Added integration tests for triggers.
- Added integration tests for user defined functions.
- Added `New-CosmosDbBackOffPolicy` function for controlling the behaviour
 of a function when a "Too Many Request" (error code 429) is recieved -
 See [Issue #87](https://github.com/PlagueHO/CosmosDB/issues/87)
- Added support for handling a back-off policy to the `Invoke-CosmosDbRequest`
 function.

## What is New in CosmosDB 2.0.16.465

June 20, 2018

- Added None as an IndexingMode - See [Issue #120](https://github.com/PlagueHO/CosmosDB/issues/120)

## What is New in CosmosDB 2.0.15.454

June 15, 2018

- Fix creation of spatial index by `New-CosmosDbCollectionIncludedPathIndex`
 so that precision is not used when passing to `New-CosmosDbCollection`.
- Added support for `-PartitionKey` in `Invoke-CosmosDbStoredProcedure` - See [Issue #116](https://github.com/PlagueHO/CosmosDB/issues/116)
- Changed -StoredProcedureParameter from string[] to object[] in `Invoke-CosmosDbStoredProcedure` - See [Issue #116](https://github.com/PlagueHO/CosmosDB/issues/116)
- Updated `Invoke-CosmosDbStoredProcedure` to set `x-ms-documentdb-script-enable-logging: true` header and write stored procedure logs to the Verbose Stream when `-Debug` is set - See [Issue #116](https://github.com/PlagueHO/CosmosDB/issues/116)

## What is New in CosmosDB 2.0.14.439

June 12, 2018

- Fixed Code Coverage upload to CodeCov.io.
- Fix `New-CosmosDbCollectionIncludedPathIndex` Kind parameter spelling
 of spacial - See [Issue #112](https://github.com/PlagueHO/CosmosDB/issues/112).
- Added parameter validation to `New-CosmosDbCollectionIncludedPathIndex`.

## What is New in CosmosDB 2.0.13.427

June 03, 2018

- Added `Set-CosmosDbCollection` function for updating a collection - See
 [Issue #104](https://github.com/PlagueHO/CosmosDB/issues/104).
- Updated `Invoke-CosmosDbRequest` function to output additional exception
 information to the Verbose stream - See [Issue #103](https://github.com/PlagueHO/CosmosDB/issues/103).
           

FileList

Version History

Version Downloads Last updated
4.7.0 894,126 1/29/2023
4.7.0-previe... 13 1/22/2023
4.6.0 86,399 8/7/2022
4.6.0-previe... 29 8/7/2022
4.6.0-previe... 215 5/30/2022
4.6.0-previe... 235 9/17/2021
4.6.0-previe... 29 9/2/2021
4.5.0 154,794 5/29/2021
4.5.0-previe... 28 5/23/2021
4.5.0-previe... 29 5/23/2021
4.4.3 47,676 11/13/2020
4.4.3-previe... 28 11/12/2020
4.4.2 1,267 11/11/2020
4.4.2-previe... 28 11/11/2020
4.4.1 2,420 10/27/2020
4.4.1-previe... 28 10/27/2020
4.4.0 5,993 8/30/2020
4.4.0-previe... 29 8/30/2020
4.3.0 4,810 8/11/2020
4.3.0-previe... 31 8/10/2020
4.2.2-previe... 30 8/8/2020
4.2.2-previe... 29 8/8/2020
4.2.1 12,740 6/15/2020
4.2.1-previe... 31 6/15/2020
4.2.0 3,019 6/1/2020
4.2.0-previe... 30 6/1/2020
4.2.0-previe... 30 5/31/2020
4.2.0-previe... 30 5/31/2020
4.2.0-previe... 30 5/30/2020
4.1.0 7,006 5/15/2020
4.1.0-previe... 851 5/15/2020
4.0.0 1,916 5/11/2020
4.0.0-previe... 404 5/11/2020
4.0.0-previe... 405 5/11/2020
3.7.0 9,467 3/24/2020
3.7.0-previe... 412 3/24/2020
3.6.2-previe... 408 3/21/2020
3.6.2-previe... 411 3/20/2020
3.6.2-previe... 409 3/20/2020
3.6.1 10,660 3/19/2020
3.6.1-previe... 410 3/19/2020
3.5.2.487 1,156 3/14/2020
3.5.1.458 24,946 11/12/2019
3.5.0.426 44,112 7/20/2019
3.4.0.411 1,497 6/29/2019
3.3.0.405 920 6/22/2019
3.2.4.376 1,747 5/30/2019
3.2.3.359 5,265 4/5/2019
3.2.2.347 1,167 3/20/2019
3.2.1.332 2,064 2/22/2019
3.2.0.320 1,579 2/7/2019
3.1.0.293 7,113 12/26/2018
3.0.0.279 2,003 12/23/2018
2.1.15.239 126,593 11/18/2018
2.1.14.222 965 11/15/2018
2.1.13.215 1,969 11/6/2018
2.1.12.137 1,397 10/29/2018
2.1.11.130 (current version) 496 10/27/2018
2.1.10.104 842 10/22/2018
2.1.10.103 424 10/22/2018
2.1.9.95 475 10/21/2018
2.1.8.59 1,860 10/3/2018
2.1.8.58 414 10/3/2018
2.1.7.675 7,937 9/11/2018
2.1.7.635 508 9/10/2018
2.1.6.561 21,631 8/24/2018
2.1.5.548 1,411 8/4/2018
2.1.4.536 941 7/25/2018
2.1.3.528 6,764 7/12/2018
2.1.2.514 722 7/3/2018
2.1.1.498 555 6/26/2018
2.1.0.487 462 6/24/2018
2.0.16.465 694 6/20/2018
2.0.15.454 567 6/15/2018
2.0.14.439 564 6/12/2018
2.0.13.427 687 6/3/2018
2.0.12.418 1,630 5/20/2018
2.0.11.407 2,315 5/12/2018
2.0.10.388 805 4/26/2018
2.0.10.382 440 4/25/2018
2.0.9.364 651 4/9/2018
2.0.9.360 418 4/9/2018
2.0.8.350 490 4/5/2018
2.0.7.288 3,308 3/11/2018
2.0.6.247 452 3/9/2018
2.0.5.216 510 3/5/2018
2.0.4.202 829 2/27/2018
2.0.3.190 1,751 2/24/2018
2.0.2.184 426 2/24/2018
2.0.1.173 3,524 1/27/2018
2.0.0.163 990 1/14/2018
2.0.0.152 506 12/23/2017
1.0.12.126 445 12/8/2017
1.0.11.117 428 12/8/2017
1.0.10.108 432 12/6/2017
1.0.9.100 442 11/5/2017
1.0.8.91 449 11/5/2017
1.0.7.85 434 11/3/2017
1.0.6.79 430 11/2/2017
Show less