From 5acece341b5cea1242e31176147c001746f8d1c5 Mon Sep 17 00:00:00 2001 From: v-minh1 Date: Fri, 13 Dec 2024 15:56:36 +0800 Subject: [PATCH 1/5] Compare properties description with current doc, update source files --- ...pplicationInsightsComponentProperties.java | 2 +- .../com/azure/core/util/Configuration.java | 2 +- .../implementation/enums/AuthProperty.java | 2 +- .../AadAuthenticationProperties.java | 30 +++++++++---------- .../AadProfileEnvironmentProperties.java | 4 +-- .../properties/AadProfileProperties.java | 4 +-- .../AadResourceServerProperties.java | 4 +-- .../properties/AadB2cProfileProperties.java | 2 +- .../properties/AadB2cProperties.java | 6 ++-- .../AzureAppConfigurationProperties.java | 2 +- .../properties/AzureCosmosProperties.java | 14 ++++----- .../AzureEventHubsCommonProperties.java | 2 +- .../common/AzureKeyVaultProperties.java | 2 +- .../AzureProfileConfigurationProperties.java | 6 ++-- .../proxy/ProxyConfigurationProperties.java | 2 +- .../common/AzureStorageProperties.java | 2 +- .../StorageRetryConfigurationProperties.java | 2 +- .../profile/AzureEnvironmentProperties.java | 4 +-- 18 files changed, 46 insertions(+), 46 deletions(-) diff --git a/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java b/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java index 2d29a45db2f63..ef22987381337 100644 --- a/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java +++ b/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java @@ -72,7 +72,7 @@ public final class ApplicationInsightsComponentProperties { private OffsetDateTime creationDate; /* - * Azure Tenant Id. + * Azure Tenant Id. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. */ @JsonProperty(value = "TenantId", access = JsonProperty.Access.WRITE_ONLY) private String tenantId; diff --git a/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java b/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java index 8b2d627902d48..103c2e6aa88e6 100644 --- a/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java +++ b/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java @@ -143,7 +143,7 @@ public class Configuration implements Cloneable { public static final String PROPERTY_AZURE_CLOUD = "AZURE_CLOUD"; /** - * The Azure Active Directory endpoint to connect to. + * The Microsoft Entra endpoint to connect to. */ public static final String PROPERTY_AZURE_AUTHORITY_HOST = "AZURE_AUTHORITY_HOST"; diff --git a/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java b/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java index 1daf1c7383dd2..4a5dcdedc1453 100644 --- a/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java +++ b/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java @@ -53,7 +53,7 @@ public enum AuthProperty { AUTHORITY_HOST("azure.authorityHost", AzureAuthorityHosts.AZURE_PUBLIC_CLOUD, "The well known authority hosts for the Azure Public Cloud and sovereign clouds.", true), /** - * Tenant ID for Azure resources. + * Tenant ID for Azure resources. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. */ TENANT_ID("azure.tenantId", "Tenant ID for Azure resources.", true), /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java index 1b07cf57889ff..31196f79b9c07 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java @@ -78,7 +78,7 @@ public class AadAuthenticationProperties implements InitializingBean { private String redirectUriTemplate = "{baseUrl}/login/oauth2/code/"; /** - * App ID URI which might be used in the "aud" claim of an id_token. For instance, 'api://{applicationId}'. + * App ID URI that might be used in the "aud" claim of an `id_token`. For instance, `api://{applicationId}`. * See Microsoft doc about APP ID URL for more details: https://learn.microsoft.com/azure/active-directory/develop/security-best-practices-for-app-registration#application-id-uri */ private String appIdUri; @@ -121,31 +121,31 @@ public class AadAuthenticationProperties implements InitializingBean { private Duration jwkSetCacheRefreshTime = Duration.ofMinutes(5); /** - * The redirect uri after logout. For instance, 'http://localhost:8080/'. + * The redirect uri after logout. For instance, `http://localhost:8080/`. * See Microsoft doc about Redirect URI for more details: https://learn.microsoft.com/azure/active-directory/develop/security-best-practices-for-app-registration#redirect-uri */ private String postLogoutRedirectUri; /** - * If true activates the stateless auth filter AADAppRoleStatelessAuthenticationFilter. The default is false which - * activates AADAuthenticationFilter. + * If true activates the stateless auth filter `AADAppRoleStatelessAuthenticationFilter`. The default is false, which + * activates `AADAuthenticationFilter`. */ private Boolean sessionStateless = false; /** * The OAuth2 authorization clients, contains the authorization grant type, client authentication method and scope. - * The clients will be converted to OAuth2 ClientRegistration, the other ClientRegistration information(such as client id, client secret) inherits from the delegated OAuth2 login client 'azure'. - * For instance,' - * authorization-clients.webapi.authorization-grant-type=on_behalf_of, - * authorization-clients.webapi.client-authentication-method=client_secret_post, - * authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope1, - * authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope2 - * '. + * The clients will be converted to OAuth2 `ClientRegistration`, the other `ClientRegistration` information(such as client id, client secret) inherits from the delegated OAuth2 login client `azure`. + * For instance,` + * authorization-clients.webapi.authorization-grant-type=on_behalf_of`, + * `authorization-clients.webapi.client-authentication-method=client_secret_post`, + * `authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope1`, + * `authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope2` + * . */ private final Map authorizationClients = new HashMap<>(); /** - * Type of the Azure AD application. Supported types are: WEB_APPLICATION, RESOURCE_SERVER, RESOURCE_SERVER_WITH_OBO, WEB_APPLICATION_AND_RESOURCE_SERVER. The value can be inferred by dependencies, only 'web_application_and_resource_server' must be configured manually. + * The type of the Microsoft Entra application. Supported types are: `WEB_APPLICATION`, `RESOURCE_SERVER`, `RESOURCE_SERVER_WITH_OBO`, `WEB_APPLICATION_AND_RESOURCE_SERVER`. The value can be inferred by dependencies, only `web_application_and_resource_server` must be configured manually. */ private AadApplicationType applicationType; @@ -187,17 +187,17 @@ public void setApplicationType(AadApplicationType applicationType) { public static class UserGroupProperties { /** - * The group names can be used to construct GrantedAuthority. + * The group names can be used to construct `GrantedAuthority`. */ private List allowedGroupNames = new ArrayList<>(); /** - * The group IDs can be used to construct GrantedAuthority. + * The group IDs can be used to construct `GrantedAuthority`. */ private Set allowedGroupIds = new HashSet<>(); /** - * Whether to use transitive way to get members. If "true", use "v1.0/me/transitiveMemberOf" to get members. Otherwise, use "v1.0/me/memberOf". The default value is `false`. + * Whether to use transitive way to get members. If `true`, use `v1.0/me/transitiveMemberOf` to get members. Otherwise, use `v1.0/me/memberOf`. The default value is `false`. */ private boolean useTransitiveMembers = false; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileEnvironmentProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileEnvironmentProperties.java index 9a8edcf39f4a5..a88db1bc50afc 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileEnvironmentProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileEnvironmentProperties.java @@ -10,11 +10,11 @@ public class AadProfileEnvironmentProperties { /** - * Azure Active Directory endpoint. For example: https://login.microsoftonline.com/ + * Microsoft Entra endpoint. For example: `https://login.microsoftonline.com/` */ private String activeDirectoryEndpoint; /** - * Microsoft Graph endpoint. For example: https://graph.microsoft.com/ + * Microsoft Graph endpoint. For example: `https://graph.microsoft.com/` */ private String microsoftGraphEndpoint; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileProperties.java index 0c8993c5c349a..8983c2dc888c2 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadProfileProperties.java @@ -11,7 +11,7 @@ public class AadProfileProperties { /** - * Azure Tenant ID. + * Azure Tenant ID. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. */ private String tenantId; // tenantId can not set to "common" here, otherwise we can not know whether it's set by customer or it is the default value. /** @@ -19,7 +19,7 @@ public class AadProfileProperties { */ private AzureProfileOptionsProvider.CloudType cloudType; /** - * Properties to Azure Active Directory endpoints. + * Properties to Microsoft Entra endpoints. */ @NestedConfigurationProperty private final AadProfileEnvironmentProperties environment = new AadProfileEnvironmentProperties(); diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadResourceServerProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadResourceServerProperties.java index 733a6a28bd2e4..38283a9cc8695 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadResourceServerProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadResourceServerProperties.java @@ -33,12 +33,12 @@ public class AadResourceServerProperties implements InitializingBean { /** * - * Configure which claim in access token be returned in AuthenticatedPrincipal#getName. Example: If use the default value, and the access_token's "sub" scope value is "testValue", then AuthenticatedPrincipal#getName will return "testValue". The default value is `"sub"`. + * Configure which claim in access token be returned in `AuthenticatedPrincipal#getName`. Example: If use the default value, and the access_token's "sub" scope value is "testValue", then `AuthenticatedPrincipal#getName` will return "testValue". The default value is `"sub"`. */ private String principalClaimName; /** - * Configure which claim will be used to build GrantedAuthority, and prefix of the GrantedAuthority's string value. Example: If use the default value, and the access_token's "scp" scope value is "testValue", then GrantedAuthority with "SCOPE_testValue" will be created. The default value is `"scp" -> "SCOPE_", "roles" -> "APPROLE_"`. + * Configure which claim will be used to build `GrantedAuthority`, and prefix of the GrantedAuthority's string value. Example: If use the default value, and the access_token's "scp" scope value is "testValue", then `GrantedAuthority` with `SCOPE_testValue` will be created. The default value is `"scp" -> "SCOPE_", "roles" -> "APPROLE_"`. */ private Map claimToAuthorityPrefixMap; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProfileProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProfileProperties.java index 50006c460ccbf..6909c79b99f01 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProfileProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProfileProperties.java @@ -8,7 +8,7 @@ */ public class AadB2cProfileProperties { /** - * Azure Tenant ID. + * Azure Tenant ID. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. */ private String tenantId; // tenantId can not set to "common" here, otherwise we can not know whether it's set by customer or it is the default value. diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProperties.java index 983f53443488b..db911660c0881 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aadb2c/configuration/properties/AadB2cProperties.java @@ -54,7 +54,7 @@ public class AadB2cProperties implements InitializingBean { private final AadB2cCredentialProperties credential = new AadB2cCredentialProperties(); /** - * App ID URI which might be used in the "aud" claim of a token. For instance, 'https://{hostname}/{applicationId}'. + * App ID URI that might be used in the "aud" claim of a token. For instance, `https://{hostname}/{applicationId}`. * See Microsoft doc about APP ID URL for more details: https://learn.microsoft.com/azure/active-directory/develop/security-best-practices-for-app-registration#application-id-uri */ private String appIdUri; @@ -81,7 +81,7 @@ public class AadB2cProperties implements InitializingBean { private int jwtSizeLimit = RemoteJWKSet.DEFAULT_HTTP_SIZE_LIMIT; /* bytes */ /** - * Redirect url after logout. + * Redirect URL after logout. */ private String logoutSuccessUrl = DEFAULT_LOGOUT_SUCCESS_URL; @@ -97,7 +97,7 @@ public class AadB2cProperties implements InitializingBean { private String userNameAttributeName; /** - * Reply url after get authorization code. + * Reply URL after get authorization code. */ private String replyUrl = "{baseUrl}/login/oauth2/code/"; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/appconfiguration/AzureAppConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/appconfiguration/AzureAppConfigurationProperties.java index 99d0a337600a7..32c84df7285de 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/appconfiguration/AzureAppConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/appconfiguration/AzureAppConfigurationProperties.java @@ -16,7 +16,7 @@ public class AzureAppConfigurationProperties extends AbstractAzureHttpConfigurat public static final String PREFIX = "spring.cloud.azure.appconfiguration"; /** - * Endpoint of the Azure App Configuration instance. For instance, 'https://{appConfigurationName}.azconfig.io'. + * Endpoint of the Azure App Configuration instance. For instance, `https://{appConfigurationName}.azconfig.io`. */ private String endpoint; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/cosmos/properties/AzureCosmosProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/cosmos/properties/AzureCosmosProperties.java index 5ccb0da5029d1..a270db184330b 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/cosmos/properties/AzureCosmosProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/cosmos/properties/AzureCosmosProperties.java @@ -30,23 +30,23 @@ public class AzureCosmosProperties extends AbstractAzureServiceConfigurationProp private final ClientConfigurationProperties client = new ClientConfigurationProperties(); /** - * Endpoint of the Cosmos DB. + * Endpoint of the Azure Cosmos DB instance. */ private String endpoint; /** - * Key to authenticate for accessing the Cosmos DB. + * Key to authenticate for accessing the Azure Cosmos DB instance. */ private String key; /** - * Database name of the Cosmos DB. + * Database name of the Azure Cosmos DB instance. */ private String database; /** - * Resource token to authenticate for accessing the Cosmos DB. + * Resource token to authenticate for accessing the Azure Cosmos DB instance. */ private String resourceToken; /** - * Whether to enable client telemetry which will periodically collect database operations aggregation statistics, + * Whether to enable client telemetry, which will periodically collect database operations aggregation statistics, * system information like cpu/memory and send it to cosmos monitoring service, which will be helpful during * debugging. */ @@ -56,11 +56,11 @@ public class AzureCosmosProperties extends AbstractAzureServiceConfigurationProp */ private Boolean endpointDiscoveryEnabled; /** - * Whether to enable connections sharing across multiple Cosmos Clients. + * Whether to enable connections sharing across multiple Azure Cosmos DB Clients. */ private Boolean connectionSharingAcrossClientsEnabled; /** - * Whether to only return the headers and status code in Cosmos DB response in case of Create, Update and Delete + * Whether to only return the headers and status code in Azure Cosmos DB response in case of Create, Update and Delete * operations on CosmosItem. If set to false, service doesn't return payload in the response. */ private Boolean contentResponseOnWriteEnabled; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/eventhubs/properties/AzureEventHubsCommonProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/eventhubs/properties/AzureEventHubsCommonProperties.java index 8067a2957a0d8..2260bca9a2e87 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/eventhubs/properties/AzureEventHubsCommonProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/eventhubs/properties/AzureEventHubsCommonProperties.java @@ -30,7 +30,7 @@ public abstract class AzureEventHubsCommonProperties extends AbstractAzureAmqpCo /** * A custom endpoint address when connecting to the Event Hubs service. This can be useful when your network does * not allow connecting to the standard Azure Event Hubs endpoint address, but does allow connecting through an - * intermediary. For example: https://my.custom.endpoint.com:55300. + * intermediary. For example: `https://my.custom.endpoint.com:55300`. */ private String customEndpointAddress; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/common/AzureKeyVaultProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/common/AzureKeyVaultProperties.java index e6951f7cc4f9d..049691c18c593 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/common/AzureKeyVaultProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/common/AzureKeyVaultProperties.java @@ -15,7 +15,7 @@ public class AzureKeyVaultProperties extends AbstractAzureHttpConfigurationPrope public static final String PREFIX = "spring.cloud.azure.keyvault"; /** - * Azure Key Vault endpoint. For instance, 'https://{your-unique-keyvault-name}.vault.azure.net/'. + * Azure Key Vault endpoint. For instance, `https://{your-unique-keyvault-name}.vault.azure.net/`. */ private String endpoint; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java index 15f7328dba0d4..2f52244896e74 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java @@ -13,7 +13,7 @@ public class AzureProfileConfigurationProperties extends AzureProfileOptionsAdapter { /** - * Tenant ID for Azure resources. + * Tenant ID for Azure resources. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. */ private String tenantId; /** @@ -92,11 +92,11 @@ public static final class AzureEnvironmentConfigurationProperties implements Azu */ private String galleryEndpoint; /** - * The Azure Active Directory endpoint to connect to. + * The Microsoft Entra endpoint to connect to. */ private String activeDirectoryEndpoint; /** - * The Azure Active Directory resource ID. + * The Microsoft Entra resource ID. */ private String activeDirectoryResourceId; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/proxy/ProxyConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/proxy/ProxyConfigurationProperties.java index 40358569003f8..084a42f876890 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/proxy/ProxyConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/proxy/ProxyConfigurationProperties.java @@ -11,7 +11,7 @@ public class ProxyConfigurationProperties implements ProxyOptionsProvider.ProxyOptions { /** - * Type of the proxy. For instance of http, 'http', 'socks4', 'socks5'. For instance of amqp, 'http', 'socks'. + * The type of the proxy. For instance of http, `http`, `socks4`, `socks5`. For instance of amqp, `http`, `socks`. */ private String type; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java index 688fd252ee655..24fc94046c52f 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java @@ -17,7 +17,7 @@ public class AzureStorageProperties extends AbstractAzureServiceConfigurationPro public static final String PREFIX = "spring.cloud.azure.storage"; /** - * Endpoint for Azure Storage service. For instance, 'https://{storage-account-name}.blob.storage.azure.net' for blob or 'https://{storage-account-name}.file.storage.azure.net' for file share or 'https://{storage-account-name}.queue.storage.azure.net' for queue. + * Endpoint for Azure Storage service. For instance, `https://{storage-account-name}.blob.storage.azure.net` for blob or `https://{storage-account-name}.file.storage.azure.net` for file share or 'https://{storage-account-name}.queue.storage.azure.net` for queue. */ protected String endpoint; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java index 120e57ce37457..af74e45ea53c0 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java @@ -14,7 +14,7 @@ public class StorageRetryConfigurationProperties extends RetryConfigurationProperties implements StorageRetry { /** - * Secondary Storage account to retry requests against. if the primary region becomes unavailable. For instance, 'https://{storage-account-name}-secondary.file.storage.azure.net'. + * Secondary Storage account to retry requests against. if the primary region becomes unavailable. For instance, `https://{storage-account-name}-secondary.file.storage.azure.net`. */ private String secondaryHost; /** diff --git a/sdk/spring/spring-cloud-azure-core/src/main/java/com/azure/spring/cloud/core/properties/profile/AzureEnvironmentProperties.java b/sdk/spring/spring-cloud-azure-core/src/main/java/com/azure/spring/cloud/core/properties/profile/AzureEnvironmentProperties.java index 1c050b67414a3..0a354b00c8d76 100644 --- a/sdk/spring/spring-cloud-azure-core/src/main/java/com/azure/spring/cloud/core/properties/profile/AzureEnvironmentProperties.java +++ b/sdk/spring/spring-cloud-azure-core/src/main/java/com/azure/spring/cloud/core/properties/profile/AzureEnvironmentProperties.java @@ -61,11 +61,11 @@ public class AzureEnvironmentProperties implements AzureProfileOptionsProvider.A */ private String galleryEndpoint; /** - * The Azure Active Directory endpoint to connect to. + * The Microsoft Entra endpoint to connect to. */ private String activeDirectoryEndpoint; /** - * The Azure Active Directory resource id. + * The Microsoft Entra resource id. */ private String activeDirectoryResourceId; /** From 246f70abda65e71469b6233a2b7aad6ded56f6f0 Mon Sep 17 00:00:00 2001 From: v-minh1 Date: Tue, 17 Dec 2024 15:22:06 +0800 Subject: [PATCH 2/5] update properties description according to current doc --- .../properties/AadAuthenticationProperties.java | 6 +++--- .../jms/properties/AzureServiceBusJmsProperties.java | 2 +- .../properties/AzureKeyVaultPropertySourceProperties.java | 2 +- .../core/profile/AzureProfileConfigurationProperties.java | 2 +- .../storage/common/AzureStorageProperties.java | 2 +- .../common/StorageRetryConfigurationProperties.java | 2 +- .../additional-spring-configuration-metadata.json | 8 ++++---- .../queue/core/properties/StorageQueueProperties.java | 2 +- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java index 31196f79b9c07..15158d265cf31 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/aad/configuration/properties/AadAuthenticationProperties.java @@ -111,12 +111,12 @@ public class AadAuthenticationProperties implements InitializingBean { private int jwtSizeLimit = RemoteJWKSet.DEFAULT_HTTP_SIZE_LIMIT; /* bytes */ /** - * The lifespan(duration) of the cached JWK set before it expires. The default value is `5m`. + * The lifespan(duration) of the cached JWK set before it expires. */ private Duration jwkSetCacheLifespan = Duration.ofMinutes(5); /** - * The refresh time(duration) of the cached JWK set before it expires. The default value is `5m`. + * The refresh time(duration) of the cached JWK set before it expires. */ private Duration jwkSetCacheRefreshTime = Duration.ofMinutes(5); @@ -197,7 +197,7 @@ public static class UserGroupProperties { private Set allowedGroupIds = new HashSet<>(); /** - * Whether to use transitive way to get members. If `true`, use `v1.0/me/transitiveMemberOf` to get members. Otherwise, use `v1.0/me/memberOf`. The default value is `false`. + * Whether to use transitive way to get members. If `true`, use `v1.0/me/transitiveMemberOf` to get members. Otherwise, use `v1.0/me/memberOf`. */ private boolean useTransitiveMembers = false; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/jms/properties/AzureServiceBusJmsProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/jms/properties/AzureServiceBusJmsProperties.java index 807abd3f67ba5..4731890b14d43 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/jms/properties/AzureServiceBusJmsProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/jms/properties/AzureServiceBusJmsProperties.java @@ -50,7 +50,7 @@ public class AzureServiceBusJmsProperties implements InitializingBean, Passwordl * Whether to enable supporting azure identity token credentials. * * If the value is true, then 'spring.jms.servicebus.namespace' must be set. - * If the passwordlessEnabled is true, it will try to authenticate connections with Azure AD. + * If the passwordlessEnabled is true, it will try to authenticate connections with Microsoft Entra ID. */ private boolean passwordlessEnabled = false; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/secrets/properties/AzureKeyVaultPropertySourceProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/secrets/properties/AzureKeyVaultPropertySourceProperties.java index 94bbbbb4a9aa1..6320cf3388f18 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/secrets/properties/AzureKeyVaultPropertySourceProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/keyvault/secrets/properties/AzureKeyVaultPropertySourceProperties.java @@ -19,7 +19,7 @@ public class AzureKeyVaultPropertySourceProperties extends AbstractAzureHttpConf public static final Duration DEFAULT_REFRESH_INTERVAL = Duration.ofMinutes(30); /** - * Azure Key Vault endpoint. For instance, 'https://{your-unique-keyvault-name}.vault.azure.net/'. + * Azure Key Vault endpoint. For instance, `https://{your-unique-keyvault-name}.vault.azure.net/`. */ private String endpoint; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java index 2f52244896e74..70385c45298bc 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/properties/core/profile/AzureProfileConfigurationProperties.java @@ -21,7 +21,7 @@ public class AzureProfileConfigurationProperties extends AzureProfileOptionsAdap */ private String subscriptionId; /** - * Name of the Azure cloud to connect to. Supported types are: AZURE, AZURE_CHINA, AZURE_US_GOVERNMENT, OTHER. The default value is `AZURE`. + * Name of the Azure cloud to connect to. Supported types are: `AZURE`, `AZURE_CHINA`, `AZURE_US_GOVERNMENT`, `OTHER`. The default value is `AZURE`. */ private AzureProfileOptionsProvider.CloudType cloudType; diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java index 24fc94046c52f..af1f6a03742cb 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java @@ -17,7 +17,7 @@ public class AzureStorageProperties extends AbstractAzureServiceConfigurationPro public static final String PREFIX = "spring.cloud.azure.storage"; /** - * Endpoint for Azure Storage service. For instance, `https://{storage-account-name}.blob.storage.azure.net` for blob or `https://{storage-account-name}.file.storage.azure.net` for file share or 'https://{storage-account-name}.queue.storage.azure.net` for queue. + * Endpoint for Azure Storage service. For instance, `https://{storage-account-name}.blob.storage.azure.net` for blob or `https://{storage-account-name}.file.storage.azure.net` for file share or `https://{storage-account-name}.queue.storage.azure.net` for queue. */ protected String endpoint; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java index af74e45ea53c0..b28c813fd2b94 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/java/com/azure/spring/cloud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java @@ -14,7 +14,7 @@ public class StorageRetryConfigurationProperties extends RetryConfigurationProperties implements StorageRetry { /** - * Secondary Storage account to retry requests against. if the primary region becomes unavailable. For instance, `https://{storage-account-name}-secondary.file.storage.azure.net`. + * Secondary Storage account to retry requests against if the primary region becomes unavailable. For instance, `https://{storage-account-name}-secondary.file.storage.azure.net`. */ private String secondaryHost; /** diff --git a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index 3ba5cb5772a82..274dad9853e37 100644 --- a/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/sdk/spring/spring-cloud-azure-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -285,7 +285,7 @@ { "name": "spring.cloud.azure.keyvault.secret.property-sources[0].endpoint", "type": "java.lang.String", - "description": "Azure Key Vault endpoint. For instance, 'https://{your-unique-keyvault-name}.vault.azure.net/'.", + "description": "Azure Key Vault endpoint. For instance, `https://{your-unique-keyvault-name}.vault.azure.net/`.", "sourceType": "com.azure.spring.cloud.autoconfigure.implementation.keyvault.secrets.properties.AzureKeyVaultPropertySourceProperties" }, { @@ -423,7 +423,7 @@ { "name": "spring.cloud.azure.keyvault.secret.property-sources[0].profile.tenant-id", "type": "java.lang.String", - "description": "Tenant ID for Azure resources.", + "description": "Tenant ID for Azure resources. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID.", "sourceType": "com.azure.spring.cloud.autoconfigure.implementation.properties.core.profile.AzureProfileConfigurationProperties" }, { @@ -453,7 +453,7 @@ { "name": "spring.cloud.azure.keyvault.secret.property-sources[0].proxy.type", "type": "java.lang.String", - "description": "Type of the proxy. For instance of http, 'http', 'socks4', 'socks5'. For instance of amqp, 'http', 'socks'.", + "description": "The type of the proxy. For instance of http, `http`, `socks4`, `socks5`. For instance of amqp, `http`, `socks`.", "sourceType": "com.azure.spring.cloud.autoconfigure.implementation.properties.core.proxy.ProxyConfigurationProperties" }, { @@ -587,7 +587,7 @@ { "name": "spring.datasource.azure.profile.tenant-id", "type": "java.lang.String", - "description": "Tenant ID for Azure resources.", + "description": "Tenant ID for Azure resources. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID.", "sourceType": "com.azure.spring.cloud.autoconfigure.implementation.passwordless.properties.AzureJdbcPasswordlessProperties" }, { diff --git a/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java b/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java index cae47a56375de..d439efffbc77c 100644 --- a/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java +++ b/sdk/spring/spring-messaging-azure-storage-queue/src/main/java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java @@ -21,7 +21,7 @@ public StorageQueueProperties() { private static final String QUEUE_ENDPOINT_PATTERN = "https://%s.queue%s"; /** - * Endpoint for Azure Storage service. For instance, 'https://{storage-account-name}.queue.storage.azure.net'. + * Endpoint for Azure Storage service. For instance, `https://{storage-account-name}.queue.storage.azure.net`. */ private String endpoint; /** From ddf33f9ad34bace0165b047a19f1c0af2ba7a5a2 Mon Sep 17 00:00:00 2001 From: v-minh1 Date: Tue, 17 Dec 2024 17:11:12 +0800 Subject: [PATCH 3/5] Revert changes to ApplicationInsightsComponentProperties.java --- .../fluent/models/ApplicationInsightsComponentProperties.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java b/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java index 769acd9208c8b..c8c141565b3e8 100644 --- a/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java +++ b/sdk/applicationinsights/azure-resourcemanager-applicationinsights/src/main/java/com/azure/resourcemanager/applicationinsights/fluent/models/ApplicationInsightsComponentProperties.java @@ -72,7 +72,7 @@ public final class ApplicationInsightsComponentProperties private OffsetDateTime creationDate; /* - * Azure Tenant Id. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. + * Azure Tenant Id. */ private String tenantId; From c45c6f1317d292df02bd24699c8fbf42192fee28 Mon Sep 17 00:00:00 2001 From: v-minh1 Date: Tue, 17 Dec 2024 17:11:33 +0800 Subject: [PATCH 4/5] Revert changes to Configuration.java --- .../src/main/java/com/azure/core/util/Configuration.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java b/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java index 103c2e6aa88e6..8b2d627902d48 100644 --- a/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java +++ b/sdk/core/azure-core/src/main/java/com/azure/core/util/Configuration.java @@ -143,7 +143,7 @@ public class Configuration implements Cloneable { public static final String PROPERTY_AZURE_CLOUD = "AZURE_CLOUD"; /** - * The Microsoft Entra endpoint to connect to. + * The Azure Active Directory endpoint to connect to. */ public static final String PROPERTY_AZURE_AUTHORITY_HOST = "AZURE_AUTHORITY_HOST"; From 63db810c4fca627f5ee203c9d31233c800780e99 Mon Sep 17 00:00:00 2001 From: v-minh1 Date: Tue, 17 Dec 2024 17:11:52 +0800 Subject: [PATCH 5/5] Revert changes to AuthProperty.java --- .../identity/extensions/implementation/enums/AuthProperty.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java b/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java index 4a5dcdedc1453..1daf1c7383dd2 100644 --- a/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java +++ b/sdk/identity/azure-identity-extensions/src/main/java/com/azure/identity/extensions/implementation/enums/AuthProperty.java @@ -53,7 +53,7 @@ public enum AuthProperty { AUTHORITY_HOST("azure.authorityHost", AzureAuthorityHosts.AZURE_PUBLIC_CLOUD, "The well known authority hosts for the Azure Public Cloud and sovereign clouds.", true), /** - * Tenant ID for Azure resources. The values allowed for `tenant-id` are: `common`, `organizations`, `consumers`, or the tenant ID. + * Tenant ID for Azure resources. */ TENANT_ID("azure.tenantId", "Tenant ID for Azure resources.", true), /**