CosmosDB

3.2.1.332

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 -RequiredVersion 3.2.1.332

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

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-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.2.1.331

 February 22, 2018

 - 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, 2018

 - 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.

 ## What is New in CosmosDB 2.1.15.237

 November 17, 2018

 - Added support for Continuation Tokens to `Get-CosmosDbCollection`
   to support getting more than 100 collections - fixes [Issue #244](https://github.com/PlagueHO/CosmosDB/issues/244).
 - Updated markdown documentation with PlatyPs 0.11.1.
 - Corrected markdown documentation for `Get-CosmosDbCollectionSize`.
 - Corrected continuation token examples for `Get-CosmosDbDocument`.
 - Updated CI pipeline to use Pester 4.4.2.
 - Updated CI pipeline to use PlatyPS 0.12.
 - Renamed `ResultHeaders` parameter to `ResponseHeader` in
   `Get-CosmosDbDocuments` function to adhere to PowerShell standards,
   but included alias for `ResultHeaders` to prevent breaking change.

 ## What is New in CosmosDB 2.1.14.220

 November 15, 2018

 - Extended maximum length of Account Name parameter to be 50 characters - fixes
   [Issue #201](https://github.com/PlagueHO/CosmosDB/issues/201).

 ## What is New in CosmosDB 2.1.13.214

 November 4, 2018

 - Added new integration tests for testing simple index policies.
 - Split the multiple functions scripts into single functions and
   change the build pipeline to combine them all during
   staging - fixes [Issue #201](https://github.com/PlagueHO/CosmosDB/issues/201).
 - Temporarily suppressed running tests using MacOS in Azure Pipelines
   because the Hosted Agent has been updated with Az, preventing the
   AzureRM.NetCore modules from being installed.
 - Improved validation on Name and ResourceGroupName parameters on
   `*-CosmosDBAccount*` functions - fixes [Issue #211](https://github.com/PlagueHO/CosmosDB/issues/211).
 - Improved validation on Account parameter on `*-CosmosDBDatabase*` functions.
 - Improved validation on Account and ResourceGroupName parameter on
   `New-CosmosDbContext` function.
 - Improved validation on Database Id parameter on
   `*-CosmosDBDatabase*` functions - fixes [Issue #212](https://github.com/PlagueHO/CosmosDB/issues/212).
 - Improved validation on Collection Id parameter on
   `*-CosmosDBCollection*` functions - fixes [Issue #213](https://github.com/PlagueHO/CosmosDB/issues/213).
 - Improved validation on Account parameter on `*-CosmosDBCollection*` functions.
 - Improved validation on Database parameter on `*-CosmosDBCollection*` functions.
 - Improved validation on Stored Procedure Id parameter on
   `*-CosmosDBStoredProcedure*` functions - fixes [Issue #214](https://github.com/PlagueHO/CosmosDB/issues/214).
 - Improved validation on Account parameter on `*-CosmosDBStoredProcedure*` functions.
 - Improved validation on Database parameter on `*-CosmosDBStoredProcedure*` functions.
 - Improved validation on Collection parameter on `*-CosmosDBStoredProcedure*` functions.
 - Improved validation on Trigger Id parameter on
   `*-CosmosDBTrigger*` functions - fixes [Issue #215](https://github.com/PlagueHO/CosmosDB/issues/215).
 - Improved validation on Account parameter on `*-CosmosDBTrigger*` functions.
 - Improved validation on Database parameter on `*-CosmosDBTrigger*` functions.
 - Improved validation on Collection parameter on `*-CosmosDBTrigger*` functions.
 - Improved validation on User Defined Function Id parameter on
   `*-CosmosDBUserDefinedFunction*` functions - fixes [Issue #216](https://github.com/PlagueHO/CosmosDB/issues/216).
 - Improved validation on Account parameter on `*-CosmosDBUserDefinedFunction*` functions.
 - Improved validation on Database parameter on `*-CosmosDBUserDefinedFunction*` functions.
 - Improved validation on Collection parameter on `*-CosmosDBUserDefinedFunction*` functions.
 - Improved validation on User Id parameter on
   `*-CosmosDBUser*` functions - fixes [Issue #217](https://github.com/PlagueHO/CosmosDB/issues/217).
 - Improved validation on Account parameter on `*-CosmosDBUser*` functions.
 - Improved validation on Database parameter on `*-CosmosDBUser*` functions.
 - Improved validation on Document Id parameter on
   `*-CosmosDBDocument*` functions - fixes [Issue #227](https://github.com/PlagueHO/CosmosDB/issues/227).
 - Improved validation on Account parameter on `*-CosmosDBDocument*` functions.
 - Improved validation on Database parameter on `*-CosmosDBDocument*` functions.
 - Improved validation on Collection parameter on `*-CosmosDBDocument*` functions.
 - Improved validation on Permission Id parameter on
   `*-CosmosDBPermission*` functions - fixes [Issue #218](https://github.com/PlagueHO/CosmosDB/issues/218).
 - Improved validation on Account parameter on `*-CosmosDBPermission*` functions.
 - Improved validation on Database parameter on `*-CosmosDBPermission*` functions.
 - Improved validation on User parameter on `*-CosmosDBPermission*` functions.
 - Improved validation on Attachment Id parameter on
   `*-CosmosDBAttachment*` functions - fixes [Issue #228](https://github.com/PlagueHO/CosmosDB/issues/228).
 - Improved validation on Account parameter on `*-CosmosDBAttachment*` functions.
 - Improved validation on Database parameter on `*-CosmosDBAttachment*` functions.
 - Improved validation on Collection parameter on `*-CosmosDBAttachment*` functions.
 - Improved validation on Document parameter on `*-CosmosDBAttachment*` functions.
 - Added tests to validate module manifest is valud - fixes [Issue #236](https://github.com/PlagueHO/CosmosDB/issues/236).
 

Version History

Version Downloads Last updated
3.2.3.359 1,147 4/5/2019
3.2.2.347 752 3/20/2019
3.2.1.332 (current version) 1,646 2/22/2019
3.2.0.320 1,164 2/7/2019
3.1.0.293 2,722 12/26/2018
3.0.0.279 513 12/23/2018
2.1.15.239 34,945 11/18/2018
2.1.14.222 548 11/15/2018
2.1.13.215 1,548 11/6/2018
2.1.12.137 839 10/29/2018
2.1.11.130 84 10/27/2018
2.1.10.104 430 10/22/2018
2.1.10.103 12 10/22/2018
2.1.9.95 61 10/21/2018
2.1.8.59 1,332 10/3/2018
2.1.8.58 3 10/3/2018
2.1.7.675 3,795 9/11/2018
2.1.7.635 99 9/10/2018
2.1.6.561 17,076 8/24/2018
2.1.5.548 1,001 8/4/2018
2.1.4.536 529 7/25/2018
2.1.3.528 3,375 7/12/2018
2.1.2.514 311 7/3/2018
2.1.1.498 141 6/26/2018
2.1.0.487 51 6/24/2018
2.0.16.465 272 6/20/2018
2.0.15.454 144 6/15/2018
2.0.14.439 124 6/12/2018
2.0.13.427 266 6/3/2018
2.0.12.418 906 5/20/2018
2.0.11.407 1,882 5/12/2018
2.0.10.388 364 4/26/2018
2.0.10.382 15 4/25/2018
2.0.9.364 237 4/9/2018
2.0.9.360 5 4/9/2018
2.0.8.350 77 4/5/2018
2.0.7.288 2,879 3/11/2018
2.0.6.247 28 3/9/2018
2.0.5.216 83 3/5/2018
2.0.4.202 406 2/27/2018
2.0.3.190 1,327 2/24/2018
2.0.2.184 2 2/24/2018
2.0.1.173 510 1/27/2018
2.0.0.163 170 1/14/2018
2.0.0.152 79 12/23/2017
1.0.12.126 18 12/8/2017
1.0.11.117 4 12/8/2017
1.0.10.108 4 12/6/2017
1.0.9.100 16 11/5/2017
1.0.8.91 12 11/5/2017
1.0.7.85 9 11/3/2017
1.0.6.79 3 11/2/2017
.