Azure Cognitive Search: SearchResourceEncryptionKey raises 'not iterable' error during data source connection

TL;DR

Issue Azure/azure-sdk-for-python#37251 (closed, 22 comments): - Package Name: azure.search.documents - Package Version: 11.6.0b4 - Operating System: OSX, version: 14.6.1 - Python Version: 3.9.6 Describe the bug When attempting to use the azure-search-documents SDK, the encryption key provided is not accepted due to a type mismatch.

Steps

1. Issue Azure/azure-sdk-for-python#37251 (closed, 22 comments): - Package Name: azure.search.documents - Package Version: 11.6.0b4 - Operating System: OSX, version: 14.6.1 - Python Version: 3.9.6 Describe the bug When attempting to use the azure-search-documents SDK, the encryption key provided is not accepted due to a type mismatch. The SDK does not handle the type correctly, leading to a failure during deserialization when creating the data source connection. As according to the Microsoft documentation, SearchResourceEncryptionKey object is passed, but an error arises, where an iterable type is expected for encryption key.
2. This was a bug in azure-search-documents 11.6.0b4: SearchResourceEncryptionKey raised a 'not iterable' error when creating a data source connection because the SDK mishandled the encryption key type. Fix: upgrade azure-search-documents to 11.6.0b5 (shipped 2024-09-19), the reporter confirmed the issue resolved on the new pre-release. If you see type errors around SearchResourceEncryptionKey, check your package version first.

When to use

You are seeing this: The SDK does not handle the type correctly, leading to a failure during deserialization when creating the data source connection. Use this skill when you run into "Azure Cognitive Search: SearchResourceEncryptionKey raises 'not iterable' error during data source connection".

When not to use

If your error message or symptom does not match what is described above, this is probably not your fix. Search for your exact error text instead of forcing this one to fit.

Versions

Versions mentioned in the source: 11.6, 14.6.1, 3.9.6. If you are on something much newer or older, the details may have shifted.

Why this happens

Version: 14.6.1 - Python Version: 3.9.6 Describe the bug When attempting to use the azure-search-documents SDK, the encryption key provided is not accepted due to a type mismatch.

In gh:Azure/azure-sdk-for-python#37251 (Azure AI Search), the issue reported was: Issue Azure/azure-sdk-for-python#37251 (closed, 22 comments): - Package Name: azure.search.documents - Package Version: 11.6.0b4 - Operating System: OSX, version: 14.6.1 - Python Version: 3.9.6 Describe the bug When attempting to use the azure-search-documents SDK, the encryption key provided is not accepted due to a type mismatch. The SDK does not handle the type correctly, leading to a failure during deserialization when creating the data source connection. As according to the Microsoft documentation, SearchResourceEncryptionKey object is passed, but an error arises, where an iterable type is expected for encryption key. The verified resolution from the thread: This was a bug in azure-search-documents 11.6.0b4: SearchResourceEncryptionKey raised a 'not iterable' error when creating a data source connection because the SDK mishandled the encryption key type. Fix: upgrade azure-search-documents to 11.6.0b5 (shipped 2024-09-19), the reporter confirmed the issue resolved on the new pre-release. If you see type errors around SearchResourceEncryptionKey, check your package version first. Source: mount the host path https at container path //github.com/Azure/azure-sdk-for-python/issues/37251