v5.0.0-preview0002

[v5.0.0-preview0002]

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.
• Added Ubuntu-22.04 testing to build pipeline - Fixes Issue #474.
• Removed MacOS-10.15 testing from build pipeline because it is no longer supported by Microsoft
  managed Azure DevOps images - Fixes Issue #476.
• Added macOS-12 testing to build pipeline - Fixes Issue #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.
• Changed module import process to load the Az.Accounts and Az.Resources modules
  only if they haven't already been loaded to support saving the module and storing in
  folders.

Added

• Added support for setting an Entra Id OAuth2 Token in the New-CosmosDbContext - Fixes Issue #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.

v5.0.0-preview0001

[v5.0.0-preview0001]

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.
• Added Ubuntu-22.04 testing to build pipeline - Fixes Issue #474.
• Removed MacOS-10.15 testing from build pipeline because it is no longer supported by Microsoft
  managed Azure DevOps images - Fixes Issue #476.
• Added macOS-12 testing to build pipeline - Fixes Issue #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.
• 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.

v4.7.0

[v4.7.0]

• Added -ConnectionString parameter to New-CosmosDbContext - Fixes Issue #426.

Fixed

• Fixed spelling errors in documentation.

v4.7.0-preview0001

[v4.7.0-preview0001]

• Added -ConnectionString parameter to New-CosmosDbContext - Fixes Issue #426.

Fixed

• Fixed spelling errors in documentation.

v4.6.0

[v4.6.0]

Fixed

• Fix Azure DevOps build pipeline and update to latest sampler pattern.
• Fix exception being thrown when a 429 is returned by CosmosDB, but the
  x-ms-retry-after-ms header is not returned. This may occur in requests
  that follow large (> 1MB) insert or updates - Fixes Issue #458.

Changed

• Update Azure DevOps pipeline Linux agent version for build task
  to be ubuntu-latest - Fixes Issue #422.
• Updated PSScriptAnalyzer tests to be skipped when PowerShell Core
  version is less than 7.0.3 - Fixes Issue #431.
• Updated the New-CosmosDbAccount command to add a new Capability
  parameter - Fixes Issue #439.
• Updated tests on PowerShell 6.x for MacOS 10.14 to 10.15 - Fixes Issue #450.
• Updated README.md to remove markdown issues.

Added

• Added tests on PowerShell 7.x on Ubuntu 20.04 - Fixes Issue #433.
• Added tests on Windows PowerShell 5.1 on Windows Server 2022 - Fixes Issue #436.
• Added tests on PowerShell 6.x on MacOS 11 - Fixes Issue #450.

Removed

• Removed tests against PowerShell Core 6.x as PowerShell 7.x is recommended - Fixes
  Issue #434.
• Removed all tests on Ubuntu 16.04 - Fixes Issue #433.
• Removed tests against Windows PowerShell 5.1 on Windows Server 2016 - Fixes
  Issue #451.

v4.6.0-preview0004

[v4.6.0-preview0004]

Fixed

• Fix Azure DevOps build pipeline and update to latest sampler pattern.
• Fix exception being thrown when a 429 is returned by CosmosDB, but the
  x-ms-retry-after-ms header is not returned. This may occur in requests
  that follow large (> 1MB) insert or updates - Fixes Issue #458.

Changed

• Update Azure DevOps pipeline Linux agent version for build task
  to be ubuntu-latest - Fixes Issue #422.
• Updated PSScriptAnalyzer tests to be skipped when PowerShell Core
  version is less than 7.0.3 - Fixes Issue #431.
• Updated the New-CosmosDbAccount command to add a new Capability
  parameter - Fixes Issue #439.
• Updated tests on PowerShell 6.x for MacOS 10.14 to 10.15 - Fixes Issue #450.
• Updated README.md to remove markdown issues.

Added

• Added tests on PowerShell 7.x on Ubuntu 20.04 - Fixes Issue #433.
• Added tests on Windows PowerShell 5.1 on Windows Server 2022 - Fixes Issue #436.
• Added tests on PowerShell 6.x on MacOS 11 - Fixes Issue #450.

Removed

