diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md b/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md index f05f58881d2e..3c2e00b52909 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md +++ b/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md @@ -2,6 +2,7 @@ ## 1.0.0-beta.2 (2020-05-06) - Fixed Receipt type bug to select the valueString field via fieldValue. +- Rename `apiKey()` to `credential()` on FormRecognizerClientBuilder. This package's [documentation](https://github.com/Azure/azure-sdk-for-java/blob/azure-ai-formrecognizer_1.0.0-beta.2/sdk/formrecognizer/azure-ai-formrecognizer/README.md) diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/README.md b/sdk/formrecognizer/azure-ai-formrecognizer/README.md index d310096c43c7..f64bb4085578 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/README.md +++ b/sdk/formrecognizer/azure-ai-formrecognizer/README.md @@ -59,7 +59,7 @@ az cognitiveservices account create \ ``` ### Authenticate the client In order to interact with the Form Recognizer service, you will need to create an instance of the `FormRecognizerClient` -class. You will need an **endpoint** and an **API key** to instantiate a client object, +class. You will need an **endpoint** and an **key** to instantiate a client object, they can be found in the [Azure Portal][azure_portal] under the "Quickstart" in your created Form Recognizer resource. See the full details regarding [authentication][authentication] of Cognitive Services. @@ -67,7 +67,7 @@ Form Recognizer resource. See the full details regarding [authentication][authen The `credential` parameter may be provided as a [`AzureKeyCredential`][azure_key_credential] from [azure-core][azure_core]. ##### Create FormRecognizerClient with AzureKeyCredential -To use an [API key][api_key], provide the key as a string to the AzureKeyCredential. This can be found in the [Azure Portal][azure_portal] +To use AzureKeyCredential authentication, provide the [key][key] as a string to the [AzureKeyCredential][azure_key_credential]. This can be found in the [Azure Portal][azure_portal] under the "Quickstart" section or by running the following Azure CLI command: ```bash @@ -77,7 +77,7 @@ Use the API key as the credential parameter to authenticate the client: ```java FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); ``` @@ -85,13 +85,13 @@ The Azure Form Recognizer client library provides a way to **rotate the existing ```java -AzureKeyCredential credential = new AzureKeyCredential("{api_key}"); +AzureKeyCredential credential = new AzureKeyCredential("{key}"); FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint("{endpoint}") .buildClient(); -credential.update("{new_api_key}"); +credential.update("{new_key}"); ``` ## Key concepts @@ -336,7 +336,8 @@ When you submit a pull request, a CLA-bot will automatically determine whether y This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. -[api_key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource +[azure_key_credential]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core/src/main/java/com/azure/core/credential/AzureKeyCredential.java +[key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource [api_reference_doc]: https://aka.ms/azsdk-java-formrecognizer-ref-docs [authentication]: https://docs.microsoft.com/azure/cognitive-services/authentication [azure_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilder.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilder.java index e9a5bd0c6cc5..5200eb9e3bd0 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilder.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilder.java @@ -43,7 +43,7 @@ * *

