Fixed the issue that encryptionKey was lost during serialization (Azure#37410)

* To fix Azure#37251

* add test

* update

* update

* Update changelog

Author: xiangyan99

sdk/search/azure-search-documents/CHANGELOG.md

@@ -1,16 +1,15 @@
 # Release History
 
-## 11.6.0b5 (Unreleased)
+## 11.6.0b5 (2024-09-17)
 
 ### Features Added
 
 - `SearchIndexClient`.`get_search_client` inherits the API version.
 
-### Breaking Changes
-
 ### Bugs Fixed
 
 - Fixed the issue that we missed ODATA header when using Entra ID auth.
+- Fixed the issue that `encryptionKey` was lost during serialization.  #37251
 
 ### Other Changes
 
@@ -32,6 +31,80 @@
   - `azure.search.documents.indexes.models.VectorSearchProfile.vectorizer` -> `azure.search.documents.indexes.models.VectorSearchProfile.vectorizer_name`
   - `azure.search.documents.indexes.models.VectorSearchVectorizer.name` -> `azure.search.documents.indexes.models.VectorSearchVectorizer.vectorizer_name`
 
+## 11.5.1 (2024-07-30)
+
+### Other Changes
+
+- Improved type checks.
+
+## 11.5.0 (2024-07-16)
+
+### Breaking Changes
+
+> These changes do not impact the API of stable versions such as 11.4.0.
+> Only code written against a beta version such as 11.6.0b4 may be affected.
+- Below models are renamed
+  - `azure.search.documents.indexes.models.SearchIndexerIndexProjections` -> `azure.search.documents.indexes.models.SearchIndexerIndexProjection`
+  - `azure.search.documents.indexes.models.LineEnding` -> `azure.search.documents.indexes.models.OrcLineEnding`
+  - `azure.search.documents.indexes.models.ScalarQuantizationCompressionConfiguration` -> `azure.search.documents.indexes.models.ScalarQuantizationCompression`
+  - `azure.search.documents.indexes.models.VectorSearchCompressionConfiguration` -> `azure.search.documents.indexes.models.VectorSearchCompression`
+  - `azure.search.documents.indexes.models.VectorSearchCompressionTargetDataType` -> `azure.search.documents.indexes.models.VectorSearchCompressionTarget`
+
+- Below models do not exist in this release
+  - `azure.search.documents.models.QueryLanguage`
+  - `azure.search.documents.models.QuerySpellerType`
+  - `azure.search.documents.models.QueryDebugMode`
+  - `azure.search.documents.models.HybridCountAndFacetMode`
+  - `azure.search.documents.models.HybridSearch`
+  - `azure.search.documents.models.SearchScoreThreshold`
+  - `azure.search.documents.models.VectorSimilarityThreshold`
+  - `azure.search.documents.models.VectorThreshold`
+  - `azure.search.documents.models.VectorThresholdKind`
+  - `azure.search.documents.models.VectorizableImageBinaryQuery`
+  - `azure.search.documents.models.VectorizableImageUrlQuery`
+  - `azure.search.documents.indexes.models.SearchAlias`
+  - `azure.search.documents.indexes.models.AIServicesVisionParameters`
+  - `azure.search.documents.indexes.models.AIServicesVisionVectorizer`
+  - `azure.search.documents.indexes.models.AIStudioModelCatalogName`
+  - `azure.search.documents.indexes.models.AzureMachineLearningParameters`
+  - `azure.search.documents.indexes.models.AzureMachineLearningSkill`
+  - `azure.search.documents.indexes.models.AzureMachineLearningVectorizer`
+  - `azure.search.documents.indexes.models.CustomVectorizer`
+  - `azure.search.documents.indexes.models.CustomNormalizer`
+  - `azure.search.documents.indexes.models.DocumentKeysOrIds`
+  - `azure.search.documents.indexes.models.IndexingMode`
+  - `azure.search.documents.indexes.models.LexicalNormalizer`
+  - `azure.search.documents.indexes.models.LexicalNormalizerName`
+  - `azure.search.documents.indexes.models.NativeBlobSoftDeleteDeletionDetectionPolicy`
+  - `azure.search.documents.indexes.models.SearchIndexerCache`
+  - `azure.search.documents.indexes.models.SkillNames`
+  - `azure.search.documents.indexes.models.VisionVectorizeSkill`
+
+- SearchAlias operations do not exist in this release
+- `SearchIndexerClient.reset_documents` does not exist in this release
+- `SearchIndexerClient.reset_skills` does not exist in this release
+
+- Below properties do not exist
+  - `azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.identity`
+  - `azure.search.documents.indexes.models.SearchIndex.normalizers`
+  - `azure.search.documents.indexes.models.SearchField.normalizer_name`
+
+- Below parameters do not exist
+  - `SearchClient.search.debug`
+  - `SearchClient.search.hybrid_search`
+  - `SearchClient.search.query_language`
+  - `SearchClient.search.query_speller`
+  - `SearchClient.search.semantic_fields`
+  - `SearchIndexerClient.create_or_update_indexer.skip_indexer_reset_requirement_for_cache`
+  - `SearchIndexerClient.create_or_update_data_source_connection.skip_indexer_reset_requirement_for_cache`
+  - `SearchIndexerClient.create_or_update_skillset.skip_indexer_reset_requirement_for_cache`
+  - `SearchIndexerClient.create_or_update_indexer.disable_cache_reprocessing_change_detection`
+  - `SearchIndexerClient.create_or_update_skillset.disable_cache_reprocessing_change_detection`
+
+### Other Changes
+
+- Updated default API version to `2024-07-01`.
+
 ## 11.6.0b4 (2024-05-07)
 
 ### Features Added

sdk/search/azure-search-documents/azure/search/documents/indexes/models/_models.py

@@ -1121,7 +1121,9 @@ def _to_generated(self):
             data_change_detection_policy=self.data_change_detection_policy,
             data_deletion_detection_policy=self.data_deletion_detection_policy,
             e_tag=self.e_tag,
-            encryption_key=self.encryption_key,
+            encryption_key=(
+                self.encryption_key._to_generated() if self.encryption_key else None  # pylint: disable=protected-access
+            ),
             identity=self.identity,
         )
 