• Removed tests against PowerShell Core 6.x as PowerShell 7.x is recommended - Fixes
  Issue #434.
• Removed all tests on Ubuntu 16.04 - Fixes Issue #433.
• Removed tests against Windows PowerShell 5.1 on Windows Server 2016 - Fixes
  Issue #451.

v4.6.0-preview0003

[v4.6.0-preview0003]

Fixed

• Fix Azure DevOps build pipeline and update to latest sampler pattern.

Changed

• Update Azure DevOps pipeline Linux agent version for build task
  to be ubuntu-latest - Fixes Issue #422.
• Updated PSScriptAnalyzer tests to be skipped when PowerShell Core
  version is less than 7.0.3 - Fixes Issue #431.
• Updated the New-CosmosDbAccount command to add a new Capability
  parameter - Fixes Issue #439.
• Updated tests on PowerShell 6.x for MacOS 10.14 to 10.15 - Fixes Issue #450.

Added

• Added tests on PowerShell 7.x on Ubuntu 20.04 - Fixes Issue #433.
• Added tests on Windows PowerShell 5.1 on Windows Server 2022 - Fixes Issue #436.
• Added tests on PowerShell 6.x on MacOS 11 - Fixes Issue #450.

Removed

• Removed tests against PowerShell Core 6.x as PowerShell 7.x is recommended - Fixes
  Issue #434.
• Removed all tests on Ubuntu 16.04 - Fixes Issue #433.
• Removed tests against Windows PowerShell 5.1 on Windows Server 2016 - Fixes
  Issue #451.

v4.6.0-preview0002

[v4.6.0-preview0002]

Changed

• Update Azure DevOps pipeline Linux agent version for build task
  to be ubuntu-latest - Fixes Issue #422.
• Updated PSScriptAnalyzer tests to be skipped when PowerShell Core
  version is less than 7.0.3 - Fixes Issue #431.
• Updated the New-CosmosDbAccount command to add a new Capability parameter - Fixes Issue #439.

Added

• Added tests on PowerShell 7.x on Ubuntu 20.04 - Fixes Issue #433.
• Added tests on Windows 5.1 on Windows Server 2022 - Fixes Issue #436.

Removed

• Removed tests against PowerShell Core 6.x as PowerShell 7.x is recommended - Fixes
  Issue #434.
• Removed all tests on Ubuntu 16.04 - Fixes Issue #433.

v4.6.0-preview0001

[v4.6.0-preview0001]

Changed

• Update Azure DevOps pipeline Linux agent version for build task
  to be ubuntu-latest - Fixes Issue #422.
• Updated PSScriptAnalyzer tests to be skipped when PowerShell Core
  version is less than 7.0.3 - Fixes Issue #431.

Added

• Added tests on PowerShell 7.x on Ubuntu 20.04 - Fixes Issue #433.
• Added tests on Windows 5.1 on Windows Server 2022 - Fixes Issue #436.

Removed

• Removed tests against PowerShell Core 6.x as PowerShell 7.x is recommended - Fixes
  Issue #434.
• Removed all tests on Ubuntu 16.04 - Fixes Issue #433.

v4.5.0

[v4.5.0]

Changed

• Convert build pipeline to use GitTools Azure DevOps extension tasks
  instead of deprecated GitVersion extension.
• Correct value of Environment parameter in context object returned
  by New-CosmosDbContext - Fixes Issue #411.
• Update requirements.psd1 to install modules Az.Accounts
  2.2.8 - Fixes Issue #415.
• Updated ComsosDB.cs to add getters and setters to properties - Fixes Issue #417.

Fixed

• Fix CI pipeline deployment stage to ensure correctly detects running
  in Azure DevOps organization.
• Fix CI pipeline release stage by adding Sampler GitHub tasks which
  were moved out of the main sampler module into a new module
  Sampler.GitHubTasks - Fixes Issue #418.

Added

• Added ReturnJson parameter to New-CosmosDbDocument, Set-CosmosDbDocument
  and Get-CosmosDbDocument functions to allow return of documents that can
  not be converted to objects due to duplicate key names that only differ in
  case - Fixes Issue #413.