azurerm_machine_learning_workspace - Update Validation to allow Hub and Project

[JonDunnDAFF]

Adding support for new Kinds of Machine Learning Workspace.

• Hub
• Project

As per resource documentation for AI Studio: https://learn.microsoft.com/en-us/azure/ai-studio/concepts/ai-resources

Providing template.json from Azure Portal export of resource as evidence of supported Kinds due to lack of information specified in Azure API documentation for resource.

template.json

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 "+1" or "me too" comments, they generate extra noise for PR followers and do not help prioritize for review

Description

Azure Machine Learning has been integrated into a new interface referred to as Azure AI Studio. This interface surfaces two new 'Kinds' of ML Workspace as defined in the reference documentation for AI Studio: https://learn.microsoft.com/en-us/azure/ai-studio/concepts/ai-resources

This Pull Request is to update the validation rules for the Machine Learning workspace Kind to allow these new values of Hub and Project.

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 relevent 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_machine_learning_workspace - Update Validation to allow Hub and Project

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

Note

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

[stephybun]

Thanks for this PR @JonDunnDAFF.

Similar to #25729 I think these would want to be added as separate resources.

Looking at how the resources relate to one another in the portal, an AI Hub Project can be created within an AI Hub. Adding these as values to kind means the corresponding configuration in Terraform would have an azurerm_machine_learning_workspace referencing a parent or child azurerm_machine_learning_workspace, which to me seems odd and has the potential to cause confusion about the relationship and hierarchy of these resources.

Although the AI Hub and Project resources are created using the same API for the AML Workspace and have similar configuration parameters, there is the possibility for these to diverge over time.

With the above in mind I think these need to be added as separate resources instead of extending the values for kind. Is that something you would be able to look into?

[JonDunnDAFF]

Thanks for this PR @JonDunnDAFF.

Similar to #25729 I think these would want to be added as separate resources.

Looking at how the resources relate to one another in the portal, an AI Hub Project can be created within an AI Hub. Adding these as values to kind means the corresponding configuration in Terraform would have an azurerm_machine_learning_workspace referencing a parent or child azurerm_machine_learning_workspace, which to me seems odd and has the potential to cause confusion about the relationship and hierarchy of these resources.

Although the AI Hub and Project resources are created using the same API for the AML Workspace and have similar configuration parameters, there is the possibility for these to diverge over time.

With the above in mind I think these need to be added as separate resources instead of extending the values for kind. Is that something you would be able to look into?

Would you recommend adding these as individual resources e.g. machine_leaning_project and machine_learning_hub to make it clear that the underlying resource is an ML workspace or would it be better off tying this to the latest Microsoft branding and going with ai_project and ai_hub noting that the underlying resource remains an ML instance in the documentation?

[stephybun]

@JonDunnDAFF we usually follow the brand/commercial name of the service or product, so in this case I think azurerm_ai_hub and azurerm_ai_project are the way to go. I don't think it's necessary for users to be aware of which underlying API the resources are using and in any case that information is easily looked up in the source code.

In case it's your first time adding new resources to the provider might I suggest looking through our contributor documentation and ensuring that the new resources added are using the Typed SDK.

[JonDunnDAFF]

Thanks @stephybun, I will have a crack at the problem based on your solution and following the documentation as described. I will close this Pull Request and create a new one once I have a working implementation of the new resources.