CosmosDB

3.5.1.458

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

Installation Options

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

Install-Module -Name CosmosDB

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

Author(s)

Daniel Scott-Raynsford

Copyright

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

Owners

Tags

CosmosDB DocumentDb Azure Windows Linux MacOS

Functions

Get-CosmosDbAccount Get-CosmosDbAccountConnectionString Get-CosmosDbAccountMasterKey Get-CosmosDbAttachment Get-CosmosDbAttachmentResourcePath Get-CosmosDbCollection Get-CosmosDbCollectionResourcePath Get-CosmosDbCollectionSize Get-CosmosDbContextToken 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-CosmosDbCollectionUniqueKey New-CosmosDbCollectionUniqueKeyPolicy 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

Release Notes


 ## What is New in CosmosDB 3.5.1.458

 November 12, 2019

 - Change `psakefile.ps1` to detect Azure Pipelines correctly.
 - Updated `BuildHelpers` support module for CI pipelines to 2.0.10.
 - Added PowerShell Gallery badge to `README.md`.
 - Refactored `Invoke-CosmosDbRequest` and added
   `Get-CosmosDbAuthorizationHeadersFromContext` to split out function to pull
   token out of `Context` object. This was done to reduce the size of the
   `Invoke-CosmosDbRequest` function and to improve testability.
 - Fix TravisCI MacOS build - fixes [Issue #313](https://github.com/PlagueHO/CosmosDB/issues/313).
 - Created helper function `Format-CosmosDbDocumentPartitionKey` to
   format the partition key string passed to `x-ms-documentdb-partitionkey`
   in document functions.
 - Add support for integer partition keys to functions
   `Get-CosmosDbDocument`, `New-CosmosDbDocument`, `Remove-CosmosDbDocument`
   and `Set-CosmosDbDocument`.

 ## What is New in CosmosDB 3.5.0.425

 July 19, 2019

 - Fix issue with integration test execution error in Azure DevOps
   when running against a pull request and the contributor has not
   set build environment variables for connecting to Azure - fixes [Issue #304](https://github.com/PlagueHO/CosmosDB/issues/304).
 - Added `.markdownlint.json` to enable linting of markdown files.
 - Added optional `ETag` parameter to `Set-CosmosDbDocument` to check if
   the document has been updated since last get.

 ## What is New in CosmosDB 3.4.0.410

 June 29, 2019

 - Added `OfferThroughput` parameter to `New-CosmosDbDatabase`
   function - fixes [Issue #110](https://github.com/PlagueHO/CosmosDB/issues/110).

 ## What is New in CosmosDB 3.3.0.404

 June 22, 2019

 - Moved CosmosDB namespace class definitions into C# project to be built
   into a .NET Standard 2.0 DLL that can be loaded instead of a CS file.
   This is to work around a problem with Azure Functions 2.0 where
   types can not be compiled in the runtime (see [this issue](https://github.com/Azure/azure-functions-powershell-worker/issues/220)) -
   fixes [Issue #290](https://github.com/PlagueHO/CosmosDB/issues/290).

 ## What is New in CosmosDB 3.2.4.375

 May 30, 2019

 - Update `requirements.psd1` to install modules `Az.Resources` 1.3.1 and
   `Az.Accounts` 1.5.1.
 - Change `requirements.psd1` to specify `minimumversion` of `Az.Resources`
   and `Az.Accounts`.
 - Enabled tests and removed the warning when executing the function
   `Get-CosmosDbAccountConnectionString` because the underlying REST API
   has been fixed and now functions correctly - fixes [Issue #291](https://github.com/PlagueHO/CosmosDB/issues/291).
 - Added parameter `MasterKeyType` to function `Get-CosmosDbAccountConnectionString`
   to only return a specific connection string - fixes [Issue #291](https://github.com/PlagueHO/CosmosDB/issues/291).

 ## What is New in CosmosDB 3.2.3.358

 April 5, 2019

 - Fix incorrectly encoded strings being returned by `Get-CosmosDbDocument`
   when UTF-8 results are returned - fixes [Issues #282](https://github.com/PlagueHO/CosmosDB/issues/282).
 - Rename `CosmosDb.psdepend.ps1` to `requirements.psd1` to be a more
   generic name.

 ## What is New in CosmosDB 3.2.2.348

 March 19, 2019

 - Added Azure Pipelines YAML definition for executing automated
   testing on a daily schedule - fixes [Issue #272](https://github.com/PlagueHO/CosmosDB/issues/272).
 - Extend AppVeyor test automation to run on Windows Server 2012R2
   and Windows Server 2016.
 - Update `cosmosdb.psdepend.psd1` to install modules `Az.Resources` 1.2.0 and
   `Az.Accounts` 1.4.0.
 - Added `Windows`, `Linux` and `MacOS` tags to module manifest to
   improve searchability in PowerShell Gallery.

 ## What is New in CosmosDB 3.2.1.331

 February 22, 2019

 - Added support for `PartitionKey` in `*-CosmosDBAttachment`
   functions - fixes [Issue #274](https://github.com/PlagueHO/CosmosDB/issues/274).
 - Update `cosmosdb.psdepend.psd1` to install modules `Az.Resources` 1.1.2 and
   `Az.Accounts` 1.3.0.
 - Suppress verbose output when loading module during automated
   testing to reduce output.

 ## What is New in CosmosDB 3.2.0.320

 February 6, 2019

 - Convert module name to be a variable in PSake file to make it more
   easily portable between projects.
 - Fix `Notes` display in Readme Markdown - fixes [Issue #269](https://github.com/PlagueHO/CosmosDB/issues/269).
 - Update `cosmosdb.psdepend.psd1` to install modules `Az` 1.2.1 and
   `Pester` 4.7.0.
 - Deprecate `Hash` index policy kind and throw exception when used
   in `New-CosmosDbCollectionIncludedPathIndex`. See [this page](https://docs.microsoft.com/en-us/azure/cosmos-db/index-types#index-kind)
   for more information - fixes [Issue #271](https://github.com/PlagueHO/CosmosDB/issues/271).

 ## What is New in CosmosDB 3.1.0.293

 December 26, 2018

 - Updated manifest to include required modules `Az.Accounts` 1.0.0
   and `Az.Resources` 1.0.0.
 - Updated manifest to include `CompatiblePSEditions` of 'Desktop' and
   'Core'.
 - Updated minimum supported PowerShell version to 5.1.
 - Updated `cosmosdb.depend.psd1` to ensure `Az` modules are installed
   when running 'Deploy' PSake task.
 - Improve build task code to ensure Git tag is correctly set.

 ## What is New in CosmosDB 3.0.0.279

 December 23, 2018

 - BREAKING CHANGE: Converted to use `Az` PowerShell Module from
   `AzureRm` and `AzureRm.NetCore` PowerShell Module - fixes [Issue #190](https://github.com/PlagueHO/CosmosDB/issues/190).
 - Renamed `build.ps1` to `psake.ps1` to indicate that it is used
   to execute `Psake` tasks.
 - Add Codacy Code Quality badge to `README.MD`.
 - Configure PSScriptAnalyzer to show errors, warnings and informational
   violations in Visual Studio Code.
 - Fix generic tests to validate PSScriptAnalyzer errors, warnings and
   informational rules.
 - Converted use of alias `Add-AzAccount` to `Connect-AzAccount`.
 - Updated to use `Az` PowerShell Module 1.0.1.
 - Correct `AliasesToExport` in manifest.
 - Minor corrections to markdown to improve best practice adherence.
 - Minor corrections to CI support files to improve best practice
   adherence.
 - Added ShouldProcess support to `New-CosmosDbAccountMasterKey` and
   `New-CosmosDbContext`.
 - Added ShouldProcess support TestHelper functions.
 - Updated CONTRIBUTING.MD to more accurately reflect current process of
   contributing to the module.
 - Updated STYLEGUIDELINES.MD to match current standards and best practices.
 - Added support for setting and updating Cross-Origin Resource Sharing (CORS)
   allowed origins in `New-CosmosDbAccount` and `Set-CosmosDbAccount`
   respectively - fixes [Issue #249](https://github.com/PlagueHO/CosmosDB/issues/249).
 - Changed `Remove-CosmosDbAccount` to prevent second confirmation prompt
   when removing account.
 - Enabled `*-CosmosDbAccount` tests to run in AppVeyor.
 

Version History

Version Downloads Last updated
3.5.1.458 (current version) 9,244 11/12/2019
3.5.0.426 12,511 7/20/2019
3.4.0.411 1,087 6/29/2019
3.3.0.405 512 6/22/2019
3.2.4.376 1,294 5/30/2019
3.2.3.359 3,925 4/5/2019
3.2.2.347 759 3/20/2019
3.2.1.332 1,654 2/22/2019
3.2.0.320 1,172 2/7/2019
3.1.0.293 2,996 12/26/2018
3.0.0.279 1,379 12/23/2018
2.1.15.239 91,881 11/18/2018
2.1.14.222 553 11/15/2018
2.1.13.215 1,558 11/6/2018
2.1.12.137 841 10/29/2018
2.1.11.130 86 10/27/2018
2.1.10.104 433 10/22/2018
2.1.10.103 14 10/22/2018
2.1.9.95 63 10/21/2018
2.1.8.59 1,401 10/3/2018
2.1.8.58 5 10/3/2018
2.1.7.675 5,170 9/11/2018
2.1.7.635 101 9/10/2018
2.1.6.561 18,971 8/24/2018
2.1.5.548 1,003 8/4/2018
2.1.4.536 531 7/25/2018
2.1.3.528 4,168 7/12/2018
2.1.2.514 313 7/3/2018
2.1.1.498 143 6/26/2018
2.1.0.487 53 6/24/2018
2.0.16.465 274 6/20/2018
2.0.15.454 148 6/15/2018
2.0.14.439 134 6/12/2018
2.0.13.427 268 6/3/2018
2.0.12.418 1,191 5/20/2018
2.0.11.407 1,896 5/12/2018
2.0.10.388 366 4/26/2018
2.0.10.382 17 4/25/2018
2.0.9.364 239 4/9/2018
2.0.9.360 7 4/9/2018
2.0.8.350 79 4/5/2018
2.0.7.288 2,882 3/11/2018
2.0.6.247 30 3/9/2018
2.0.5.216 85 3/5/2018
2.0.4.202 408 2/27/2018
2.0.3.190 1,329 2/24/2018
2.0.2.184 4 2/24/2018
2.0.1.173 2,762 1/27/2018
2.0.0.163 219 1/14/2018
2.0.0.152 81 12/23/2017
1.0.12.126 23 12/8/2017
1.0.11.117 6 12/8/2017
1.0.10.108 6 12/6/2017
1.0.9.100 18 11/5/2017
1.0.8.91 18 11/5/2017
1.0.7.85 11 11/3/2017
1.0.6.79 5 11/2/2017