`azurerm_ai_services` - mark as deprecated for 5.0 by ZiChuanBuXiu · Pull Request #31809 · hashicorp/terraform-provider-azurerm

ZiChuanBuXiu · 2026-02-24T02:41:50Z

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

Mark azurerm_ai_services as deprecated for 5.0 as it's replaced by azurerm_cognitive_account

Use azurerm_cognitive_account as DeprecatedInFavourOfResource for azurerm_ai_services
Add conditional skip for azurerm_ai_services acceptance tests
Add conditional check for resource registration
Remove reference for azurerm_ai_services
- Resource template in AI Foundry test
- Code samples in AI Foundry/AI Foundry Project document
Update ai_services.html.markdown to indicate deprecation
Add migration guide in 5.0-upgrade-guide.html.markdown

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)

Acceptance test for Cognitive AI Services

Acceptance test for AI Foundry

Verification test for deprecation warning

Change Log

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

azurerm_ai_services - Deprecate for 5.0 in favour of azurerm_cognitive_account [GH-00000]

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 #0000

AI Assistance Disclosure

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

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

lgtm!

magodo

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

gerrytan

Thanks @ZiChuanBuXiu , I left some question and feedbacks. Please also trigger another run of acctest if you push a commit. You can run only relevant test using the tctest tool.

gerrytan · 2026-03-05T05:28:15Z

+| (not present) | `kind` | **Required**. Set to `"AIServices"` to match the behaviour of `azurerm_ai_services`. |
+| `local_authentication_enabled` | `local_auth_enabled` | **Renamed**. Both default to `true`. |
+| `public_network_access` | `public_network_access_enabled` | **Changed type**. String (`"Enabled"` / `"Disabled"`) → Boolean (`true` / `false`). Defaults to `true`. |
+| (not present) | `project_management_enabled` |**Required**. Set to `true` to match the behaviour of `azurerm_ai_services`. |


project_management_enabled is not a required field in cognitive_account. Also in ai_services we never set any value. Are you saying the API default when it's nil is equal to true?

It's not a "REQUIRED" field but it's required to be set to true during migration, otherwise it will force a new resource to be created based on this instruction.

I may change the wording to Mandatory to make it less confusing with the "Required" field terminology?

To add some more context, project_management_enabled flag is optional and false by default as it's not applicable to other kinds. Users should be setting the project_management_enabled to true when kind is set to AIServices. Without it, users can't create projects within the account which defeats the purpose.

Ah got it thanks!

Also noted we already got a CustomizeDiff check for this in cognitive_account:

internal/services/cognitive/cognitive_account_resource.go

