Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
update properties description according to current doc
  • Loading branch information
v-minh1 committed Dec 17, 2024
commit 246f70abda65e71469b6233a2b7aad6ded56f6f0
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down Expand Up @@ -197,7 +197,7 @@ public static class UserGroupProperties {
private Set<String> 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;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
{
Expand Down Expand Up @@ -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"
},
{
Expand Down Expand Up @@ -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"
},
{
Expand Down Expand Up @@ -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"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
/**
Expand Down
Loading