Update the Cognitive SDK to use API Version 2024-10-01 from `2023-0…

…5-01` (#27851) * Update SDK version for Cognitive RP * Setting access keys only when localAuth is enabled to resolve accTests failure * Add notification on attributes and align changes in datasource * Add notification on attributes and align changes in datasource * Update website/docs/d/cognitive_account.html.markdown Co-authored-by: stephybun <[email protected]> * Update website/docs/r/ai_services.html.markdown Co-authored-by: stephybun <[email protected]> * Update website/docs/r/cognitive_account.html.markdown Co-authored-by: stephybun <[email protected]> --------- Co-authored-by: stephybun <[email protected]>
hashicorp · Nov 8, 2024 · 5bcbf40 · 5bcbf40
1 parent 45d09f1
commit 5bcbf40
Show file tree

Hide file tree

Showing 120 changed files with 613 additions and 96 deletions.
diff --git a/internal/services/bot/bot_channel_direct_line_speech_resource.go b/internal/services/bot/bot_channel_direct_line_speech_resource.go
@@ -11,7 +11,7 @@ import (
 	"github.com/hashicorp/go-azure-helpers/lang/response"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/hashicorp/terraform-provider-azurerm/helpers/azure"
 	"github.com/hashicorp/terraform-provider-azurerm/helpers/tf"

diff --git a/internal/services/cognitive/ai_services_resource.go b/internal/services/cognitive/ai_services_resource.go
@@ -15,7 +15,7 @@ import (
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/identity"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	"github.com/hashicorp/go-azure-sdk/sdk/environments"
 	"github.com/hashicorp/terraform-provider-azurerm/helpers/tf"
 	commonValidate "github.com/hashicorp/terraform-provider-azurerm/helpers/validate"
@@ -389,16 +389,6 @@ func (AzureAIServicesResource) Read() sdk.ResourceFunc {
 				return fmt.Errorf("retrieving %s: %+v", *id, err)
 			}
 
-			keys, err := client.AccountsListKeys(ctx, *id)
-			if err != nil {
-				return fmt.Errorf("listing the Keys for %s: %+v", id, err)
-			}
-
-			if model := keys.Model; model != nil {
-				state.PrimaryAccessKey = pointer.From(model.Key1)
-				state.SecondaryAccessKey = pointer.From(model.Key2)
-			}
-
 			state.Name = id.AccountName
 			state.ResourceGroupName = id.ResourceGroupName
 
@@ -427,6 +417,18 @@ func (AzureAIServicesResource) Read() sdk.ResourceFunc {
 					if props.DisableLocalAuth != nil {
 						localAuthEnabled = !*props.DisableLocalAuth
 					}
+
+					if localAuthEnabled {
+						keys, err := client.AccountsListKeys(ctx, *id)
+						if err != nil {
+							return fmt.Errorf("listing the Keys for %s: %+v", id, err)
+						}
+
+						if model := keys.Model; model != nil {
+							state.PrimaryAccessKey = pointer.From(model.Key1)
+							state.SecondaryAccessKey = pointer.From(model.Key2)
+						}
+					}
 					state.LocalAuthorizationEnabled = localAuthEnabled
 
 					customerManagedKey, err := flattenAzureAIServicesCustomerManagedKey(props.Encryption, env)

diff --git a/internal/services/cognitive/ai_services_resource_test.go b/internal/services/cognitive/ai_services_resource_test.go
@@ -10,7 +10,7 @@ import (
 	"testing"
 
 	"github.com/hashicorp/go-azure-helpers/lang/pointer"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/clients"
@@ -66,8 +66,6 @@ func TestAccCognitiveAzureAIServices_complete(t *testing.T) {
 				check.That(data.ResourceName).ExistsInAzure(r),
 				check.That(data.ResourceName).Key("tags.%").HasValue("1"),
 				check.That(data.ResourceName).Key("tags.Acceptance").HasValue("Test"),
-				check.That(data.ResourceName).Key("primary_access_key").Exists(),
-				check.That(data.ResourceName).Key("secondary_access_key").Exists(),
 			),
 		},
 		data.ImportStep(),
@@ -94,8 +92,6 @@ func TestAccCognitiveAzureAIServices_update(t *testing.T) {
 				check.That(data.ResourceName).ExistsInAzure(r),
 				check.That(data.ResourceName).Key("tags.%").HasValue("1"),
 				check.That(data.ResourceName).Key("tags.Acceptance").HasValue("Test"),
-				check.That(data.ResourceName).Key("primary_access_key").Exists(),
-				check.That(data.ResourceName).Key("secondary_access_key").Exists(),
 			),
 		},
 	})

diff --git a/internal/services/cognitive/client/client.go b/internal/services/cognitive/client/client.go
@@ -6,8 +6,8 @@ package client
 import (
 	"fmt"
 
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/deployments"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/deployments"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/common"
 )
 

diff --git a/internal/services/cognitive/cognitive_account_customer_managed_key_resource.go b/internal/services/cognitive/cognitive_account_customer_managed_key_resource.go
@@ -8,7 +8,7 @@ import (
 	"time"
 
 	"github.com/hashicorp/go-azure-helpers/lang/pointer"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	"github.com/hashicorp/terraform-provider-azurerm/helpers/tf"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/clients"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/locks"

diff --git a/internal/services/cognitive/cognitive_account_customer_managed_key_resource_test.go b/internal/services/cognitive/cognitive_account_customer_managed_key_resource_test.go
@@ -8,7 +8,7 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/clients"

diff --git a/internal/services/cognitive/cognitive_account_data_source.go b/internal/services/cognitive/cognitive_account_data_source.go
@@ -12,7 +12,7 @@ import (
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/identity"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/tags"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/clients"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/timeouts"
@@ -36,6 +36,11 @@ func dataSourceCognitiveAccount() *pluginsdk.Resource {
 
 			"location": commonschema.LocationComputed(),
 
+			"local_auth_enabled": {
+				Type:     pluginsdk.TypeBool,
+				Computed: true,
+			},
+
 			"kind": {
 				Type:     pluginsdk.TypeString,
 				Computed: true,
@@ -90,19 +95,8 @@ func dataSourceCognitiveAccountRead(d *pluginsdk.ResourceData, meta interface{})
 		return fmt.Errorf("retrieving %s: %+v", id, err)
 	}
 
-	keys, err := client.AccountsListKeys(ctx, id)
-	if err != nil {
-		// TODO: gracefully fail here
-		return fmt.Errorf("retrieving Keys for %s: %+v", id, err)
-	}
-
 	d.SetId(id.ID())
 
-	if model := keys.Model; model != nil {
-		d.Set("primary_access_key", model.Key1)
-		d.Set("secondary_access_key", model.Key2)
-	}
-
 	if model := resp.Model; model != nil {
 		d.Set("location", location.NormalizeNilable(model.Location))
 		d.Set("kind", model.Kind)
@@ -115,6 +109,25 @@ func dataSourceCognitiveAccountRead(d *pluginsdk.ResourceData, meta interface{})
 				d.Set("qna_runtime_endpoint", apiProps.QnaRuntimeEndpoint)
 			}
 			d.Set("endpoint", props.Endpoint)
+
+			localAuthEnabled := true
+			if props.DisableLocalAuth != nil {
+				localAuthEnabled = !*props.DisableLocalAuth
+			}
+			d.Set("local_auth_enabled", localAuthEnabled)
+
+			if localAuthEnabled {
+				keys, err := client.AccountsListKeys(ctx, id)
+				if err != nil {
+					// note for the resource we shouldn't gracefully fail since we have permission to CRUD it
+					return fmt.Errorf("listing the Keys for %s: %+v", id, err)
+				}
+
+				if model := keys.Model; model != nil {
+					d.Set("primary_access_key", model.Key1)
+					d.Set("secondary_access_key", model.Key2)
+				}
+			}
 		}
 
 		flattenedIdentity, err := identity.FlattenSystemAndUserAssignedMap(model.Identity)

diff --git a/internal/services/cognitive/cognitive_account_data_source_test.go b/internal/services/cognitive/cognitive_account_data_source_test.go
@@ -23,6 +23,7 @@ func TestAccCognitiveAccountDataSource_basic(t *testing.T) {
 			Check: acceptance.ComposeTestCheckFunc(
 				check.That(data.ResourceName).Key("kind").HasValue("Face"),
 				check.That(data.ResourceName).Key("tags.%").HasValue("1"),
+				check.That(data.ResourceName).Key("local_auth_enabled").HasValue("true"),
 				check.That(data.ResourceName).Key("primary_access_key").Exists(),
 				check.That(data.ResourceName).Key("secondary_access_key").Exists(),
 			),
@@ -40,6 +41,7 @@ func TestAccCognitiveAccountDataSource_identity(t *testing.T) {
 			Check: acceptance.ComposeTestCheckFunc(
 				check.That(data.ResourceName).Key("kind").HasValue("Face"),
 				check.That(data.ResourceName).Key("tags.%").HasValue("1"),
+				check.That(data.ResourceName).Key("local_auth_enabled").HasValue("true"),
 				check.That(data.ResourceName).Key("primary_access_key").Exists(),
 				check.That(data.ResourceName).Key("secondary_access_key").Exists(),
 				check.That(data.ResourceName).Key("identity.0.principal_id").Exists(),

diff --git a/internal/services/cognitive/cognitive_account_resource.go b/internal/services/cognitive/cognitive_account_resource.go
@@ -15,7 +15,7 @@ import (
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/identity"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
 	"github.com/hashicorp/go-azure-helpers/resourcemanager/tags"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	search "github.com/hashicorp/go-azure-sdk/resource-manager/search/2022-09-01/services"
 	"github.com/hashicorp/terraform-provider-azurerm/helpers/azure"
 	"github.com/hashicorp/terraform-provider-azurerm/helpers/tf"
@@ -518,17 +518,6 @@ func resourceCognitiveAccountRead(d *pluginsdk.ResourceData, meta interface{}) e
 		return fmt.Errorf("retrieving %s: %+v", *id, err)
 	}
 
-	keys, err := client.AccountsListKeys(ctx, *id)
-	if err != nil {
-		// note for the resource we shouldn't gracefully fail since we have permission to CRUD it
-		return fmt.Errorf("listing the Keys for %s: %+v", *id, err)
-	}
-
-	if model := keys.Model; model != nil {
-		d.Set("primary_access_key", model.Key1)
-		d.Set("secondary_access_key", model.Key2)
-	}
-
 	d.Set("name", id.AccountName)
 	d.Set("resource_group_name", id.ResourceGroupName)
 
@@ -591,6 +580,19 @@ func resourceCognitiveAccountRead(d *pluginsdk.ResourceData, meta interface{}) e
 			}
 			d.Set("local_auth_enabled", localAuthEnabled)
 
+			if localAuthEnabled {
+				keys, err := client.AccountsListKeys(ctx, *id)
+				if err != nil {
+					// note for the resource we shouldn't gracefully fail since we have permission to CRUD it
+					return fmt.Errorf("listing the Keys for %s: %+v", *id, err)
+				}
+
+				if model := keys.Model; model != nil {
+					d.Set("primary_access_key", model.Key1)
+					d.Set("secondary_access_key", model.Key2)
+				}
+			}
+
 			customerManagedKey, err := flattenCognitiveAccountCustomerManagedKey(props.Encryption)
 			if err != nil {
 				return err

diff --git a/internal/services/cognitive/cognitive_account_resource_test.go b/internal/services/cognitive/cognitive_account_resource_test.go
@@ -9,7 +9,7 @@ import (
 	"regexp"
 	"testing"
 
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/clients"
@@ -133,8 +133,6 @@ func TestAccCognitiveAccount_complete(t *testing.T) {
 				check.That(data.ResourceName).Key("kind").HasValue("Face"),
 				check.That(data.ResourceName).Key("tags.%").HasValue("1"),
 				check.That(data.ResourceName).Key("tags.Acceptance").HasValue("Test"),
-				check.That(data.ResourceName).Key("primary_access_key").Exists(),
-				check.That(data.ResourceName).Key("secondary_access_key").Exists(),
 			),
 		},
 		data.ImportStep(),
@@ -163,8 +161,6 @@ func TestAccCognitiveAccount_update(t *testing.T) {
 				check.That(data.ResourceName).Key("kind").HasValue("Face"),
 				check.That(data.ResourceName).Key("tags.%").HasValue("1"),
 				check.That(data.ResourceName).Key("tags.Acceptance").HasValue("Test"),
-				check.That(data.ResourceName).Key("primary_access_key").Exists(),
-				check.That(data.ResourceName).Key("secondary_access_key").Exists(),
 			),
 		},
 	})

diff --git a/internal/services/cognitive/cognitive_deployment_resource.go b/internal/services/cognitive/cognitive_deployment_resource.go
@@ -10,8 +10,8 @@ import (
 
 	"github.com/hashicorp/go-azure-helpers/lang/pointer"
 	"github.com/hashicorp/go-azure-helpers/lang/response"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/deployments"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/cognitiveservicesaccounts"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/deployments"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/locks"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"

diff --git a/internal/services/cognitive/cognitive_deployment_resource_test.go b/internal/services/cognitive/cognitive_deployment_resource_test.go
@@ -9,7 +9,7 @@ import (
 	"testing"
 
 	"github.com/hashicorp/go-azure-helpers/lang/response"
-	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2023-05-01/deployments"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/cognitive/2024-10-01/deployments"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/acceptance/check"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/clients"

diff --git a/...k/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts/model_capacityconfig.go b/...k/resource-manager/cognitive/2023-05-01/cognitiveservicesaccounts/model_capacityconfig.go
diff --git a/...azure-sdk/resource-manager/cognitive/2023-05-01/deployments/model_deploymentproperties.go b/...azure-sdk/resource-manager/cognitive/2023-05-01/deployments/model_deploymentproperties.go
diff --git a/...05-01/cognitiveservicesaccounts/README.md → ...10-01/cognitiveservicesaccounts/README.md b/...05-01/cognitiveservicesaccounts/README.md → ...10-01/cognitiveservicesaccounts/README.md
diff --git a/...05-01/cognitiveservicesaccounts/client.go → ...10-01/cognitiveservicesaccounts/client.go b/...05-01/cognitiveservicesaccounts/client.go → ...10-01/cognitiveservicesaccounts/client.go