New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

`azurerm_search_service` - upgrade search service API to version `2023-11-01` and expose `semantic_search_sku` field #23698

Merged

WodansSon merged 4 commits into main from e_semantic_search

Oct 27, 2023

Collaborator

WodansSon commented Oct 26, 2023

No description provided.


          Initial Check-in...

3d7029a

WodansSon added enhancement documentation dependencies service/search labels

github-actions bot added the size/XL label

tombuildsstuff requested changes

View reviewed changes

Member

tombuildsstuff left a comment

Thanks for this PR - I've taken a look through and left a few comments inline, mostly to make use of the None pattern for this field - but if we can update this to account for that, then this otherwise LGTM 👍

Thanks!

internal/services/search/search_service_resource.go Outdated

Comment on lines 167 to 169

+              				Default:  services.SearchSemanticSearchDisabled,
+              				ValidateFunc: validation.StringInSlice([]string{
+              					string(services.SearchSemanticSearchDisabled),

Member

tombuildsstuff Oct 26, 2023

We should treat disabled as a None value - meaning we can remove this default and the possible value here:

Suggested change

      
            				Default:  services.SearchSemanticSearchDisabled,
          
            				ValidateFunc: validation.StringInSlice([]string{
          
            					string(services.SearchSemanticSearchDisabled),
          
            				ValidateFunc: validation.StringInSlice([]string{

In favour of this field being empty/unset when null

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

internal/services/search/search_service_resource.go Outdated

               		return fmt.Errorf("%q SKUs in %q mode can have a maximum of 3 partitions, got %d", string(services.SkuNameStandardThree), string(services.HostingModeHighDensity), partitionCount)
               	}
+              	// NOTE: Semantic Search SKU cannot be set if the SKU is 'free'
+              	if skuName == services.SkuNameFree && semanticSearchSku != string(services.SearchSemanticSearchDisabled) {
+              		return fmt.Errorf("'semantic_search_sku' can only be set to %q if the 'sku' field is set to %q, got %q", string(services.SearchSemanticSearchDisabled), string(services.SkuNameFree), semanticSearchSku)

Member

tombuildsstuff Oct 26, 2023

which allows this to become:

Suggested change

      
            		return fmt.Errorf("'semantic_search_sku' can only be set to %q if the 'sku' field is set to %q, got %q", string(services.SearchSemanticSearchDisabled), string(services.SkuNameFree), semanticSearchSku)
          
            		return fmt.Errorf("`semantic_search_sku` can only be specified when `sku` is not set to %q string(services.SkuNameFree)

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

internal/services/search/search_service_resource.go Outdated

               			DisableLocalAuth: pointer.To(!localAuthenticationEnabled),
               			PartitionCount:   pointer.To(partitionCount),
               			ReplicaCount:     pointer.To(replicaCount),
+              			SemanticSearch:   pointer.To(services.SearchSemanticSearch(semanticSearchSku)),

Member

tombuildsstuff Oct 26, 2023

in this case can we conditionally assign this field depending on whether it's != ""

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

internal/services/search/search_service_resource.go Outdated

               	cmkEnforcementEnabled := d.Get("customer_managed_key_enforcement_enabled").(bool)
               	localAuthenticationEnabled := d.Get("local_authentication_enabled").(bool)
               	authenticationFailureMode := d.Get("authentication_failure_mode").(string)
+              	semanticSearchSku := d.Get("semantic_search_sku").(string)

Member

tombuildsstuff Oct 26, 2023

Since this field is Optional, we can then default this here:

Suggested change

      
            	semanticSearchSku := d.Get("semantic_search_sku").(string)
          
            	semanticSearchSku := services.SearchSemanticSearchDisabled
          
            	if v := d.Get("semantic_search_sku").(string); v != "" {
          
            		semanticSearchSku = services.SearchSemanticSearch(v)
          
            	}

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

internal/services/search/search_service_resource.go Outdated

Comment on lines 456 to 463

+              		semanticSearchSku := d.Get("semantic_search_sku").(string)
+              		// NOTE: Semantic Search SKU cannot be set if the SKU is 'free'
+              		if pointer.From(model.Sku.Name) == services.SkuNameFree && semanticSearchSku != string(services.SearchSemanticSearchDisabled) {
+              			return fmt.Errorf("'semantic_search_sku' can only be set to %q if the 'sku' field is set to %q, got %q", string(services.SearchSemanticSearchDisabled), string(services.SkuNameFree), semanticSearchSku)
+              		}
+              		model.Properties.SemanticSearch = pointer.To(services.SearchSemanticSearch(semanticSearchSku))

Member

tombuildsstuff Oct 26, 2023

Which means this can become:

Suggested change

      
            		semanticSearchSku := d.Get("semantic_search_sku").(string)
          
            		// NOTE: Semantic Search SKU cannot be set if the SKU is 'free'
          
            		if pointer.From(model.Sku.Name) == services.SkuNameFree && semanticSearchSku != string(services.SearchSemanticSearchDisabled) {
          
            			return fmt.Errorf("'semantic_search_sku' can only be set to %q if the 'sku' field is set to %q, got %q", string(services.SearchSemanticSearchDisabled), string(services.SkuNameFree), semanticSearchSku)
          
            		}
          
            		model.Properties.SemanticSearch = pointer.To(services.SearchSemanticSearch(semanticSearchSku))
          
            		semanticSearchSku := services.SearchSemanticSearchDisabled
          
            		if v := d.Get("semantic_search_sku").(string); v != "" {
          
            			semanticSearchSku = services.SearchSemanticSearch(v)
          
            		}
          
            		// NOTE: Semantic Search SKU cannot be set if the SKU is 'free'
          
            		if pointer.From(model.Sku.Name) == services.SkuNameFree && semanticSearchSku != services.SearchSemanticSearchDisabled {
          
            			return fmt.Errorf("`semantic_search_sku` can only be specified when `sku` is not set to %q string(services.SkuNameFree)
          
            		}
          
            		model.Properties.SemanticSearch = pointer.To(semanticSearchSku)

To allow this property to be removed/marked as null in the configuration to remove this field

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

internal/services/search/search_service_resource.go Outdated

               		return fmt.Errorf("%q SKUs in %q mode can have a maximum of 3 partitions, got %d", string(services.SkuNameStandardThree), string(services.HostingModeHighDensity), partitionCount)
               	}
+              	// NOTE: Semantic Search SKU cannot be set if the SKU is 'free'
+              	if skuName == services.SkuNameFree && semanticSearchSku != string(services.SearchSemanticSearchDisabled) {

Member

tombuildsstuff Oct 26, 2023

which would mean we don't need to cast this one:

Suggested change

      
            	if skuName == services.SkuNameFree && semanticSearchSku != string(services.SearchSemanticSearchDisabled) {
          
            	if skuName == services.SkuNameFree && semanticSearchSku != services.SearchSemanticSearchDisabled {

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

internal/services/search/search_service_resource.go Outdated

Comment on lines 558 to 560

+              			if props.SemanticSearch != nil {
+              				semanticSearchSku = string(pointer.From(props.SemanticSearch))
+              			}

Member

tombuildsstuff Oct 26, 2023

to map the None behaviour this can become:

Suggested change

      
            			if props.SemanticSearch != nil {
          
            				semanticSearchSku = string(pointer.From(props.SemanticSearch))
          
            			}
          
            			semanticSearchSku := ""
          
            			if props.SemanticSearch != nil && pointer.From(props.SemanticSearch) != services.SearchSemanticSearchDisabled {
          
            				semanticSearchSku = string(pointer.From(props.SemanticSearch))
          
            			}

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

website/docs/r/search_service.html.markdown Outdated

		@@ -108,6 +108,10 @@ The following arguments are supported:

		* `replica_count` - (Optional) Specifies the number of Replica's which should be created for this Search Service. This field cannot be set when using a `free` sku ([see the Microsoft documentation](https://learn.microsoft.com/azure/search/search-sku-tier)).

		* `semantic_search_sku` - (Optional) The Semantic Search SKU which should be used for this Search Service. Possible values include `disabled`, `free` and `standard`. Defaults to `disabled`.

Member

tombuildsstuff Oct 26, 2023

Updated to remove the disabled value, but typically these are prefixed with Specifies:

Suggested change

      
            * `semantic_search_sku` - (Optional) The Semantic Search SKU which should be used for this Search Service. Possible values include `disabled`, `free` and `standard`. Defaults to `disabled`.
          
            * `semantic_search_sku` - (Optional) Specifies the Semantic Search SKU which should be used for this Search Service. Possible values include `free` and `standard`.

Collaborator Author

WodansSon Oct 26, 2023

Fixed.

github-actions bot added waiting-response and removed waiting-response labels

WodansSon added 3 commits

October 26, 2023 13:26


          Address PR comments...

ee393a5


          Alway pass default sematic value in create...

d51d2a6


          combining tests due to the quota of one 'free' sku

5fa2ed6

Collaborator Author

WodansSon commented Oct 26, 2023

katbyte approved these changes

View reviewed changes

Collaborator

katbyte left a comment

LGTM 🔎

WodansSon merged commit cd601ba into main

23 checks passed

WodansSon deleted the e_semantic_search branch

October 27, 2023 00:30

github-actions bot added this to the v3.78.0 milestone

WodansSon added a commit that referenced this pull request


          Updating to include #23698

bcbfa8f

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment