How to Configure a Proxy for Azure SearchClient in Python?

Question

I'm working within a corporate network that uses a proxy server, and I'm trying to connect to Azure Cognitive Search using the SearchClient from the azure-search-documents SDK in Python. I've been struggling to configure the client to route requests through our proxy.

I tried importing RequestsTransport to set up a custom transport layer:

from azure.core.pipeline.transport import RequestsTransport

proxy_settings = {...}

transport = RequestsTransport(proxies=proxy_settings)

search_client = SearchClient(
    endpoint=endpoint,
    index_name=index_name,
    credential=AzureKeyCredential(api_key),
    transport=transport
)

But the import of RequestTransport is not found.

1. How can I properly configure the SearchClient to use a proxy in a corporate network?
2. Why am I unable to import RequestsTransport from azure.core.pipeline.transport?
3. Is there a recommended way to set up the SearchClient with proxy settings and handle SSL verification within a proxy environment?

Any help would be greatly appreciated!

Answer 1

@Brünning, Georg To configure the SearchClient to use a proxy in a corporate network, you can use the AiohttpTransport class from the azure.core.pipeline.transport module instead of RequestsTransport. Here's an example of how to set up the SearchClient with proxy settings and handle SSL verification within a proxy environment:

from azure.core.pipeline.transport import AiohttpTransport
from azure.search.documents import SearchClient
from azure.core.credentials import AzureKeyCredential

proxy_settings = {
    "http": "http://<proxy_host>:<proxy_port>",
    "https": "https://<proxy_host>:<proxy_port>"
}

transport = AiohttpTransport(
    proxies=proxy_settings,
    ssl_verification=True
)

search_client = SearchClient(
    endpoint=endpoint,
    index_name=index_name,
    credential=AzureKeyCredential(api_key),
    transport=transport
)

In this example, replace <proxy_host> and <proxy_port> with the hostname and port number of your proxy server. The ssl_verification parameter is set to True to enable SSL verification within the proxy environment.

Regarding your question about why you are unable to import RequestsTransport, it's because RequestsTransport is not included in the azure.core.pipeline.transport module. Instead, you can use AiohttpTransport as shown in the example above

Answer 2

I also encountered this issue. And I finally find a way to set the proxy in corporate network.

proxy_settings = { 
"http": "http://<proxy_host>:<proxy_port>", 
"https": "https://<proxy_host>:<proxy_port>" 
}

proxy_session = requests.Session()
proxy_session.proxies = proxy_settings

search_client = SearchClient(endpoint=endpoint, 
                             index_name=index_name,          
                             session=proxy_session,
                             connection_verify=False,
                             )