@@ -1141,7 +1143,13 @@ def _from_generated(cls, search_indexer_data_source) -> Optional[Self]:
             data_change_detection_policy=search_indexer_data_source.data_change_detection_policy,
             data_deletion_detection_policy=search_indexer_data_source.data_deletion_detection_policy,
             e_tag=search_indexer_data_source.e_tag,
-            encryption_key=search_indexer_data_source.encryption_key,
+            encryption_key=(
+                SearchResourceEncryptionKey._from_generated(  # pylint: disable=protected-access
+                    search_indexer_data_source.encryption_key
+                )
+                if search_indexer_data_source.encryption_key
+                else None
+            ),
             identity=search_indexer_data_source.identity,
         )
 

sdk/search/azure-search-documents/tests/test_models.py

@@ -0,0 +1,33 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+
+from azure.search.documents.indexes.models import (
+    SearchIndexerDataContainer,
+    SearchIndexerDataSourceConnection,
+    SearchResourceEncryptionKey,
+)
+
+
+def test_encryption_key_serialization():
+    from azure.search.documents.indexes._generated.models import (
+        SearchResourceEncryptionKey as SearchResourceEncryptionKeyGen,
+    )
+
+    container = SearchIndexerDataContainer(name="container_name")
+    encryption_key = SearchResourceEncryptionKey(
+        key_name="key",
+        key_version="key_version",
+        vault_uri="vault_uri",
+        application_id="application_id",
+    )
+    data_source_connection = SearchIndexerDataSourceConnection(
+        name="datasource-name",
+        type="azureblob",
+        connection_string="connection_string",
+        container=container,
+        encryption_key=encryption_key,
+    )
+    packed_data_source = data_source_connection._to_generated()
+    assert isinstance(packed_data_source.encryption_key, SearchResourceEncryptionKeyGen)