azurerm_cognitive_account - Support for OpenAI to AIServices upgrade/rollback scenario

[promisinganuj]

Community Note

• Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
• Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

This PR it to enhance the Cognitive Services Account to support the upgrade path from Open AI account (kind = OpenAI) to Azure AI Foundry (kind = AIServices), and rollback of such an upgrade (AIServices -> OpenAI) as described here.

Here is a summary of the changes:

• Removing 'ForceNew' for kind attribute.
• Allowing changing project_management_enabled from true to false for kind OpenAI.
• Adding conditional ForceNew to allow change from kind OpenAI to AIServices (upgrade) and from AIServices to OpenAI (rollback) without forcing new resource creating.
• Handling a REST API bug ([BUG] Microsoft.CognitiveServices/accounts - AllowProjectManagement not set to false for AIServices to OpenAI rollback scenario Azure/azure-rest-api-specs#38678) where the allowed_project_management property is not reset to false as part of the rollback.
• Added a new acceptance test for upgrade and rollback scenario.
• Code improvement by using pointer package instead of utils.
• Updating the documentation accordingly.

PR Checklist

• I have followed the guidelines in our Contributing Documentation.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
• I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
• I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
  For example: “resource_name_here - description of change e.g. adding property new_property_name_here”

Changes to existing Resource / Data Source

• I have added an explanation of what my changes do and why I'd like you to include them (This may be covered by linking to an issue above, but may benefit from additional explanation).
• I have written new tests for my resource or datasource changes & updated any relevant documentation.
• I have successfully run tests with my changes locally. If not, please provide details on testing challenges that prevented you running the tests.
• (For changes that include a state migration only). I have manually tested the migration path between relevant versions of the provider.

Testing

• My submission includes Test coverage as described in the Contribution Guide and the tests pass. (if this is not possible for any reason, please include details of why you did or could not add test coverage)

Change Log

Below please provide what should go into the changelog (if anything) conforming to the Changelog Format documented here.

• azurerm_cognitive_account - Support for OpenAI to AIServices upgrade/rollback scenario [Support for OpenAI to AIServices upgrade in azurerm_cognitive_account #31044]

This is a (please select all that apply):

• Bug Fix
• New Feature (ie adding a service, resource, or data source)
• Enhancement
• Breaking Change

Related Issue(s)

Fixes #31044

AI Assistance Disclosure

• AI Assisted - This contribution was made by, or with the assistance of, AI/LLMs

AI is used only to validate the changes and ensuring the best practices are applied.

Rollback Plan

If a change needs to be reverted, we will publish an updated version of the provider.

Changes to Security Controls

Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

[promisinganuj]

Acceptance Test results:
All acceptance tests, except the 4 which fails in "main" as well, are passing.

[teowa]

Hi @promisinganuj , thank you for the PR. I have added a few comments, hope you may take a look.

[promisinganuj]

@teowa , I have addressed the review comments. Please take another look.

[teowa]

Thanks @promisinganuj , LGTM!

[promisinganuj]

Latest acceptance test results. All acceptance tests, except the 4 which fails in "main" as well, are passing:

[magodo]

Thanks for this PR!
I have left some additional mostly minor comments that once addressed this should be good to merge 👍

[promisinganuj]

@magodo, thanks for the review. I have responded to your feedback, please take another look.

[magodo]

@promisinganuj Thanks! LGTM now!

[catriona-m]

Thanks @promisinganuj LGTM!

comments addressed

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.