v6.1.1-preview0001

[v6.1.1-preview0001]

v6.1.0

[v6.1.0]

Fixed

• Fixed Get-CosmosDbEntraIdToken to return the SecureString from
  the Get-AzAccessToken call rather than generating a new SecureString
  from the token property. This was resulting in a 401 Unauthorized error
  when calling any of the dataplane functions that used the Entra ID token -
  fixes Issue #511
• Fixed Convert-CosmosDbSecureStringToString to include process block so
  that pipelining works correctly.

Changed

• Changed Get-CosmosDbEntraIdToken so that if Get-AzAccessToken returns a
  null or empty token, it will throw an exception rather than returning a
  null or empty string.
• CHORE: Added .Devcontainer and Dependabot configuration files to the repository
  to support development in Visual Studio Code with a Docker container.
• CHORE: Updated Pull Request and Issue templates to use YAML forms in the
  .github/ISSUE_TEMPLATE folder.
• CHORE: Updated Az.Accounts to 5.0.0 or above requirements.psd1 and
  CosmosDB.psd1 - fixes Issue #509
• CHORE: Updated Az.Resources to 8.0.0 or above in requirements.psd1 and
  CosmosDB.psd1 - fixes Issue #509
• CHORE: Added copilot-instructions.md to control Copilot suggestions in the
  repository. This file is used to provide instructions to Copilot on how to
  generate code for the module.
• CHORE: Added prompts\create-spec.prompt.md to provide a prompt for creating
  new specifications for the module.
• CHORE: Added prompts\update-llms.yaml to provide a prompt for updating the
  llms.txt file for the repo.
• Removed testing on Ubuntu-20.04 from the CI pipeline because it is no longer
  supported by Microsoft managed Azure DevOps images.

v6.1.0-preview0002

[v6.1.0-preview0002]

Fixed

• Fixed Get-CosmosDbEntraIdToken to return the SecureString from
  the Get-AzAccessToken call rather than generating a new SecureString
  from the token property. This was resulting in a 401 Unauthorized error
  when calling any of the dataplane functions that used the Entra ID token -
  fixes Issue #511
• Fixed Convert-CosmosDbSecureStringToString to include process block so
  that pipelining works correctly.

Changed

• Changed Get-CosmosDbEntraIdToken so that if Get-AzAccessToken returns a
  null or empty token, it will throw an exception rather than returning a
  null or empty string.
• CHORE: Added .Devcontainer and Dependabot configuration files to the repository
  to support development in Visual Studio Code with a Docker container.
• CHORE: Updated Pull Request and Issue templates to use YAML forms in the
  .github/ISSUE_TEMPLATE folder.
• CHORE: Updated Az.Accounts to 5.0.0 or above requirements.psd1 and
  CosmosDB.psd1 - fixes Issue #509
• CHORE: Updated Az.Resources to 8.0.0 or above in requirements.psd1 and
  CosmosDB.psd1 - fixes Issue #509
• CHORE: Added copilot-instructions.md to control Copilot suggestions in the
  repository. This file is used to provide instructions to Copilot on how to
  generate code for the module.
• CHORE: Added prompts\create-spec.prompt.md to provide a prompt for creating
  new specifications for the module.
• CHORE: Added prompts\update-llms.yaml to provide a prompt for updating the
  llms.txt file for the repo.
• Removed testing on Ubuntu-20.04 from the CI pipeline because it is no longer
  supported by Microsoft managed Azure DevOps images.

v6.1.0-preview0001

[v6.1.0-preview0001]

Changed

• CHORE: Added .Devcontainer and Dependabot configuration files to the repository
  to support development in Visual Studio Code with a Docker container.
• CHORE: Updated Pull Request and Issue templates to use YAML forms in the
  .github/ISSUE_TEMPLATE folder.
• CHORE: Updated Az.Accounts to 4.2.0 only in requirements.psd1 and
  CosmosDB.psd1 - fixes Issue #509
• CHORE: Updated Az.Resources to 7.1.0 and above in requirements.psd1 and
  CosmosDB.psd1 - fixes Issue #509
• CHORE: Added copilot-instructions.md to control Copilot suggestions in the
  repository. This file is used to provide instructions to Copilot on how to
  generate code for the module.
• CHORE: Added prompts\create-spec.prompt.md to provide a prompt for creating
  new specifications for the module.
• CHORE: Added prompts\update-llms.yaml to provide a prompt for updating the
  llms.txt file for the repo.
• Removed testing on Ubuntu-20.04 from the CI pipeline because it is no longer
  supported by Microsoft managed Azure DevOps images.

v6.0.2-preview0002

[v6.0.2-preview0002]

v6.0.2-preview0001

[v6.0.2-preview0001]

v6.0.1

[v6.0.1]

Added

• Added support for setting EndpointHostname in New-CosmosDbContext to allow
  setting the base URI for the Cosmos DB account when using Entra ID authentication
  or token based authentication. This allows the use of future Azure Clouds that
  may not be supported by this module.
• Added alias BaseUri forEndpointHostname in New-CosmosDbContext function.

v6.0.1-preview0001

[v6.0.1-preview0001]

Added

• Added support for setting EndpointHostname in New-CosmosDbContext to allow
  setting the base URI for the Cosmos DB account when using Entra ID authentication
  or token based authentication. This allows the use of future Azure Clouds that
  may not be supported by this module.
• Added alias BaseUri forEndpointHostname in New-CosmosDbContext function.

v6.0.0

[v6.0.0]

Changed

• BREAKING CHANGE: Exceptions returned by Invoke-CosmosDbRequest are now
  CosmosDb.ResponseException objects instead of either
  Microsoft.PowerShell.Commands.HttpResponseException (PowerShell 7.x) or
  System.Net.HttpWebResponse (PowerShell 5.x) objects. This is to prevent
  authorization Headers from being returned in the exception object. In future
  the filtered headers and other response information may be included in the
  CosmosDb.ResponseException object.

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.

Fixed

• 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.
• Converted CI pipeline Test stage to use matrix to reduce duplication of code.
• FIx spelling error of ApplicationObjectId variable in CI pipeline.

v6.0.0-preview0001

[v6.0.0-preview0001]

Changed

• BREAKING CHANGE: Exceptions returned by Invoke-CosmosDbRequest are now
  CosmosDb.ResponseException objects instead of either
  Microsoft.PowerShell.Commands.HttpResponseException (PowerShell 7.x) or
  System.Net.HttpWebResponse (PowerShell 5.x) objects. This is to prevent
  authorization Headers from being returned in the exception object. In future
  the filtered headers and other response information may be included in the
  CosmosDb.ResponseException object.

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.

Fixed

• 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.
• Converted CI pipeline Test stage to use matrix to reduce duplication of code.
• FIx spelling error of ApplicationObjectId variable in CI pipeline.