clarify properties (Azure#33802)

azure-sdk · Mar 2, 2023 · 6a0010e · 6a0010e
1 parent 93bcf94
commit 6a0010e
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 9 deletions.
diff --git a/.../autoconfigure/implementation/properties/core/retry/AmqpRetryConfigurationProperties.java b/.../autoconfigure/implementation/properties/core/retry/AmqpRetryConfigurationProperties.java
@@ -14,7 +14,7 @@
 public class AmqpRetryConfigurationProperties extends RetryConfigurationProperties implements RetryOptionsProvider.AmqpRetryOptions {
 
     /**
-     * Amount of time to wait until a timeout.
+     * Amount of time(Duration) to wait until a timeout.
      */
     private Duration tryTimeout;
 

diff --git a/...loud/autoconfigure/implementation/storage/blob/properties/AzureStorageBlobProperties.java b/...loud/autoconfigure/implementation/storage/blob/properties/AzureStorageBlobProperties.java
@@ -17,11 +17,13 @@ public class AzureStorageBlobProperties extends AzureStorageProperties implement
     private static final String BLOB_ENDPOINT_PATTERN = "https://%s.blob%s";
 
     /**
-     * Customer provided key used to encrypt blob contents on the server.
+     * Customer-provided encryption key(base64 encoded string) used to encrypt blob contents on the server.
+     * See Microsoft doc about Customer-provided Keys for more details: https://learn.microsoft.com/azure/storage/blobs/encryption-customer-provided-keys
      */
     private String customerProvidedKey;
     /**
-     * Encryption scope used to encrypt blob contents on the server.
+     * Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope.
+     * See Microsoft doc about Encryption Scope for more details: https://learn.microsoft.com/azure/storage/blobs/encryption-scope-overview
      */
     private String encryptionScope;
     /**

diff --git a/...zure/spring/cloud/autoconfigure/implementation/storage/common/AzureStorageProperties.java b/...zure/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.
+     * 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/...loud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java b/...loud/autoconfigure/implementation/storage/common/StorageRetryConfigurationProperties.java
@@ -14,11 +14,11 @@
 public class StorageRetryConfigurationProperties extends RetryConfigurationProperties implements StorageRetry {
 
     /**
-     * Secondary Storage account to retry requests against.
+     * 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;
     /**
-     * Amount of time to wait until a timeout.
+     * Amount of time(Duration) to wait until a timeout.
      */
     private Duration tryTimeout;
 

diff --git a/...ud/autoconfigure/implementation/storage/queue/properties/AzureStorageQueueProperties.java b/...ud/autoconfigure/implementation/storage/queue/properties/AzureStorageQueueProperties.java
@@ -21,7 +21,7 @@ public class AzureStorageQueueProperties extends AzureStorageProperties implemen
      */
     private QueueServiceVersion serviceVersion;
     /**
-     * How queue message body is represented in HTTP requests and responses.
+     * How queue message body is represented in HTTP requests and responses. All Supported types are: NONE, BASE64.
      */
     private QueueMessageEncoding messageEncoding;
     /**

diff --git a/...e-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/...e-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -870,7 +870,7 @@
     {
       "name": "spring.cloud.azure.servicebus.retry-options.try-timeout",
       "type": "java.time.Duration",
-      "description": "Amount of time to wait until a timeout. This is a legacy property.",
+      "description": "Amount of time(Duration) to wait until a timeout. This is a legacy property.",
       "deprecation": {
         "level": "error",
         "reason": "Deprecate to keep consistent with the unified configuration options.",

diff --git a/...java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java b/...java/com/azure/spring/messaging/storage/queue/core/properties/StorageQueueProperties.java
@@ -15,7 +15,7 @@ public class StorageQueueProperties extends AzureHttpSdkProperties implements Qu
     private static final String QUEUE_ENDPOINT_PATTERN = "https://%s.queue%s";
 
     /**
-     * Endpoint for Azure Storage service.
+     * Endpoint for Azure Storage service. For instance, 'https://{storage-account-name}.queue.storage.azure.net'.
      */
     private String endpoint;
     /**