CosmosDB

Author(s)

• Daniel Scott-Raynsford

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

• • Az.Accounts (>= 1.0.0)
  • Az.Resources (>= 1.0.0)

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.