if d.Get("project_management_enabled").(bool) { if kind != "AIServices" { return errors.New("`project_management_enabled` can only be set to `true` when `kind` is set to `AIServices`") }

gerrytan · 2026-03-05T05:30:23Z

+| `local_authentication_enabled` | `local_auth_enabled` | **Renamed**. Both default to `true`. |
+| `public_network_access` | `public_network_access_enabled` | **Changed type**. String (`"Enabled"` / `"Disabled"`) → Boolean (`true` / `false`). Defaults to `true`. |
+| (not present) | `project_management_enabled` |**Required**. Set to `true` to match the behaviour of `azurerm_ai_services`. |
+| `customer_managed_key.managed_hsm_key_id`  | (not present) | `customer_managed_key.managed_hsm_key_id` is not present in `azurerm_cognitive_account`. Try update to use `customer_managed_key.key_vault_key_id` before migration. |


This needs grammatical improvement

Suggested change

| `customer_managed_key.managed_hsm_key_id` | (not present) | `customer_managed_key.managed_hsm_key_id` is not present in `azurerm_cognitive_account`. Try update to use `customer_managed_key.key_vault_key_id` before migration. |

| `customer_managed_key.managed_hsm_key_id` | (not present) | Use `customer_managed_key.key_vault_key_id` property, it can accept both regular and HSM key id. |

gerrytan · 2026-03-05T05:34:31Z


+### `azurerm_ai_services`
+
+* This deprecated resource has been retired and has been removed from the Azure Provider.


Please use the wording format for superseded removal

Suggested change

* This deprecated resource has been retired and has been removed from the Azure Provider.

* This deprecated resource has been superseded by `azurerm_cognitive_account` and has been removed from the Azure Provider.

gerrytan · 2026-03-05T05:39:42Z


 Manages an AI Services Account.

+~> **Note:** The `azurerm_ai_services` resource has been deprecated and will be removed in v5.0 of the AzureRM Provider. Please use [`azurerm_cognitive_account`](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cognitive_account) resource instead.


Do not hardcode full URI, use relative link instead

Suggested change

~> **Note:** The `azurerm_ai_services` resource has been deprecated and will be removed in v5.0 of the AzureRM Provider. Please use [`azurerm_cognitive_account`](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cognitive_account) resource instead.

~> **Note:** The `azurerm_ai_services` resource has been deprecated and will be removed in v5.0 of the AzureRM Provider. Please use [`azurerm_cognitive_account`](cognitive_account.html.markdown) resource instead.

promisinganuj

lgtm!

gerrytan

I have triggered a fresh set of acctests:

And have pinged @magodo to run the GH workflow.

Assuming all the result is good, this PR is good to go. Nice work @ZiChuanBuXiu !

gerrytan · 2026-03-06T05:22:23Z

+| (not present) | `kind` | **Required**. Set to `"AIServices"` to match the behaviour of `azurerm_ai_services`. |
+| `local_authentication_enabled` | `local_auth_enabled` | **Renamed**. Both default to `true`. |
+| `public_network_access` | `public_network_access_enabled` | **Changed type**. String (`"Enabled"` / `"Disabled"`) → Boolean (`true` / `false`). Defaults to `true`. |
+| (not present) | `project_management_enabled` |**Required**. Set to `true` to match the behaviour of `azurerm_ai_services`. |


Ah got it thanks!

Also noted we already got a CustomizeDiff check for this in cognitive_account:

internal/services/cognitive/cognitive_account_resource.go

if d.Get("project_management_enabled").(bool) { if kind != "AIServices" { return errors.New("`project_management_enabled` can only be set to `true` when `kind` is set to `AIServices`") }

Deprecate azurerm_ai_services for 5.0

8d0084e

github-actions Bot added documentation service/cognitive-services service/machine-learning size/M enhancement ai-assisted labels Feb 24, 2026

ZiChuanBuXiu marked this pull request as ready for review February 24, 2026 03:17

ZiChuanBuXiu requested review from a team, WodansSon and magodo as code owners February 24, 2026 03:17

promisinganuj self-requested a review February 27, 2026 03:53

promisinganuj previously approved these changes Feb 27, 2026

View reviewed changes

magodo reviewed Feb 27, 2026

View reviewed changes

Comment thread internal/services/machinelearning/ai_foundry_resource_test.go

magodo previously approved these changes Feb 27, 2026

View reviewed changes

promisinganuj mentioned this pull request Mar 4, 2026

Private Endpoint Creation Fails for Azure AI Foundry: Provider Marks Cognitive Account as Complete While ARM State Is Still "Accepted" #31712

Open

1 task

ZiChuanBuXiu added 3 commits March 4, 2026 16:10

Merge branch 'main' into dp/deprecate-ai-service

06b4555

Merge branch 'main' into dp/deprecate-ai-service

ab5acc2

Add migration guide

bad3e53

ZiChuanBuXiu dismissed stale reviews from magodo and promisinganuj via bad3e53 March 4, 2026 05:55

ZiChuanBuXiu added 3 commits March 5, 2026 09:23

Fix migration guide

7974a7e

Rollback unwanted formatting

46dffe7

Rollback unwanted formatting

c6a9706

ZiChuanBuXiu requested a review from promisinganuj March 4, 2026 22:34

Update heading and link

59ac194

gerrytan self-requested a review March 5, 2026 00:01

Fix migration guide

7e9597f

gerrytan suggested changes Mar 5, 2026

View reviewed changes

Fix document

26ba93b

ZiChuanBuXiu requested a review from gerrytan March 5, 2026 23:20

promisinganuj approved these changes Mar 6, 2026

View reviewed changes

gerrytan approved these changes Mar 6, 2026

View reviewed changes

mybayern1974 added the ready label Apr 16, 2026

katbyte removed the ready label Apr 22, 2026

This comment has been minimized.

Sign in to view

	\| `customer_managed_key.managed_hsm_key_id` \| (not present) \| `customer_managed_key.managed_hsm_key_id` is not present in `azurerm_cognitive_account`. Try update to use `customer_managed_key.key_vault_key_id` before migration. \|
	\| `customer_managed_key.managed_hsm_key_id` \| (not present) \| Use `customer_managed_key.key_vault_key_id` property, it can accept both regular and HSM key id. \|


		### `azurerm_ai_services`

		* This deprecated resource has been retired and has been removed from the Azure Provider.

	* This deprecated resource has been retired and has been removed from the Azure Provider.
	* This deprecated resource has been superseded by `azurerm_cognitive_account` and has been removed from the Azure Provider.


		Manages an AI Services Account.

		~> Note: The `azurerm_ai_services` resource has been deprecated and will be removed in v5.0 of the AzureRM Provider. Please use [`azurerm_cognitive_account`](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cognitive_account) resource instead.

Conversation

ZiChuanBuXiu commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Community Note

Description

PR Checklist

Changes to existing Resource / Data Source

Testing

Acceptance test for Cognitive AI Services

Acceptance test for AI Foundry

Verification test for deprecation warning

Change Log

Related Issue(s)

AI Assistance Disclosure

Rollback Plan

Changes to Security Controls

Uh oh!

promisinganuj left a comment

Choose a reason for hiding this comment

Uh oh!

magodo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gerrytan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

promisinganuj left a comment

Choose a reason for hiding this comment

Uh oh!

gerrytan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ZiChuanBuXiu commented Feb 24, 2026 •

edited

Loading