diff --git a/sdk/appconfiguration/azure-data-appconfiguration/README.md b/sdk/appconfiguration/azure-data-appconfiguration/README.md index 32a738851876..cd17d5c44172 100644 --- a/sdk/appconfiguration/azure-data-appconfiguration/README.md +++ b/sdk/appconfiguration/azure-data-appconfiguration/README.md @@ -28,56 +28,6 @@ Use the client library for App Configuration to create and manage application co ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -AppConfiguration to use Netty HTTP client. - -### Alternate HTTP Client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-data-appconfiguration;current}) -```xml - - - com.azure - azure-data-appconfiguration - 1.0.1 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-client), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - ### Create an App Configuration Store To create a Configuration Store you can use the Azure Portal or [Azure CLI][azure_cli]. @@ -406,6 +356,17 @@ configurationClient.addConfigurationSettingWithResponse( ``` For more detail information, check out the [AddHeadersFromContextPolicy][add_headers_from_context_policy] +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps - Samples are explained in detail [here][samples_readme]. diff --git a/sdk/keyvault/azure-security-keyvault-certificates/README.md b/sdk/keyvault/azure-security-keyvault-certificates/README.md index 4cc80714a7b9..3b6b0601cd40 100644 --- a/sdk/keyvault/azure-security-keyvault-certificates/README.md +++ b/sdk/keyvault/azure-security-keyvault-certificates/README.md @@ -20,56 +20,6 @@ Maven dependency for Azure Key Client library. Add it to your project's pom file ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -KeyVault Certificates to use Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-security-keyvault-certificates;current}) -```xml - - - com.azure - azure-security-keyvault-certificates - 4.0.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-certificate-client), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - ### Prerequisites - Java Development Kit (JDK) with version 8 or above @@ -85,7 +35,7 @@ In order to interact with the Key Vault service, you'll need to create an instan The `DefaultAzureCredential` way of authentication by providing client secret credentials is being used in this getting started section but you can find more ways to authenticate with [azure-identity][azure_identity]. - #### Create/Get credentials +#### Create/Get credentials To create/get client key credentials you can use the [Azure Portal][azure_create_application_in_portal], [Azure CLI][azure_keyvault_cli_full] or [Azure Cloud Shell](https://shell.azure.com/bash) Here is [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to @@ -339,6 +289,17 @@ try { } ``` +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Several KeyVault Java SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault: diff --git a/sdk/keyvault/azure-security-keyvault-keys/README.md b/sdk/keyvault/azure-security-keyvault-keys/README.md index ce3eba78432c..f1a552efeb61 100644 --- a/sdk/keyvault/azure-security-keyvault-keys/README.md +++ b/sdk/keyvault/azure-security-keyvault-keys/README.md @@ -21,56 +21,6 @@ Maven dependency for Azure Key Client library. Add it to your project's pom file ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -KeyVault Keys to use Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-security-keyvault-keys;current}) -```xml - - - com.azure - azure-security-keyvault-keys - 4.1.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-key-client), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - ### Prerequisites - Java Development Kit (JDK) with version 8 or above @@ -179,7 +129,6 @@ The Key client performs the interactions with the Azure Key Vault service for ge ### Cryptography Client: The Cryptography client performs the cryptographic operations locally or calls the Azure Key Vault service depending on how much key information is available locally. It supports encrypting, decrypting, signing, verifying, key wrapping, key unwrapping and retrieving the configured key. An asynchronous and synchronous, CryptographyClient, client exists in the SDK allowing for selection of a client based on an application's use case. - ## Examples ### Sync API The following sections provide several code snippets covering some of the most common Azure Key Vault Key Service tasks, including: @@ -439,6 +388,17 @@ try { } ``` +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the + [HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Several KeyVault Java SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault: diff --git a/sdk/keyvault/azure-security-keyvault-secrets/README.md b/sdk/keyvault/azure-security-keyvault-secrets/README.md index 4eb55cb6e3c6..01f7006fbd11 100644 --- a/sdk/keyvault/azure-security-keyvault-secrets/README.md +++ b/sdk/keyvault/azure-security-keyvault-secrets/README.md @@ -22,56 +22,6 @@ Maven dependency for Azure Secret Client library. Add it to your project's pom f ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -KeyVault Secrets to use Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-security-keyvault-secrets;current}) -```xml - - - com.azure - azure-security-keyvault-secrets - 4.1.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-secret-client), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - ### Prerequisites - Java Development Kit (JDK) with version 8 or above @@ -87,7 +37,7 @@ In order to interact with the Key Vault service, you'll need to create an instan The `DefaultAzureCredential` way of authentication by providing client secret credentials is being used in this getting started section but you can find more ways to authenticate with [azure-identity][azure_identity]. - #### Create/Get credentials +#### Create/Get credentials To create/get client secret credentials you can use the [Azure Portal][azure_create_application_in_portal], [Azure CLI][azure_keyvault_cli_full] or [Azure Cloud Shell](https://shell.azure.com/bash) Here is [Azure Cloud Shell](https://shell.azure.com/bash) snippet below to @@ -328,6 +278,16 @@ try { } ``` +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the [HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Several KeyVault Java SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault: diff --git a/sdk/storage/azure-storage-blob-batch/README.md b/sdk/storage/azure-storage-blob-batch/README.md index c80971f5dd49..d307b8039d77 100644 --- a/sdk/storage/azure-storage-blob-batch/README.md +++ b/sdk/storage/azure-storage-blob-batch/README.md @@ -27,58 +27,6 @@ definition, such as text or binary data. ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -Storage Blob Batch to use Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-storage-blob-batch;current}) -```xml - - - com.azure - azure-storage-blob-batch - 12.2.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-blobserviceclient), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -```java -// ./src/samples/java/com/azure/storage/blob/batch/ReadmeSamples.java#L35-L38 - -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - ### Create a Storage Account To create a Storage Account you can use the Azure Portal or [Azure CLI][storage_account_create_cli]. @@ -193,6 +141,17 @@ When interacts with blobs using this Java client library, errors returned by the status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a container or blob that doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Get started with our [Blob Batch samples][blob_samples]: diff --git a/sdk/storage/azure-storage-blob-cryptography/README.md b/sdk/storage/azure-storage-blob-cryptography/README.md index 207167610444..0dd34e81cf05 100644 --- a/sdk/storage/azure-storage-blob-cryptography/README.md +++ b/sdk/storage/azure-storage-blob-cryptography/README.md @@ -26,56 +26,6 @@ This package supports client side encryption for blob storage. ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -Storage Blob to use Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-storage-blob-cryptography;current}) -```xml - - - com.azure - azure-storage-blob - 12.2.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-blobserviceclient), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning](https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning) section of the wiki. - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - ### Create a Storage Account To create a Storage Account you can use the Azure Portal or [Azure CLI][storage_account_create_cli]. @@ -158,6 +108,17 @@ When interacting with blobs using this Java client library, errors returned by t status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a container or blob that doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps ## Contributing diff --git a/sdk/storage/azure-storage-blob-nio/README.md b/sdk/storage/azure-storage-blob-nio/README.md index b23502f9c1bd..1447b4e63e57 100644 --- a/sdk/storage/azure-storage-blob-nio/README.md +++ b/sdk/storage/azure-storage-blob-nio/README.md @@ -23,56 +23,6 @@ ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use the Netty HTTP client. Adding the above dependency will automatically configure -Storage Blob to use the Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is an HTTP client available for that too. Exclude the default -Netty and include the OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-storage-blob;current}) -```xml - - - com.azure - azure-storage-blob - 12.2.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-blobserviceclient) unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this by allowing users to provide custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - ### Create a Storage Account To create a Storage Account you can use the [Azure Portal][storage_account_create_portal] or [Azure CLI][storage_account_create_cli]. @@ -176,6 +126,17 @@ When interacting with blobs using this Java client library, errors returned by t status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a container or blob that doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Several Storage blob Java SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault: diff --git a/sdk/storage/azure-storage-blob/README.md b/sdk/storage/azure-storage-blob/README.md index 6339cf47634d..47d7dc318b5e 100644 --- a/sdk/storage/azure-storage-blob/README.md +++ b/sdk/storage/azure-storage-blob/README.md @@ -27,56 +27,6 @@ definition, such as text or binary data. ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use the Netty HTTP client. Adding the above dependency will automatically configure -Storage Blob to use the Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is an HTTP client available for that too. Exclude the default -Netty and include the OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-storage-blob;current}) -```xml - - - com.azure - azure-storage-blob - 12.2.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-blobserviceclient) unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this by allowing users to provide custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - ### Create a Storage Account To create a Storage Account you can use the [Azure Portal][storage_account_create_portal] or [Azure CLI][storage_account_create_cli]. @@ -305,6 +255,17 @@ When interacting with blobs using this Java client library, errors returned by t status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a container or blob that doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Several Storage blob Java SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault: diff --git a/sdk/storage/azure-storage-file-datalake/README.md b/sdk/storage/azure-storage-file-datalake/README.md index e9a799d860ed..7f50efab7b73 100644 --- a/sdk/storage/azure-storage-file-datalake/README.md +++ b/sdk/storage/azure-storage-file-datalake/README.md @@ -30,56 +30,6 @@ Add a dependency on Azure Storage File Datalake ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use the Netty HTTP client. Adding the above dependency will automatically configure -Storage Data Lake to use the Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is an HTTP client available for that too. Exclude the default -Netty and include the OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-storage-file-datalake;current}) -```xml - - - com.azure - azure-storage-file-datalake - 12.0.0-beta.9 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-datalakeserviceclient) unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this by allowing users to provide custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - ### Create a Storage Account To create a Storage Account you can use the [Azure Portal][storage_account_create_portal] or [Azure CLI][storage_account_create_cli]. Note: To use data lake, your account must have hierarchical namespace enabled. @@ -170,10 +120,10 @@ In the past, cloud-based analytics had to compromise in areas of performance, ma Data Lake Storage Gen2 offers two types of resources: -- The _filesystem used via 'DataLakeFileSystemClient' -- The _path used via 'DataLakeFileClient' or 'DataLakeDirectoryClient' +- The `_filesystem` used via 'DataLakeFileSystemClient' +- The `_path` used via 'DataLakeFileClient' or 'DataLakeDirectoryClient' -|ADLS Gen2 | Blob | +|ADLS Gen2 | Blob | | --------------------------| ---------- | |Filesystem | Container | |Path (File or Directory) | Blob | @@ -375,6 +325,17 @@ When interacting with data lake using this Java client library, errors returned status codes returned for [REST API][error_codes] requests. For example, if you try to retrieve a file system or path that doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Several Storage datalake Java SDK samples are available to you in the SDK's GitHub repository. diff --git a/sdk/storage/azure-storage-file-share/README.md b/sdk/storage/azure-storage-file-share/README.md index b1172af3cc5b..aab4102f2a2f 100644 --- a/sdk/storage/azure-storage-file-share/README.md +++ b/sdk/storage/azure-storage-file-share/README.md @@ -29,56 +29,6 @@ Shares provide a way to organize sets of files and also can be mounted as an SMB ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -Storage File Share to use Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-storage-file-share;current}) -```xml - - - com.azure - azure-storage-file-share - 12.1.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#file-services), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - ### Create a Storage Account To create a Storage Account you can use the Azure Portal or [Azure CLI][azure_cli]. @@ -499,6 +449,17 @@ fileClient.setHttpHeaders(newFileSize, httpHeaders); When you interact with file using this Java client library, errors returned by the service correspond to the same HTTP status codes returned for [REST API][storage_file_rest] requests. For example, if you try to retrieve a share that doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps ## Contributing diff --git a/sdk/storage/azure-storage-queue/README.md b/sdk/storage/azure-storage-queue/README.md index a39995d2739d..241157cb9188 100644 --- a/sdk/storage/azure-storage-queue/README.md +++ b/sdk/storage/azure-storage-queue/README.md @@ -25,55 +25,6 @@ A single queue message can be up to 64 KB in size, and a queue can contain milli ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure Storage Queue to use Netty HTTP client. - -### Alternate HTTP client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-storage-queue;current}) -```xml - - - com.azure - azure-storage-queue - 12.2.0 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;current}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#build-a-client), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - ### Create a Storage Account To create a Storage Account you can use the Azure Portal or [Azure CLI][azure_cli]. @@ -442,6 +393,17 @@ queueClient.setMetadata(metadata); When you interact with queue using this Java client library, errors returned by the service correspond to the same HTTP status codes returned for [REST API][storage_rest] requests. For example, if you try to retrieve a queue that doesn't exist in your Storage Account, a `404` error is returned, indicating `Not Found`. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps Several Storage Queue Java SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault: diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md index d48f3f3bd7a4..74851c0b0262 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/README.md +++ b/sdk/textanalytics/azure-ai-textanalytics/README.md @@ -30,68 +30,6 @@ and includes six main functions: ``` [//]: # ({x-version-update-end}) -### Default HTTP Client -All client libraries, by default, use Netty HTTP client. Adding the above dependency will automatically configure -Text Analytics to use Netty HTTP client. - -[//]: # ({x-version-update-start;com.azure:azure-core-http-netty;dependency}) -```xml - - com.azure - azure-core-http-netty - 1.2.0 - -``` -[//]: # ({x-version-update-end}) - -### Alternate HTTP Client -If, instead of Netty it is preferable to use OkHTTP, there is a HTTP client available for that too. Exclude the default -Netty and include OkHTTP client in your pom.xml. - -[//]: # ({x-version-update-start;com.azure:azure-ai-textanalytics;current}) -```xml - - - com.azure - azure-ai-textanalytics - 1.0.0-beta.1 - - - com.azure - azure-core-http-netty - - - -``` -[//]: # ({x-version-update-end}) - -[//]: # ({x-version-update-start;com.azure:azure-core-http-okhttp;dependency}) -```xml - - - com.azure - azure-core-http-okhttp - 1.1.0 - -``` -[//]: # ({x-version-update-end}) - -### Configuring HTTP Clients -When an HTTP client is included on the classpath, as shown above, it is not necessary to specify it in the client library [builders](#create-a-client), unless you want to customize the HTTP client in some fashion. If this is desired, the `httpClient` builder method is often available to achieve just this, by allowing users to provide a custom (or customized) `com.azure.core.http.HttpClient` instances. - -For starters, by having the Netty or OkHTTP dependencies on your classpath, as shown above, you can create new instances of these `HttpClient` types using their builder APIs. For example, here is how you would create a Netty HttpClient instance: - - -```java -HttpClient client = new NettyAsyncHttpClientBuilder() - .port(8080) - .wiretap(true) - .build(); -``` - -### Default SSL library -All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides better performance compared to the default SSL implementation within the JDK. For more information, including how to reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. - ### Create a Text Analytics resource Text Analytics supports both [multi-service and single-service access](https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows). Create a Cognitive Services resource if you plan to access multiple cognitive services under a single endpoint/key. For Text Analytics access only, create a Text Analytics resource. @@ -361,6 +299,17 @@ You can set the `AZURE_LOG_LEVEL` environment variable to view logging statement example, setting `AZURE_LOG_LEVEL=2` would show all informational, warning, and error log messages. The log levels can be found here: [log levels][LogLevels]. +### Default HTTP Client +All client libraries by default use the Netty HTTP client. Adding the above dependency will automatically configure +the client library to use the Netty HTTP client. Configuring or changing the HTTP client is detailed in the +[HTTP clients wiki](https://github.com/Azure/azure-sdk-for-java/wiki/HTTP-clients). + +### Default SSL library +All client libraries, by default, use the Tomcat-native Boring SSL library to enable native-level performance for SSL +operations. The Boring SSL library is an uber jar containing native libraries for Linux / macOS / Windows, and provides +better performance compared to the default SSL implementation within the JDK. For more information, including how to +reduce the dependency size, refer to the [performance tuning][performance_tuning] section of the wiki. + ## Next steps - Samples are explained in detail [here][samples_readme].