azurerm_cognitive_deployment - remove ForceNew tag for property 'capacity'

[liuwuliuyun]

Fixes #23226

Remove this forcenew tag since by testing this is not a force new property.

Testing evidence using AzAPI provider:

terraform {
  required_providers {
    azapi = {
      source = "azure/azapi"
    }
  }
}

provider "azapi" {
}

provider "azurerm" {
  features {}
}
resource "azurerm_resource_group" "example" {
  name     = "yunliutest2222"
  location = "eastus"
}

resource "azurerm_cognitive_account" "example" {
  name                = "yunliutest222"
  location            = azurerm_resource_group.example.location
  resource_group_name = azurerm_resource_group.example.name
  kind                = "OpenAI"
  sku_name            = "S0"
}

resource "azapi_resource" "example" {
  type      = "Microsoft.CognitiveServices/accounts/deployments@2023-05-01"
  name      = "testdeployment"
  parent_id = azurerm_cognitive_account.example.id

  body = jsonencode({
    sku = {
      name     = "Standard"
      capacity = 2 // Change from 1->2
    }
    properties = {

      model = {
        format  = "OpenAI"
        name    = "gpt-35-turbo"
        version = "0301"
      }
    }
  })
}

Output

PS C:\Users\yunliu1\Documents\terraformtest\cognitive> terraform apply -auto-approve
azurerm_resource_group.example: Refreshing state... [id=/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/yunliutest2222]
azurerm_cognitive_account.example: Refreshing state... [id=/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/yunliutest2222/providers/Microsoft.CognitiveServices/accounts/yunliutest222]
azapi_resource.example: Refreshing state... [id=/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/yunliutest2222/providers/Microsoft.CognitiveServices/accounts/yunliutest222/deployments/testdeployment]

Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
  ~ update in-place

Terraform will perform the following actions:

  # azapi_resource.example will be updated in-place
  ~ resource "azapi_resource" "example" {
      ~ body                      = jsonencode(
          ~ {
              ~ sku        = {
                  ~ capacity = 1 -> 2
                    name     = "Standard"
                }
                # (1 unchanged attribute hidden)
            }
        )
        id                        = "/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/yunliutest2222/providers/Microsoft.CognitiveServices/accounts/yunliutest222/deployments/testdeployment"
        name                      = "testdeployment"
      ~ output                    = jsonencode({}) -> (known after apply)
        tags                      = {}
        # (6 unchanged attributes hidden)
    }

Plan: 0 to add, 1 to change, 0 to destroy.
azapi_resource.example: Modifying... [id=/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/yunliutest2222/providers/Microsoft.CognitiveServices/accounts/yunliutest222/deployments/testdeployment]
azapi_resource.example: Modifications complete after 3s [id=/subscriptions/85b3dbca-5974-4067-9669-67a141095a76/resourceGroups/yunliutest2222/providers/Microsoft.CognitiveServices/accounts/yunliutest222/deployments/testdeployment]

Apply complete! Resources: 0 added, 1 changed, 0 destroyed.

[tombuildsstuff]

Could we add a test with a non OpenAI type to validate this works for other types of accounts too?

[liuwuliuyun]

Sure, I will test that today

[liuwuliuyun]

@tombuildsstuff I am not able to perform this test because in azurerm_cognitive_deployment, the only supported format is OpenAI and it does not make sense to create a cognitive account of other type with a deployment of openai format. Link to the defination of format https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/cognitive_deployment#format

[stephybun]

@liuwuliuyun we should still add an update test for this property with deployment type of OpenAI so that we can track if anything changes/regresses in the API.

[liuwuliuyun]

@stephybun Thanks for the review. Agreed on adding the testcase.

[liuwuliuyun]

• Add an update function to perform update
• Remove ForceNew tag in the scale block
• Remove ForceNew tag in the sku block (enabled in 4.0 version, calling the same api here)
• Add an update test case

Testing Evidence:

GOROOT=C:\Program Files\Go #gosetup
GOPATH=C:\Users\yunliu1\go #gosetup
"C:\Program Files\Go\bin\go.exe" test -c -o C:\Users\yunliu1\AppData\Local\JetBrains\GoLand2023.2\tmp\GoLand\___TestAccCognitiveDeploymentSequential_in_github_com_hashicorp_terraform_provider_azurerm_internal_services_cognitive.test.exe github.com/hashicorp/terraform-provider-azurerm/internal/services/cognitive #gosetup
"C:\Program Files\Go\bin\go.exe" tool test2json -t C:\Users\yunliu1\AppData\Local\JetBrains\GoLand2023.2\tmp\GoLand\___TestAccCognitiveDeploymentSequential_in_github_com_hashicorp_terraform_provider_azurerm_internal_services_cognitive.test.exe -test.v -test.paniconexit0 -test.run ^\QTestAccCognitiveDeploymentSequential\E$ #gosetup
=== RUN   TestAccCognitiveDeploymentSequential
--- PASS: TestAccCognitiveDeploymentSequential (994.08s)
=== RUN   TestAccCognitiveDeploymentSequential/deployment
    --- PASS: TestAccCognitiveDeploymentSequential/deployment (994.08s)
=== RUN   TestAccCognitiveDeploymentSequential/deployment/update
        --- PASS: TestAccCognitiveDeploymentSequential/deployment/update (277.42s)
=== RUN   TestAccCognitiveDeploymentSequential/deployment/basic
        --- PASS: TestAccCognitiveDeploymentSequential/deployment/basic (235.65s)
=== RUN   TestAccCognitiveDeploymentSequential/deployment/requiresImport
        --- PASS: TestAccCognitiveDeploymentSequential/deployment/requiresImport (239.89s)
=== RUN   TestAccCognitiveDeploymentSequential/deployment/complete
        --- PASS: TestAccCognitiveDeploymentSequential/deployment/complete (241.12s)
PASS


Process finished with the exit code 0

BTW, tc server tests failures are due to the lack of permission to create OpenAI deployments. Let me know if you have futher questions.

[stephybun]

Thanks @liuwuliuyun LGTM 👍

[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.