summary:"Attempts to load a proxy from the configuration."
modifiers:
- "static"
parameters:
- description:"The <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> that is used to load proxy configurations from the environment. If\n <code>null</code> is passed then <xref uid=\"com.azure.core.util.Configuration.getGlobalConfiguration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#getGlobalConfiguration()\"></xref> will be used."
desc:"Attempts to load a proxy from the configuration.\n\nIf a proxy is found and loaded the proxy address is DNS resolved.\n\nEnvironment configurations are loaded in this order:\n\n1. Azure HTTPS\n2. Azure HTTP\n3. Java HTTPS\n4. Java HTTP\n\nAzure proxy configurations will be preferred over Java proxy configurations as they are more closely scoped to the purpose of the SDK. Additionally, more secure protocols, HTTPS vs HTTP, will be preferred.\n\n`null` will be returned if no proxy was found in the environment."
returns:
description:"A <xref uid=\"com.azure.core.http.ProxyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyOptions\"></xref> reflecting a proxy loaded from the environment, if no proxy is found <code>null</code>\n will be returned."
summary:"Attempts to load a proxy from the environment."
modifiers:
- "static"
parameters:
- description:"The <xref uid=\"com.azure.core.util.Configuration\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration\"></xref> that is used to load proxy configurations from the environment. If\n <code>null</code> is passed then <xref uid=\"com.azure.core.util.Configuration.getGlobalConfiguration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#getGlobalConfiguration()\"></xref> will be used. If <xref uid=\"com.azure.core.util.Configuration.NONE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#NONE\"></xref> is passed <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IllegalArgumentException\"></xref> will be thrown."
- description:"Flag determining whether the returned <xref uid=\"com.azure.core.http.ProxyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyOptions\"></xref> is unresolved."
desc:"Attempts to load a proxy from the environment.\n\nIf a proxy is found and loaded, the proxy address is DNS resolved based on `createUnresolved`. When `createUnresolved` is true resolving <xref uid=\"com.azure.core.http.ProxyOptions.getAddress()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getAddress()\"></xref> may be required before using the address in network calls.\n\nEnvironment configurations are loaded in this order:\n\n1. Azure HTTPS\n2. Azure HTTP\n3. Java HTTPS\n4. Java HTTP\n\nAzure proxy configurations will be preferred over Java proxy configurations as they are more closely scoped to the purpose of the SDK. Additionally, more secure protocols, HTTPS vs HTTP, will be preferred.\n\n`null` will be returned if no proxy was found in the environment."
returns:
description:"A <xref uid=\"com.azure.core.http.ProxyOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProxyOptions\"></xref> reflecting a proxy loaded from the environment, if no proxy is found <code>null</code>\n will be returned."
desc:"Sets the hosts which bypass the proxy.\n\nThe expected format of the passed string is a `'|'` delimited list of hosts which should bypass the proxy. Individual host strings may contain regex characters such as `'*'`."
desc:"Represents the proxy configuration to be used in HTTP clients.\n\nThis class encapsulates the proxy settings, including the proxy type, address, and optional credentials. It provides methods to set and get these properties.\n\nThis class is useful when you want to configure a proxy for an HTTP client. For example, you can use it to create a proxy with specific credentials, or to specify hosts that should bypass the proxy.\n\nNote: This class provides a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Type\"></xref> enum to represent the proxy type, which can be HTTP, SOCKS4, or SOCKS5."
