v5.2.0-preview0001

[v5.2.0-preview0001]

Added

• Added Get-CosmosDbRequestExceptionString function to get the exception string
  from a Cosmos DB response. Refactored Invoke-CosmosDbRequest to use this
  function to get the exception string from the response.
• Added testing for MacOS-13, MacOS-14, MacOS-15, Windows Server 2025, Ubuntu-24.04
  and PowerShell 7.x on Windows Server 2019, 2022 and 2025 to the CI pipeline.

Fixed

• Converted CI pipeline Test stage to use matrix to reduce duplication of code.
• FIx spelling error of ApplicationObjectId variable in CI pipeline.

v5.1.0

[v5.1.0]

Fixed

• Fixed pipeline build step by limiting Gitversion to 5.* version.
• Change default integration test region from East US to Australia East due
  to quota limitations.
• Removed MacOS-11 testing from build pipeline because it is no longer supported
  by Microsoft managed Azure DevOps images.
• Changed integration tests to display the removal of the Cosmos DB account
  in the teardown phase to ensure the account is removed after the tests are
  completed.
• Updated collection and database autoscale minimum from 4000 to
  1000 - Fixes Issue #493.
• Changed integration tests to attempt to clean up the Cosmos DB resource group
  if it is not removed by the teardown phase - Fixes Issue #494.

v5.1.0-preview0001

[v5.1.0-preview0001]

Fixed

• Fixed pipeline build step by limiting Gitversion to 5.* version.
• Change default integration test region from East US to Australia East due
  to quota limitations.
• Removed MacOS-11 testing from build pipeline because it is no longer supported
  by Microsoft managed Azure DevOps images.
• Changed integration tests to display the removal of the Cosmos DB account
  in the teardown phase to ensure the account is removed after the tests are
  completed.
• Updated collection and database autoscale minimum from 4000 to
  1000 - Fixes Issue #493.
• Changed integration tests to attempt to clean up the Cosmos DB resource group
  if it is not removed by the teardown phase - Fixes Issue #494.

v5.0.1-preview0002

[v5.0.1-preview0002]

Fixed

• Fixed pipeline build step by limiting Gitversion to 5.* version.
• Change default integration test region from East US to Australia East due
  to quota limitations.
• Removed MacOS-11 testing from build pipeline because it is no longer supported
  by Microsoft managed Azure DevOps images.
• Changed integration tests to display the removal of the Cosmos DB account
  in the teardown phase to ensure the account is removed after the tests are
  completed.

v5.0.1-preview0001

[v5.0.1-preview0001]

Fixed

• Fixed pipeline build step by limiting Gitversion to 5.* version.
• Change default integration test region from East US to Australia East due
  to quota limitations.
• Removed MacOS-11 testing from build pipeline because it is no longer supported
  by Microsoft managed Azure DevOps images.

v5.0.0

[v5.0.0]

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