* The client needs the service endpoint of the Azure Form Recognizer to access the resource service. - * {@link #apiKey(AzureKeyCredential)} gives + * {@link #credential(AzureKeyCredential)} gives * the builder access credential. *

* @@ -114,7 +114,7 @@ public FormRecognizerClientBuilder() { * * @return A FormRecognizerClient with the options set from the builder. * @throws NullPointerException if {@link #endpoint(String) endpoint} or - * {@link #apiKey(AzureKeyCredential) apiKey} has not been set. + * {@link #credential(AzureKeyCredential)} has not been set. * @throws IllegalArgumentException if {@link #endpoint(String) endpoint} cannot be parsed into a valid URL. */ public FormRecognizerClient buildClient() { @@ -132,8 +132,8 @@ public FormRecognizerClient buildClient() { *

* * @return A FormRecognizerAsyncClient with the options set from the builder. - * @throws NullPointerException if {@link #endpoint(String) endpoint} or - * {@link #apiKey(AzureKeyCredential) apiKey} has not been set. + * @throws NullPointerException if {@link #endpoint(String) endpoint} or {@link #credential(AzureKeyCredential)} + * has not been set. * @throws IllegalArgumentException if {@link #endpoint(String) endpoint} cannot be parsed into a valid URL. */ public FormRecognizerAsyncClient buildAsyncClient() { @@ -219,14 +219,15 @@ public FormRecognizerClientBuilder endpoint(String endpoint) { } /** - * Sets the credential to use when authenticating HTTP requests for this FormRecognizerClientBuilder. + * Sets the {@link AzureKeyCredential} to use when authenticating HTTP requests for this + * FormRecognizerClientBuilder. * - * @param apiKeyCredential API key credential + * @param apiKeyCredential {@link AzureKeyCredential} API key credential * * @return The updated FormRecognizerClientBuilder object. * @throws NullPointerException If {@code apiKeyCredential} is {@code null} */ - public FormRecognizerClientBuilder apiKey(AzureKeyCredential apiKeyCredential) { + public FormRecognizerClientBuilder credential(AzureKeyCredential apiKeyCredential) { this.credential = Objects.requireNonNull(apiKeyCredential, "'apiKeyCredential' cannot be null."); return this; } diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledData.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledData.java index 63d68064e5b1..383ac95ea3b7 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledData.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledData.java @@ -29,7 +29,7 @@ public static void main(String[] args) throws IOException { // Instantiate a client that will be used to call the service. FormRecognizerClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledDataAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledDataAsync.java index a276f1bb4305..6ea47c7df417 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledDataAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/AdvancedDiffLabeledUnlabeledDataAsync.java @@ -36,7 +36,7 @@ public static void main(String[] args) throws IOException { // Instantiate a client that will be used to call the service. FormRecognizerAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java index 8a20174d502b..19d7771e5c33 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerAsyncClientJavaDocCodeSnippets.java @@ -31,7 +31,7 @@ public class FormRecognizerAsyncClientJavaDocCodeSnippets { public void createFormRecognizerAsyncClient() { // BEGIN: com.azure.ai.formrecognizer.FormRecognizerAsyncClient.instantiation FormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); // END: com.azure.ai.formrecognizer.FormRecognizerAsyncClient.instantiation @@ -47,7 +47,7 @@ public void createFormRecognizerAsyncClientWithPipeline() { .build(); FormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .pipeline(pipeline) .buildAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerClientJavaDocCodeSnippets.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerClientJavaDocCodeSnippets.java index b63a74a39410..ecf5a62f8873 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerClientJavaDocCodeSnippets.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/FormRecognizerClientJavaDocCodeSnippets.java @@ -28,7 +28,7 @@ public class FormRecognizerClientJavaDocCodeSnippets { public void createFormRecognizerClient() { // BEGIN: com.azure.ai.formrecognizer.FormRecognizerClient.instantiation FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); // END: com.azure.ai.formrecognizer.FormRecognizerClient.instantiation @@ -44,7 +44,7 @@ public void createFormRecognizerClientWithPipeline() { .build(); FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .pipeline(pipeline) .buildClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxes.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxes.java index 3888caf35c23..81beb2d11e09 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxes.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxes.java @@ -25,7 +25,7 @@ public class GetBoundingBoxes { public static void main(String[] args) { // Instantiate a client that will be used to call the service. FormRecognizerClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxesAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxesAsync.java index c2f4ab4d92cc..f4525add2062 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxesAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/GetBoundingBoxesAsync.java @@ -28,7 +28,7 @@ public class GetBoundingBoxesAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. FormRecognizerAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModels.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModels.java index 924f228152ad..94140b0527d0 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModels.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModels.java @@ -26,7 +26,7 @@ public class ManageCustomModels { public static void main(final String[] args) { // Instantiate a client that will be used to call the service. FormTrainingClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient().getFormTrainingClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModelsAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModelsAsync.java index ab508858b83a..1c4729c7d5a6 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModelsAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ManageCustomModelsAsync.java @@ -22,7 +22,7 @@ public class ManageCustomModelsAsync { public static void main(final String[] args) { // Instantiate a client that will be used to call the service. FormTrainingAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient().getFormTrainingAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ReadmeSamples.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ReadmeSamples.java index 3d2fa63107f8..74e21002bbf4 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ReadmeSamples.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/ReadmeSamples.java @@ -31,26 +31,26 @@ public class ReadmeSamples { private FormTrainingClient formTrainingClient = formRecognizerClient.getFormTrainingClient(); /** - * Code snippet for getting sync client using the API key authentication. + * Code snippet for getting sync client using the AzureKeyCredential authentication. */ - public void useApiKeySyncClient() { + public void useAzureKeyCredentialSyncClient() { FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); } /** - * Code snippet for rotating API key of the client + * Code snippet for rotating AzureKeyCredential of the client */ - public void rotatingApiKey() { - AzureKeyCredential credential = new AzureKeyCredential("{api_key}"); + public void rotatingAzureKeyCredential() { + AzureKeyCredential credential = new AzureKeyCredential("{key}"); FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint("{endpoint}") .buildClient(); - credential.update("{new_api_key}"); + credential.update("{new_key}"); } public void recognizeCustomForm() { diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContent.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContent.java index aa9ce8165358..abd803df8ddc 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContent.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContent.java @@ -32,7 +32,7 @@ public static void main(final String[] args) throws IOException { // Instantiate a client that will be used to call the service. FormRecognizerClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContentAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContentAsync.java index 015140e3763d..149a09ddf71c 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContentAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeContentAsync.java @@ -26,7 +26,7 @@ public static void main(final String[] args) { // Instantiate a client that will be used to call the service. FormRecognizerAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomForms.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomForms.java index 33b4150dea21..103d306b01ff 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomForms.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomForms.java @@ -24,7 +24,7 @@ public class RecognizeCustomForms { public static void main(String[] args) { // Instantiate a client that will be used to call the service. FormRecognizerClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomFormsAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomFormsAsync.java index 92230bc18811..a8e648d23bdf 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomFormsAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeCustomFormsAsync.java @@ -36,7 +36,7 @@ public class RecognizeCustomFormsAsync { public static void main(String[] args) throws IOException { // Instantiate a client that will be used to call the service. FormRecognizerAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceipts.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceipts.java index b31778da8978..8f4a7b711dcd 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceipts.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceipts.java @@ -33,7 +33,7 @@ public class RecognizeReceipts { public static void main(final String[] args) throws IOException { // Instantiate a client that will be used to call the service. FormRecognizerClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsAsync.java index d091a1fd806f..4e871ae1b4af 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsAsync.java @@ -37,7 +37,7 @@ public class RecognizeReceiptsAsync { public static void main(final String[] args) throws IOException { // Instantiate a client that will be used to call the service. FormRecognizerAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrl.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrl.java index a19a597861e8..981d0a648218 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrl.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrl.java @@ -25,7 +25,7 @@ public class RecognizeReceiptsFromUrl { public static void main(final String[] args) { // Instantiate a client that will be used to call the service. FormRecognizerClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrlAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrlAsync.java index 006481d07830..2d60b2d8b83e 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrlAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/RecognizeReceiptsFromUrlAsync.java @@ -28,7 +28,7 @@ public class RecognizeReceiptsFromUrlAsync { public static void main(final String[] args) { // Instantiate a client that will be used to call the service. FormRecognizerAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabels.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabels.java index 735c09055935..faef79025a9e 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabels.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabels.java @@ -22,7 +22,7 @@ public static void main(String[] args) { // Instantiate a client that will be used to call the service. FormTrainingClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient().getFormTrainingClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabelsAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabelsAsync.java index b36f6b6d5d5c..529b7d039f08 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabelsAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithLabelsAsync.java @@ -27,7 +27,7 @@ public static void main(String[] args) { // Instantiate a client that will be used to call the service. FormTrainingAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_Key}")) + .credential(new AzureKeyCredential("{api_Key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient().getFormTrainingAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithoutLabels.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithoutLabels.java index 1216b471be03..aec502c17e44 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithoutLabels.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelWithoutLabels.java @@ -22,7 +22,7 @@ public static void main(String[] args) { // Instantiate a client that will be used to call the service. FormTrainingClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_Key}")) + .credential(new AzureKeyCredential("{api_Key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildClient().getFormTrainingClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelsWithoutLabelsAsync.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelsWithoutLabelsAsync.java index 8685eb782771..a877e5a26a81 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelsWithoutLabelsAsync.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/java/com/azure/ai/formrecognizer/TrainModelsWithoutLabelsAsync.java @@ -27,7 +27,7 @@ public static void main(String[] args) { // Instantiate a client that will be used to call the service. FormTrainingAsyncClient client = new FormRecognizerClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("https://{endpoint}.cognitiveservices.azure.com/") .buildAsyncClient().getFormTrainingAsyncClient(); diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderTest.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderTest.java index d264bd8493d8..8ca09af6bc69 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderTest.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderTest.java @@ -133,7 +133,7 @@ String getEndpoint() { */ FormRecognizerClientBuilder createClientBuilder(String endpoint, AzureKeyCredential credential) { final FormRecognizerClientBuilder clientBuilder = new FormRecognizerClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint(endpoint); if (interceptorManager.isPlaybackMode()) { diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderUnitTest.java b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderUnitTest.java index 59717344b555..b6e41332f82f 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderUnitTest.java +++ b/sdk/formrecognizer/azure-ai-formrecognizer/src/test/java/com/azure/ai/formrecognizer/FormRecognizerClientBuilderUnitTest.java @@ -48,21 +48,21 @@ public void invalidProtocol() { } /** - * Test for null API key + * Test for null AzureKeyCredential */ @Test - public void nullApiKey() { + public void nullAzureKeyCredential() { assertThrows(NullPointerException.class, () -> { final FormRecognizerClientBuilder builder = new FormRecognizerClientBuilder(); - builder.endpoint(VALID_HTTPS_LOCALHOST).apiKey(null); + builder.endpoint(VALID_HTTPS_LOCALHOST).credential(null); }); } /** - * Test for empty Api Key without any other authentication + * Test for empty Key without any other authentication */ @Test - public void emptyApiKey() { + public void emptyKeyCredential() { assertThrows(IllegalArgumentException.class, () -> new AzureKeyCredential("")); } } diff --git a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md index 1b76ce7af009..62108b5578b0 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md +++ b/sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md @@ -1,7 +1,7 @@ # Release History ## 1.0.0-beta.5 (Unreleased) - +- Rename `apiKey()` to `credential()` on TextAnalyticsClientBuilder. ## 1.0.0-beta.4 (2020-04-07) - Throws an illegal argument exception when the given list of documents is an empty list. diff --git a/sdk/textanalytics/azure-ai-textanalytics/README.md b/sdk/textanalytics/azure-ai-textanalytics/README.md index 99da1134884b..54f9af356ed2 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/README.md +++ b/sdk/textanalytics/azure-ai-textanalytics/README.md @@ -68,32 +68,32 @@ Text Analytics resource. See the full details regarding [authentication][authent The authentication credential may be provided as the API key to your resource or as a token from Azure Active Directory. -##### **Option 1**: Create TextAnalyticsClient with API Key Credential -To use an [API key][api_key], provide the key as a string. This can be found in the [Azure Portal][azure_portal] +##### **Option 1**: Create TextAnalyticsClient with AzureKeyCredential +To use AzureKeyCredential authentication, provide the [key][key] as a string to the [AzureKeyCredential][azure_key_credential]. This can be found in the [Azure Portal][azure_portal] under the "Quickstart" section or by running the following Azure CLI command: ```bash az cognitiveservices account keys list --resource-group --name ``` -Use the API key as the credential parameter to authenticate the client: +Use the key as the credential parameter to authenticate the client: ```java TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); ``` -The Azure Text Analytics client library provides a way to **rotate the existing API key**. +The Azure Text Analytics client library provides a way to **rotate the existing key**. ```java -AzureKeyCredential credential = new AzureKeyCredential("{api_key}"); +AzureKeyCredential credential = new AzureKeyCredential("{key}"); TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint("{endpoint}") .buildClient(); -credential.update("{new_api_key}"); +credential.update("{new_key}"); ``` ##### **Option 2**: Create TextAnalyticsClient with Azure Active Directory Credential To use an [Azure Active Directory (AAD) token credential][aad_credential], @@ -202,14 +202,14 @@ Text analytics support both synchronous and asynchronous client creation by usin ``` java TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); ``` ``` java TextAnalyticsAsyncClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); ``` @@ -314,8 +314,9 @@ When you submit a pull request, a CLA-bot will automatically determine whether y This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [opencode@microsoft.com][coc_contact] with any additional questions or comments. +[azure_key_credential]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core/src/main/java/com/azure/core/credential/AzureKeyCredential.java [aad_credential]: https://docs.microsoft.com/azure/cognitive-services/authentication#authenticate-with-azure-active-directory -[api_key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource +[key]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows#get-the-keys-for-your-resource [api_reference_doc]: https://aka.ms/azsdk-java-textanalytics-ref-docs [authentication]: https://docs.microsoft.com/azure/cognitive-services/authentication [azure_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilder.java b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilder.java index 74d98eee9127..b78dfeac6610 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilder.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilder.java @@ -43,7 +43,7 @@ * *

* The client needs the service endpoint of the Azure Text Analytics to access the resource service. {@link - * #apiKey(AzureKeyCredential)} or {@link #credential(TokenCredential) credential(TokenCredential)} give the builder + * #credential(AzureKeyCredential)} or {@link #credential(TokenCredential) credential(TokenCredential)} give the builder * access credential. *

* @@ -125,7 +125,7 @@ public TextAnalyticsClientBuilder() { *

* * @return A {@link TextAnalyticsClient} with the options set from the builder. - * @throws NullPointerException if {@link #endpoint(String) endpoint} or {@link #apiKey(AzureKeyCredential) apiKey} + * @throws NullPointerException if {@link #endpoint(String) endpoint} or {@link #credential(AzureKeyCredential)} * has not been set. * @throws IllegalArgumentException if {@link #endpoint(String) endpoint} cannot be parsed into a valid URL. */ @@ -143,7 +143,7 @@ public TextAnalyticsClient buildClient() { *

* * @return A {@link TextAnalyticsAsyncClient} with the options set from the builder. - * @throws NullPointerException if {@link #endpoint(String) endpoint} or {@link #apiKey(AzureKeyCredential) apiKey} + * @throws NullPointerException if {@link #endpoint(String) endpoint} or {@link #credential(AzureKeyCredential)} * has not been set. * @throws IllegalArgumentException if {@link #endpoint(String) endpoint} cannot be parsed into a valid URL. */ @@ -254,13 +254,14 @@ public TextAnalyticsClientBuilder endpoint(String endpoint) { } /** - * Sets the credential to use when authenticating HTTP requests for this {@link TextAnalyticsClientBuilder}. + * Sets the {@link AzureKeyCredential} to use when authenticating HTTP requests for this + * {@link TextAnalyticsClientBuilder}. * - * @param keyCredential API key credential + * @param keyCredential {@link AzureKeyCredential} API key credential * @return The updated {@link TextAnalyticsClientBuilder} object. * @throws NullPointerException If {@code keyCredential} is {@code null} */ - public TextAnalyticsClientBuilder apiKey(AzureKeyCredential keyCredential) { + public TextAnalyticsClientBuilder credential(AzureKeyCredential keyCredential) { this.credential = Objects.requireNonNull(keyCredential, "'keyCredential' cannot be null."); return this; } diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentiment.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentiment.java index fda179d703fd..8dce1bfbda75 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentiment.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentiment.java @@ -19,7 +19,7 @@ public class AnalyzeSentiment { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentimentAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentimentAsync.java index 1f1350887654..7c8dba522894 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentimentAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/AnalyzeSentimentAsync.java @@ -20,7 +20,7 @@ public class AnalyzeSentimentAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguage.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguage.java index 720bf192d52f..31366ed43a82 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguage.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguage.java @@ -18,7 +18,7 @@ public class DetectLanguage { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguageAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguageAsync.java index 5b02434eab6d..a4fc692a651a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguageAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/DetectLanguageAsync.java @@ -19,7 +19,7 @@ public class DetectLanguageAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrases.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrases.java index ecd766f34870..e9c30347e536 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrases.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrases.java @@ -17,7 +17,7 @@ public class ExtractKeyPhrases { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrasesAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrasesAsync.java index fe183de2eec7..824922014fc8 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrasesAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ExtractKeyPhrasesAsync.java @@ -19,7 +19,7 @@ public class ExtractKeyPhrasesAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ReadmeSamples.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ReadmeSamples.java index c6450ddaadc2..3a30b3c8b9ec 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ReadmeSamples.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/ReadmeSamples.java @@ -37,21 +37,21 @@ public void configureHttpClient() { } /** - * Code snippet for getting sync client using the API key authentication. + * Code snippet for getting sync client using the AzureKeyCredential authentication. */ - public void useApiKeySyncClient() { + public void useAzureKeyCredentialSyncClient() { TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); } /** - * Code snippet for getting async client using API key authentication. + * Code snippet for getting async client using AzureKeyCredential authentication. */ - public void useApiKeyAsyncClient() { + public void useAzureKeyCredentialAsyncClient() { TextAnalyticsAsyncClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); } @@ -67,16 +67,16 @@ public void useAadAsyncClient() { } /** - * Code snippet for rotating API key of the client + * Code snippet for rotating AzureKeyCredential of the client */ - public void rotatingApiKey() { - AzureKeyCredential credential = new AzureKeyCredential("{api_key}"); + public void rotatingAzureKeyCredential() { + AzureKeyCredential credential = new AzureKeyCredential("{key}"); TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint("{endpoint}") .buildClient(); - credential.update("{new_api_key}"); + credential.update("{new_key}"); } /** diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntities.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntities.java index 12014b9bf8ce..3ceb99fcea66 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntities.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntities.java @@ -17,7 +17,7 @@ public class RecognizeEntities { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntitiesAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntitiesAsync.java index 16860a1c238a..1e66ef5b36a5 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntitiesAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeEntitiesAsync.java @@ -19,7 +19,7 @@ public class RecognizeEntitiesAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntities.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntities.java index 1565c2eb52ad..08bab97c57f6 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntities.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntities.java @@ -17,7 +17,7 @@ public class RecognizeLinkedEntities { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntitiesAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntitiesAsync.java index 884871cff5a2..5d533dad4d69 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntitiesAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RecognizeLinkedEntitiesAsync.java @@ -19,7 +19,7 @@ public class RecognizeLinkedEntitiesAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateApiKey.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateAzureKeyCredential.java similarity index 93% rename from sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateApiKey.java rename to sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateAzureKeyCredential.java index 64cb31d7c1a4..9cd085bceb24 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateApiKey.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateAzureKeyCredential.java @@ -9,7 +9,7 @@ /** * Sample demonstrates how to rotate the existing API key of text analytics client */ -public class RotateApiKey { +public class RotateAzureKeyCredential { /** * Main method to invoke this demo about how to rotate the existing API key of text analytics client. @@ -17,9 +17,9 @@ public class RotateApiKey { * @param args Unused arguments to the program. */ public static void main(String[] args) { - AzureKeyCredential credential = new AzureKeyCredential("{api_key}"); + AzureKeyCredential credential = new AzureKeyCredential("{key}"); TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateApiKeyAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateAzureKeyCredentialAsync.java similarity index 95% rename from sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateApiKeyAsync.java rename to sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateAzureKeyCredentialAsync.java index 90b893518755..8e26db32a53e 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateApiKeyAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/RotateAzureKeyCredentialAsync.java @@ -10,7 +10,7 @@ /** * Sample demonstrates how to rotate the existing API key of text analytics client */ -public class RotateApiKeyAsync { +public class RotateAzureKeyCredentialAsync { /** * Main method to invoke this demo about how to rotate the existing API key of text analytics client. @@ -18,9 +18,9 @@ public class RotateApiKeyAsync { * @param args Unused arguments to the program. */ public static void main(String[] args) { - AzureKeyCredential credential = new AzureKeyCredential("{api_key}"); + AzureKeyCredential credential = new AzureKeyCredential("{key}"); TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClientJavaDocCodeSnippets.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClientJavaDocCodeSnippets.java index 293b5112762b..7057181c728b 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClientJavaDocCodeSnippets.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClientJavaDocCodeSnippets.java @@ -33,7 +33,7 @@ public class TextAnalyticsAsyncClientJavaDocCodeSnippets { public TextAnalyticsAsyncClient createTextAnalyticsAsyncClient() { // BEGIN: com.azure.ai.textanalytics.TextAnalyticsAsyncClient.instantiation TextAnalyticsAsyncClient textAnalyticsAsyncClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); // END: com.azure.ai.textanalytics.TextAnalyticsAsyncClient.instantiation @@ -43,17 +43,17 @@ public TextAnalyticsAsyncClient createTextAnalyticsAsyncClient() { /** * Code snippet for updating the existing API key. */ - public void rotateApiKey() { - // BEGIN: com.azure.ai.textanalytics.models.TextAnalyticsApiKeyCredential - AzureKeyCredential credential = new AzureKeyCredential("{api_key}"); + public void rotateAzureKeyCredential() { + // BEGIN: com.azure.ai.textanalytics.models.AzureKeyCredential + AzureKeyCredential credential = new AzureKeyCredential("{key}"); TextAnalyticsAsyncClient textAnalyticsAsyncClient = new TextAnalyticsClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint("{endpoint}") .buildAsyncClient(); credential.update("{new_api_key}"); - // END: com.azure.ai.textanalytics.models.TextAnalyticsApiKeyCredential + // END: com.azure.ai.textanalytics.models.AzureKeyCredential } // Languages diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsClientJavaDocCodeSnippets.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsClientJavaDocCodeSnippets.java index 27915a3fdcb4..d88c0e6eee6a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsClientJavaDocCodeSnippets.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/TextAnalyticsClientJavaDocCodeSnippets.java @@ -39,7 +39,7 @@ public void createTextAnalyticsClientWithPipeline() { .build(); TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .pipeline(pipeline) .buildClient(); @@ -52,7 +52,7 @@ public void createTextAnalyticsClientWithPipeline() { public void createTextAnalyticsClient() { // BEGIN: com.azure.ai.textanalytics.TextAnalyticsClient.instantiation TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); // END: com.azure.ai.textanalytics.TextAnalyticsClient.instantiation diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocuments.java index 422dde419aea..114f7a7cd6f8 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocuments.java @@ -31,7 +31,7 @@ public class AnalyzeSentimentBatchDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocumentsAsync.java index 33320208fcfc..09ed165ffcae 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchDocumentsAsync.java @@ -30,7 +30,7 @@ public class AnalyzeSentimentBatchDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocuments.java index 63dbe7fc3a56..2d5423f034db 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocuments.java @@ -26,7 +26,7 @@ public class AnalyzeSentimentBatchStringDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocumentsAsync.java index bee51fc1c905..2c3e2a32eb1d 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/AnalyzeSentimentBatchStringDocumentsAsync.java @@ -27,7 +27,7 @@ public class AnalyzeSentimentBatchStringDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocuments.java index 9461cd8b04d6..c7e86c1e593f 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocuments.java @@ -30,7 +30,7 @@ public class DetectLanguageBatchDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocumentsAsync.java index 90586073c778..b0c3ca69e63f 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchDocumentsAsync.java @@ -29,7 +29,7 @@ public class DetectLanguageBatchDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocuments.java index 89e24f3ed420..755b55d740c3 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocuments.java @@ -24,7 +24,7 @@ public class DetectLanguageBatchStringDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocumentsAsync.java index 7d275b1750e0..7c032136afb6 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/DetectLanguageBatchStringDocumentsAsync.java @@ -25,7 +25,7 @@ public class DetectLanguageBatchStringDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocuments.java index dfe2f8ceaa99..820fe64c0f64 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocuments.java @@ -29,7 +29,7 @@ public class ExtractKeyPhrasesBatchDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocumentsAsync.java index e4e28bce670c..4fcd9a3c2971 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchDocumentsAsync.java @@ -28,7 +28,7 @@ public class ExtractKeyPhrasesBatchDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocuments.java index 7afaf6295167..1ba940219ca7 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocuments.java @@ -24,7 +24,7 @@ public class ExtractKeyPhrasesBatchStringDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocumentsAsync.java index bccb9ad84c8e..6bc3fe4e8543 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/ExtractKeyPhrasesBatchStringDocumentsAsync.java @@ -24,7 +24,7 @@ public class ExtractKeyPhrasesBatchStringDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocuments.java index bc74c16cf747..5bbf21d68270 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocuments.java @@ -29,7 +29,7 @@ public class RecognizeEntitiesBatchDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocumentsAsync.java index 4fdf184e3e2f..dc16b89f1ed4 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchDocumentsAsync.java @@ -28,7 +28,7 @@ public class RecognizeEntitiesBatchDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocuments.java index 8353962295d3..714dc2a44d61 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocuments.java @@ -24,7 +24,7 @@ public class RecognizeEntitiesBatchStringDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocumentsAsync.java index 0b6e6de29d82..38511aeecf8a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeEntitiesBatchStringDocumentsAsync.java @@ -24,7 +24,7 @@ public class RecognizeEntitiesBatchStringDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocuments.java index 492ad2f1d008..b0e2ebdc23fc 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocuments.java @@ -29,7 +29,7 @@ public class RecognizeLinkedEntitiesBatchDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocumentsAsync.java index ce04bb66030d..ad08aed75cd7 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchDocumentsAsync.java @@ -28,7 +28,7 @@ public class RecognizeLinkedEntitiesBatchDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocuments.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocuments.java index b58034b19d2c..4c25929d6b99 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocuments.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocuments.java @@ -24,7 +24,7 @@ public class RecognizeLinkedEntitiesBatchStringDocuments { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocumentsAsync.java b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocumentsAsync.java index 681ef3b535dc..a364f2f1be5e 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocumentsAsync.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/samples/java/com/azure/ai/textanalytics/batch/RecognizeLinkedEntitiesBatchStringDocumentsAsync.java @@ -24,7 +24,7 @@ public class RecognizeLinkedEntitiesBatchStringDocumentsAsync { public static void main(String[] args) { // Instantiate a client that will be used to call the service. TextAnalyticsAsyncClient client = new TextAnalyticsClientBuilder() - .apiKey(new AzureKeyCredential("{api_key}")) + .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient(); diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/DocumentInputTest.java b/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/DocumentInputTest.java index e57e35ffb531..63709dd10d1b 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/DocumentInputTest.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/DocumentInputTest.java @@ -31,7 +31,7 @@ public class DocumentInputTest { protected static void beforeTest() { client = new TextAnalyticsClientBuilder() .endpoint(VALID_HTTPS_LOCALHOST) - .apiKey(new AzureKeyCredential("fakeKey")) + .credential(new AzureKeyCredential("fakeKey")) .buildClient(); } diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderTest.java b/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderTest.java index 0bc5e7b5b01f..65557315c399 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderTest.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderTest.java @@ -306,7 +306,7 @@ String getEndpoint() { */ TextAnalyticsClientBuilder createClientBuilder(String endpoint, AzureKeyCredential credential) { final TextAnalyticsClientBuilder clientBuilder = new TextAnalyticsClientBuilder() - .apiKey(credential) + .credential(credential) .endpoint(endpoint); if (interceptorManager.isPlaybackMode()) { diff --git a/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderUnitTest.java b/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderUnitTest.java index fad092eb8771..cf37b68d6e4a 100644 --- a/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderUnitTest.java +++ b/sdk/textanalytics/azure-ai-textanalytics/src/test/java/com/azure/ai/textanalytics/TextAnalyticsClientBuilderUnitTest.java @@ -4,6 +4,7 @@ package com.azure.ai.textanalytics; import com.azure.core.credential.AzureKeyCredential; +import com.azure.core.credential.TokenCredential; import org.junit.jupiter.api.Test; import static com.azure.ai.textanalytics.TestUtils.VALID_HTTPS_LOCALHOST; @@ -48,22 +49,23 @@ public void invalidProtocol() { } /** - * Test for null API key + * Test for empty Api Key without any other authentication */ @Test - public void nullApiKey() { - assertThrows(NullPointerException.class, () -> { - final TextAnalyticsClientBuilder builder = new TextAnalyticsClientBuilder(); - builder.endpoint(VALID_HTTPS_LOCALHOST).apiKey(null); - }); + public void emptyApiKey() { + assertThrows(IllegalArgumentException.class, () -> new AzureKeyCredential("")); } /** - * Test for empty Api Key without any other authentication + * Test for null API key */ @Test - public void emptyApiKey() { - assertThrows(IllegalArgumentException.class, () -> new AzureKeyCredential("")); + public void nullApiKey() { + AzureKeyCredential azureKeyCredential = null; + assertThrows(NullPointerException.class, () -> { + final TextAnalyticsClientBuilder builder = new TextAnalyticsClientBuilder(); + builder.endpoint(VALID_HTTPS_LOCALHOST).credential(azureKeyCredential); + }); } /** @@ -71,9 +73,10 @@ public void emptyApiKey() { */ @Test public void nullAADCredential() { + TokenCredential tokenCredential = null; assertThrows(NullPointerException.class, () -> { final TextAnalyticsClientBuilder builder = new TextAnalyticsClientBuilder(); - builder.endpoint(VALID_HTTPS_LOCALHOST).credential(null); + builder.endpoint(VALID_HTTPS_LOCALHOST).credential(tokenCredential); }); } }