New Resource: `azurerm_cognitive_account_rai_policy` #28013

liuwuliuyun · 2024-11-14T06:38:08Z

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

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.

Adding a new resource in Cognitive RP - azurerm_cognitive_account_rai_policy.

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)

Note that the custom block list hasn't been integrated into the AzureRM provider yet, but it's possible to implement it using the AzAPI provider for the time being. I plan to incorporate it into the complete test case as soon as the azurerm_cognitive_account_custom_blocklist resource is added in the provider.

Change Log

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

New Resource: azurerm_cognitive_account_rai_policy [New Resource: azurerm_cognitive_account_rai_policy #28013]

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

katbyte

LGTM 🚜

internal/services/cognitive/client/client.go

internal/services/cognitive/cognitive_account_rai_policy_resource.go

stephybun · 2024-12-04T10:36:13Z

internal/services/cognitive/cognitive_account_rai_policy_resource_test.go

+  sku_name            = "S0"
+}
+
+resource "azurerm_cognitive_account_rai_policy" "test" {


custom_blocklist is missing here?

The custom blocklist resource is currently not supported in AzureRM. Here is a PR to add support for this resource. I will also update the test case to include the custom blocklist resource in a seperate PR once that PR got merged. This property is included here because it can be created and used with the AzAPI provider. Per that PR's discussion, should we change this property to the id of custom blocklist?

The order in which these resources have been added is backwards then since properties that accept other resources as input should be referred to by their IDs instead of a name string.

stephybun · 2024-12-04T10:36:33Z

internal/services/cognitive/cognitive_account_rai_policy_resource_test.go

There's no update test here?

Because all the changable property are already tested in the complete test case. Also followed guidance. I will add a update test case here using complete template to update. In this case, the complete test case is no longer needed right?

Thanks for linking the guidance @liuwuliuyun. The acceptance test section of that guide is updated, I submitted a PR to update it #28241

stephybun · 2024-12-04T10:36:53Z

internal/services/cognitive/registration.go

@@ -56,5 +56,6 @@ func (r Registration) Resources() []sdk.Resource {
 	return []sdk.Resource{
 		AzureAIServicesResource{},
 		CognitiveDeploymentResource{},
+		CognitiveAccountRaiPolicyResource{},


Alphabetical ordering, please move this to line 58

stephybun · 2024-12-04T10:38:52Z

website/docs/r/cognitive_account_rai_policy.html.markdown

+
+* `id` - The ID of the Cognitive Service Account RAI Policy.
+
+* `type` - The type of the Cognitive Service Account RAI Policy. Possible values are `SystemManaged` or `UserManaged`.


Suggested change

* `type` - The type of the Cognitive Service Account RAI Policy. Possible values are `SystemManaged` or `UserManaged`.

Will remove this

stephybun · 2024-12-04T10:39:14Z

website/docs/r/cognitive_account_rai_policy.html.markdown

+* `create` - (Defaults to 30 minutes) Used when creating the Cognitive Service Account.
+* `update` - (Defaults to 30 minutes) Used when updating the Cognitive Service Account.
+* `read` - (Defaults to 5 minutes) Used when retrieving the Cognitive Service Account.
+* `delete` - (Defaults to 30 minutes) Used when deleting the Cognitive Service Account.


Suggested change

* `create` - (Defaults to 30 minutes) Used when creating the Cognitive Service Account.

* `update` - (Defaults to 30 minutes) Used when updating the Cognitive Service Account.

* `read` - (Defaults to 5 minutes) Used when retrieving the Cognitive Service Account.

* `delete` - (Defaults to 30 minutes) Used when deleting the Cognitive Service Account.

* `create` - (Defaults to 30 minutes) Used when creating the Cognitive Service Account RAI Policy.

* `update` - (Defaults to 30 minutes) Used when updating the Cognitive Service Account RAI Policy.

* `read` - (Defaults to 5 minutes) Used when retrieving the Cognitive Service Account RAI Policy.

* `delete` - (Defaults to 30 minutes) Used when deleting the Cognitive Service Account RAI Policy.

Will change

Co-authored-by: stephybun <[email protected]>

liuwuliuyun · 2024-12-10T07:13:29Z

Rerun all tests:

…ggested

stephybun · 2024-12-11T12:31:47Z

Dependent on #28043 going in first so custom_blocklist can be tested.

stephybun · 2024-12-12T09:55:41Z

@liuwuliuyun #28043 has gone in, can you please rebase and update your test case to include custom_blocklist?

# Conflicts: # internal/services/cognitive/client/client.go # vendor/modules.txt

liuwuliuyun · 2024-12-13T02:50:45Z

I have identified a design issue when including the custom_blocklist.

Whether we use an ID or name, such as when the user sets rai_blocklist_id = azurerm_cognitive_account_rai_blocklist.test.id in azurerm_cognitive_account_rai_policy.test, it creates a dependency from azurerm_cognitive_account_rai_policy.test to azurerm_cognitive_account_rai_blocklist.test.

This dependency causes Terraform to wait for azurerm_cognitive_account_rai_blocklist.test to finish deleting before deleting azurerm_cognitive_account_rai_policy.test. However, this sequence is not allowed by the API and results in an error: Please remove references for rai_blocklist then delete it.

Additionally, manually adding depends_on = [azurerm_cognitive_account_rai_policy.test] in the resource azurerm_cognitive_account_rai_blocklist.test creates a circular dependency.

@stephybun, do you have any suggestions on how to resolve this?

liuwuliuyun · 2024-12-17T05:18:26Z

To address the issue I mentioned, I have removed the custom_blocklist for this resource and intend to create a new resource azurerm_cognitive_account_rai_policy_custom_blocklist_association to handle this special case. @stephybun What do you think?

catriona-m · 2025-01-16T17:39:38Z

To address the issue I mentioned, I have removed the custom_blocklist for this resource and intend to create a new resource azurerm_cognitive_account_rai_policy_custom_blocklist_association to handle this special case. @stephybun What do you think?

Hi @liuwuliuyun - after discussion with the rest of the team, we think your suggested approach should work here. Are there any more changes required on this PR for this to work or is this ready to be re-reviewed?

liuwuliuyun · 2025-01-22T06:42:20Z

To address the issue I mentioned, I have removed the custom_blocklist for this resource and intend to create a new resource azurerm_cognitive_account_rai_policy_custom_blocklist_association to handle this special case. @stephybun What do you think?

Hi @liuwuliuyun - after discussion with the rest of the team, we think your suggested approach should work here. Are there any more changes required on this PR for this to work or is this ready to be re-reviewed?

No more changes if you could agree on this approach, thanks.

catriona-m

Thanks @liuwuliuyun LGTM!

comments addressed

* Update for #27950 * Update for #27824 * Update for #28592 #28583 #28599 #28590 #28453 * Update #28528 * Update for #27853 * Update CHANGELOG.md #28221 * Update for #27760 * Update CHANGELOG.md #28480 * Update CHANGELOG.md typo * Update CHANGELOG.md #28372 * Update CHANGELOG.md for #26047 also alphabetised ENHANCEMENTS * Update for #28146 * Update CHANGELOG.md #28013 * Update CHANGELOG.md for #28492 * Update CHANGELOG.md for #28648 * Update CHANGELOG.md for #28549 * Update for #28469 #28620 * prep for release * i touched it last --------- Co-authored-by: catriona-m <[email protected]> Co-authored-by: jackofallops <[email protected]> Co-authored-by: sreallymatt <[email protected]> Co-authored-by: Matthew Frahry <[email protected]> Co-authored-by: jackofallops <[email protected]>

Add new resource azurerm_cognitive_account_rai_policy

6b6730b

github-actions bot added documentation dependencies service/cognitive-services size/XL waiting-response labels Nov 14, 2024

liuwuliuyun marked this pull request as ready for review November 14, 2024 06:39

liuwuliuyun requested review from katbyte and a team as code owners November 14, 2024 06:39

liuwuliuyun marked this pull request as draft November 14, 2024 06:50

Optimize code and dependancies for RAI policy

87122c5

github-actions bot added waiting-response and removed waiting-response labels Nov 14, 2024

Resolve golint issues by pre-allocation

536d670

github-actions bot removed the waiting-response label Nov 14, 2024

liuwuliuyun marked this pull request as ready for review November 14, 2024 10:13

rcskosir added the new-resource label Nov 14, 2024

liuwuliuyun mentioned this pull request Nov 15, 2024

New Resource: azurerm_cognitive_rai_policy - Azure OpenAI Content Filters #28024

Closed

13 tasks

katbyte previously approved these changes Dec 4, 2024

View reviewed changes

stephybun previously requested changes Dec 4, 2024

View reviewed changes

github-actions bot added the waiting-response label Dec 4, 2024

stephybun mentioned this pull request Dec 9, 2024

New Resource: azurerm_cognitive_rai_blocklist #28043

Merged

14 tasks

Apply suggestions from code review

91404ee

Co-authored-by: stephybun <[email protected]>

liuwuliuyun dismissed katbyte’s stale review via 91404ee December 10, 2024 02:39

github-actions bot added waiting-response and removed waiting-response labels Dec 10, 2024

Update according to review comment.

cace0c9

github-actions bot removed the waiting-response label Dec 10, 2024

liuwuliuyun requested a review from stephybun December 10, 2024 07:14

liuwuliuyun added 2 commits December 11, 2024 13:36

Change custom_blocklist.name to custom_blocklist.id

8913a7a

Rename custom_blocklist.id to custom_blocklist.rai_blocklist_id as su…

c18d7cc

…ggested

github-actions bot added the waiting-response label Dec 11, 2024

Merge branch 'main' into cog-rai-policy

143cc86

# Conflicts: # internal/services/cognitive/client/client.go # vendor/modules.txt

github-actions bot removed the waiting-response label Dec 13, 2024

Remove custom_blocklist from the RAI Policy resource

1629e59

github-actions bot added the waiting-response label Dec 17, 2024

github-actions bot added waiting-response and removed waiting-response labels Dec 17, 2024

Resolve lint issue

6dbb70f

github-actions bot removed the waiting-response label Dec 17, 2024

katbyte added the waiting-response label Jan 20, 2025

github-actions bot removed the waiting-response label Jan 22, 2025

catriona-m approved these changes Jan 30, 2025

View reviewed changes

catriona-m merged commit 9375225 into hashicorp:main Jan 30, 2025
33 checks passed

github-actions bot added this to the v4.17.0 milestone Jan 30, 2025

catriona-m added a commit that referenced this pull request Jan 30, 2025

Update CHANGELOG.md #28013

35fdb97

davidjbng mentioned this pull request Jan 31, 2025

Resource azurerm_cognitive_account_rai_policy requires severity_threshold where does not have an effect #28653

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Resource: `azurerm_cognitive_account_rai_policy` #28013

New Resource: `azurerm_cognitive_account_rai_policy` #28013

liuwuliuyun commented Nov 14, 2024 •

edited

Loading

katbyte left a comment

stephybun Dec 4, 2024

liuwuliuyun Dec 10, 2024 •

edited

Loading

stephybun Dec 10, 2024

stephybun Dec 4, 2024

liuwuliuyun Dec 10, 2024 •

edited

Loading

stephybun Dec 11, 2024

stephybun Dec 4, 2024

liuwuliuyun Dec 10, 2024

stephybun Dec 4, 2024

liuwuliuyun Dec 10, 2024

stephybun Dec 4, 2024

liuwuliuyun Dec 10, 2024

liuwuliuyun commented Dec 10, 2024

stephybun commented Dec 11, 2024

stephybun commented Dec 12, 2024

liuwuliuyun commented Dec 13, 2024

liuwuliuyun commented Dec 17, 2024

catriona-m commented Jan 16, 2025

liuwuliuyun commented Jan 22, 2025

catriona-m left a comment


		* `id` - The ID of the Cognitive Service Account RAI Policy.

		* `type` - The type of the Cognitive Service Account RAI Policy. Possible values are `SystemManaged` or `UserManaged`.

New Resource: azurerm_cognitive_account_rai_policy #28013

New Resource: azurerm_cognitive_account_rai_policy #28013

Conversation

liuwuliuyun commented Nov 14, 2024 • edited Loading

Community Note

Description

PR Checklist

Testing

Change Log

Related Issue(s)

katbyte left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

liuwuliuyun Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

liuwuliuyun Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

liuwuliuyun commented Dec 10, 2024

stephybun commented Dec 11, 2024

stephybun commented Dec 12, 2024

liuwuliuyun commented Dec 13, 2024

liuwuliuyun commented Dec 17, 2024

catriona-m commented Jan 16, 2025

liuwuliuyun commented Jan 22, 2025

catriona-m left a comment

Choose a reason for hiding this comment

New Resource: `azurerm_cognitive_account_rai_policy` #28013

New Resource: `azurerm_cognitive_account_rai_policy` #28013

liuwuliuyun commented Nov 14, 2024 •

edited

Loading

liuwuliuyun Dec 10, 2024 •

edited

Loading

liuwuliuyun Dec 10, 2024 •

edited

Loading