From fa8d80967df4c2f76a55b716b440ecec5ac14eec Mon Sep 17 00:00:00 2001 From: JoshTheTechWriter <183134486+JoshTheTechWriter@users.noreply.github.com> Date: Wed, 15 Jan 2025 12:43:06 -0500 Subject: [PATCH 1/3] Ninth bundle of files. --- .../spring-framework/resource-handling.md | 20 ++++----- .../spring-framework/secret-management.md | 28 ++++++------- ...ur-restful-api-using-spring-cloud-azure.md | 4 +- ...-boot-starter-for-entra-developer-guide.md | 42 +++++++++---------- .../spring-cloud-azure-overview.md | 10 ++--- .../spring-cloud-stream-support.md | 16 +++---- .../spring-framework/spring-data-support.md | 28 ++++++------- .../spring-integration-support.md | 22 +++++----- .../spring-framework/spring-jms-support.md | 6 +-- .../spring-messaging-support.md | 30 ++++++------- .../spring-security-support.md | 24 +++++------ .../testcontainers-support.md | 2 +- ...using-event-hubs-in-spring-applications.md | 26 ++++++------ ...sing-service-bus-in-spring-applications.md | 34 +++++++-------- ...ng-storage-queue-in-spring-applications.md | 22 +++++----- .../create-hello-world-web-app.md | 6 +-- .../java/toolkit-for-eclipse/installation.md | 2 +- ...aging-redis-caches-using-azure-explorer.md | 4 +- ...g-virtual-machines-using-azure-explorer.md | 8 ++-- .../toolkit-for-intellij/chatgpt-intellij.md | 2 +- 20 files changed, 168 insertions(+), 168 deletions(-) diff --git a/articles/java/spring-framework/resource-handling.md b/articles/java/spring-framework/resource-handling.md index e9fea8c329..18034ce638 100644 --- a/articles/java/spring-framework/resource-handling.md +++ b/articles/java/spring-framework/resource-handling.md @@ -41,7 +41,7 @@ The `spring-cloud-azure-starter-storage-blob` dependency is only required when y The `spring-cloud-azure-starter-storage-file-share` dependency is only required when you're using Azure Storage File Share. > [!TIP] -> We also provide `spring-cloud-azure-starter-storage` to support all the features of Storage. If you choose to use it, `spring.cloud.azure.storage.enable` is the property to configure and the default value is *true*. You can then use `spring.cloud.azure.storage..enable` to disable unneeded services. +> We also provide `spring-cloud-azure-starter-storage` to support all the features of Storage. If you choose to use it, `spring.cloud.azure.storage.enable` is the property to configure and the default value is `true`. You can then use `spring.cloud.azure.storage..enable` to disable unneeded services. ## Configuration @@ -53,24 +53,24 @@ The following table lists the configurable properties of `spring-cloud-azure-sta > [!div class="mx-tdBreakAll"] > | Property | Default | Description | > |------------------------------------------------|---------|--------------------------------------------------------------------------| -> | *spring.cloud.azure.storage.blob*.enabled | true | A value that indicates whether an Azure Blob Storage service is enabled. | -> | *spring.cloud.azure.storage.blob*.endpoint | | The URI to connect to Azure Blob Storage. | -> | *spring.cloud.azure.storage.blob*.account-key | | The private key to connect to Azure Blob Storage. | -> | *spring.cloud.azure.storage.blob*.account-name | | The Azure Storage Blob account name. +> | `*spring.cloud.azure.storage.blob*.enabled` | true | A value that indicates whether an Azure Blob Storage service is enabled. | +> | `*spring.cloud.azure.storage.blob*.endpoint` | | The URI to connect to Azure Blob Storage. | +> | `*spring.cloud.azure.storage.blob*.account-key` | | The private key to connect to Azure Blob Storage. | +> | `*spring.cloud.azure.storage.blob*.account-name` | | The Azure Storage Blob account name. The following table lists the configurable properties of `spring-cloud-azure-starter-storage-file-share`: > [!div class="mx-tdBreakAll"] > | Property | Default | Description | > |-----------------------------------------------------|---------|-----------------------------------------------------------------------| -> | *spring.cloud.azure.storage.fileshare*.enabled | true | A value that indicates whether Azure File Storage service is enabled. | -> | *spring.cloud.azure.storage.fileshare*.endpoint | | The URI to connect to Azure File Storage. | -> | *spring.cloud.azure.storage.fileshare*.account-key | | The private key to connect to Azure File Storage. | -> | *spring.cloud.azure.storage.fileshare*.account-name | | The Azure Storage File Share account name. | +> | `*spring.cloud.azure.storage.fileshare*.enabled` | true | A value that indicates whether Azure File Storage service is enabled. | +> | `*spring.cloud.azure.storage.fileshare*.endpoint` | | The URI to connect to Azure File Storage. | +> | `*spring.cloud.azure.storage.fileshare*.account-key` | | The private key to connect to Azure File Storage. | +> | `*spring.cloud.azure.storage.fileshare*.account-name` | | The Azure Storage File Share account name. | ## Basic usage -Add the following properties to your *application.yml* file: +Add the following properties to your **application.yml** file: ```yaml spring: diff --git a/articles/java/spring-framework/secret-management.md b/articles/java/spring-framework/secret-management.md index 833c402dd4..8e8114595a 100644 --- a/articles/java/spring-framework/secret-management.md +++ b/articles/java/spring-framework/secret-management.md @@ -24,7 +24,7 @@ Spring Cloud Azure construct `PropertySource` which holds secrets stored in Azur ``` > [!TIP] -> We also provide `spring-cloud-azure-starter-keyvault` to support all the features of Key Vault. If you choose to use it, `spring.cloud.azure.keyvault.enable` is the property to configure and the default value is *true*. You can then use `spring.cloud.azure.keyvault..enable` to disable unneeded services. +> We also provide `spring-cloud-azure-starter-keyvault` to support all the features of Key Vault. If you choose to use it, `spring.cloud.azure.keyvault.enable` is the property to configure and the default value is `true`. You can then use `spring.cloud.azure.keyvault..enable` to disable unneeded services. ## Basic usage @@ -85,7 +85,7 @@ Key Vault secret names support only characters in `[0-9a-zA-Z-]`. For more infor #### Use property placeholders -For example, suppose you're setting this property in your *application.properties* file: +For example, suppose you're setting this property in your **application.properties** file: ```properties property.with.special.character__=${propertyWithoutSpecialCharacter} @@ -136,18 +136,18 @@ public static void main(String[] args) { > [!div class="mx-tdBreakAll"] > | Property | Default value | Description | > |--------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------| -> | *spring.cloud.azure.keyvault.secret*.property-source-enabled | true | Whether to enable the Key Vault property source. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].name | | Name of this property source. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].endpoint | | Azure Key Vault endpoint. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].case-sensitive | false | Whether the secret keys are case-sensitive. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].secret-keys | | The secret keys supported for this property source. All keys be retrieved if this property is missing. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].refresh-interval | 30m | Time interval to refresh all Key Vault secrets. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].service-version | | Secret service version used when making API requests. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].client | | Client related properties. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].credential | | Credential related properties. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].profile | | Profile related properties. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].proxy | | Proxy related properties. | -> | *spring.cloud.azure.keyvault.secret*.property-sources[].retry | | Retry related properties. | +> | `*spring.cloud.azure.keyvault.secret*.property-source-enabled` | true | Whether to enable the Key Vault property source. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].name` | | Name of this property source. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].endpoint` | | Azure Key Vault endpoint. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].case-sensitive` | false | Whether the secret keys are case-sensitive. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].secret-keys` | | The secret keys supported for this property source. All keys be retrieved if this property is missing. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].refresh-interval` | 30m | Time interval to refresh all Key Vault secrets. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].service-version` | | Secret service version used when making API requests. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].client` | | Client related properties. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].credential` | | Credential related properties. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].profile` | | Profile related properties. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].proxy` | | Proxy related properties. | +> | `*spring.cloud.azure.keyvault.secret*.property-sources[].retry` | | Retry related properties. | * See [Authorize access with Microsoft Entra ID](authentication.md#authorize-access-with-azure-active-directory) to make sure the [security principal](/azure/active-directory/develop/app-objects-and-service-principals#service-principal-object) has been granted the sufficient permission to access the Azure Key Vault Secrets. * If common properties like `client`, `credential`, `profile`, `proxy`, `retry` aren't configured in `spring.cloud.azure.keyvault.secret.property-sources[].xxx`, `spring.cloud.azure.xxx` will be used. See [Spring Cloud Azure configuration](configuration-properties-global.md) to get more information about these common properties. diff --git a/articles/java/spring-framework/secure-your-restful-api-using-spring-cloud-azure.md b/articles/java/spring-framework/secure-your-restful-api-using-spring-cloud-azure.md index 12390ae9b9..9639833c41 100644 --- a/articles/java/spring-framework/secure-your-restful-api-using-spring-cloud-azure.md +++ b/articles/java/spring-framework/secure-your-restful-api-using-spring-cloud-azure.md @@ -86,7 +86,7 @@ Next, enable the REST API protection with Spring Cloud Azure. ### Add Security dependencies -To install the Spring Cloud Azure Starter Azure Active Directory module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Starter Azure Active Directory module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -106,7 +106,7 @@ To install the Spring Cloud Azure Starter Azure Active Directory module, add the > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Starter Microsoft Entra artifact: diff --git a/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md b/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md index 476f242b33..a277db36e4 100644 --- a/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md +++ b/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md @@ -54,11 +54,11 @@ This scenario uses the [The OAuth 2.0 authorization code grant](/azure/active-di To use the Microsoft Entra starter in this scenario, use the following steps: -Set the redirect URI to *\/login/oauth2/code/*. For example: `http://localhost:8080/login/oauth2/code/`. Be sure to include the trailing `/`. For more information about the redirect URI, see [Add a redirect URI](/azure/active-directory/develop/quickstart-register-app#add-a-redirect-uri) in [Quickstart: Register an application with the Microsoft identity platform](/azure/active-directory/develop/quickstart-register-app). +Set the redirect URI to `application-base-uri>/login/oauth2/code/`. For example: `http://localhost:8080/login/oauth2/code/`. Be sure to include the trailing `/`. For more information about the redirect URI, see [Add a redirect URI](/azure/active-directory/develop/quickstart-register-app#add-a-redirect-uri) in [Quickstart: Register an application with the Microsoft identity platform](/azure/active-directory/develop/quickstart-register-app). :::image type="content" source="media/spring-boot-starter-for-entra-developer-guide/web-application-set-redirect-uri-2.png" alt-text="Screenshot of Azure portal showing web app authentication page with redirect URI highlighted."::: -Add the following dependencies to your *pom.xml* file. +Add the following dependencies to your **pom.xml** file. ```xml @@ -74,7 +74,7 @@ Add the following dependencies to your *pom.xml* file. > [!NOTE] > For more information about how to manage Spring Cloud Azure library versions by using a bill of materials (BOM), see the [Getting started](developer-guide-overview.md#getting-started) section of the [Spring Cloud Azure developer guide](developer-guide-overview.md). -Add the following properties to your *application.yml* file. You can get the values for these properties from the app registration you created in the Azure portal, as described in the prerequisites. +Add the following properties to your **application.yml** file. You can get the values for these properties from the app registration you created in the Azure portal, as described in the prerequisites. ```yaml spring: @@ -161,7 +161,7 @@ To use the Microsoft Entra starter in this scenario, use the following steps: Set the redirect URI as described previously. -Add the following dependencies to your *pom.xml* file. +Add the following dependencies to your **pom.xml** file. ```xml @@ -177,7 +177,7 @@ Add the following dependencies to your *pom.xml* file. > [!NOTE] > For more information about how to manage Spring Cloud Azure library versions by using a bill of materials (BOM), see the [Getting started](developer-guide-overview.md#getting-started) section of the [Spring Cloud Azure developer guide](developer-guide-overview.md). -Add the following properties to your *application.yml* file, as described previously: +Add the following properties to your **application.yml** file, as described previously: ```yaml spring: @@ -224,7 +224,7 @@ This scenario doesn't support sign in, but protects the server by validating the To use the Microsoft Entra starter in this scenario, use the following steps: -Add the following dependencies to your *pom.xml* file. +Add the following dependencies to your **pom.xml** file. ```xml @@ -240,7 +240,7 @@ Add the following dependencies to your *pom.xml* file. > [!NOTE] > For more information about how to manage Spring Cloud Azure library versions by using a bill of materials (BOM), see the [Getting started](developer-guide-overview.md#getting-started) section of the [Spring Cloud Azure developer guide](developer-guide-overview.md). -Add the following properties to your *application.yml* file, as described previously: +Add the following properties to your **application.yml** file, as described previously: ```yaml spring: @@ -253,7 +253,7 @@ spring: app-id-uri: ``` -You can use both the *\* and *\* values to verify the access token. You can get the *\* value from the Azure portal, as shown in the following images: +You can use both the `` and `` values to verify the access token. You can get the `` value from the Azure portal, as shown in the following images: :::image type="content" source="media/spring-boot-starter-for-entra-developer-guide/get-app-id-uri-2.png" alt-text="Screenshot of Azure portal showing web app Expose an API page with Application ID URI highlighted."::: @@ -325,7 +325,7 @@ This scenario supports a resource server visiting other resource servers. To use the Microsoft Entra starter in this scenario, use the following steps: -Add the following dependencies to your *pom.xml* file. +Add the following dependencies to your **pom.xml** file. ```xml @@ -345,7 +345,7 @@ Add the following dependencies to your *pom.xml* file. > [!NOTE] > For more information about how to manage Spring Cloud Azure library versions by using a bill of materials (BOM), see the [Getting started](developer-guide-overview.md#getting-started) section of the [Spring Cloud Azure developer guide](developer-guide-overview.md). -Add the following properties to your *application.yml* file: +Add the following properties to your **application.yml** file: ```yaml spring: @@ -386,7 +386,7 @@ This scenario supports [Access a web application](#access-a-web-application) and To use `aad-starter` in this scenario, follow these steps: -Add the following dependencies to your *pom.xml* file. +Add the following dependencies to your **pom.xml** file. ```xml @@ -406,7 +406,7 @@ Add the following dependencies to your *pom.xml* file. > [!NOTE] > For more information about how to manage Spring Cloud Azure library versions by using a bill of materials (BOM), see the [Getting started](developer-guide-overview.md#getting-started) section of the [Spring Cloud Azure developer guide](developer-guide-overview.md). -Update your *application.yml* file. Set property `spring.cloud.azure.active-directory.application-type` to `web_application_and_resource_server`, and specify the authorization type for each authorization client, as shown in the following example. +Update your **application.yml** file. Set property `spring.cloud.azure.active-directory.application-type` to `web_application_and_resource_server`, and specify the authorization type for each authorization client, as shown in the following example. ```yaml spring: @@ -524,15 +524,15 @@ The Spring Boot Starter for Microsoft Entra ID provides the following properties | Properties | Description | |----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| spring.cloud.azure.active-directory.app-id-uri | Used by the resource server to validate the audience in the access token. The access token is valid only when the audience is equal to the *\* or *\* values described previously. | +| spring.cloud.azure.active-directory.app-id-uri | Used by the resource server to validate the audience in the access token. The access token is valid only when the audience is equal to the `` or `` values described previously. | | spring.cloud.azure.active-directory.authorization-clients | A map that configures the resource APIs the application is going to visit. Each item corresponds to one resource API the application is going to visit. In your Spring code, each item corresponds to one `OAuth2AuthorizedClient` object. | -| spring.cloud.azure.active-directory.authorization-clients.*\*.scopes | The API permissions of a resource server that the application is going to acquire. | -| spring.cloud.azure.active-directory.authorization-clients.*\*.authorization-grant-type | The type of authorization client. Supported types are [authorization_code](/azure/active-directory/develop/v2-oauth2-auth-code-flow) (default type for webapp), [on_behalf_of](/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) (default type for resource-server), [client_credentials](/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow). | +| `spring.cloud.azure.active-directory.authorization-clients..scopes` | The API permissions of a resource server that the application is going to acquire. | +| `spring.cloud.azure.active-directory.authorization-clients..authorization-grant-type` | The type of authorization client. Supported types are [authorization_code](/azure/active-directory/develop/v2-oauth2-auth-code-flow) (default type for webapp), [on_behalf_of](/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) (default type for resource-server), [client_credentials](/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow). | | spring.cloud.azure.active-directory.application-type | Refer to [Application type](#application-type). | | spring.cloud.azure.active-directory.profile.environment.active-directory-endpoint | The base URI for the authorization server. The default value is `https://login.microsoftonline.com/`. | | spring.cloud.azure.active-directory.credential.client-id | The registered application ID in Microsoft Entra ID. | | spring.cloud.azure.active-directory.credential.client-secret | The client secret of the registered application. | -| spring.cloud.azure.active-directory.user-group.use-transitive-members | Use `v1.0/me/transitiveMemberOf` to get groups if set to *true*. Otherwise, use `/v1.0/me/memberOf`. | +| spring.cloud.azure.active-directory.user-group.use-transitive-members | Use `v1.0/me/transitiveMemberOf` to get groups if set to `true`. Otherwise, use `/v1.0/me/memberOf`. | | spring.cloud.azure.active-directory.post-logout-redirect-uri | The redirect URI for posting the sign-out. | | spring.cloud.azure.active-directory.profile.tenant-id | The Azure tenant ID. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. | | spring.cloud.azure.active-directory.user-group.allowed-group-names | The expected user groups that an authority will be granted to if found in the response from the `MemberOf` Graph API call. | @@ -542,7 +542,7 @@ The following examples show you how to use these properties: **Property example 1:** To use [Azure China 21Vianet](/azure/china/resources-developer-guide#check-endpoints-in-azure) instead of Azure Global, use the following step. -- Add the following properties to your *application.yml* file: +- Add the following properties to your **application.yml** file: ```yaml spring: @@ -559,7 +559,7 @@ With this method, you can use an [Azure sovereign or national cloud](/azure/acti **Property example 2:** To use a group name to protect some method in a web application, use the following steps: -Add the following property to your *application.yml* file: +Add the following property to your **application.yml** file: ```yaml spring: @@ -665,7 +665,7 @@ public class RoleController { **Property example 3:** To enable client credential flow in a resource server visiting resource servers, use the following steps: -Add the following property to your *application.yml* file: +Add the following property to your **application.yml** file: ```yaml spring: @@ -758,9 +758,9 @@ The Azure SDKs for Java offer a consistent logging story to help troubleshoot an ### Enable Spring logging -Spring enables all the supported logging systems to set logger levels in the Spring environment (for example, in *application.properties*) by using `logging.level.=` where level is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF. You can configure the root logger by using `logging.level.root`. +Spring enables all the supported logging systems to set logger levels in the Spring environment (for example, in **application.properties**) by using `logging.level.=` where level is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF. You can configure the root logger by using `logging.level.root`. -The following example shows potential logging settings in the *application.properties* file: +The following example shows potential logging settings in the **application.properties** file: ```properties logging.level.root=WARN diff --git a/articles/java/spring-framework/spring-cloud-azure-overview.md b/articles/java/spring-framework/spring-cloud-azure-overview.md index a6815ec973..bfd433a637 100644 --- a/articles/java/spring-framework/spring-cloud-azure-overview.md +++ b/articles/java/spring-framework/spring-cloud-azure-overview.md @@ -40,7 +40,7 @@ The following section demonstrates the benefits of using Spring Cloud Azure. In Without Spring Cloud Azure, if you want to retrieve secrets stored in Azure Key Vault, you need to the following steps: -1. Add the following dependencies to your *pom.xml* file: +1. Add the following dependencies to your **pom.xml** file: ```xml @@ -149,7 +149,7 @@ Without Spring Cloud Azure, if you want to retrieve secrets stored in Azure Key } ``` -1. Add the necessary properties to your *application.yml* file, as shown in the following example: +1. Add the necessary properties to your **application.yml** file, as shown in the following example: ```yaml azure: @@ -166,7 +166,7 @@ Without Spring Cloud Azure, if you want to retrieve secrets stored in Azure Key With Spring Cloud Azure, if you want to retrieve secrets stored in Azure Key Vault, the requirements are simpler, as shown in the following steps: -1. Add the following dependencies to your *pom.xml* file: +1. Add the following dependencies to your **pom.xml** file: ```xml @@ -195,10 +195,10 @@ With Spring Cloud Azure, if you want to retrieve secrets stored in Azure Key Vau > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). -1. Add the following properties to your *application.yml* file: +1. Add the following properties to your **application.yml** file: ```yaml spring: diff --git a/articles/java/spring-framework/spring-cloud-stream-support.md b/articles/java/spring-framework/spring-cloud-stream-support.md index e776c27ef1..7c7ebcfb69 100644 --- a/articles/java/spring-framework/spring-cloud-stream-support.md +++ b/articles/java/spring-framework/spring-cloud-stream-support.md @@ -197,7 +197,7 @@ The above [connection](#connection-configuration-properties) and [common Azure S 1. Fill the configuration options with credential information. - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -227,7 +227,7 @@ The above [connection](#connection-configuration-properties) and [common Azure S mode: MANUAL ``` - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: @@ -264,7 +264,7 @@ The above [connection](#connection-configuration-properties) and [common Azure S > [!NOTE] > The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. For more information about these values, see the [Used the wrong endpoint (personal and organization accounts)](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist#cause-3-used-the-wrong-endpoint-personal-and-organization-accounts) section of [Error AADSTS50020 - User account from identity provider does not exist in tenant](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist). For information on converting your single-tenant app, see [Convert single-tenant app to multitenant on Microsoft Entra ID](/entra/identity-platform/howto-convert-app-to-be-multi-tenant). - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -572,7 +572,7 @@ For the basic message headers supported, see the [Event Hubs message headers](sp Connection to multiple Event Hubs namespaces is also supported by using multiple binders. This sample takes a connection string as example. Credentials of service principals and managed identities are also supported. You can set related properties in each binder's environment settings. -1. To use multiple binders with Event Hubs, configure the following properties in your *application.yml* file: +1. To use multiple binders with Event Hubs, configure the following properties in your **application.yml** file: ```yaml spring: @@ -837,7 +837,7 @@ The above [connection](#connection-configuration-properties-1) and [common Azure 1. Fill the configuration options with credential information. - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -865,7 +865,7 @@ The above [connection](#connection-configuration-properties-1) and [common Azure entity-type: queue # set as "topic" if you use Service Bus Topic ``` - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: @@ -901,7 +901,7 @@ The above [connection](#connection-configuration-properties-1) and [common Azure > [!NOTE] > The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. For more information about these values, see the [Used the wrong endpoint (personal and organization accounts)](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist#cause-3-used-the-wrong-endpoint-personal-and-organization-accounts) section of [Error AADSTS50020 - User account from identity provider does not exist in tenant](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist). For information on converting your single-tenant app, see [Convert single-tenant app to multitenant on Microsoft Entra ID](/entra/identity-platform/howto-convert-app-to-be-multi-tenant). - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -1153,7 +1153,7 @@ For the basic message headers supported, see the [Service Bus message headers](s Connection to multiple Service Bus namespaces is also supported by using multiple binders. This sample takes connection string as example. Credentials of service principals and managed identities are also supported, users can set related properties in each binder's environment settings. -1. To use multiple binders of ServiceBus, configure the following properties in your *application.yml* file: +1. To use multiple binders of ServiceBus, configure the following properties in your **application.yml** file: ```yaml spring: diff --git a/articles/java/spring-framework/spring-data-support.md b/articles/java/spring-framework/spring-data-support.md index 72a3e4a345..aae433ede0 100644 --- a/articles/java/spring-framework/spring-data-support.md +++ b/articles/java/spring-framework/spring-data-support.md @@ -37,19 +37,19 @@ The following table lists the configurable properties of `spring-cloud-azure-sta > [!div class="mx-tdBreakAll"] > | Property | Description | > |--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| -> | *spring.cloud.azure.cosmos*.enabled | A value that indicates whether Azure Cosmos DB Service is enabled. The default value is *true*. | -> | *spring.cloud.azure.cosmos*.database | The Azure Cosmos DB database ID. | -> | *spring.cloud.azure.cosmos*.endpoint | The URI to connect Azure Cosmos DB. | -> | *spring.cloud.azure.cosmos*.key | The PrivateKey to connect Azure Cosmos DB. | -> | *spring.cloud.azure.cosmos*.credential.client-certificate-password | The password of the certificate file. | -> | *spring.cloud.azure.cosmos*.credential.client-certificate-path | The path of a PEM certificate file to use when performing service principal authentication with Azure. | -> | *spring.cloud.azure.cosmos*.credential.client-id | The client ID to use when performing service principal authentication with Azure. | -> | *spring.cloud.azure.cosmos*.credential.client-secret | The client secret to use when performing service principal authentication with Azure. | -> | *spring.cloud.azure.cosmos*.credential.managed-identity-enabled | Whether to enable managed identity. The default value is *false*. | -> | *spring.cloud.azure.cosmos*.credential.password | The password to use when performing username/password authentication with Azure. | -> | *spring.cloud.azure.cosmos*.credential.username | The username to use when performing username/password authentication with Azure. | -> | *spring.cloud.azure.cosmos*.populate-query-metrics | A value that indicates whether to populate diagnostics strings and query metrics. The default value is *false*. | -> | *spring.cloud.azure.cosmos*.consistency-level | A [consistency level](/azure/cosmos-db/consistency-levels) for Azure Cosmos DB. | +> | `*spring.cloud.azure.cosmos*.enabled` | A value that indicates whether Azure Cosmos DB Service is enabled. The default value is `true`. | +> | `*spring.cloud.azure.cosmos*.database` | The Azure Cosmos DB database ID. | +> | `*spring.cloud.azure.cosmos*.endpoint` | The URI to connect Azure Cosmos DB. | +> | `*spring.cloud.azure.cosmos*.key` | The PrivateKey to connect Azure Cosmos DB. | +> | `*spring.cloud.azure.cosmos*.credential.client-certificate-password` | The password of the certificate file. | +> | `*spring.cloud.azure.cosmos*.credential.client-certificate-path` | The path of a PEM certificate file to use when performing service principal authentication with Azure. | +> | `*spring.cloud.azure.cosmos*.credential.client-id` | The client ID to use when performing service principal authentication with Azure. | +> | `*spring.cloud.azure.cosmos*.credential.client-secret` | The client secret to use when performing service principal authentication with Azure. | +> | `*spring.cloud.azure.cosmos*.credential.managed-identity-enabled` | Whether to enable managed identity. The default value is `false`. | +> | `*spring.cloud.azure.cosmos*.credential.password` | The password to use when performing username/password authentication with Azure. | +> | `*spring.cloud.azure.cosmos*.credential.username` | The username to use when performing username/password authentication with Azure. | +> | `*spring.cloud.azure.cosmos*.populate-query-metrics` | A value that indicates whether to populate diagnostics strings and query metrics. The default value is `false`. | +> | `*spring.cloud.azure.cosmos*.consistency-level` | A [consistency level](/azure/cosmos-db/consistency-levels) for Azure Cosmos DB. | ### Key concepts @@ -67,7 +67,7 @@ The following list shows the key concepts of the Spring Data support: * The Spring Data [@Id](https://github.com/spring-projects/spring-data-commons/blob/db62390de90c93a78743c97cc2cc9ccd964994a5/src/main/java/org/springframework/data/annotation/Id.java) annotation. There are two ways to map a field in a domain class to the `id` of an Azure Cosmos DB document: * Annotate a field in domain class with `@Id`. This field will be mapped to document `id` in Azure Cosmos DB. - * Set the name of this field to `id`. This field will be mapped to document `id` in Azure Cosmos DB. + `*` Set the name of this field to `id`. This field will be mapped to document `id` in Azure Cosmos DB. > [!NOTE] > If both ways are applied, the `@Id` annotation has higher priority. diff --git a/articles/java/spring-framework/spring-integration-support.md b/articles/java/spring-framework/spring-integration-support.md index a011d284ad..663150c56d 100644 --- a/articles/java/spring-framework/spring-integration-support.md +++ b/articles/java/spring-framework/spring-integration-support.md @@ -115,7 +115,7 @@ developers can use `EventHubsContainerProperties` for the configuration. See [th 1. Fill the credential configuration options. - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -130,7 +130,7 @@ developers can use `EventHubsContainerProperties` for the configuration. See [th account-key: ${CHECKPOINT-ACCESS-KEY} ``` - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -147,7 +147,7 @@ developers can use `EventHubsContainerProperties` for the configuration. See [th account-name: ${ACCOUNT_NAME} ``` - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: @@ -415,7 +415,7 @@ developers can use `ServiceBusContainerProperties` for the configuration. See [t 1. Fill the credential configuration options. - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -425,7 +425,7 @@ developers can use `ServiceBusContainerProperties` for the configuration. See [t connection-string: ${AZURE_SERVICE_BUS_CONNECTION_STRING} ``` - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -443,7 +443,7 @@ developers can use `ServiceBusContainerProperties` for the configuration. See [t > [!NOTE] > The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. For more information about these values, see the [Used the wrong endpoint (personal and organization accounts)](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist#cause-3-used-the-wrong-endpoint-personal-and-organization-accounts) section of [Error AADSTS50020 - User account from identity provider does not exist in tenant](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist). For information on converting your single-tenant app, see [Convert single-tenant app to multitenant on Microsoft Entra ID](/entra/identity-platform/howto-convert-app-to-be-multi-tenant). - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: @@ -615,7 +615,7 @@ Mapping between Service Bus Headers and Spring Headers: This starter supports [Service Bus partitioning](/azure/service-bus-messaging/service-bus-partitioning) by allowing setting partition key and session ID in the message header. This section introduces how to set partition key for messages. -*Recommended:* Use `ServiceBusMessageHeaders.PARTITION_KEY` as the key of the header. +Recommended: Use `ServiceBusMessageHeaders.PARTITION_KEY` as the key of the header. ```java public class SampleController { @@ -630,7 +630,7 @@ public class SampleController { } ``` -*Not recommended but currently supported:* `AzureHeaders.PARTITION_KEY` as the key of the header. +Not recommended but currently supported: `AzureHeaders.PARTITION_KEY` as the key of the header. ```java public class SampleController { @@ -730,7 +730,7 @@ Connection configurable properties of spring-cloud-azure-starter-integration-sto 1. Fill the credential configuration options. - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -741,7 +741,7 @@ Connection configurable properties of spring-cloud-azure-starter-integration-sto connection-string: ${AZURE_STORAGE_QUEUE_CONNECTION_STRING} ``` - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -760,7 +760,7 @@ Connection configurable properties of spring-cloud-azure-starter-integration-sto > [!NOTE] > The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. For more information about these values, see the [Used the wrong endpoint (personal and organization accounts)](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist#cause-3-used-the-wrong-endpoint-personal-and-organization-accounts) section of [Error AADSTS50020 - User account from identity provider does not exist in tenant](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist). For information on converting your single-tenant app, see [Convert single-tenant app to multitenant on Microsoft Entra ID](/entra/identity-platform/howto-convert-app-to-be-multi-tenant). - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: diff --git a/articles/java/spring-framework/spring-jms-support.md b/articles/java/spring-framework/spring-jms-support.md index 51336c7e2a..fed729f074 100644 --- a/articles/java/spring-framework/spring-jms-support.md +++ b/articles/java/spring-framework/spring-jms-support.md @@ -54,7 +54,7 @@ The following table describes the configurable properties when using the Spring > | **spring.jms.servicebus**.enabled | A value that indicates whether to enable Service Bus JMS autoconfiguration. The default value is `true`. | > | **spring.jms.servicebus**.idle-timeout | The connection idle timeout duration that indicates how long the client expects Service Bus to keep a connection alive when no messages are delivered. The default value is `2m`. | > | **spring.jms.servicebus**.passwordless-enabled | Whether to enable passwordless for Azure Service Bus JMS. The default value is `false`. | -> | **spring.jms.servicebus**.pricing-tier | The Azure Service Bus Price Tier. Supported values are *premium* and *standard*. Premium tier uses Java Message Service (JMS) 2.0, while standard tier use JMS 1.1 to interact with Azure Service Bus. | +> | **spring.jms.servicebus**.pricing-tier | The Azure Service Bus Price Tier. Supported values are `premium and `standard`. Premium tier uses Java Message Service (JMS) 2.0, while standard tier use JMS 1.1 to interact with Azure Service Bus. | > | **spring.jms.servicebus**.listener.reply-pub-sub-domain | A value that indicates whether the reply destination type is a topic. Only works for the `topicJmsListenerContainerFactory` bean. | > | **spring.jms.servicebus**.listener.phase | The phase in which this container should be started and stopped. | > | **spring.jms.servicebus**.listener.reply-qos-settings | Configures the `QosSettings` to use when sending a reply. | @@ -83,7 +83,7 @@ For more information, see [Spring JMS Document](https://docs.spring.io/spring-fr ### Connect to Azure Service Bus JMS using passwordless -Configure the following properties in your *application.yml* file: +Configure the following properties in your **application.yml** file: ```yaml spring: @@ -101,7 +101,7 @@ spring: 1. To use the managed identity, enable the managed identity for your service and assign the `Azure Service Bus Data Owner` role. For more information, see [Authenticate a managed identity with Microsoft Entra ID to access Azure Service Bus resources](/azure/service-bus-messaging/service-bus-managed-service-identity). -1. Configure the following properties in your *application.yml* file: +1. Configure the following properties in your **application.yml** file: ```yaml spring: diff --git a/articles/java/spring-framework/spring-messaging-support.md b/articles/java/spring-framework/spring-messaging-support.md index cba3b26097..f6bc9206ea 100644 --- a/articles/java/spring-framework/spring-messaging-support.md +++ b/articles/java/spring-framework/spring-messaging-support.md @@ -22,7 +22,7 @@ This article describes how you can use Spring Cloud Azure and Spring Messaging t ### Key concepts -Azure Event Hubs is a native data-streaming service in the cloud that can stream millions of events per second, with low latency, from any source to any destination. The Spring Messaging for Azure Event Hubs project applies core Spring concepts to the development of event hubs-based messaging solutions. It provides a *template* as a high-level abstraction for sending messages. It also provides support for message-driven plain old Java objects ( ) with `@EventHubsListener` annotations and a *listener container*. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. +Azure Event Hubs is a native data-streaming service in the cloud that can stream millions of events per second, with low latency, from any source to any destination. The Spring Messaging for Azure Event Hubs project applies core Spring concepts to the development of event hubs-based messaging solutions. It provides a template as a high-level abstraction for sending messages. It also provides support for message-driven plain old Java objects ( ) with `@EventHubsListener` annotations and a listener container. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. ### Dependency setup @@ -63,7 +63,7 @@ Use the following steps to send messages: 1. Fill in the credential configuration options using one of the following approaches: - * For credentials as `DefaultAzureCredential`, configure the following properties in your *application.yml* file: + * For credentials as `DefaultAzureCredential`, configure the following properties in your **application.yml** file: ```yaml spring: @@ -77,7 +77,7 @@ Use the following steps to send messages: account-name: ${CHECKPOINT-STORAGE-ACCOUNT} ``` - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -92,7 +92,7 @@ Use the following steps to send messages: account-key: ${CHECKPOINT-ACCESS-KEY} ``` - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -109,7 +109,7 @@ Use the following steps to send messages: account-name: ${ACCOUNT_NAME} ``` - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: @@ -190,7 +190,7 @@ For more information, see the [azure-spring-boot-samples](https://github.com/Azu ### Key concepts -Azure Service Bus is a fully managed enterprise message broker with message queues and publish-subscribe topics. The Spring Messaging for Azure Service Bus project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a *template* as a high-level abstraction for sending messages. It also provides support for message-driven POJOs with `@ServiceBusListener` annotations and a *listener container*. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. +Azure Service Bus is a fully managed enterprise message broker with message queues and publish-subscribe topics. The Spring Messaging for Azure Service Bus project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a template as a high-level abstraction for sending messages. It also provides support for message-driven POJOs with `@ServiceBusListener` annotations and a listener container. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. ### Dependency setup @@ -226,7 +226,7 @@ Use the following steps to send messages: 1. Fill in the credential configuration options using one of the following approaches: - * For credentials as `DefaultAzureCredential`, configure the following properties in your *application.yml* file: + * For credentials as `DefaultAzureCredential`, configure the following properties in your **application.yml** file: ```yaml spring: @@ -237,7 +237,7 @@ Use the following steps to send messages: entity-type: ${AZURE_SERVICE_BUS_ENTITY_TYPE} ``` - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -248,7 +248,7 @@ Use the following steps to send messages: entity-type: ${AZURE_SERVICE_BUS_ENTITY_TYPE} ``` - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -267,7 +267,7 @@ Use the following steps to send messages: > [!NOTE] > The following values are allowed for `tenant-id`: `common`, `organizations`, `consumers`, or the tenant ID. For more information about these values, see the [Used the wrong endpoint (personal and organization accounts)](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist#cause-3-used-the-wrong-endpoint-personal-and-organization-accounts) section of [Error AADSTS50020 - User account from identity provider does not exist in tenant](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist). For information on converting your single-tenant app, see [Convert single-tenant app to multitenant on Microsoft Entra ID](/entra/identity-platform/howto-convert-app-to-be-multi-tenant). - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: @@ -356,7 +356,7 @@ For more information, see the [azure-spring-boot-samples](https://github.com/Azu ### Key concepts -Azure Queue Storage is a service for storing large numbers of messages. You access messages from anywhere in the world via authenticated calls using HTTP or HTTPS. A queue message can be up to 64 KB in size. A queue can contain millions of messages, up to the total capacity limit of a storage account. Queues are commonly used to create a backlog of work to process asynchronously. The Spring Messaging for Azure Queue Storage project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a *template* as a high-level abstraction for sending and receiving messages. These libraries promote the use of dependency injection and declarative configuration. +Azure Queue Storage is a service for storing large numbers of messages. You access messages from anywhere in the world via authenticated calls using HTTP or HTTPS. A queue message can be up to 64 KB in size. A queue can contain millions of messages, up to the total capacity limit of a storage account. Queues are commonly used to create a backlog of work to process asynchronously. The Spring Messaging for Azure Queue Storage project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a template as a high-level abstraction for sending and receiving messages. These libraries promote the use of dependency injection and declarative configuration. ### Dependency setup @@ -391,7 +391,7 @@ Use the following steps to send and receive messages: 1. Fill in the credential configuration options using one of the following approaches: - * For credentials as `DefaultAzureCredential`, configure the following properties in your *application.yml* file: + * For credentials as `DefaultAzureCredential`, configure the following properties in your **application.yml** file: ```yaml spring: @@ -402,7 +402,7 @@ Use the following steps to send and receive messages: account-name: ${AZURE_STORAGE_QUEUE_ACCOUNT_NAME} ``` - * For credentials as connection string, configure the following properties in your *application.yml* file: + * For credentials as connection string, configure the following properties in your **application.yml** file: ```yaml spring: @@ -413,7 +413,7 @@ Use the following steps to send and receive messages: connection-string: ${AZURE_STORAGE_QUEUE_CONNECTION_STRING} ``` - * For credentials as managed identities, configure the following properties in your *application.yml* file: + * For credentials as managed identities, configure the following properties in your **application.yml** file: ```yaml spring: @@ -432,7 +432,7 @@ Use the following steps to send and receive messages: > [!NOTE] > The following values are allowed for `tenant-id`: `common`, `organizations`, `consumers`, or the tenant ID. For more information about these values, see the [Used the wrong endpoint (personal and organization accounts)](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist#cause-3-used-the-wrong-endpoint-personal-and-organization-accounts) section of [Error AADSTS50020 - User account from identity provider does not exist in tenant](/troubleshoot/azure/active-directory/error-code-aadsts50020-user-account-identity-provider-does-not-exist). For information on converting your single-tenant app, see [Convert single-tenant app to multitenant on Microsoft Entra ID](/entra/identity-platform/howto-convert-app-to-be-multi-tenant). - * For credentials as service principal, configure the following properties in your *application.yml* file: + * For credentials as service principal, configure the following properties in your **application.yml** file: ```yaml spring: diff --git a/articles/java/spring-framework/spring-security-support.md b/articles/java/spring-framework/spring-security-support.md index 67f455482c..5737872f06 100644 --- a/articles/java/spring-framework/spring-security-support.md +++ b/articles/java/spring-framework/spring-security-support.md @@ -238,7 +238,7 @@ Developers can customize the redirect-uri. :::image type="content" source="media/spring-cloud-azure/system-diagram-redirect-uri.png" alt-text="System diagram for redirect URIs." border="false"::: -Add `redirect-uri-template` properties in your *application.yml* file. +Add `redirect-uri-template` properties in your **application.yml** file. ```yaml spring: @@ -642,8 +642,8 @@ By doing this, when access `/app-role1` endpoint, the following claims in access To use a JSON Web Token (JWT) for client authentication, use the following steps: 1. See the [Register your certificate with Microsoft identity platform](/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-microsoft-identity-platform) section of [Microsoft identity platform application authentication certificate credentials](/azure/active-directory/develop/active-directory-certificate-credentials). -1. Upload a *.pem* certificate to the application registered in the Azure portal. -1. Configure the certificate path and password of a *.PFX* or *.P12* certificate. +1. Upload a **.pem** certificate to the application registered in the Azure portal. +1. Configure the certificate path and password of a **.PFX** or **.P12** certificate. 1. Add the property `spring.cloud.azure.active-directory.authorization-clients.azure.client-authentication-method=private_key_jwt` configuration to the client to be authenticated through JWT client authentication. The following example configuration file is for a web application scenario. The certificate information is configured in the global properties. @@ -1055,7 +1055,7 @@ Grant admin consent for ***Graph*** permissions. :::image type="content" source="media/spring-cloud-azure/add-graph-permissions.png" alt-text="Azure portal screenshot showing API permissions screen for an app, with graph permissions highlighted." lightbox="media/spring-cloud-azure/add-graph-permissions.png"::: -Add the following dependencies to your *pom.xml* file. +Add the following dependencies to your **pom.xml** file. ##### [Spring Cloud Azure 5.x](#tab/SpringCloudAzure5x) @@ -1113,7 +1113,7 @@ Add the following dependencies to your *pom.xml* file. --- -Add properties to your *application.yml* file using the values you created earlier, as shown in the following example: +Add properties to your **application.yml** file using the values you created earlier, as shown in the following example: ```yaml spring: @@ -1216,9 +1216,9 @@ public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter { --- -Copy the *home.html* from [aad-b2c-web-application sample](https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/aad/spring-cloud-azure-starter-active-directory-b2c/aad-b2c-web-application/src/main/resources/templates/home.html), and replace the `PROFILE_EDIT_USER_FLOW` and `PASSWORD_RESET_USER_FLOW` with your user flow names that you used previously. +Copy the **home.html** from [aad-b2c-web-application sample](https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/aad/spring-cloud-azure-starter-active-directory-b2c/aad-b2c-web-application/src/main/resources/templates/home.html), and replace the `PROFILE_EDIT_USER_FLOW` and `PASSWORD_RESET_USER_FLOW` with your user flow names that you used previously. -Build and test your app. Let `Webapp` run on port *8080*. +Build and test your app. Let `Webapp` run on port `8080`. After your application is built and started by Maven, open `http://localhost:8080/` in a web browser. You should be redirected to the login page. @@ -1334,7 +1334,7 @@ public class SampleConfiguration { To write your `WebApiA` Java code, see the **Accessing a resource server** section. -Build and test your app. Let `Webapp` and `WebApiA` run on port *8080* and *8081* respectively. Start the `Webapp` and `WebApiA` applications. Return to the home page after logging in successfully. You can then access `http://localhost:8080/webapp/webApiA` to get the `WebApiA` resource response. +Build and test your app. Let `Webapp` and `WebApiA` run on port `8080` and `8081` respectively. Start the `Webapp` and `WebApiA` applications. Return to the home page after logging in successfully. You can then access `http://localhost:8080/webapp/webApiA` to get the `WebApiA` resource response. #### Usage 3: Accessing a resource server @@ -1344,7 +1344,7 @@ To build your `WebApiA` permission, see [Usage 2: Web Application Accessing Reso Add `WebApiA` permission and grant admin consent for your web application. -Add the following dependencies to your *pom.xml* file. +Add the following dependencies to your **pom.xml** file. ```xml @@ -1446,7 +1446,7 @@ public class ResourceServerConfiguration extends WebSecurityConfigurerAdapter { --- -Build and test your app. Let `WebApiA` run on port *8081*. Get the access token for the `webApiA` resource and then access `http://localhost:8081/webApiA/sample` as the Bearer authorization header. +Build and test your app. Let `WebApiA` run on port `8081`. Get the access token for the `webApiA` resource and then access `http://localhost:8081/webApiA/sample` as the Bearer authorization header. #### Usage 4: Resource server accessing other resource servers @@ -1473,7 +1473,7 @@ Grant admin consent for `WebApiB` permissions. :::image type="content" source="media/spring-cloud-azure/application-api-permissions-web-api-a.png" alt-text="Azure portal screenshot showing application WebApiA API permissions screen." lightbox="media/spring-cloud-azure/application-api-permissions-web-api-a.png"::: -On the basis of **Accessing a resource server**, add the following dependency to your *pom.xml* file. +On the basis of **Accessing a resource server**, add the following dependency to your **pom.xml** file. ```xml @@ -1560,7 +1560,7 @@ public class SampleConfiguration { } ``` -Build and test your app. Let `WebApiA` and `WebApiB` run on port *8081* and *8082* respectively. Start the `WebApiA` and `WebApiB` applications, get the access token for `webApiA` resource, and access `http://localhost:8081/webApiA/webApiB/sample` as the Bearer authorization header. +Build and test your app. Let `WebApiA` and `WebApiB` run on port `8081` and `8082` respectively. Start the `WebApiA` and `WebApiB` applications, get the access token for `webApiA` resource, and access `http://localhost:8081/webApiA/webApiB/sample` as the Bearer authorization header. ### Samples diff --git a/articles/java/spring-framework/testcontainers-support.md b/articles/java/spring-framework/testcontainers-support.md index eefa47ddaa..029b56ba74 100644 --- a/articles/java/spring-framework/testcontainers-support.md +++ b/articles/java/spring-framework/testcontainers-support.md @@ -14,7 +14,7 @@ ms.custom: devx-track-java, devx-track-extended-java This article describes how to integrate Spring Cloud Azure with [Testcontainers](https://testcontainers.com/) to write effective integration tests for your applications. -*Testcontainers* is an open-source framework for providing throwaway, lightweight instances of databases, message brokers, web browsers, or just about anything that can run in a Docker container. It integrates with JUnit, enabling you to write a test class that can start up a container before any of the tests run. Testcontainers is especially useful for writing integration tests that talk to a real backend service. +Testcontainers is an open-source framework for providing throwaway, lightweight instances of databases, message brokers, web browsers, or just about anything that can run in a Docker container. It integrates with JUnit, enabling you to write a test class that can start up a container before any of the tests run. Testcontainers is especially useful for writing integration tests that talk to a real backend service. The `spring-cloud-azure-testcontainers` library now supports integration testing for the following Azure services: diff --git a/articles/java/spring-framework/using-event-hubs-in-spring-applications.md b/articles/java/spring-framework/using-event-hubs-in-spring-applications.md index edbb3d85c2..ec2debff37 100644 --- a/articles/java/spring-framework/using-event-hubs-in-spring-applications.md +++ b/articles/java/spring-framework/using-event-hubs-in-spring-applications.md @@ -52,7 +52,7 @@ The [Spring Cloud Azure Event Hubs Starter](https://mvnrepository.com/artifact/c ### Add dependencies -To install the Spring Cloud Azure Event Hubs Starter module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Event Hubs Starter module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -72,7 +72,7 @@ To install the Spring Cloud Azure Event Hubs Starter module, add the following d > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Event Hubs artifact: @@ -356,7 +356,7 @@ You can build the client beans by yourself, but the process is complicated. In S The following list shows some reasons why this code isn't flexible or graceful: - The Event Hubs namespace and event hub name are hard coded. -- If you use `@Value` to get configurations from the Spring environment, you can't have IDE hints in your *application.properties* file. +- If you use `@Value` to get configurations from the Spring environment, you can't have IDE hints in your **application.properties** file. - If you have a microservice scenario, you must duplicate the code in each project, and it's easy to make mistakes and hard to be consistent. Fortunately, building the client beans by yourself isn't necessary with Spring Cloud Azure. Instead, you can directly inject them and use the configuration properties that you're already familiar with to configure Storage queue. For more information, see [Spring Cloud Azure configuration](configuration.md). @@ -382,7 +382,7 @@ This guide shows you how to use Spring Messaging Azure Event Hubs to send messag ### Add dependencies -To install the Spring Messaging Azure Event Hubs module, add the following dependencies to your *pom.xml* file: +To install the Spring Messaging Azure Event Hubs module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -402,7 +402,7 @@ To install the Spring Messaging Azure Event Hubs module, add the following depen > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure starter, Spring Messaging Event Hubs and Azure Event Hubs Checkpoint Store artifacts: @@ -506,7 +506,7 @@ This guide shows you how to use Spring Integration Azure Event Hubs to send mess ### Add dependencies -To install the Spring Cloud Azure Event Hubs Integration Starter module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Event Hubs Integration Starter module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -526,7 +526,7 @@ To install the Spring Cloud Azure Event Hubs Integration Starter module, add the > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Event Hubs Integration artifact: @@ -695,7 +695,7 @@ This guide shows you how to use Spring Cloud Stream Event Hubs Binder to send me ### Add dependencies -To install the Spring Cloud Azure Event Hubs Stream Binder module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Event Hubs Stream Binder module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -715,7 +715,7 @@ To install the Spring Cloud Azure Event Hubs Stream Binder module, add the follo > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Event Hubs Stream Binder artifact: @@ -803,7 +803,7 @@ This guide shows you how to use Azure Event Hubs and [Spring Kafka](https://mvnr ### Add dependencies -To install the Spring Cloud Azure starter and Spring Kafka modules, adding the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure starter and Spring Kafka modules, adding the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -823,7 +823,7 @@ To install the Spring Cloud Azure starter and Spring Kafka modules, adding the f > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure starter and Spring Kafka artifact: @@ -905,7 +905,7 @@ This guide shows you how to use Azure Event Hubs and [Spring Cloud Stream Kafka ### Add dependencies -To install the Spring Cloud Azure starter and Spring Cloud Stream binder Kafka modules, adding the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure starter and Spring Cloud Stream binder Kafka modules, adding the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -925,7 +925,7 @@ To install the Spring Cloud Azure starter and Spring Cloud Stream binder Kafka m > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure starter artifact: diff --git a/articles/java/spring-framework/using-service-bus-in-spring-applications.md b/articles/java/spring-framework/using-service-bus-in-spring-applications.md index 64019fa6d4..4c9060bd24 100644 --- a/articles/java/spring-framework/using-service-bus-in-spring-applications.md +++ b/articles/java/spring-framework/using-service-bus-in-spring-applications.md @@ -14,7 +14,7 @@ This article shows you how to use Azure Service Bus in Java applications built w Azure provides an asynchronous messaging platform called [Azure Service Bus](/azure/service-bus-messaging/service-bus-messaging-overview) (Service Bus), which is based on the [Advanced Message Queueing Protocol 1.0](http://www.amqp.org/) (AMQP 1.0) standard. You can use Service Bus across the range of supported Azure platforms. -Spring Cloud Azure provides various modules for sending messages to and receiving messages from Service Bus *queues* and *topics*/*subscriptions* using Spring frameworks. +Spring Cloud Azure provides various modules for sending messages to and receiving messages from Service Bus queues and topics/subscriptions using Spring frameworks. You can use the following modules independently or combine them for different use cases: @@ -53,7 +53,7 @@ The [Spring Cloud Azure Service Bus Starter](https://mvnrepository.com/artifact/ ### Add the Service Bus dependency -To install the Spring Cloud Azure Service Bus Starter module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Service Bus Starter module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -73,7 +73,7 @@ To install the Spring Cloud Azure Service Bus Starter module, add the following > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Service Bus artifact: @@ -233,7 +233,7 @@ You can build those client beans by yourself, but the process is complicated. In ``` > [!NOTE] - > Be sure to replace the *``* placeholder with your Service Bus host name from the Azure portal. Replace the *``* placeholder with your own queue name configured in your Service Bus namespace. + > Be sure to replace the `` placeholder with your Service Bus host name from the Azure portal. Replace the `` placeholder with your own queue name configured in your Service Bus namespace. 1. Inject the client beans to your application, as shown in the following example: @@ -284,7 +284,7 @@ You can build those client beans by yourself, but the process is complicated. In The following list shows reasons why this code isn't flexible or graceful: - The namespace and queue/topic/subscription names are hard coded. -- If you use `@Value` to get configurations from the Spring environment, you can't have IDE hints in your *application.properties* file. +- If you use `@Value` to get configurations from the Spring environment, you can't have IDE hints in your **application.properties** file. - If you have a microservice scenario, you must duplicate the code in each project, and it's easy to make mistakes and hard to be consistent. Fortunately, building the client beans by yourself isn't necessary with Spring Cloud Azure. Instead, you can directly inject the beans and use the [configuration properties](spring-cloud-azure.md?tabs=maven#configuration-properties) that you're already familiar with to configure Service Bus. @@ -309,7 +309,7 @@ This guide shows you how to use Spring Cloud Azure Service Bus Starter for JMS A ### Add the Service Bus dependency -To install the Spring Cloud Azure Service Bus JMS Starter module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Service Bus JMS Starter module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -329,7 +329,7 @@ To install the Spring Cloud Azure Service Bus JMS Starter module, add the follow > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Service Bus JMS artifact: @@ -397,7 +397,7 @@ To install the Spring Cloud Azure Service Bus JMS Starter module, add the follow ``` > [!NOTE] - > Be sure to replace the *``* placeholder with your own queue name configured in your Service Bus namespace. + > Be sure to replace the `` placeholder with your own queue name configured in your Service Bus namespace. > > If you're using a topic/subscription, change the `destination` parameter as the topic name, and the `containerFactory` should be `topicJmsListenerContainerFactory`. Also, add the `subscription` parameter to describe the subscription name. @@ -422,7 +422,7 @@ To install the Spring Cloud Azure Service Bus JMS Starter module, add the follow ``` > [!NOTE] - > Be sure to replace the *``* placeholder with your own queue name configured in your Service Bus namespace. + > Be sure to replace the `` placeholder with your own queue name configured in your Service Bus namespace. > [!TIP] > Be sure to add the `@EnableIntegration` annotation, which triggers the discovery of methods annotated with `@JmsListener`, creating the message listener container under the covers. @@ -451,7 +451,7 @@ This guide shows you how to use Spring Messaging Azure Service Bus to send messa ### Add the Service Bus dependency -To install the Spring Messaging Azure Service Bus module, add the following dependencies to your *pom.xml* file: +To install the Spring Messaging Azure Service Bus module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -471,7 +471,7 @@ To install the Spring Messaging Azure Service Bus module, add the following depe > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Messaging Service Bus and Spring Cloud Azure starter artifacts: @@ -558,7 +558,7 @@ This guide shows you how to use Spring Integration Azure Service Bus to send mes ### Add the Service Bus dependency -To install the Spring Cloud Azure Service Bus Integration Starter module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Service Bus Integration Starter module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -578,7 +578,7 @@ To install the Spring Cloud Azure Service Bus Integration Starter module, add th > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Service Bus Integration artifact: @@ -717,7 +717,7 @@ This guide shows you how to use Spring Cloud Stream Service Bus Binder to send m ### Add the Service Bus dependency -To install the Spring Cloud Azure Service Bus Stream Binder module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Service Bus Stream Binder module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -737,7 +737,7 @@ To install the Spring Cloud Azure Service Bus Stream Binder module, add the foll > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Service Bus Integration artifact: @@ -772,7 +772,7 @@ To install the Spring Cloud Azure Service Bus Stream Binder module, add the foll } ``` - - Add the configuration to specify the `queue` name for consuming by replacing the *``* placeholder, as shown in the following example: + - Add the configuration to specify the `queue` name for consuming by replacing the `` placeholder, as shown in the following example: ```properties # name for the `Consumer` bean @@ -803,7 +803,7 @@ To install the Spring Cloud Azure Service Bus Stream Binder module, add the foll } ``` - - Add the configuration to specify the `queue` name for sending by replacing the *``* placeholder in the following example: + - Add the configuration to specify the `queue` name for sending by replacing the `` placeholder in the following example: ```properties # "consume" is added from the previous step diff --git a/articles/java/spring-framework/using-storage-queue-in-spring-applications.md b/articles/java/spring-framework/using-storage-queue-in-spring-applications.md index 7d6ab7318e..c78fec0b61 100644 --- a/articles/java/spring-framework/using-storage-queue-in-spring-applications.md +++ b/articles/java/spring-framework/using-storage-queue-in-spring-applications.md @@ -42,7 +42,7 @@ The Spring Cloud Azure Storage Queue Starter module imports [Azure Storage Queue ### Add dependencies -To install the Spring Cloud Azure Storage Queue Starter module, add the following dependencies to your *pom.xml* file: +To install the Spring Cloud Azure Storage Queue Starter module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -62,7 +62,7 @@ To install the Spring Cloud Azure Storage Queue Starter module, add the followin > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure Queue Storage Queue artifact: @@ -155,7 +155,7 @@ To send messages to and receive messages from Azure Storage queues, use the foll You can build the client beans by yourself, but the process is complicated. In Spring Boot applications, you have to manage properties, learn the builder pattern, and register the clients to your Spring application context. The following steps show you how to do that. -1. Build the client programmatically in your Spring application, as shown in the following example. Be sure to replace the *``* placeholder with your own value. +1. Build the client programmatically in your Spring application, as shown in the following example. Be sure to replace the **``** placeholder with your own value. ```java import com.azure.identity.DefaultAzureCredentialBuilder; @@ -210,7 +210,7 @@ You can build the client beans by yourself, but the process is complicated. In S The following list shows reasons why this code isn't flexible or graceful: - The storage account and queue names are hard coded. -- If you use `@Value` to get configurations from the Spring environment, you can't have IDE hints in your *application.properties* file. +- If you use `@Value` to get configurations from the Spring environment, you can't have IDE hints in your **application.properties** file. - If you have a microservice scenario, you must duplicate the code in each project, and it's easy to make mistakes and hard to be consistent. Fortunately, building the client beans by yourself isn't necessary with Spring Cloud Azure. Instead, you can directly inject them and use the configuration properties that you're already familiar with to configure the storage queue. For more information, see [Spring Cloud Azure configuration properties](configuration-properties-all.md). @@ -232,7 +232,7 @@ The following sections show you how to use Spring Messaging Azure Storage Queue ### Add dependencies -To install the Spring Messaging Azure Storage Queue module, add the following dependencies to your *pom.xml* file: +To install the Spring Messaging Azure Storage Queue module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -252,7 +252,7 @@ To install the Spring Messaging Azure Storage Queue module, add the following de > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Cloud Azure starter and Spring Messaging Storage Queue artifacts: @@ -278,7 +278,7 @@ Use the following steps to configure and code your application: spring.cloud.azure.storage.queue.account-name= ``` -1. Wire up a sender and a receiver to send and receive messages with Spring, as shown in the following example. Be sure to replace the *``* placeholder with your own value. +1. Wire up a sender and a receiver to send and receive messages with Spring, as shown in the following example. Be sure to replace the `` placeholder with your own value. ```java import com.azure.spring.messaging.AzureHeaders; @@ -339,7 +339,7 @@ The following sections show you how to use Spring Integration Azure Storage Queu ### Add dependencies -To install the Spring Integration Azure Storage Queue module, add the following dependencies to your *pom.xml* file: +To install the Spring Integration Azure Storage Queue module, add the following dependencies to your **pom.xml** file: - The Spring Cloud Azure Bill of Materials (BOM): @@ -359,7 +359,7 @@ To install the Spring Integration Azure Storage Queue module, add the following > [!NOTE] > If you're using Spring Boot 2.x, be sure to set the `spring-cloud-azure-dependencies` version to `4.19.0`. - > This Bill of Material (BOM) should be configured in the `` section of your *pom.xml* file. This ensures that all Spring Cloud Azure dependencies are using the same version. + > This Bill of Material (BOM) should be configured in the `` section of your **pom.xml** file. This ensures that all Spring Cloud Azure dependencies are using the same version. > For more information about the version used for this BOM, see [Which Version of Spring Cloud Azure Should I Use](https://github.com/Azure/azure-sdk-for-java/wiki/Spring-Versions-Mapping#which-version-of-spring-cloud-azure-should-i-use). - The Spring Integration Azure Storage Queue artifacts: @@ -381,7 +381,7 @@ Use the following steps to configure and code your application: spring.cloud.azure.storage.queue.account-name= ``` -1. Create a new `QueueReceiveConfiguration` Java class as shown in the following example. This class is used to define a message receiver. Be sure to replace the *``* placeholder with your own value. +1. Create a new `QueueReceiveConfiguration` Java class as shown in the following example. This class is used to define a message receiver. Be sure to replace the `` placeholder with your own value. ```java import com.azure.spring.integration.storage.queue.inbound.StorageQueueMessageSource; @@ -419,7 +419,7 @@ Use the following steps to configure and code your application: } ``` -1. Create a new `QueueSendConfiguration` Java class as shown in the following example. This class is used to define a message sender. Be sure to replace the *``* placeholder with your own value. +1. Create a new `QueueSendConfiguration` Java class as shown in the following example. This class is used to define a message sender. Be sure to replace the **``** placeholder with your own value. ```java import com.azure.spring.integration.core.handler.DefaultMessageHandler; diff --git a/articles/java/toolkit-for-eclipse/create-hello-world-web-app.md b/articles/java/toolkit-for-eclipse/create-hello-world-web-app.md index def0fd5ddf..3f83d9be21 100644 --- a/articles/java/toolkit-for-eclipse/create-hello-world-web-app.md +++ b/articles/java/toolkit-for-eclipse/create-hello-world-web-app.md @@ -43,15 +43,15 @@ The following steps walk you through the Azure sign in process in your Eclipse d 1. Once signed in, close your browser and switch back to your Eclipse IDE. In the **Select Subscriptions** dialog box, select the subscriptions that you want to use, then click **Select**. -### Install required software *(optional)* +### Install required software (optional) To ensure you have required components to work with web app projects, follow these steps: 1. Click the **Help** menu, and then click **Install New Software**. -1. In the **Available Software** dialog, click **Manage**, and make sure the latest Eclipse version is selected (e.g. *2020-06*). +1. In the **Available Software** dialog, click **Manage**, and make sure the latest Eclipse version is selected (e.g. **2020-06**). -1. Click **Apply and Close**. Expand the *Work with:* dropdown menu to show suggested sites. Select the latest Eclipse version site to query available software. +1. Click **Apply and Close**. Expand the **Work with:** dropdown menu to show suggested sites. Select the latest Eclipse version site to query available software. 1. Scroll down the list and select the **Web, XML, Java EE and OSGi Enterprise Development** item. Click **Next**. diff --git a/articles/java/toolkit-for-eclipse/installation.md b/articles/java/toolkit-for-eclipse/installation.md index c37095564b..20e9b5babb 100644 --- a/articles/java/toolkit-for-eclipse/installation.md +++ b/articles/java/toolkit-for-eclipse/installation.md @@ -52,7 +52,7 @@ The Eclipse Marketplace wizard in the Eclipse IDE allows users to browse the [Ec ## Install new software -You can install the Azure Toolkit for Eclipse directly from the *Help* menu in the form of new software. +You can install the Azure Toolkit for Eclipse directly from the **Help** menu in the form of new software. 1. Click the **Help** menu, and then click **Install New Software**. diff --git a/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md b/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md index c58d932e08..43eda26ee8 100644 --- a/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md +++ b/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md @@ -30,7 +30,7 @@ The following steps walk you through the steps to create a redis cache using the ![Create New Redis Cache Dialog Box][CR02] - a. **DNS Name**: Specifies the DNS subdomain for the new redis cache, which is prepended to ".redis.cache.windows.net"; for example: *wingtiptoys.redis.cache.windows.net*. + a. **DNS Name**: Specifies the DNS subdomain for the new redis cache, which is prepended to ".redis.cache.windows.net"; for example: **wingtiptoys.redis.cache.windows.net**. b. **Subscription**: Specifies the Azure subscription you want to use for the new redis cache. @@ -38,7 +38,7 @@ The following steps walk you through the steps to create a redis cache using the * **Create New**: Specifies that you want to create a new resource group. * **Use Existing**: Specifies that you will choose from a list of resource groups associated with your Azure account. - d. **Location**: Specifies the location where your redis cache is created; for example, *West US*. + d. **Location**: Specifies the location where your redis cache is created; for example, **West US**. e. **Pricing Tier**: Specifies which pricing tier your redis cache uses; this setting determines the number of client connections. (For more information, see [Redis Cache Pricing].) diff --git a/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md b/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md index ccf85b23e2..fff67f8712 100644 --- a/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md +++ b/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md @@ -26,14 +26,14 @@ The Azure Explorer, which is part of the Azure Toolkit for Eclipse, provides Jav 1. In the **Choose a Subscription** window, select your subscription, and then click **Next**. -1. In the **Select a Virtual Machine Image** window, select your **Location** (e.g. *West US*). You'll have the option to proceed with a recommended image or select a custom image. For this quickstart, we will proceed with the recommended image. +1. In the **Select a Virtual Machine Image** window, select your **Location**, for example, **West US**. You'll have the option to proceed with a recommended image or select a custom image. For this quickstart, we will proceed with the recommended image. If you choose to select a custom image, enter the following information: - * **Publisher**: Specifies the publisher that created the image you'll use to create your virtual machine (for example, *Microsoft*). + * **Publisher**: Specifies the publisher that created the image you'll use to create your virtual machine (for example, **Microsoft**). - * **Offer**: Specifies the virtual machine offering to use from the selected publisher (for example, *JDK*). + * **Offer**: Specifies the virtual machine offering to use from the selected publisher (for example, **JDK**). - * **Sku**: Specifies the stockkeeping unit (SKU) to use from the selected offering (for example, *JDK_8*). + * **Sku**: Specifies the stockkeeping unit (SKU) to use from the selected offering (for example, **JDK_8**). * **Version #**: Specifies which version of the selected SKU to use. diff --git a/articles/java/toolkit-for-intellij/chatgpt-intellij.md b/articles/java/toolkit-for-intellij/chatgpt-intellij.md index 40516cedbf..905d3a4866 100644 --- a/articles/java/toolkit-for-intellij/chatgpt-intellij.md +++ b/articles/java/toolkit-for-intellij/chatgpt-intellij.md @@ -44,7 +44,7 @@ The following steps walk you through the Azure sign-in process in your IntelliJ 1. After the sign-in workflow, right-click the Azure OpenAI item in Azure Explorer and select **Create Azure OpenAI Service**. 1. In the **Create Azure OpenAI Service** dialog box, specify the following information and then select **OK**: - - **Name**: A descriptive name for your Azure OpenAI Service resource, such as *MyOpenAIResource*. This name is also your custom domain name in your endpoint. Your resource name can only include alphanumeric characters and hyphens, and can't start or end with a hyphen. + - **Name**: A descriptive name for your Azure OpenAI Service resource, such as **MyOpenAIResource**. This name is also your custom domain name in your endpoint. Your resource name can only include alphanumeric characters and hyphens, and can't start or end with a hyphen. - **Region**: The location of your instance. Certain models are only available in specific regions. For more information, see [Azure OpenAI Service models](/azure/ai-services/openai/concepts/models). - **Sku**: Standard Azure OpenAI resources are billed based on token usage. For more information, see [Azure OpenAI Service pricing](https://azure.microsoft.com/pricing/details/cognitive-services/openai-service/). From 45e98ca72f1fb39e2c0ee8853beac68373d4442b Mon Sep 17 00:00:00 2001 From: JoshTheTechWriter <183134486+JoshTheTechWriter@users.noreply.github.com> Date: Mon, 20 Jan 2025 15:10:53 -0500 Subject: [PATCH 2/3] Removed backticks from three files. --- .../spring-framework/resource-handling.md | 16 ++++++------ .../spring-framework/secret-management.md | 24 ++++++++--------- .../spring-framework/spring-data-support.md | 26 +++++++++---------- 3 files changed, 33 insertions(+), 33 deletions(-) diff --git a/articles/java/spring-framework/resource-handling.md b/articles/java/spring-framework/resource-handling.md index 18034ce638..5d5b2e0e83 100644 --- a/articles/java/spring-framework/resource-handling.md +++ b/articles/java/spring-framework/resource-handling.md @@ -53,20 +53,20 @@ The following table lists the configurable properties of `spring-cloud-azure-sta > [!div class="mx-tdBreakAll"] > | Property | Default | Description | > |------------------------------------------------|---------|--------------------------------------------------------------------------| -> | `*spring.cloud.azure.storage.blob*.enabled` | true | A value that indicates whether an Azure Blob Storage service is enabled. | -> | `*spring.cloud.azure.storage.blob*.endpoint` | | The URI to connect to Azure Blob Storage. | -> | `*spring.cloud.azure.storage.blob*.account-key` | | The private key to connect to Azure Blob Storage. | -> | `*spring.cloud.azure.storage.blob*.account-name` | | The Azure Storage Blob account name. +> | *spring.cloud.azure.storage.blob*.enabled | true | A value that indicates whether an Azure Blob Storage service is enabled. | +> | *spring.cloud.azure.storage.blob*.endpoint | | The URI to connect to Azure Blob Storage. | +> | *spring.cloud.azure.storage.blob*.account-key | | The private key to connect to Azure Blob Storage. | +> | *spring.cloud.azure.storage.blob*.account-name | | The Azure Storage Blob account name. The following table lists the configurable properties of `spring-cloud-azure-starter-storage-file-share`: > [!div class="mx-tdBreakAll"] > | Property | Default | Description | > |-----------------------------------------------------|---------|-----------------------------------------------------------------------| -> | `*spring.cloud.azure.storage.fileshare*.enabled` | true | A value that indicates whether Azure File Storage service is enabled. | -> | `*spring.cloud.azure.storage.fileshare*.endpoint` | | The URI to connect to Azure File Storage. | -> | `*spring.cloud.azure.storage.fileshare*.account-key` | | The private key to connect to Azure File Storage. | -> | `*spring.cloud.azure.storage.fileshare*.account-name` | | The Azure Storage File Share account name. | +> | *spring.cloud.azure.storage.fileshare*.enabled | true | A value that indicates whether Azure File Storage service is enabled. | +> | *spring.cloud.azure.storage.fileshare*.endpoint | | The URI to connect to Azure File Storage. | +> | *spring.cloud.azure.storage.fileshare*.account-key | | The private key to connect to Azure File Storage. | +> | *spring.cloud.azure.storage.fileshare*.account-name | | The Azure Storage File Share account name. | ## Basic usage diff --git a/articles/java/spring-framework/secret-management.md b/articles/java/spring-framework/secret-management.md index 8e8114595a..bd428bec87 100644 --- a/articles/java/spring-framework/secret-management.md +++ b/articles/java/spring-framework/secret-management.md @@ -136,18 +136,18 @@ public static void main(String[] args) { > [!div class="mx-tdBreakAll"] > | Property | Default value | Description | > |--------------------------------------------------------------------------|---------------|--------------------------------------------------------------------------------------------------------| -> | `*spring.cloud.azure.keyvault.secret*.property-source-enabled` | true | Whether to enable the Key Vault property source. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].name` | | Name of this property source. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].endpoint` | | Azure Key Vault endpoint. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].case-sensitive` | false | Whether the secret keys are case-sensitive. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].secret-keys` | | The secret keys supported for this property source. All keys be retrieved if this property is missing. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].refresh-interval` | 30m | Time interval to refresh all Key Vault secrets. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].service-version` | | Secret service version used when making API requests. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].client` | | Client related properties. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].credential` | | Credential related properties. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].profile` | | Profile related properties. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].proxy` | | Proxy related properties. | -> | `*spring.cloud.azure.keyvault.secret*.property-sources[].retry` | | Retry related properties. | +> | *spring.cloud.azure.keyvault.secret*.property-source-enabled | true | Whether to enable the Key Vault property source. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].name | | Name of this property source. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].endpoint | | Azure Key Vault endpoint. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].case-sensitive | false | Whether the secret keys are case-sensitive. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].secret-keys | | The secret keys supported for this property source. All keys be retrieved if this property is missing. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].refresh-interval | 30m | Time interval to refresh all Key Vault secrets. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].service-version | | Secret service version used when making API requests. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].client | | Client related properties. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].credential | | Credential related properties. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].profile | | Profile related properties. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].proxy | | Proxy related properties. | +> | *spring.cloud.azure.keyvault.secret*.property-sources[].retry | | Retry related properties. | * See [Authorize access with Microsoft Entra ID](authentication.md#authorize-access-with-azure-active-directory) to make sure the [security principal](/azure/active-directory/develop/app-objects-and-service-principals#service-principal-object) has been granted the sufficient permission to access the Azure Key Vault Secrets. * If common properties like `client`, `credential`, `profile`, `proxy`, `retry` aren't configured in `spring.cloud.azure.keyvault.secret.property-sources[].xxx`, `spring.cloud.azure.xxx` will be used. See [Spring Cloud Azure configuration](configuration-properties-global.md) to get more information about these common properties. diff --git a/articles/java/spring-framework/spring-data-support.md b/articles/java/spring-framework/spring-data-support.md index aae433ede0..78ff612dae 100644 --- a/articles/java/spring-framework/spring-data-support.md +++ b/articles/java/spring-framework/spring-data-support.md @@ -37,19 +37,19 @@ The following table lists the configurable properties of `spring-cloud-azure-sta > [!div class="mx-tdBreakAll"] > | Property | Description | > |--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| -> | `*spring.cloud.azure.cosmos*.enabled` | A value that indicates whether Azure Cosmos DB Service is enabled. The default value is `true`. | -> | `*spring.cloud.azure.cosmos*.database` | The Azure Cosmos DB database ID. | -> | `*spring.cloud.azure.cosmos*.endpoint` | The URI to connect Azure Cosmos DB. | -> | `*spring.cloud.azure.cosmos*.key` | The PrivateKey to connect Azure Cosmos DB. | -> | `*spring.cloud.azure.cosmos*.credential.client-certificate-password` | The password of the certificate file. | -> | `*spring.cloud.azure.cosmos*.credential.client-certificate-path` | The path of a PEM certificate file to use when performing service principal authentication with Azure. | -> | `*spring.cloud.azure.cosmos*.credential.client-id` | The client ID to use when performing service principal authentication with Azure. | -> | `*spring.cloud.azure.cosmos*.credential.client-secret` | The client secret to use when performing service principal authentication with Azure. | -> | `*spring.cloud.azure.cosmos*.credential.managed-identity-enabled` | Whether to enable managed identity. The default value is `false`. | -> | `*spring.cloud.azure.cosmos*.credential.password` | The password to use when performing username/password authentication with Azure. | -> | `*spring.cloud.azure.cosmos*.credential.username` | The username to use when performing username/password authentication with Azure. | -> | `*spring.cloud.azure.cosmos*.populate-query-metrics` | A value that indicates whether to populate diagnostics strings and query metrics. The default value is `false`. | -> | `*spring.cloud.azure.cosmos*.consistency-level` | A [consistency level](/azure/cosmos-db/consistency-levels) for Azure Cosmos DB. | +> | *spring.cloud.azure.cosmos*.enabled | A value that indicates whether Azure Cosmos DB Service is enabled. The default value is `true`. | +> | *spring.cloud.azure.cosmos*.database | The Azure Cosmos DB database ID. | +> | *spring.cloud.azure.cosmos*.endpoint | The URI to connect Azure Cosmos DB. | +> | *spring.cloud.azure.cosmos*.key | The PrivateKey to connect Azure Cosmos DB. | +> | *spring.cloud.azure.cosmos*.credential.client-certificate-password | The password of the certificate file. | +> | *spring.cloud.azure.cosmos*.credential.client-certificate-path | The path of a PEM certificate file to use when performing service principal authentication with Azure. | +> | *spring.cloud.azure.cosmos*.credential.client-id | The client ID to use when performing service principal authentication with Azure. | +> | *spring.cloud.azure.cosmos*.credential.client-secret | The client secret to use when performing service principal authentication with Azure. | +> | *spring.cloud.azure.cosmos*.credential.managed-identity-enabled | Whether to enable managed identity. The default value is `false`. | +> | *spring.cloud.azure.cosmos*.credential.password | The password to use when performing username/password authentication with Azure. | +> | *spring.cloud.azure.cosmos*.credential.username | The username to use when performing username/password authentication with Azure. | +> | *spring.cloud.azure.cosmos*.populate-query-metrics | A value that indicates whether to populate diagnostics strings and query metrics. The default value is `false`. | +> | *spring.cloud.azure.cosmos*.consistency-level | A [consistency level](/azure/cosmos-db/consistency-levels) for Azure Cosmos DB. | ### Key concepts From c788994f9312c529ffe10032063ca74cbf38bd21 Mon Sep 17 00:00:00 2001 From: Joshua Goldstein <183134486+JoshTheTechWriter@users.noreply.github.com> Date: Tue, 21 Jan 2025 10:00:26 -0500 Subject: [PATCH 3/3] Apply suggestions from code review --- .../spring-boot-starter-for-entra-developer-guide.md | 6 +++--- articles/java/spring-framework/spring-data-support.md | 2 +- articles/java/spring-framework/spring-messaging-support.md | 6 +++--- articles/java/spring-framework/spring-security-support.md | 2 +- articles/java/spring-framework/testcontainers-support.md | 2 +- .../using-service-bus-in-spring-applications.md | 2 +- .../using-storage-queue-in-spring-applications.md | 4 ++-- .../managing-redis-caches-using-azure-explorer.md | 2 +- .../managing-virtual-machines-using-azure-explorer.md | 2 +- 9 files changed, 14 insertions(+), 14 deletions(-) diff --git a/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md b/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md index a277db36e4..c5c63b9000 100644 --- a/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md +++ b/articles/java/spring-framework/spring-boot-starter-for-entra-developer-guide.md @@ -54,7 +54,7 @@ This scenario uses the [The OAuth 2.0 authorization code grant](/azure/active-di To use the Microsoft Entra starter in this scenario, use the following steps: -Set the redirect URI to `application-base-uri>/login/oauth2/code/`. For example: `http://localhost:8080/login/oauth2/code/`. Be sure to include the trailing `/`. For more information about the redirect URI, see [Add a redirect URI](/azure/active-directory/develop/quickstart-register-app#add-a-redirect-uri) in [Quickstart: Register an application with the Microsoft identity platform](/azure/active-directory/develop/quickstart-register-app). +Set the redirect URI to `/login/oauth2/code/`. For example: `http://localhost:8080/login/oauth2/code/`. Be sure to include the trailing `/`. For more information about the redirect URI, see [Add a redirect URI](/azure/active-directory/develop/quickstart-register-app#add-a-redirect-uri) in [Quickstart: Register an application with the Microsoft identity platform](/azure/active-directory/develop/quickstart-register-app). :::image type="content" source="media/spring-boot-starter-for-entra-developer-guide/web-application-set-redirect-uri-2.png" alt-text="Screenshot of Azure portal showing web app authentication page with redirect URI highlighted."::: @@ -527,7 +527,7 @@ The Spring Boot Starter for Microsoft Entra ID provides the following properties | spring.cloud.azure.active-directory.app-id-uri | Used by the resource server to validate the audience in the access token. The access token is valid only when the audience is equal to the `` or `` values described previously. | | spring.cloud.azure.active-directory.authorization-clients | A map that configures the resource APIs the application is going to visit. Each item corresponds to one resource API the application is going to visit. In your Spring code, each item corresponds to one `OAuth2AuthorizedClient` object. | | `spring.cloud.azure.active-directory.authorization-clients..scopes` | The API permissions of a resource server that the application is going to acquire. | -| `spring.cloud.azure.active-directory.authorization-clients..authorization-grant-type` | The type of authorization client. Supported types are [authorization_code](/azure/active-directory/develop/v2-oauth2-auth-code-flow) (default type for webapp), [on_behalf_of](/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) (default type for resource-server), [client_credentials](/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow). | +| `spring.cloud.azure.active-directory.authorization-clients..authorization-grant-type` | The type of authorization client. Supported types are [`authorization_code`](/azure/active-directory/develop/v2-oauth2-auth-code-flow) (default type for webapp), [`on_behalf_of`](/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) (default type for resource-server), [`client_credentials`](/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow). | | spring.cloud.azure.active-directory.application-type | Refer to [Application type](#application-type). | | spring.cloud.azure.active-directory.profile.environment.active-directory-endpoint | The base URI for the authorization server. The default value is `https://login.microsoftonline.com/`. | | spring.cloud.azure.active-directory.credential.client-id | The registered application ID in Microsoft Entra ID. | @@ -758,7 +758,7 @@ The Azure SDKs for Java offer a consistent logging story to help troubleshoot an ### Enable Spring logging -Spring enables all the supported logging systems to set logger levels in the Spring environment (for example, in **application.properties**) by using `logging.level.=` where level is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF. You can configure the root logger by using `logging.level.root`. +Spring enables all the supported logging systems to set logger levels in the Spring environment (for example, in **application.properties**) by using `logging.level.=` where `` is one of `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, or `OFF`. You can configure the root logger by using `logging.level.root`. The following example shows potential logging settings in the **application.properties** file: diff --git a/articles/java/spring-framework/spring-data-support.md b/articles/java/spring-framework/spring-data-support.md index 78ff612dae..ad8e9fa499 100644 --- a/articles/java/spring-framework/spring-data-support.md +++ b/articles/java/spring-framework/spring-data-support.md @@ -67,7 +67,7 @@ The following list shows the key concepts of the Spring Data support: * The Spring Data [@Id](https://github.com/spring-projects/spring-data-commons/blob/db62390de90c93a78743c97cc2cc9ccd964994a5/src/main/java/org/springframework/data/annotation/Id.java) annotation. There are two ways to map a field in a domain class to the `id` of an Azure Cosmos DB document: * Annotate a field in domain class with `@Id`. This field will be mapped to document `id` in Azure Cosmos DB. - `*` Set the name of this field to `id`. This field will be mapped to document `id` in Azure Cosmos DB. + * Set the name of this field to `id`. This field will be mapped to document `id` in Azure Cosmos DB. > [!NOTE] > If both ways are applied, the `@Id` annotation has higher priority. diff --git a/articles/java/spring-framework/spring-messaging-support.md b/articles/java/spring-framework/spring-messaging-support.md index f6bc9206ea..c4d837260e 100644 --- a/articles/java/spring-framework/spring-messaging-support.md +++ b/articles/java/spring-framework/spring-messaging-support.md @@ -22,7 +22,7 @@ This article describes how you can use Spring Cloud Azure and Spring Messaging t ### Key concepts -Azure Event Hubs is a native data-streaming service in the cloud that can stream millions of events per second, with low latency, from any source to any destination. The Spring Messaging for Azure Event Hubs project applies core Spring concepts to the development of event hubs-based messaging solutions. It provides a template as a high-level abstraction for sending messages. It also provides support for message-driven plain old Java objects ( ) with `@EventHubsListener` annotations and a listener container. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. +Azure Event Hubs is a native data-streaming service in the cloud that can stream millions of events per second, with low latency, from any source to any destination. The Spring Messaging for Azure Event Hubs project applies core Spring concepts to the development of event hubs-based messaging solutions. It provides a *template* as a high-level abstraction for sending messages. It also provides support for message-driven plain old Java objects ( ) with `@EventHubsListener` annotations and a *listener container*. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. ### Dependency setup @@ -190,7 +190,7 @@ For more information, see the [azure-spring-boot-samples](https://github.com/Azu ### Key concepts -Azure Service Bus is a fully managed enterprise message broker with message queues and publish-subscribe topics. The Spring Messaging for Azure Service Bus project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a template as a high-level abstraction for sending messages. It also provides support for message-driven POJOs with `@ServiceBusListener` annotations and a listener container. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. +Azure Service Bus is a fully managed enterprise message broker with message queues and publish-subscribe topics. The Spring Messaging for Azure Service Bus project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a *template* as a high-level abstraction for sending messages. It also provides support for message-driven POJOs with `@ServiceBusListener` annotations and a *listener container*. These libraries promote the use of dependency injection and declarative configuration. In all of these cases, you can see similarities to the JMS support in the Spring Framework and RabbitMQ support in Spring AMQP. ### Dependency setup @@ -356,7 +356,7 @@ For more information, see the [azure-spring-boot-samples](https://github.com/Azu ### Key concepts -Azure Queue Storage is a service for storing large numbers of messages. You access messages from anywhere in the world via authenticated calls using HTTP or HTTPS. A queue message can be up to 64 KB in size. A queue can contain millions of messages, up to the total capacity limit of a storage account. Queues are commonly used to create a backlog of work to process asynchronously. The Spring Messaging for Azure Queue Storage project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a template as a high-level abstraction for sending and receiving messages. These libraries promote the use of dependency injection and declarative configuration. +Azure Queue Storage is a service for storing large numbers of messages. You access messages from anywhere in the world via authenticated calls using HTTP or HTTPS. A queue message can be up to 64 KB in size. A queue can contain millions of messages, up to the total capacity limit of a storage account. Queues are commonly used to create a backlog of work to process asynchronously. The Spring Messaging for Azure Queue Storage project applies core Spring concepts to the development of service bus-based messaging solutions. It provides a *template* as a high-level abstraction for sending and receiving messages. These libraries promote the use of dependency injection and declarative configuration. ### Dependency setup diff --git a/articles/java/spring-framework/spring-security-support.md b/articles/java/spring-framework/spring-security-support.md index 5737872f06..b3d723fae5 100644 --- a/articles/java/spring-framework/spring-security-support.md +++ b/articles/java/spring-framework/spring-security-support.md @@ -1216,7 +1216,7 @@ public class WebSecurityConfiguration extends WebSecurityConfigurerAdapter { --- -Copy the **home.html** from [aad-b2c-web-application sample](https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/aad/spring-cloud-azure-starter-active-directory-b2c/aad-b2c-web-application/src/main/resources/templates/home.html), and replace the `PROFILE_EDIT_USER_FLOW` and `PASSWORD_RESET_USER_FLOW` with your user flow names that you used previously. +Copy the **home.html** from [`aad-b2c-web-application` sample](https://github.com/Azure-Samples/azure-spring-boot-samples/tree/main/aad/spring-cloud-azure-starter-active-directory-b2c/aad-b2c-web-application/src/main/resources/templates/home.html), and replace the `PROFILE_EDIT_USER_FLOW` and `PASSWORD_RESET_USER_FLOW` with your user flow names that you used previously. Build and test your app. Let `Webapp` run on port `8080`. diff --git a/articles/java/spring-framework/testcontainers-support.md b/articles/java/spring-framework/testcontainers-support.md index 029b56ba74..eefa47ddaa 100644 --- a/articles/java/spring-framework/testcontainers-support.md +++ b/articles/java/spring-framework/testcontainers-support.md @@ -14,7 +14,7 @@ ms.custom: devx-track-java, devx-track-extended-java This article describes how to integrate Spring Cloud Azure with [Testcontainers](https://testcontainers.com/) to write effective integration tests for your applications. -Testcontainers is an open-source framework for providing throwaway, lightweight instances of databases, message brokers, web browsers, or just about anything that can run in a Docker container. It integrates with JUnit, enabling you to write a test class that can start up a container before any of the tests run. Testcontainers is especially useful for writing integration tests that talk to a real backend service. +*Testcontainers* is an open-source framework for providing throwaway, lightweight instances of databases, message brokers, web browsers, or just about anything that can run in a Docker container. It integrates with JUnit, enabling you to write a test class that can start up a container before any of the tests run. Testcontainers is especially useful for writing integration tests that talk to a real backend service. The `spring-cloud-azure-testcontainers` library now supports integration testing for the following Azure services: diff --git a/articles/java/spring-framework/using-service-bus-in-spring-applications.md b/articles/java/spring-framework/using-service-bus-in-spring-applications.md index 4c9060bd24..6f51555f9c 100644 --- a/articles/java/spring-framework/using-service-bus-in-spring-applications.md +++ b/articles/java/spring-framework/using-service-bus-in-spring-applications.md @@ -14,7 +14,7 @@ This article shows you how to use Azure Service Bus in Java applications built w Azure provides an asynchronous messaging platform called [Azure Service Bus](/azure/service-bus-messaging/service-bus-messaging-overview) (Service Bus), which is based on the [Advanced Message Queueing Protocol 1.0](http://www.amqp.org/) (AMQP 1.0) standard. You can use Service Bus across the range of supported Azure platforms. -Spring Cloud Azure provides various modules for sending messages to and receiving messages from Service Bus queues and topics/subscriptions using Spring frameworks. +Spring Cloud Azure provides various modules for sending messages to and receiving messages from Service Bus *queues* and *topics*/*subscriptions* using Spring frameworks. You can use the following modules independently or combine them for different use cases: diff --git a/articles/java/spring-framework/using-storage-queue-in-spring-applications.md b/articles/java/spring-framework/using-storage-queue-in-spring-applications.md index c78fec0b61..ae1b70e0ca 100644 --- a/articles/java/spring-framework/using-storage-queue-in-spring-applications.md +++ b/articles/java/spring-framework/using-storage-queue-in-spring-applications.md @@ -155,7 +155,7 @@ To send messages to and receive messages from Azure Storage queues, use the foll You can build the client beans by yourself, but the process is complicated. In Spring Boot applications, you have to manage properties, learn the builder pattern, and register the clients to your Spring application context. The following steps show you how to do that. -1. Build the client programmatically in your Spring application, as shown in the following example. Be sure to replace the **``** placeholder with your own value. +1. Build the client programmatically in your Spring application, as shown in the following example. Be sure to replace the `` placeholder with your own value. ```java import com.azure.identity.DefaultAzureCredentialBuilder; @@ -419,7 +419,7 @@ Use the following steps to configure and code your application: } ``` -1. Create a new `QueueSendConfiguration` Java class as shown in the following example. This class is used to define a message sender. Be sure to replace the **``** placeholder with your own value. +1. Create a new `QueueSendConfiguration` Java class as shown in the following example. This class is used to define a message sender. Be sure to replace the `` placeholder with your own value. ```java import com.azure.spring.integration.core.handler.DefaultMessageHandler; diff --git a/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md b/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md index 43eda26ee8..d03d14c901 100644 --- a/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md +++ b/articles/java/toolkit-for-eclipse/managing-redis-caches-using-azure-explorer.md @@ -30,7 +30,7 @@ The following steps walk you through the steps to create a redis cache using the ![Create New Redis Cache Dialog Box][CR02] - a. **DNS Name**: Specifies the DNS subdomain for the new redis cache, which is prepended to ".redis.cache.windows.net"; for example: **wingtiptoys.redis.cache.windows.net**. + a. **DNS Name**: Specifies the DNS subdomain for the new redis cache, which is prepended to **.redis.cache.windows.net**, for example, **wingtiptoys.redis.cache.windows.net**. b. **Subscription**: Specifies the Azure subscription you want to use for the new redis cache. diff --git a/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md b/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md index fff67f8712..2226dfa36b 100644 --- a/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md +++ b/articles/java/toolkit-for-eclipse/managing-virtual-machines-using-azure-explorer.md @@ -26,7 +26,7 @@ The Azure Explorer, which is part of the Azure Toolkit for Eclipse, provides Jav 1. In the **Choose a Subscription** window, select your subscription, and then click **Next**. -1. In the **Select a Virtual Machine Image** window, select your **Location**, for example, **West US**. You'll have the option to proceed with a recommended image or select a custom image. For this quickstart, we will proceed with the recommended image. +1. In the **Select a Virtual Machine Image** window, select your **Location** (for example, **West US**). You'll have the option to proceed with a recommended image or select a custom image. For this quickstart, we will proceed with the recommended image. If you choose to select a custom image, enter the following information: * **Publisher**: Specifies the publisher that created the image you'll use to create your virtual machine (for example, **Microsoft**).