From 8451bb74b48e6a2e20379c34cfc3683e37161947 Mon Sep 17 00:00:00 2001 From: Amanda Nguyen <48961492+amnguye@users.noreply.github.com> Date: Fri, 17 Jul 2020 10:16:15 -0700 Subject: [PATCH] Fixing see href doc bug, some formatting, and a few links in Azure.Storage.* libraries (#13349) --- .../src/BlobBatch.cs | 16 +- .../src/BlobChangeFeedClient.cs | 8 +- .../src/AppendBlobClient.cs | 60 +++- .../Azure.Storage.Blobs/src/BlobBaseClient.cs | 189 ++++++++--- .../Azure.Storage.Blobs/src/BlobClient.cs | 88 ++++-- .../src/BlobClientOptions.cs | 13 +- .../src/BlobContainerClient.cs | 168 +++++++--- .../src/BlobLeaseClient.cs | 56 +++- .../src/BlobServiceClient.cs | 88 ++++-- .../Azure.Storage.Blobs/src/BlobUriBuilder.cs | 4 +- .../src/BlockBlobClient.cs | 85 +++-- .../src/Models/BlobHttpHeaders.cs | 4 +- .../Azure.Storage.Blobs/src/PageBlobClient.cs | 149 ++++++--- .../src/Sas/BlobSasBuilder.cs | 4 +- .../src/Sas/BlobSasQueryParameters.cs | 4 +- .../src/Sas/AccountSasBuilder.cs | 3 +- .../src/Sas/SasQueryParameters.cs | 4 +- .../src/DataLakeClientOptions.cs | 10 +- .../src/DataLakeDirectoryClient.cs | 86 +++-- .../src/DataLakeFileClient.cs | 169 +++++++--- .../src/DataLakeFileSystemClient.cs | 92 ++++-- .../src/DataLakeLeaseClient.cs | 40 ++- .../src/DataLakePathClient.cs | 84 +++-- .../src/DataLakeServiceClient.cs | 24 +- .../src/Models/FileDownloadDetails.cs | 2 +- .../src/Models/PathHttpHeaders.cs | 4 +- .../src/Sas/DataLakeSasBuilder.cs | 5 +- .../src/Sas/DataLakeSasQueryParameters.cs | 4 +- .../src/Models/ShareFileHttpHeaders.cs | 4 +- .../src/Sas/ShareSasBuilder.cs | 5 +- .../src/ShareClient.cs | 175 +++++++--- .../src/ShareClientOptions.cs | 13 +- .../src/ShareDirectoryClient.cs | 188 ++++++++--- .../src/ShareFileClient.cs | 298 +++++++++++++----- .../src/ShareServiceClient.cs | 63 +++- .../src/ShareUriBuilder.cs | 4 +- .../Azure.Storage.Queues/src/QueueClient.cs | 261 +++++++++++---- .../src/QueueClientOptions.cs | 18 +- .../src/QueueServiceClient.cs | 81 +++-- .../src/QueueUriBuilder.cs | 4 +- .../src/Sas/QueueSasBuilder.cs | 5 +- 41 files changed, 1934 insertions(+), 648 deletions(-) diff --git a/sdk/storage/Azure.Storage.Blobs.Batch/src/BlobBatch.cs b/sdk/storage/Azure.Storage.Blobs.Batch/src/BlobBatch.cs index 45f22e843b9d6..251ceb80083da 100644 --- a/sdk/storage/Azure.Storage.Blobs.Batch/src/BlobBatch.cs +++ b/sdk/storage/Azure.Storage.Blobs.Batch/src/BlobBatch.cs @@ -13,7 +13,8 @@ namespace Azure.Storage.Blobs.Specialized /// operations in a single request via . /// /// For more information, see - /// . + /// + /// Blob Batch. /// public class BlobBatch : IDisposable { @@ -113,7 +114,7 @@ private void SetBatchOperationType(BlobBatchOperationType operationType) /// . /// /// For more information, see - /// . + /// Delete Blob. /// /// /// The name of the container containing the blob to delete. @@ -160,7 +161,7 @@ public virtual Response DeleteBlob( /// . /// /// For more information, see - /// . + /// Delete Blob. /// /// /// The blob to delete's primary endpoint. @@ -206,8 +207,9 @@ public virtual Response DeleteBlob( /// /// A block blob's tier determines Hot/Cool/Archive storage type. This /// operation does not update the blob's ETag. For detailed - /// information about block blob level tiering - /// . + /// information about block blob level tiering see + /// + /// Blob Storage Tiers. /// /// /// The name of the container containing the blob to set the tier of. @@ -258,7 +260,9 @@ public virtual Response SetBlobAccessTier( /// A block blob's tier determines Hot/Cool/Archive storage type. This /// operation does not update the blob's ETag. For detailed /// information about block blob level tiering - /// . + /// + /// Blob Storage Tiers. + /// /// /// /// The blob's primary endpoint. diff --git a/sdk/storage/Azure.Storage.Blobs.ChangeFeed/src/BlobChangeFeedClient.cs b/sdk/storage/Azure.Storage.Blobs.ChangeFeed/src/BlobChangeFeedClient.cs index 33c40dd9975dc..9dc07e86f8d3d 100644 --- a/sdk/storage/Azure.Storage.Blobs.ChangeFeed/src/BlobChangeFeedClient.cs +++ b/sdk/storage/Azure.Storage.Blobs.ChangeFeed/src/BlobChangeFeedClient.cs @@ -37,7 +37,9 @@ internal BlobChangeFeedClient(BlobServiceClient blobServiceClient) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, . + /// For more information, see + /// + /// Configuring Azure Storage conneciton strings. /// public BlobChangeFeedClient(string connectionString) { @@ -53,7 +55,9 @@ public BlobChangeFeedClient(string connectionString) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, . + /// For more information, see + /// + /// Configuring Azure Storage conneciton strings. /// /// /// Optional client options that define the transport pipeline diff --git a/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs b/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs index 8ad9567bc6175..4ec55b4f02818 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs @@ -224,7 +224,9 @@ private static void AssertNoClientSideEncryption(BlobClientOptions options) /// class with an identical source but the specified /// timestamp. /// - /// For more information, see . + /// For more information, see + /// + /// Create a snapshot of a blob. /// /// The snapshot identifier. /// A new instance. @@ -349,7 +351,9 @@ await CreateInternal( /// the newly initialized append blob. To add content to the append /// blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional standard HTTP header properties that can be set for the @@ -395,7 +399,9 @@ public virtual Response Create( /// the newly initialized append blob. To add content to the append /// blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional standard HTTP header properties that can be set for the @@ -441,7 +447,9 @@ await CreateInternal( /// the content of the existing append blob will remain unchanged. To add content to /// the append blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional parameters. @@ -475,7 +483,9 @@ public virtual Response CreateIfNotExists( /// the content of the existing append blob will remain unchanged. To add content to /// the append blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional parameters. @@ -509,7 +519,9 @@ await CreateIfNotExistsInternal( /// the content of the existing append blob will remain unchanged. To add content to /// the append blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional standard HTTP header properties that can be set for the @@ -549,7 +561,9 @@ public virtual Response CreateIfNotExists( /// the content of the existing append blob will remain unchanged. To add content to the append /// blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional standard HTTP header properties that can be set for the @@ -589,7 +603,9 @@ await CreateIfNotExistsInternal( /// the existing append blob will remain unchanged. To add content to the append /// blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional standard HTTP header properties that can be set for the @@ -668,7 +684,9 @@ private async Task> CreateIfNotExistsInternal( /// the newly initialized append blob. To add content to the append /// blob, call the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// Optional standard HTTP header properties that can be set for the @@ -771,7 +789,9 @@ private async Task> CreateInternal( /// operation is only permitted if the blob was created as an append /// blob. /// - /// For more information, see . + /// For more information, see + /// + /// Append Block. /// /// /// A containing the content of the block to @@ -827,7 +847,9 @@ public virtual Response AppendBlock( /// operation is only permitted if the blob was created as an append /// blob. /// - /// For more information, see . + /// For more information, see + /// + /// Append Block. /// /// /// A containing the content of the block to @@ -883,7 +905,9 @@ await AppendBlockInternal( /// operation is only permitted if the blob was created as an append /// blob. /// - /// For more information, see . + /// For more information, see + /// + /// Append Block. /// /// /// A containing the content of the block to @@ -985,7 +1009,9 @@ private async Task> AppendBlockInternal( /// operation is only permitted /// if the blob was created as an append blob. /// - /// For more information, see . + /// For more information, see + /// + /// Append Block From URL. /// /// /// Specifies the of the source blob. The value may @@ -1054,7 +1080,9 @@ public virtual Response AppendBlockFromUri( /// operation is only permitted /// if the blob was created as an append blob. /// - /// For more information, see . + /// For more information, see + /// + /// Append Block From URL. /// /// /// Specifies the of the source blob. The value may @@ -1123,7 +1151,9 @@ await AppendBlockFromUriInternal( /// operation is only permitted /// if the blob was created as an append blob. /// - /// For more information, see . + /// For more information, see + /// + /// Append Block From URL. /// /// /// Specifies the of the source blob. The value may diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs index 9a635e1961d95..44fb61f0c291b 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobBaseClient.cs @@ -170,7 +170,9 @@ protected BlobBaseClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the container containing this blob. @@ -192,7 +194,9 @@ public BlobBaseClient(string connectionString, string blobContainerName, string /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the container containing this blob. @@ -371,7 +375,9 @@ internal BlobBaseClient( /// class with an identical source but the specified /// timestamp. /// - /// For more information, see . + /// For more information, see + /// + /// Create a snapshot of a blob. /// /// The snapshot identifier. /// A new instance. @@ -481,7 +487,9 @@ private void SetNameFieldsIfNull() /// The operation downloads a blob from /// the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// A describing the @@ -499,7 +507,9 @@ public virtual Response Download() => /// The operation downloads a blob from /// the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// A describing the @@ -517,7 +527,9 @@ public virtual async Task> DownloadAsync() => /// The operation downloads /// a blob from the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// Optional to propagate @@ -543,7 +555,9 @@ public virtual Response Download( /// downloads a blob from the service, including its metadata and /// properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// Optional to propagate @@ -570,7 +584,9 @@ await DownloadAsync( /// operation downloads a blob from the service, including its metadata /// and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// If provided, only download the bytes of the blob in the specified @@ -619,7 +635,9 @@ public virtual Response Download( /// operation downloads a blob from the service, including its metadata /// and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// If provided, only download the bytes of the blob in the specified @@ -667,7 +685,9 @@ await DownloadInternal( /// The operation downloads a blob /// from the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// If provided, only download the bytes of the blob in the specified @@ -1554,7 +1574,9 @@ internal async Task OpenReadInternal( /// returned from the to determine if the /// copy has completed. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob. /// /// /// Specifies the of the source blob. The value may @@ -1617,7 +1639,9 @@ public virtual CopyFromUriOperation StartCopyFromUri( /// returned from the to determine if the /// copy has completed. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob. /// /// /// Specifies the of the source blob. The value may @@ -1701,7 +1725,9 @@ public virtual CopyFromUriOperation StartCopyFromUri( /// returned from the to determine if /// the copy has completed. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob. /// /// /// Specifies the of the source blob. The value may @@ -1764,7 +1790,9 @@ public virtual async Task StartCopyFromUriAsync( /// returned from the to determine if /// the copy has completed. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob. /// /// /// Specifies the of the source blob. The value may @@ -1848,7 +1876,9 @@ public virtual async Task StartCopyFromUriAsync( /// returned from the to determine if /// the copy has completed. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob. /// /// /// Specifies the of the source blob. The value may @@ -1975,7 +2005,9 @@ private async Task> StartCopyFromUriInternal( /// , and leaves a this /// blob with zero length and full metadata. /// - /// For more information, see . + /// For more information, see + /// + /// Abort Copy Blob. /// /// /// ID of the copy operation to abort. @@ -2011,7 +2043,9 @@ public virtual Response AbortCopyFromUri( /// , and leaves a this /// blob with zero length and full metadata. /// - /// For more information, see . + /// For more information, see + /// + /// Abort Copy Blob. /// /// /// ID of the copy operation to abort. @@ -2047,7 +2081,9 @@ await AbortCopyFromUriInternal( /// , and leaves a this /// blob with zero length and full metadata. /// - /// For more information, see . + /// For more information, see + /// + /// Abort Copy Blob. /// /// /// ID of the copy operation to abort. @@ -2120,7 +2156,9 @@ private async Task AbortCopyFromUriInternal( /// /// The size of the source blob can be a maximum length of up to 256 MB. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob From URL. /// /// /// Required. Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length @@ -2169,7 +2207,9 @@ public virtual Response SyncCopyFromUri( /// /// The size of the source blob can be a maximum length of up to 256 MB. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob From URL. /// /// /// Required. Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length @@ -2218,7 +2258,9 @@ public virtual async Task> SyncCopyFromUriAsync( /// /// The size of the source blob can be a maximum length of up to 256 MB. /// - /// For more information, see . + /// For more information, see + /// + /// Copy Blob From URL. /// /// /// Required. Specifies the URL of the source blob. The value may be a URL of up to 2 KB in length @@ -2336,7 +2378,9 @@ private async Task> SyncCopyFromUriInternal( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// /// Specifies options for deleting blob snapshots. @@ -2376,7 +2420,9 @@ public virtual Response Delete( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// /// Specifies options for deleting blob snapshots. @@ -2416,7 +2462,9 @@ await DeleteInternal( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// /// Specifies options for deleting blob snapshots. @@ -2456,7 +2504,9 @@ public virtual Response DeleteIfExists( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// /// Specifies options for deleting blob snapshots. @@ -2496,7 +2546,9 @@ await DeleteIfExistsInternal( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// /// Specifies options for deleting blob snapshots. @@ -2572,7 +2624,9 @@ private async Task> DeleteIfExistsInternal( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// /// Specifies options for deleting blob snapshots. @@ -2760,7 +2814,9 @@ private async Task> ExistsInternal( /// and metadata of a soft deleted blob and any associated soft /// deleted snapshots. /// - /// For more information, see . + /// For more information, see + /// + /// Undelete Blob. /// /// /// Optional to propagate @@ -2785,7 +2841,9 @@ public virtual Response Undelete( /// and metadata of a soft deleted blob and any associated soft /// deleted snapshots. /// - /// For more information, see . + /// For more information, see + /// + /// Undelete Blob. /// /// /// Optional to propagate @@ -2810,7 +2868,9 @@ await UndeleteInternal( /// and metadata of a soft deleted blob and any associated soft /// deleted snapshots. /// - /// For more information, see . + /// For more information, see + /// + /// Undelete Blob. /// /// /// Whether to invoke the operation asynchronously. @@ -2865,7 +2925,9 @@ private async Task UndeleteInternal( /// properties for the blob. It does not return the content of the /// blob. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob Properties. /// /// /// Optional to add @@ -2898,7 +2960,9 @@ public virtual Response GetProperties( /// properties for the blob. It does not return the content of the /// blob. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob Properties. /// /// /// Optional to add @@ -2931,7 +2995,9 @@ await GetPropertiesInternal( /// properties for the blob. It does not return the content of the /// blob. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob Properties. /// /// /// Optional to add @@ -3007,10 +3073,13 @@ private async Task> GetPropertiesInternal( /// The operation sets system /// properties on the blob. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// - /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. + /// Optional. The standard HTTP header system properties to set. + /// If not specified, existing values will be cleared. /// /// /// Optional to add conditions on @@ -3043,7 +3112,9 @@ public virtual Response SetHttpHeaders( /// The operation sets system /// properties on the blob. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. @@ -3079,7 +3150,9 @@ await SetHttpHeadersInternal( /// The operation sets system /// properties on the blob. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. @@ -3167,7 +3240,9 @@ await BlobRestClient.Blob.SetHttpHeadersAsync( /// The operation sets user-defined /// metadata for the specified blob as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Metadata. /// /// /// Custom metadata to set for this blob. @@ -3203,7 +3278,9 @@ public virtual Response SetMetadata( /// The operation sets user-defined /// metadata for the specified blob as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Metadata. /// /// /// Custom metadata to set for this blob. @@ -3239,7 +3316,9 @@ await SetMetadataInternal( /// The operation sets user-defined /// metadata for the specified blob as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Metadata. /// /// /// Custom metadata to set for this blob. @@ -3325,7 +3404,9 @@ await BlobRestClient.Blob.SetMetadataAsync( /// The operation creates a /// read-only snapshot of a blob. /// - /// For more information, see . + /// For more information, see + /// + /// Snapshot Blob. /// /// /// Optional custom metadata to set for this blob snapshot. @@ -3361,7 +3442,9 @@ public virtual Response CreateSnapshot( /// The operation creates a /// read-only snapshot of a blob. /// - /// For more information, see . + /// For more information, see + /// + /// Snapshot Blob. /// /// /// Optional custom metadata to set for this blob snapshot. @@ -3397,7 +3480,9 @@ await CreateSnapshotInternal( /// The operation creates a /// read-only snapshot of a blob. /// - /// For more information, see . + /// For more information, see + /// + /// Snapshot Blob. /// /// /// Optional custom metadata to set for this blob snapshot. @@ -3481,10 +3566,12 @@ private async Task> CreateSnapshotInternal( /// bandwidth of the blob. A block blob's tier determines /// Hot/Cool/Archive storage type. This operation does not update the /// blob's ETag. For detailed information about block blob level - /// tiering + /// tiering + /// Blob Storage Tiers. /// /// For more information about setting the tier, see - /// . + /// + /// Blob Storage Tiers. /// /// /// Indicates the tier to be set on the blob. @@ -3531,10 +3618,12 @@ public virtual Response SetAccessTier( /// bandwidth of the blob. A block blob's tier determines /// Hot/Cool/Archive storage type. This operation does not update the /// blob's ETag. For detailed information about block blob level - /// tiering + /// tiering + /// Blob Storage Tiers. /// /// For more information about setting the tier, see - /// . + /// + /// Blob Storage Tiers. /// /// /// Indicates the tier to be set on the blob. @@ -3581,10 +3670,12 @@ await SetAccessTierInternal( /// bandwidth of the blob. A block blob's tier determines /// Hot/Cool/Archive storage type. This operation does not update the /// blob's ETag. For detailed information about block blob level - /// tiering + /// tiering + /// Blob Storage Tiers. /// /// For more information about setting the tier, see - /// . + /// + /// Blob Storage Tiers. /// /// /// Indicates the tier to be set on the blob. diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobClient.cs index ca93e99d9477a..2a101ec841de1 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobClient.cs @@ -43,7 +43,9 @@ protected BlobClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings. /// /// /// The name of the container containing this blob. @@ -65,7 +67,9 @@ public BlobClient(string connectionString, string blobContainerName, string blob /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings. /// /// /// The name of the container containing this blob. @@ -252,7 +256,9 @@ internal BlobClient( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -278,7 +284,9 @@ public virtual Response Upload(Stream content) => /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -304,7 +312,9 @@ public virtual Response Upload(string path) => /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -330,7 +340,9 @@ public virtual async Task> UploadAsync(Stream content) /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -357,7 +369,9 @@ public virtual async Task> UploadAsync(string path) => /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -393,7 +407,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -429,7 +445,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -465,7 +483,9 @@ public virtual Task> UploadAsync( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -502,7 +522,9 @@ await UploadAsync( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -543,7 +565,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -584,7 +608,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -625,7 +651,9 @@ public virtual Task> UploadAsync( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -667,7 +695,9 @@ await UploadAsync( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -709,7 +739,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -785,7 +817,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -832,7 +866,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. @@ -913,7 +949,9 @@ public virtual Response Upload( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -955,7 +993,9 @@ await StagedUploadInternal( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -1031,7 +1071,9 @@ public virtual Task> UploadAsync( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob.. /// /// /// A file path containing the content to upload. @@ -1078,7 +1120,9 @@ public virtual async Task> UploadAsync( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A file path containing the content to upload. diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobClientOptions.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobClientOptions.cs index 6c7fca2f2099c..1d2cc111467a8 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobClientOptions.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobClientOptions.cs @@ -22,19 +22,23 @@ public class BlobClientOptions : ClientOptions /// /// The versions of Azure Blob Storage supported by this client /// library. For more, see - /// . + /// + /// Versioning for Azure Storage Services. /// public enum ServiceVersion { #pragma warning disable CA1707 // Identifiers should not contain underscores /// /// The 2019-02-02 service version described at - /// + /// + /// Version 2019-02-02 /// V2019_02_02 = 1, /// - /// The 2019-07-07 service version. + /// The 2019-07-07 service version described at + /// + /// Version 2019-07-07 /// V2019_07_07 = 2, @@ -48,7 +52,8 @@ public enum ServiceVersion /// /// Gets the of the service API used when /// making requests. For more, see - /// . + /// + /// Versioning for Azure Storage Services. /// public ServiceVersion Version { get; } diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs index 6e5a6e3e1020f..1c4e0d0324e0a 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobContainerClient.cs @@ -165,7 +165,9 @@ protected BlobContainerClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the blob container in the storage account to reference. @@ -184,7 +186,9 @@ public BlobContainerClient(string connectionString, string blobContainerName) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the container in the storage account to reference. @@ -422,7 +426,9 @@ private void SetNameFieldsIfNull() /// under the specified account. If the container with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -473,7 +479,9 @@ public virtual Response Create( /// under the specified account. If the container with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -523,7 +531,9 @@ public virtual Response Create( /// operation creates a new container under the specified account. If the container with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -574,7 +584,9 @@ await CreateInternal( /// under the specified account. If the container with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -624,7 +636,9 @@ await CreateInternal( /// operation creates a new container under the specified account. If the container with the same name /// already exists, it is not changed. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -675,7 +689,9 @@ public virtual Response CreateIfNotExists( /// under the specified account. If the container with the same name /// already exists, it is not changed. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -725,7 +741,9 @@ public virtual Response CreateIfNotExists( /// operation creates a new container under the specified account. If the container with the same name /// already exists, it is not changed. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -776,7 +794,9 @@ await CreateIfNotExistsInternal( /// under the specified account. If the container with the same name /// already exists, it is not changed. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -826,7 +846,9 @@ await CreateIfNotExistsInternal( /// operation creates a new container under the specified account. If the container already exists, it is /// not changed. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -911,7 +933,9 @@ private async Task> CreateIfNotExistsInternal( /// under the specified account, if it does not already exist. /// If the container with the same name already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the container may be accessed @@ -1000,7 +1024,9 @@ private async Task> CreateInternal( /// container for deletion. The container and any blobs contained /// within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -1031,7 +1057,9 @@ public virtual Response Delete( /// container for deletion. The container and any blobs contained /// within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -1062,7 +1090,9 @@ await DeleteInternal( /// container for deletion if it exists. The container and any blobs /// contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -1094,7 +1124,9 @@ public virtual Response DeleteIfExists( /// container for deletion if it exists. The container and any blobs /// contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -1126,7 +1158,9 @@ await DeleteIfExistsInternal( /// container for deletion if it exists. The container and any blobs /// contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -1192,7 +1226,9 @@ private async Task> DeleteIfExistsInternal( /// container for deletion. The container and any blobs contained /// within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -1382,7 +1418,9 @@ private async Task> ExistsInternal( /// container. The data returned does not include the container's /// list of blobs. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container Properties. /// /// /// Optional to add @@ -1415,7 +1453,9 @@ public virtual Response GetProperties( /// container. The data returned does not include the container's /// list of blobs. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container Properties. /// /// /// Optional to add @@ -1448,7 +1488,9 @@ await GetPropertiesInternal( /// container. The data returned does not include the container's /// list of blobs. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container Properties. /// /// /// Optional to add @@ -1532,7 +1574,9 @@ await BlobRestClient.Container.GetPropertiesAsync( /// The operation sets one or more /// user-defined name-value pairs for the specified container. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container Metadata. /// /// /// Custom metadata to set for this container. @@ -1567,7 +1611,9 @@ public virtual Response SetMetadata( /// The operation sets one or more /// user-defined name-value pairs for the specified container. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container Metadata. /// /// /// Custom metadata to set for this container. @@ -1602,7 +1648,9 @@ await SetMetadataInternal( /// The operation sets one or more /// user-defined name-value pairs for the specified container. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container Metadata. /// /// /// Custom metadata to set for this container. @@ -1682,7 +1730,9 @@ private async Task> SetMetadataInternal( /// permissions for this container. The permissions indicate whether /// container data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container ACL. /// /// /// Optional to add @@ -1714,7 +1764,9 @@ public virtual Response GetAccessPolicy( /// permissions for this container. The permissions indicate whether /// container data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container ACL. /// /// /// Optional to add @@ -1746,7 +1798,9 @@ await GetAccessPolicyInternal( /// permissions for this container. The permissions indicate whether /// container data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container ACL. /// /// /// Optional to add @@ -1811,7 +1865,9 @@ private async Task> GetAccessPolicyInternal( /// permissions for the specified container. The permissions indicate /// whether blob container data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container ACL. /// /// /// Optionally specifies whether data in the container may be accessed @@ -1864,7 +1920,9 @@ public virtual Response SetAccessPolicy( /// permissions for the specified container. The permissions indicate /// whether blob container data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container ACL. /// /// /// Optionally specifies whether data in the container may be accessed @@ -1917,7 +1975,9 @@ await SetAccessPolicyInternal( /// permissions for the specified container. The permissions indicate /// whether blob container data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container ACL. /// /// /// Optionally specifies whether data in the container may be accessed @@ -2012,7 +2072,9 @@ private async Task> SetAccessPolicyInternal( /// multiple requests to the service while fetching all the values. /// Blobs are ordered lexicographically by name. /// - /// For more information, see List Blobs. + /// For more information, see + /// + /// List Blobs. /// /// /// Specifies trait options for shaping the blobs. @@ -2049,7 +2111,9 @@ public virtual Pageable GetBlobs( /// make multiple requests to the service while fetching all the /// values. Blobs are ordered lexicographically by name. /// - /// For more information, see List Blobs. + /// For more information, see + /// + /// List Blobs. /// /// /// Specifies trait options for shaping the blobs. @@ -2090,7 +2154,9 @@ public virtual AsyncPageable GetBlobsAsync( /// to continue enumerating the blobs segment by segment. Blobs are /// ordered lexicographically by name. /// - /// For more information, see List Blobs. + /// For more information, see + /// + /// List Blobs. /// /// /// An optional string value that identifies the segment of the list @@ -2195,7 +2261,9 @@ internal async Task> GetBlobsInternal( /// can be used to traverse a virtual /// hierarchy of blobs as though it were a file system. /// - /// For more information, see List Blobs. + /// For more information, see + /// + /// List Blobs. /// /// /// Specifies trait options for shaping the blobs. @@ -2252,7 +2320,9 @@ public virtual Pageable GetBlobsByHierarchy( /// can be used to traverse a virtual /// hierarchy of blobs as though it were a file system. /// - /// For more information, see List Blobs. + /// For more information, see + /// + /// List Blobs. /// /// /// Specifies trait options for shaping the blobs. @@ -2313,7 +2383,9 @@ public virtual AsyncPageable GetBlobsByHierarchyAsync( /// can be used to traverse a virtual hierarchy of blobs as though /// it were a file system. /// - /// For more information, see List Blobs. + /// For more information, see + /// + /// List Blobs. /// /// /// An optional string value that identifies the segment of the list @@ -2429,7 +2501,9 @@ internal async Task> GetBlobsByHierarchyInternal /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// The name of the blob to upload. /// @@ -2469,7 +2543,9 @@ public virtual Response UploadBlob( /// append blobs, please see or /// . /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// The name of the blob to upload. /// @@ -2512,7 +2588,9 @@ await GetBlobClient(blobName) /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// The name of the blob to delete. /// @@ -2554,7 +2632,9 @@ public virtual Response DeleteBlob( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// The name of the blob to delete. /// @@ -2597,7 +2677,9 @@ await GetBlobClient(blobName) /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// The name of the blob to delete. /// @@ -2639,7 +2721,9 @@ public virtual Response DeleteBlobIfExists( /// snapshots. You can delete both at the same time using /// . /// - /// For more information, see . + /// For more information, see + /// + /// Delete Blob. /// /// The name of the blob to delete. /// diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobLeaseClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobLeaseClient.cs index 226905bf261ad..b51ed16f5e99b 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobLeaseClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobLeaseClient.cs @@ -191,7 +191,9 @@ public virtual Response Acquire( /// using the active lease ID as , but you can /// specify a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the duration of the lease, in seconds, or specify @@ -237,7 +239,9 @@ await AcquireInternal( /// using the active lease ID as , but you can /// specify a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the duration of the lease, in seconds, or specify @@ -355,7 +359,9 @@ private async Task> AcquireInternal( /// container has not been leased again since the expiration of that /// lease. When you renew a lease, the lease duration clock resets. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -391,7 +397,9 @@ public virtual Response Renew( /// container has not been leased again since the expiration of that /// lease. When you renew a lease, the lease duration clock resets. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -427,7 +435,9 @@ await RenewInternal( /// container has not been leased again since the expiration of that /// lease. When you renew a lease, the lease duration clock resets. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -531,7 +541,9 @@ private async Task> RenewInternal( /// lease allows another client to immediately acquire the lease for the /// container or blob as soon as the release is complete. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -567,7 +579,9 @@ public virtual Response Release( /// lease allows another client to immediately acquire the lease for the /// container or blob as soon as the release is complete. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -603,7 +617,9 @@ await ReleaseInternal( /// lease allows another client to immediately acquire the lease for the /// container or blob as soon as the release is complete. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -713,7 +729,9 @@ await BlobRestClient.Container.ReleaseLeaseAsync( /// of an active lease. A change must include the current /// and a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// An optional proposed lease ID, in a GUID string format. A @@ -751,7 +769,9 @@ public virtual Response Change( /// of an active lease. A change must include the current /// and a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// An optional proposed lease ID, in a GUID string format. A @@ -789,7 +809,9 @@ await ChangeInternal( /// of an active lease. A change must include the current /// and a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// An optional proposed lease ID, in a GUID string format. A @@ -913,7 +935,9 @@ private async Task> ChangeInternal( /// immediately acquire a blob or container lease that has been /// released. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the proposed duration the lease should continue before @@ -970,7 +994,9 @@ public virtual Response Break( /// immediately acquire a blob or container lease that has been /// released. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the proposed duration the lease should continue before @@ -1027,7 +1053,9 @@ await BreakInternal( /// immediately acquire a blob or container lease that has been /// released. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the proposed duration the lease should continue before diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs index 6667fb85c7fb9..e780c80718d3c 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobServiceClient.cs @@ -159,7 +159,9 @@ public BlobServiceClient(string connectionString) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// Optional client options that define the transport pipeline @@ -420,7 +422,9 @@ protected static BlobClientOptions GetClientOptions(BlobServiceClient client) => /// blob containers may make multiple requests to the service while fetching /// all the values. Containers are ordered lexicographically by name. /// - /// For more information, see List Containers. + /// For more information, + /// see + /// List Containers. /// /// /// Specifies trait options for shaping the blob containers. @@ -457,7 +461,9 @@ public virtual Pageable GetBlobContainers( /// blob containers may make multiple requests to the service while fetching /// all the values. Containers are ordered lexicographically by name. /// - /// For more information, see List Containers. + /// For more information, see + /// + /// List Containers. /// /// /// Specifies trait options for shaping the blob containers. @@ -493,7 +499,9 @@ public virtual Pageable GetBlobContainers( /// blob containers may make multiple requests to the service while fetching /// all the values. Containers are ordered lexicographically by name. /// - /// For more information, see . + /// For more information, see + /// + /// List Containers. /// /// /// Specifies trait options for shaping the blob containers. @@ -530,7 +538,9 @@ public virtual AsyncPageable GetBlobContainersAsync( /// blob containers may make multiple requests to the service while fetching /// all the values. Containers are ordered lexicographically by name. /// - /// For more information, see . + /// For more information, see + /// + /// List Containers. /// /// /// Specifies trait options for shaping the blob containers. @@ -570,7 +580,9 @@ public virtual AsyncPageable GetBlobContainersAsync( /// to continue enumerating the containers segment by segment. /// Containers are ordered lexicographically by name. /// - /// For more information, see List Containers. + /// For more information, see + /// + /// List Containers. /// /// /// An optional string value that identifies the segment of the list @@ -669,7 +681,9 @@ internal async Task> GetBlobContainersInternal( /// The operation returns the sku /// name and account kind for the specified account. /// - /// For more information, see . + /// For more information, see + /// + /// Get Account Information. /// /// /// Optional to propagate @@ -693,7 +707,9 @@ public virtual Response GetAccountInfo( /// The operation returns the sku /// name and account kind for the specified account. /// - /// For more information, see . + /// For more information, see + /// + /// Get Account Information. /// /// /// Optional to propagate @@ -717,7 +733,9 @@ await GetAccountInfoInternal( /// The operation returns the sku /// name and account kind for the specified account. /// - /// For more information, see . + /// For more information, see + /// + /// Get Account Information. /// /// /// Whether to invoke the operation asynchronously. @@ -771,7 +789,9 @@ private async Task> GetAccountInfoInternal( /// of a storage account’s blob service, including properties for /// Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob Service Properties. /// /// /// Optional to propagate @@ -797,7 +817,9 @@ public virtual Response GetProperties( /// of a storage account’s blob service, including properties for /// Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob Service Properties. /// /// /// Optional to propagate @@ -823,7 +845,9 @@ await GetPropertiesInternal( /// of a storage account’s blob service, including properties for /// Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob Service Properties. /// /// /// Whether to invoke the operation asynchronously. @@ -881,7 +905,9 @@ private async Task> GetPropertiesInternal( /// the default request version for all incoming requests to the Blob /// service that do not have a version specified. /// - /// For more information, see Set Blob Service Properties. + /// For more information, see + /// + /// Set Blob Service Properties. /// /// The blob service properties. /// @@ -913,7 +939,9 @@ public virtual Response SetProperties( /// the default request version for all incoming requests to the Blob /// service that do not have a version specified. /// - /// For more information, see Set Blob Service Properties. + /// For more information, see + /// + /// Set Blob Service Properties. /// /// The blob service properties. /// @@ -945,7 +973,9 @@ await SetPropertiesInternal( /// the default request version for all incoming requests to the Blob /// service that do not have a version specified. /// - /// For more information, see Set Blob Service Properties. + /// For more information, see + /// + /// Set Blob Service Properties. /// /// The blob service properties. /// @@ -1009,7 +1039,9 @@ private async Task SetPropertiesInternal( /// geo-redundant replication () /// is enabled for the storage account. /// - /// For more information, see Get Blob Service Stats. + /// For more information, see + /// + /// Get Blob Service Stats. /// /// /// Optional to propagate @@ -1037,7 +1069,9 @@ public virtual Response GetStatistics( /// geo-redundant replication () /// is enabled for the storage account. /// - /// For more information, see Get Blob Service Stats. + /// For more information, see + /// + /// Get Blob Service Stats. /// /// /// Optional to propagate @@ -1065,7 +1099,9 @@ await GetStatisticsInternal( /// geo-redundant replication () /// is enabled for the storage account. /// - /// For more information, see Get Blob Service Stats. + /// For more information, see + /// + /// Get Blob Service Stats. /// /// /// Whether to invoke the operation asynchronously. @@ -1266,7 +1302,9 @@ private async Task> GetUserDelegationKeyInternal( /// blob container under the specified account. If the container with the /// same name already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// The name of the container to create. @@ -1316,7 +1354,9 @@ public virtual Response CreateBlobContainer( /// blob container under the specified account. If the container with the /// same name already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// The name of the container to create. @@ -1368,7 +1408,9 @@ public virtual async Task> CreateBlobContainerAsyn /// specified blob container for deletion. The container and any blobs /// contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// The name of the container to delete. @@ -1403,7 +1445,9 @@ public virtual Response DeleteBlobContainer( /// specified container for deletion. The container and any blobs /// contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// The name of the blob container to delete. diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs b/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs index 64388dd96b1b5..a47c6a9259a87 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlobUriBuilder.cs @@ -15,7 +15,9 @@ namespace Azure.Storage.Blobs /// modify the contents of a instance to point to /// different Azure Storage resources like an account, container, or blob. /// - /// For more information, see . + /// For more information, see + /// + /// Naming and Referencing Containers, Blobs, and Metadata. /// public class BlobUriBuilder { diff --git a/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs b/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs index 50b09b047b3ac..e4b0d6c382d7f 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/BlockBlobClient.cs @@ -146,7 +146,9 @@ protected BlockBlobClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the container containing this block blob. @@ -168,7 +170,9 @@ public BlockBlobClient(string connectionString, string containerName, string blo /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the container containing this block blob. @@ -328,7 +332,9 @@ private static void AssertNoClientSideEncryption(BlobClientOptions options) /// class with an identical source but the specified /// timestamp. /// - /// For more information, see . + /// For more information, see + /// + /// Create a snapshot of a blob. /// /// The snapshot identifier. /// A new instance. @@ -398,7 +404,9 @@ protected sealed override BlobBaseClient WithSnapshotCore(string snapshot) /// block blob, use the and /// operations. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -446,7 +454,9 @@ public virtual Response Upload( /// block blob, use the and /// operations. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -495,7 +505,9 @@ public virtual async Task> UploadAsync( /// block blob, use the and /// operations. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -563,7 +575,9 @@ public virtual Response Upload( /// block blob, use the and /// operations. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -631,7 +645,9 @@ public virtual async Task> UploadAsync( /// block blob, use the and /// operations. /// - /// For more information, see . + /// For more information, see + /// + /// Put Blob. /// /// /// A containing the content to upload. @@ -749,7 +765,9 @@ internal virtual async Task> UploadInternal( /// part of a block blob's "staging area" to be eventually committed /// via the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Block. /// /// /// A valid Base64 string value that identifies the block. Prior to @@ -814,7 +832,9 @@ public virtual Response StageBlock( /// part of a block blob's "staging area" to be eventually committed /// via the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Block. /// /// /// A valid Base64 string value that identifies the block. Prior to @@ -879,7 +899,9 @@ await StageBlockInternal( /// as part of a block blob's "staging area" to be eventually committed /// via the operation. /// - /// For more information, see . + /// For more information, see + /// + /// Put Block. /// /// /// A valid Base64 string value that identifies the block. Prior to @@ -982,7 +1004,9 @@ internal virtual async Task> StageBlockInternal( /// block to be committed as part of a blob where the contents are /// read from the . /// - /// For more information, see Put Block From URL. + /// For more information, see + /// + /// Put Block From URL. /// /// /// Specifies the of the source blob. The value may @@ -1059,7 +1083,9 @@ public virtual Response StageBlockFromUri( /// block to be committed as part of a blob where the contents are /// read from the . /// - /// For more information, see Put Block From URL. + /// For more information, see + /// + /// Put Block From URL. /// /// /// Specifies the of the source blob. The value may @@ -1136,7 +1162,9 @@ await StageBlockFromUriInternal( /// block to be committed as part of a blob where the contents are /// read from the . /// - /// For more information, see Put Block From URL. + /// For more information, see + /// + /// Put Block From URL. /// /// /// Specifies the of the source blob. The value may @@ -1265,7 +1293,9 @@ private async Task> StageBlockFromUriInternal( /// may belong to. Any blocks not specified in the block list and /// permanently deleted. /// - /// For more information, see . + /// For more information, see + /// + /// Put Block List. /// /// /// Specify the Uncommitted Base64 encoded block IDs to indicate that @@ -1318,7 +1348,9 @@ public virtual Response CommitBlockList( /// may belong to. Any blocks not specified in the block list and /// permanently deleted. /// - /// For more information, see Put Block List. + /// For more information, see + /// + /// Put Block List. /// /// /// Specify the Uncommitted Base64 encoded block IDs to indicate that @@ -1387,7 +1419,9 @@ public virtual Response CommitBlockList( /// may belong to. Any blocks not specified in the block list and /// permanently deleted. /// - /// For more information, see . + /// For more information, see + /// + /// Put Block List. /// /// /// Specify the Uncommitted Base64 encoded block IDs to indicate that @@ -1440,7 +1474,9 @@ await CommitBlockListInternal( /// may belong to. Any blocks not specified in the block list and /// permanently deleted. /// - /// For more information, see Put Block List. + /// For more information, see + /// + /// Put Block List. /// /// /// Specify the Uncommitted Base64 encoded block IDs to indicate that @@ -1509,7 +1545,9 @@ await CommitBlockListInternal( /// may belong to. Any blocks not specified in the block list and /// permanently deleted. /// - /// For more information, see Put Block List. + /// For more information, see + /// + /// Put Block List. /// /// /// Specify the Uncommitted Base64 encoded block IDs to indicate that @@ -1636,7 +1674,8 @@ internal virtual async Task> CommitBlockListInternal( /// /// Optionally specifies the blob snapshot to retrieve the block list /// from. For more information on working with blob snapshots, see - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Optional to add @@ -1686,7 +1725,8 @@ public virtual Response GetBlockList( /// /// Optionally specifies the blob snapshot to retrieve the block list /// from. For more information on working with blob snapshots, see - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Optional to add @@ -1736,7 +1776,8 @@ await GetBlockListInternal( /// /// Optionally specifies the blob snapshot to retrieve the block list /// from. For more information on working with blob snapshots, see - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Optional to add diff --git a/sdk/storage/Azure.Storage.Blobs/src/Models/BlobHttpHeaders.cs b/sdk/storage/Azure.Storage.Blobs/src/Models/BlobHttpHeaders.cs index a5c0de3934d61..816134e77f1cd 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/Models/BlobHttpHeaders.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/Models/BlobHttpHeaders.cs @@ -12,7 +12,9 @@ namespace Azure.Storage.Blobs.Models /// names, as specified in the Header Field Definitions section 14 of the /// HTTP/1.1 protocol specification. /// - /// For more information, see . + /// For more information, see + /// + /// Setting and retrieving properties and metadata for Blob service resources. /// public class BlobHttpHeaders { diff --git a/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs b/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs index 82fd17a192772..9cb45884f0e6b 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/PageBlobClient.cs @@ -62,7 +62,9 @@ protected PageBlobClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information + /// + /// Configure Azure Storage connection strings /// /// /// The name of the container containing this page blob. @@ -84,7 +86,9 @@ public PageBlobClient(string connectionString, string blobContainerName, string /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the container containing this page blob. @@ -219,7 +223,9 @@ private static void AssertNoClientSideEncryption(BlobClientOptions options) /// class with an identical source but the specified /// snapshot timestamp. /// - /// For more information, see . + /// For more information, see + /// + /// Create a snapshot of a blob. /// /// The snapshot identifier. /// A new instance. @@ -888,7 +894,9 @@ private async Task> CreateInternal( /// to a range of pages in a page blob, /// starting at . /// - /// For more information, see . + /// For more information, see + /// + /// Put Page. /// /// /// A containing the content of the pages to @@ -949,7 +957,9 @@ public virtual Response UploadPages( /// to a range of pages in a page blob, /// starting at . /// - /// For more information, see . + /// For more information, see + /// + /// Put Page. /// /// /// A containing the content of the pages to @@ -1010,7 +1020,9 @@ await UploadPagesInternal( /// to a range of pages in a page blob, /// starting at . /// - /// For more information, see . + /// For more information, see + /// + /// Put Page. /// /// /// A containing the content of the pages to @@ -1119,7 +1131,9 @@ private async Task> UploadPagesInternal( /// The operation clears one or more /// pages from the page blob, as specificed by the . /// - /// For more information, see . + /// For more information, see + /// + /// Put Page. /// /// /// Specifies the range of bytes to be cleared. Both the start and @@ -1161,7 +1175,9 @@ public virtual Response ClearPages( /// The operation clears one or more /// pages from the page blob, as specificed by the . /// - /// For more information, see . + /// For more information, see + /// + /// Put Page. /// /// /// Specifies the range of bytes to be cleared. Both the start and @@ -1203,7 +1219,9 @@ await ClearPagesInternal( /// The operation clears one or more /// pages from the page blob, as specificed by the . /// - /// For more information, see . + /// For more information, see + /// + /// Put Page. /// /// /// Specifies the range of bytes to be cleared. Both the start and @@ -1290,7 +1308,9 @@ private async Task> ClearPagesInternal( /// The operation returns the list of /// valid page ranges for a page blob or snapshot of a page blob. /// - /// For more information, see . + /// For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1299,7 +1319,8 @@ private async Task> ClearPagesInternal( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Optional to add @@ -1334,7 +1355,9 @@ public virtual Response GetPageRanges( /// The operation returns the list of /// valid page ranges for a page blob or snapshot of a page blob. /// - /// For more information, see . + /// For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1343,7 +1366,8 @@ public virtual Response GetPageRanges( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Optional to add @@ -1378,7 +1402,9 @@ await GetPageRangesInternal( /// The operation returns the list /// of valid page ranges for a page blob or snapshot of a page blob. /// - /// For more information, see . + /// For more information, see For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1387,7 +1413,8 @@ await GetPageRangesInternal( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Optional to add @@ -1468,7 +1495,9 @@ private async Task> GetPageRangesInternal( /// and this page blob. Changed pages /// include both updated and cleared pages. /// - /// For more information, see . + /// For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1477,7 +1506,8 @@ private async Task> GetPageRangesInternal( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Specifies that the response will contain only pages that were @@ -1525,7 +1555,9 @@ public virtual Response GetPageRangesDiff( /// and this page blob. Changed pages /// include both updated and cleared pages. /// - /// For more information, see . + /// For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1534,7 +1566,8 @@ public virtual Response GetPageRangesDiff( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Specifies that the response will contain only pages that were @@ -1582,7 +1615,9 @@ await GetPageRangesDiffInternal( /// and this page blob. Changed pages /// include both updated and cleared pages. /// - /// For more information, see . + /// For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1591,7 +1626,8 @@ await GetPageRangesDiffInternal( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// Specifies that the response will contain only pages that were @@ -1698,7 +1734,9 @@ private async Task> GetPageRangesDiffInternal( /// include both updated and cleared pages. This API only works with /// managed disk storage accounts. /// - /// For more information, see . + /// For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1707,7 +1745,8 @@ private async Task> GetPageRangesDiffInternal( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// This parameter only works with managed disk storage accounts. @@ -1757,7 +1796,9 @@ public virtual Response GetManagedDiskPageRangesDiff( /// include both updated and cleared pages. This API only works with /// managed disk storage accounts. /// - /// For more information, see . + /// For more information, see + /// + /// Get Page Ranges. /// /// /// Optionally specifies the range of bytes over which to list ranges, @@ -1766,7 +1807,8 @@ public virtual Response GetManagedDiskPageRangesDiff( /// /// Optionally specifies the blob snapshot to retrieve page ranges /// information from. For more information on working with blob snapshots, - /// Create a snapshot of a blob. + /// + /// Create a snapshot of a blob. /// /// /// This parameter only works with managed disk storage accounts. @@ -1818,7 +1860,9 @@ await GetPageRangesDiffInternal( /// specified value is less than the current size of the blob, then /// all pages above the specified value are cleared. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Specifies the maximum size for the page blob, up to 8 TB. The @@ -1859,7 +1903,9 @@ public virtual Response Resize( /// specified value is less than the current size of the blob, then /// all pages above the specified value are cleared. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Specifies the maximum size for the page blob, up to 8 TB. The @@ -1900,7 +1946,9 @@ await ResizeInternal( /// specified value is less than the current size of the blob, then /// all pages above the specified value are cleared. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Specifies the maximum size for the page blob, up to 8 TB. The @@ -1982,7 +2030,9 @@ private async Task> ResizeInternal( /// sequence number and /// for this page blob. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Specifies how the service should modify the blob's sequence number. @@ -2039,7 +2089,9 @@ public virtual Response UpdateSequenceNumber( /// sequence number and /// for this page blob. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Specifies how the service should modify the blob's sequence number. @@ -2096,7 +2148,9 @@ await UpdateSequenceNumberInternal( /// sequence number and /// for this page blob. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// /// Specifies how the service should modify the blob's sequence number. @@ -2198,8 +2252,11 @@ private async Task> UpdateSequenceNumberInternal( /// returned from the to /// determine if the copy has completed. /// - /// For more information, see - /// and Back up Azure unmanaged VM disks with incremental snapshots. + /// For more information, see + /// + /// Incremental Copy Blob and + /// + /// Back up Azure unmanaged VM disks with incremental snapshots. /// /// /// Specifies the to the source page blob as a up to @@ -2304,8 +2361,11 @@ public virtual CopyFromUriOperation StartCopyIncremental( /// returned from the /// to determine if thecopy has completed. /// - /// For more information, see - /// and Back up Azure unmanaged VM disks with incremental snapshots. + /// For more information, see + /// + /// Incremental Copy Blob and + /// + /// Back up Azure unmanaged VM disks with incremental snapshots. /// /// /// Specifies the to the source page blob as a up to @@ -2411,8 +2471,11 @@ public virtual async Task StartCopyIncrementalAsync( /// to determine if the /// copy has completed. /// - /// For more information, see - /// and Back up Azure unmanaged VM disks with incremental snapshots. + /// For more information, see + /// + /// Incremental Copy Blob and + /// + /// Back up Azure unmanaged VM disks with incremental snapshots. /// /// /// Specifies the to the source page blob as a up to @@ -2550,7 +2613,9 @@ private async Task> StartCopyIncrementalInternal( /// of pages to a page blob where the contents are read from /// sourceUri. /// - /// For more information, see . + /// For more information, see + /// + /// Put Page From URL. /// /// /// Specifies the of the source blob. The value may @@ -2625,7 +2690,9 @@ public virtual Response UploadPagesFromUri( /// of pages to a page blob where the contents are read from /// sourceUri. /// - /// For more information, see . + /// For more information, see + /// + /// Put Page From URL. /// /// /// Specifies the of the source blob. The value may @@ -2700,7 +2767,9 @@ await UploadPagesFromUriInternal( /// range of pages to a page blob where the contents are read from /// sourceUri. /// - /// For more information, see . + /// For more information, see + /// + /// Put Page From URL. /// /// /// Specifies the of the source blob. The value may diff --git a/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasBuilder.cs b/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasBuilder.cs index c10a25444e281..04cbf21d747b3 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasBuilder.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasBuilder.cs @@ -14,7 +14,9 @@ namespace Azure.Storage.Sas /// /// is used to generate a Shared Access /// Signature (SAS) for an Azure Storage container or blob. - /// For more information, see . + /// For more information, see + /// + /// Create a service SAS. /// public class BlobSasBuilder { diff --git a/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasQueryParameters.cs b/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasQueryParameters.cs index a94ffd9fb1a30..7309c85f402c8 100644 --- a/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasQueryParameters.cs +++ b/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasQueryParameters.cs @@ -13,7 +13,9 @@ namespace Azure.Storage.Sas /// parameters. You can construct a new instance using /// . /// - /// For more information, Create a service SAS. + /// For more information, + /// + /// Create a service SAS. /// public sealed class BlobSasQueryParameters : SasQueryParameters { diff --git a/sdk/storage/Azure.Storage.Common/src/Sas/AccountSasBuilder.cs b/sdk/storage/Azure.Storage.Common/src/Sas/AccountSasBuilder.cs index 4505975ff07fe..3675dccfaf56b 100644 --- a/sdk/storage/Azure.Storage.Common/src/Sas/AccountSasBuilder.cs +++ b/sdk/storage/Azure.Storage.Common/src/Sas/AccountSasBuilder.cs @@ -12,7 +12,8 @@ namespace Azure.Storage.Sas /// is used to generate an account level /// Shared Access Signature (SAS) for Azure Storage services. /// For more information, see - /// . + /// + /// Create an account SAS. /// public class AccountSasBuilder { diff --git a/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs b/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs index 68a58c356a859..27d69ba115b4d 100644 --- a/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs +++ b/sdk/storage/Azure.Storage.Common/src/Sas/SasQueryParameters.cs @@ -16,7 +16,9 @@ namespace Azure.Storage.Sas /// parameters. It includes components used by all Azure Storage resources /// (Blob Containers, Blobs, Files, and Queues). You can construct a new instance /// using the service specific SAS builder types. - /// For more information, Create a service SAS. + /// For more information, + /// + /// Create a service SAS. /// public partial class SasQueryParameters { diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeClientOptions.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeClientOptions.cs index ec3ad64d21c89..30f0cec830053 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeClientOptions.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeClientOptions.cs @@ -22,19 +22,23 @@ public class DataLakeClientOptions : ClientOptions /// /// The versions of Azure Data Lake Sevice supported by this client /// library. For more, see - /// . + /// + /// Versioning for the Azure Storage services. /// public enum ServiceVersion { #pragma warning disable CA1707 // Identifiers should not contain underscores /// /// The 2019-02-02 service version described at - /// + /// + /// Version 2019-02-02 /// V2019_02_02 = 1, /// - /// The 2019-07-07 service version. + /// The 2019-07-07 service version described at + /// + /// Version 2019-07-07 /// V2019_07_07 = 2, diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeDirectoryClient.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeDirectoryClient.cs index 6f0cddc8b8f20..a80a15ad5c7dd 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeDirectoryClient.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeDirectoryClient.cs @@ -551,7 +551,9 @@ public virtual async Task> CreateIfNotExistsAsync( /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -599,7 +601,9 @@ public virtual Response Delete( /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -650,7 +654,9 @@ public virtual async Task DeleteAsync( /// for deletion, if the directory exists. The directory is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -698,7 +704,9 @@ public virtual Response DeleteIfExists( /// for deletion, if the directory exists. The directory is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -885,7 +893,9 @@ public virtual async Task> DeleteIfExistsAsync( /// The operation returns the /// access control data for a path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", @@ -942,7 +952,9 @@ public override Response GetAccessControl( /// The operation returns the /// access control data for a path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", @@ -1002,7 +1014,9 @@ public override async Task> GetAccessControlAsync( /// The operation sets the /// Access Control on a path /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access control list for the file or directory. @@ -1064,7 +1078,9 @@ public override Response SetAccessControlList( /// The operation sets the /// Access Control on a path /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access control list for the file or directory. @@ -1129,7 +1145,9 @@ public override async Task> SetAccessControlListAsync( /// The operation sets the /// file permissions on a path. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access permissions for the file owner, the file owning group, and others. @@ -1192,7 +1210,9 @@ public override Response SetPermissions( /// The operation sets the /// file permissions on a path. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access permissions for the file owner, the file owning group, and others. @@ -1259,7 +1279,9 @@ public override async Task> SetPermissionsAsync( /// properties for the path. It does not return the content of the /// path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional to add @@ -1311,7 +1333,9 @@ public virtual Response GetProperties( /// properties for the path. It does not return the content of the /// path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional to add @@ -1361,10 +1385,13 @@ public override async Task> GetPropertiesAsync( /// The operation sets system /// properties on the path. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// - /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. + /// Optional. The standard HTTP header system properties to set. + /// If not specified, existing values will be cleared. /// /// /// Optional to add conditions on @@ -1413,10 +1440,13 @@ public override Response SetHttpHeaders( /// The operation sets system /// properties on the PATH. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// - /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. + /// Optional. The standard HTTP header system properties to set. + /// If not specified, existing values will be cleared. /// /// /// Optional to add conditions on @@ -1468,7 +1498,9 @@ public override async Task> SetHttpHeadersAsync( /// The operation sets user-defined /// metadata for the specified path as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Metadata. /// /// /// Custom metadata to set for this path. @@ -1520,7 +1552,9 @@ public override Response SetMetadata( /// The operation sets user-defined /// metadata for the specified path as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Metadata. /// /// /// Custom metadata to set for this path. @@ -1754,7 +1788,9 @@ public virtual async Task> CreateFileAsync( /// The operation deletes a file /// in this directory. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The name of the file to delete. @@ -1804,7 +1840,9 @@ public virtual Response DeleteFile( /// The operation deletes a file /// in this directory. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The name of the file to delete. @@ -2033,7 +2071,9 @@ public virtual async Task> CreateSubDirectoryA /// /// The deletes a sub directory in this directory. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The path to the directory to delete. @@ -2090,7 +2130,9 @@ public virtual Response DeleteSubDirectory( /// /// The deletes a sub directory in this directory. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The path to the directory to delete. diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileClient.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileClient.cs index 66b3a2a356f7d..3900af751f099 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileClient.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileClient.cs @@ -528,7 +528,9 @@ public virtual async Task> CreateIfNotExistsAsync( /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -576,7 +578,9 @@ public virtual Response Delete( /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -627,7 +631,9 @@ public virtual async Task DeleteAsync( /// for deletion, if the file exists. The file is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -675,7 +681,9 @@ public virtual Response DeleteIfExists( /// for deletion, if the file exists. The file is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Optional to add conditions on @@ -862,7 +870,9 @@ public virtual async Task> DeleteIfExistsAsync( /// The operation returns the /// access control data for a path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", @@ -919,7 +929,9 @@ public override Response GetAccessControl( /// The operation returns the /// access control data for a path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", @@ -979,7 +991,9 @@ public override async Task> GetAccessControlAsync( /// The operation sets the /// Access Control on a path /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access control list for the file or directory. @@ -1041,7 +1055,9 @@ public override Response SetAccessControlList( /// The operation sets the /// Access Control on a path /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access control list for the file or directory. @@ -1106,7 +1122,9 @@ public override async Task> SetAccessControlListAsync( /// The operation sets the /// file permissions on a path. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access permissions for the file owner, the file owning group, and others. @@ -1169,7 +1187,9 @@ public override Response SetPermissions( /// The operation sets the /// file permissions on a path. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access permissions for the file owner, the file owning group, and others. @@ -1236,7 +1256,9 @@ public override async Task> SetPermissionsAsync( /// properties for the path. It does not return the content of the /// path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional to add @@ -1288,7 +1310,9 @@ public virtual Response GetProperties( /// properties for the path. It does not return the content of the /// path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional to add @@ -1338,10 +1362,13 @@ public override async Task> GetPropertiesAsync( /// The operation sets system /// properties on the path. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// - /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. + /// Optional. The standard HTTP header system properties to set. + /// If not specified, existing values will be cleared. /// /// /// Optional to add conditions on @@ -1390,10 +1417,13 @@ public override Response SetHttpHeaders( /// The operation sets system /// properties on the PATH. /// - /// For more information, see . + /// For more information, see + /// + /// Set Blob Properties. /// /// - /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. + /// Optional. The standard HTTP header system properties to set. + /// If not specified, existing values will be cleared. /// /// /// Optional to add conditions on @@ -1445,7 +1475,9 @@ public override async Task> SetHttpHeadersAsync( /// The operation sets user-defined /// metadata for the specified path as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Metadata. /// /// /// Custom metadata to set for this path. @@ -1497,7 +1529,9 @@ public override Response SetMetadata( /// The operation sets user-defined /// metadata for the specified path as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Metadata. /// /// /// Custom metadata to set for this path. @@ -1549,11 +1583,14 @@ public override async Task> SetMetadataAsync( #region Append Data /// - /// The operation uploads data to be appended to a file. Data can only be appended to a file. + /// The operation uploads data to be appended to a file. + /// Data can only be appended to a file. /// To apply perviously uploaded data to a file, call Flush Data. /// Append is currently limited to 4000 MB per request. To upload large files all at once, consider using . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -1630,7 +1667,9 @@ public virtual Response Append( /// To apply perviously uploaded data to a file, call Flush Data. /// Append is currently limited to 4000 MB per request. To upload large files all at once, consider using . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -1706,7 +1745,9 @@ public virtual async Task AppendAsync( /// The operation uploads data to be appended to a file. Data can only be appended to a file. /// To apply perviously uploaded data to a file, call Flush Data. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2078,7 +2119,9 @@ internal virtual async Task> FlushInternal( /// The operation downloads a file from /// the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// A describing the @@ -2118,7 +2161,9 @@ public virtual Response Read() /// The operation downloads a file from /// the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// A describing the @@ -2159,7 +2204,9 @@ public virtual async Task> ReadAsync() /// The operation downloads a file from /// the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// Optional to propagate @@ -2204,7 +2251,9 @@ public virtual Response Read( /// The operation downloads a file from /// the service, including its metadata and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// Optional to propagate @@ -2251,7 +2300,9 @@ public virtual async Task> ReadAsync( /// operation downloads a file from the service, including its metadata /// and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// If provided, only donwload the bytes of the file in the specified @@ -2320,7 +2371,9 @@ public virtual Response Read( /// operation downloads a file from the service, including its metadata /// and properties. /// - /// For more information, see . + /// For more information, see + /// + /// Get Blob. /// /// /// If provided, only donwload the bytes of the file in the specified @@ -2637,7 +2690,9 @@ public virtual async Task ReadToAsync( /// unless otherwise specified in the or alternatively use /// , . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2728,7 +2783,9 @@ public virtual Response Upload( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2753,7 +2810,9 @@ public virtual Response Upload( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2790,7 +2849,9 @@ public virtual Response Upload( /// unless otherwise specified in the or alternatively use /// , . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2827,7 +2888,9 @@ public virtual Task> UploadAsync( /// unless otherwise specified in the or alternatively use /// , . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2882,7 +2945,9 @@ public virtual Task> UploadAsync( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2908,7 +2973,9 @@ public virtual Task> UploadAsync( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A containing the content to upload. @@ -2945,7 +3012,9 @@ public virtual Task> UploadAsync( /// unless otherwise specified in the or alternatively use /// , . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. @@ -2983,7 +3052,9 @@ public virtual Response Upload( /// unless otherwise specified in the or alternatively use /// , . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. @@ -3045,7 +3116,9 @@ public virtual Response Upload( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. @@ -3071,7 +3144,9 @@ public virtual Response Upload( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. @@ -3108,7 +3183,9 @@ public virtual Response Upload( /// unless otherwise specified in the or alternatively use /// , . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. @@ -3151,7 +3228,9 @@ public virtual async Task> UploadAsync( /// unless otherwise specified in the or alternatively use /// , . /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. @@ -3206,7 +3285,9 @@ public virtual async Task> UploadAsync( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. @@ -3232,7 +3313,9 @@ await UploadAsync( /// The /// operation creates and uploads content to a file. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// A file path containing the content to upload. diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileSystemClient.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileSystemClient.cs index 0b793d3acc294..52d700c6409f2 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileSystemClient.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeFileSystemClient.cs @@ -389,7 +389,9 @@ private void SetNameFieldsIfNull() /// under the specified account. If the file system with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the file system may be accessed @@ -459,7 +461,9 @@ public virtual Response Create( /// under the specified account. If the file system with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the file system may be accessed @@ -532,7 +536,9 @@ public virtual async Task> CreateAsync( /// under the specified account. If the file system with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the file system may be accessed @@ -605,7 +611,9 @@ public virtual Response CreateIfNotExists( /// under the specified account. If the file system with the same name /// already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// Optionally specifies whether data in the file system may be accessed @@ -680,7 +688,9 @@ public virtual async Task> CreateIfNotExistsAsync( /// file system for deletion. The file system and any paths contained /// within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -728,7 +738,9 @@ public virtual Response Delete( /// file system for deletion. The file system and any paths contained /// within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -778,7 +790,9 @@ public virtual async Task DeleteAsync( /// file system for deletion if it exists. The file system and any files /// and directories contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -826,7 +840,9 @@ public virtual Response DeleteIfExists( /// file system for deletion if it exists. The file system and any files /// and directories contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// Optional to add @@ -963,7 +979,9 @@ public virtual async Task> ExistsAsync( /// file system. The data returned does not include the file system's /// list of paths. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container Properties. /// /// /// Optional to add @@ -1016,7 +1034,9 @@ public virtual Response GetProperties( /// file system. The data returned does not include the file system's /// list of paths. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container Properties. /// /// /// Optional to add @@ -1070,7 +1090,9 @@ public virtual async Task> GetPropertiesAsync( /// The operation sets one or more /// user-defined name-value pairs for the specified file system. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container Metadata. /// /// /// Custom metadata to set for this file system. @@ -1129,7 +1151,9 @@ public virtual Response SetMetadata( /// The operation sets one or more /// user-defined name-value pairs for the specified file system. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container Metadata. /// /// /// Custom metadata to set for this file system. @@ -1192,7 +1216,9 @@ public virtual async Task> SetMetadataAsync( /// of paths in this file system. Enumerating the paths may make /// multiple requests to the service while fetching all the values. /// - /// For more information, see Path - List. + /// For more information, see + /// + /// List Path(s). /// /// /// Filters results to paths within the specified directory. @@ -1237,7 +1263,9 @@ public virtual Pageable GetPaths( /// make multiple requests to the service while fetching all the /// values. /// - /// For more information, see Path - List. + /// For more information, see + /// + /// List Path(s). /// /// /// Filters results to paths within the specified directory. @@ -1285,7 +1313,9 @@ public virtual AsyncPageable GetPathsAsync( /// to continue enumerating the paths segment by segment. Paths are /// ordered lexicographically by name. /// - /// For more information, see Path - List. + /// For more information, see + /// + /// List Path(s). /// /// /// Filters results to paths within the specified directory. @@ -1575,7 +1605,9 @@ public virtual async Task> CreateDirectoryAsyn /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The path to the directory to delete. @@ -1626,7 +1658,9 @@ public virtual Response DeleteDirectory( /// The deletes a directory in this file system. /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The path to the directory to delete. @@ -1858,7 +1892,9 @@ public virtual async Task> CreateFileAsync( /// /// The deletes a file in this file system. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The path to the file to delete. @@ -1907,7 +1943,9 @@ public virtual Response DeleteFile( /// /// The deletes a file in this file system. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// The path to the file to delete. @@ -1961,7 +1999,9 @@ public virtual async Task DeleteFileAsync( /// permissions for this file system. The permissions indicate whether /// file system data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container ACL. /// /// /// Optional to add @@ -2013,7 +2053,9 @@ public virtual Response GetAccessPolicy( /// permissions for this file system. The permissions indicate whether /// file system data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Get Container ACL. /// /// /// Optional to add @@ -2068,7 +2110,9 @@ public virtual async Task> GetAccessPolicyAsync /// permissions for the specified file system. The permissions indicate /// whether file system data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container ACL. /// /// /// Optionally specifies whether data in the file system may be accessed @@ -2145,7 +2189,9 @@ public virtual Response SetAccessPolicy( /// permissions for the specified file system. The permissions indicate /// whether the file system data may be accessed publicly. /// - /// For more information, see . + /// For more information, see + /// + /// Set Container ACL. /// /// /// Optionally specifies whether data in the file system may be accessed diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeLeaseClient.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeLeaseClient.cs index 20c928ebcf32c..256ad50f6080d 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeLeaseClient.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeLeaseClient.cs @@ -106,7 +106,9 @@ public DataLakeLeaseClient(DataLakeFileSystemClient client, string leaseId = nul /// using the active lease ID as , but you can /// specify a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the duration of the lease, in seconds, or specify @@ -171,7 +173,9 @@ public virtual Response Acquire( /// using the active lease ID as , but you can /// specify a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the duration of the lease, in seconds, or specify @@ -238,7 +242,9 @@ public virtual async Task> AcquireAsync( /// file system has not been leased again since the expiration of that /// lease. When you renew a lease, the lease duration clock resets. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -294,7 +300,9 @@ public virtual Response Renew( /// file system has not been leased again since the expiration of that /// lease. When you renew a lease, the lease duration clock resets. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -351,7 +359,9 @@ public virtual async Task> RenewAsync( /// lease allows another client to immediately acquire the lease for the /// file system or path as soon as the release is complete. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -407,7 +417,9 @@ public virtual Response Release( /// lease allows another client to immediately acquire the lease for the /// file system or path as soon as the release is complete. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Optional to add @@ -462,7 +474,9 @@ public virtual async Task> ReleaseAsync( /// of an active lease. A change must include the current /// and a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// An optional proposed lease ID, in a GUID string format. A @@ -520,7 +534,9 @@ public virtual Response Change( /// of an active lease. A change must include the current /// and a new . /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// An optional proposed lease ID, in a GUID string format. A @@ -594,7 +610,9 @@ public virtual async Task> ChangeAsync( /// immediately acquire a path or file system lease that has been /// released. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the proposed duration the lease should continue before @@ -670,7 +688,9 @@ public virtual Response Break( /// immediately acquire a path or file system lease that has been /// released. /// - /// For more information, see . + /// For more information, see + /// + /// Lease Container. /// /// /// Specifies the proposed duration the lease should continue before diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakePathClient.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakePathClient.cs index 300432459b2a7..e714b0b428800 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakePathClient.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakePathClient.cs @@ -1083,7 +1083,9 @@ public virtual async Task> ExistsAsync( /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. @@ -1138,7 +1140,9 @@ public virtual Response Delete( /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. @@ -1193,7 +1197,9 @@ public virtual async Task DeleteAsync( /// deletion. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. @@ -1269,7 +1275,9 @@ private async Task DeleteInternal( /// for deletion, if the path exists. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. @@ -1306,7 +1314,9 @@ public virtual Response DeleteIfExists( /// deletion, if the path exists. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. @@ -1343,7 +1353,9 @@ public virtual async Task> DeleteIfExistsAsync( /// deletion, if the path exists. The path is later deleted during /// garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Path. /// /// /// Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. @@ -1666,7 +1678,9 @@ private async Task> RenameInternal( /// The operation returns the /// access control data for a path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", @@ -1725,7 +1739,9 @@ public virtual Response GetAccessControl( /// The operation returns the /// access control data for a path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", @@ -1784,7 +1800,9 @@ public virtual async Task> GetAccessControlAsync( /// The operation returns the /// access control data for a path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional.Valid only when Hierarchical Namespace is enabled for the account.If "true", @@ -1871,7 +1889,9 @@ private async Task> GetAccessControlInternal( /// The operation sets the /// Access Control on a path /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access control list for the file or directory. @@ -1935,7 +1955,9 @@ public virtual Response SetAccessControlList( /// The operation sets the /// Access Control on a path /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access control list for the file or directory. @@ -1999,7 +2021,9 @@ public virtual async Task> SetAccessControlListAsync( /// The operation sets the /// Access Control on a path /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access control list for the file or directory. @@ -2093,7 +2117,9 @@ await DataLakeRestClient.Path.SetAccessControlAsync( /// The operation sets the /// file permissions on a path. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access permissions for the file owner, the file owning group, and others. @@ -2158,7 +2184,9 @@ public virtual Response SetPermissions( /// The operation sets the /// file permissions on a path. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access permissions for the file owner, the file owning group, and others. @@ -2222,7 +2250,9 @@ public virtual async Task> SetPermissionsAsync( /// The operation sets the /// file permissions on a path. /// - /// For more information, see . + /// For more information, see + /// + /// Update Path. /// /// /// The POSIX access permissions for the file owner, the file owning group, and others. @@ -2318,7 +2348,9 @@ await DataLakeRestClient.Path.SetAccessControlAsync( /// properties for the path. It does not return the content of the /// path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional to add @@ -2371,7 +2403,9 @@ public virtual Response GetProperties( /// properties for the path. It does not return the content of the /// path. /// - /// For more information, see . + /// For more information, see + /// + /// Get Properties. /// /// /// Optional to add @@ -2425,7 +2459,9 @@ public virtual async Task> GetPropertiesAsync( /// The operation sets system /// properties on the path. /// - /// For more information, see . + /// For more information, see + /// + /// Set Properties. /// /// /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. @@ -2481,7 +2517,9 @@ public virtual Response SetHttpHeaders( /// The operation sets system /// properties on the PATH. /// - /// For more information, see . + /// For more information, see + /// + /// Set Properties. /// /// /// Optional. The standard HTTP header system properties to set. If not specified, existing values will be cleared. @@ -2540,7 +2578,9 @@ public virtual async Task> SetHttpHeadersAsync( /// The operation sets user-defined /// metadata for the specified path as one or more name-value pairs. /// - /// For more information, see . + /// For more information, see + /// + /// Set Metadata. /// /// /// Custom metadata to set for this path. @@ -2595,7 +2635,9 @@ public virtual Response SetMetadata( /// The operation sets user-defined /// metadata for the specified path as one or more name-value pairs. /// - /// For more information, see . + ///For more information, see + /// + /// Set Metadata. /// /// /// Custom metadata to set for this path. diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeServiceClient.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeServiceClient.cs index 474b7a0b9b3f8..598ac38c7c259 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeServiceClient.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/DataLakeServiceClient.cs @@ -420,7 +420,9 @@ public virtual async Task> GetUserDelegationKeyAsync /// file systems may make multiple requests to the service while fetching /// all the values. File systems are ordered lexicographically by name. /// - /// For more information, see List Containers. + /// For more information, see + /// + /// List Containers. /// /// /// Specifies trait options for shaping the file systems. @@ -453,7 +455,9 @@ public virtual Pageable GetFileSystems( /// files systems may make multiple requests to the service while fetching /// all the values. File systems are ordered lexicographically by name. /// - /// For more information, see List Containers. + /// For more information, see + /// + /// List Containers. /// /// /// Specifies trait options for shaping the file systems. @@ -487,7 +491,9 @@ public virtual AsyncPageable GetFileSystemsAsync( /// file system under the specified account. If the file systen with the /// same name already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// The name of the file system to create. @@ -552,7 +558,9 @@ public virtual Response CreateFileSystem( /// file system under the specified account. If the file system with the /// same name already exists, the operation fails. /// - /// For more information, see Create Container. + /// For more information, see + /// + /// Create Container. /// /// /// The name of the file system to create. @@ -619,7 +627,9 @@ public virtual async Task> CreateFileSystemAs /// specified file system for deletion. The file system and any paths /// contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// The name of the file system to delete. @@ -671,7 +681,9 @@ public virtual Response DeleteFileSystem( /// specified file system for deletion. The file system and any paths /// contained within it are later deleted during garbage collection. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Container. /// /// /// The name of the file system to delete. diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/Models/FileDownloadDetails.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/Models/FileDownloadDetails.cs index 5ab4b8fa0261c..1c4819b8004bc 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/Models/FileDownloadDetails.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/Models/FileDownloadDetails.cs @@ -75,7 +75,7 @@ public class FileDownloadDetails public string CopyStatusDescription { get; internal set; } /// - /// String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy + /// String identifier for this copy operation. Use with Get Properties to check the status of this copy /// operation, or pass to Abort Copy Blob to abort a pending copy. /// public string CopyId { get; internal set; } diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/Models/PathHttpHeaders.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/Models/PathHttpHeaders.cs index 944743083e177..1a4e7402af219 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/Models/PathHttpHeaders.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/Models/PathHttpHeaders.cs @@ -11,7 +11,9 @@ namespace Azure.Storage.Files.DataLake.Models /// names, as specified in the Header Field Definitions section 14 of the /// HTTP/1.1 protocol specification. /// - /// For more information, see . + /// For more information, see + /// + /// Setting and retrieving properties and metadata for service resources. /// public class PathHttpHeaders { diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasBuilder.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasBuilder.cs index d2811fb2da4e7..e7cf922bf4a55 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasBuilder.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasBuilder.cs @@ -14,7 +14,10 @@ namespace Azure.Storage.Sas /// /// is used to generate a Shared Access /// Signature (SAS) for a Data Lake file system or path - /// For more information, see . + /// + /// For more information, see + /// + /// Constructing a Service SAS. /// public class DataLakeSasBuilder { diff --git a/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasQueryParameters.cs b/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasQueryParameters.cs index d974a02f92452..b30888fc2e416 100644 --- a/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasQueryParameters.cs +++ b/sdk/storage/Azure.Storage.Files.DataLake/src/Sas/DataLakeSasQueryParameters.cs @@ -13,7 +13,9 @@ namespace Azure.Storage.Sas /// parameters. You can construct a new instance using /// . /// - /// For more information, Create a service SAS. + /// For more information, + /// + /// Create a service SAS. /// public sealed class DataLakeSasQueryParameters : SasQueryParameters { diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/Models/ShareFileHttpHeaders.cs b/sdk/storage/Azure.Storage.Files.Shares/src/Models/ShareFileHttpHeaders.cs index df0cb5d459728..84696eeb7cc30 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/Models/ShareFileHttpHeaders.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/Models/ShareFileHttpHeaders.cs @@ -14,7 +14,9 @@ namespace Azure.Storage.Files.Shares.Models /// names, as specified in the Header Field Definitions section 14 of the /// HTTP/1.1 protocol specification. /// - /// For more information, see . + /// For more information, see + /// + /// Setting and retrieving properties and metadata for service resources. /// public class ShareFileHttpHeaders { diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/Sas/ShareSasBuilder.cs b/sdk/storage/Azure.Storage.Files.Shares/src/Sas/ShareSasBuilder.cs index 19bfdfedab00e..fffb7666033a2 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/Sas/ShareSasBuilder.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/Sas/ShareSasBuilder.cs @@ -12,7 +12,10 @@ namespace Azure.Storage.Sas /// /// is used to generate a Shared Access /// Signature (SAS) for an Azure Storage share, directory, or file. - /// For more information, see . + /// + /// For more information, see + /// + /// Creating a Service SAS. /// public class ShareSasBuilder { diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/ShareClient.cs b/sdk/storage/Azure.Storage.Files.Shares/src/ShareClient.cs index 78baaa0a479ec..27676a94f7828 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/ShareClient.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/ShareClient.cs @@ -117,7 +117,9 @@ protected ShareClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the share in the storage account to reference. @@ -136,7 +138,9 @@ public ShareClient(string connectionString, string shareName) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the share in the storage account to reference. @@ -253,7 +257,9 @@ internal ShareClient(Uri shareUri, HttpPipeline pipeline, ShareClientOptions.Ser /// class with an identical source but the specified /// timestamp. /// - /// For more information, see Snapshot Share. + /// For more information, see + /// + /// Snapshot Share. /// /// /// Pass null or empty string to remove the snapshot returning a URL to the base share. @@ -320,7 +326,9 @@ private void SetNameFieldsIfNull() /// under the specified account. If a share with the same name /// already exists, the operation fails. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// Optional custom metadata to set for this share. @@ -356,7 +364,9 @@ public virtual Response Create( /// under the specified account. If a share with the same name /// already exists, the operation fails. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// Optional custom metadata to set for this share. @@ -392,7 +402,9 @@ await CreateInternal( /// under the specified account. If a share with the same name /// already exists, the operation fails. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// Optional custom metadata to set for this share. @@ -465,7 +477,9 @@ internal async Task> CreateInternal( /// under the specified account. If a share with the same name /// already exists, it is not changed. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// Optional custom metadata to set for this share. @@ -500,7 +514,9 @@ public virtual Response CreateIfNotExists( /// under the specified account. If a share with the same name /// already exists, it is not changed. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// Optional custom metadata to set for this share. @@ -535,7 +551,9 @@ await CreateIfNotExistsInternal( /// under the specified account. If a share with the same name /// already exists, it is not changed. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// Optional custom metadata to set for this share. @@ -712,7 +730,9 @@ private async Task> ExistsInternal( /// /// Marks the specified share or share snapshot for deletion, if it exists. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// A value indicating whether to delete a share's snapshots in addition @@ -740,7 +760,9 @@ public virtual Response DeleteIfExists( /// /// Marks the specified share or share snapshot for deletion, if it exists. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// A value indicating whether to delete a share's snapshots in addition @@ -768,7 +790,9 @@ await DeleteIfExistsInternal( /// /// Marks the specified share or share snapshot for deletion, if it exists. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// A value indicating whether to delete a share's snapshots in addition @@ -831,7 +855,9 @@ private async Task> DeleteIfExistsInternal( /// /// Creates a read-only snapshot of a share. /// - /// For more information, see Snapshot Share. + /// For more information, see + /// + /// Snapshot Share. /// /// /// Optional custom metadata to set for this share. @@ -860,7 +886,9 @@ public virtual Response CreateSnapshot( /// /// Creates a read-only snapshot of a share. /// - /// For more information, see Snapshot Share. + /// For more information, see + /// + /// Snapshot Share. /// /// /// Optional custom metadata to set for this share. @@ -889,7 +917,9 @@ await CreateSnapshotInternal( /// /// Creates a read-only snapshot of a share. /// - /// For more information, see Snapshot Share. + /// For more information, see + /// + /// Snapshot Share. /// /// /// Optional custom metadata to set for this share. @@ -950,7 +980,9 @@ private async Task> CreateSnapshotInternal( /// Marks the specified share or share snapshot for deletion. /// The share or share snapshot and any files contained within it are later deleted during garbage collection. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// A value indicating whether to delete a share's snapshots in addition @@ -980,7 +1012,9 @@ public virtual Response Delete( /// Marks the specified share or share snapshot for deletion. /// The share or share snapshot and any files contained within it are later deleted during garbage collection. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// A value indicating whether to delete a share's snapshots in addition @@ -1010,7 +1044,9 @@ await DeleteInternal( /// Marks the specified share or share snapshot for deletion. /// The share or share snapshot and any files contained within it are later deleted during garbage collection. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// A value indicating whether to delete a share's snapshots in addition @@ -1077,7 +1113,9 @@ internal async Task DeleteInternal( /// user-defined metadata, standard HTTP properties, and system /// properties for the share. /// - /// For more information, see Get Share Properties. + /// For more information, see + /// + /// Get Share Properties. /// /// /// Optional to propagate @@ -1103,7 +1141,9 @@ public virtual Response GetProperties( /// user-defined metadata, standard HTTP properties, and system /// properties for the share. /// - /// For more information, see Get Share Properties. + /// For more information, see + /// + /// Get Share Properties. /// /// /// Optional to propagate @@ -1129,7 +1169,9 @@ await GetPropertiesInternal( /// user-defined metadata, standard HTTP properties, and system /// properties for the share. /// - /// For more information, see Get Share Properties. + /// For more information, see + /// + /// Get Share Properties. /// /// /// Whether to invoke the operation asynchronously. @@ -1185,9 +1227,14 @@ private async Task> GetPropertiesInternal( /// /// Sets the maximum size of the share. /// - /// For more information, see Set Share Properties. + /// For more information, see + /// + /// Set Share Properties. /// - /// Optional. The maximum size of the share. If unspecified, use the service's default value. + /// + /// Optional. The maximum size of the share. + /// If unspecified, use the service's default value. + /// /// /// Optional to propagate /// notifications that the operation should be cancelled. @@ -1212,9 +1259,14 @@ public virtual Response SetQuota( /// /// Sets the maximum size of the share. /// - /// For more information, see Set Share Properties. + /// For more information, see + /// + /// Set Share Properties. /// - /// Optional. The maximum size of the share. If unspecified, use the service's default value. + /// + /// Optional. The maximum size of the share. + /// If unspecified, use the service's default value. + /// /// /// Optional to propagate /// notifications that the operation should be cancelled. @@ -1239,9 +1291,14 @@ await SetQuotaInternal( /// /// Sets the maximum size of the share. /// - /// For more information, see Set Share Properties. + /// For more information, see + /// + /// Set Share Properties. /// - /// Optional. The maximum size of the share. If unspecified, use the service's default value. + /// + /// Optional. The maximum size of the share. + /// If unspecified, use the service's default value. + /// /// /// Whether to invoke the operation asynchronously. /// @@ -1300,7 +1357,9 @@ internal virtual async Task> SetQuotaInternal( /// The operation sets user-defined /// metadata for the specified share as one or more name-value pairs. /// - /// For more information, see Set Share Metadata. + /// For more information, see + /// + /// Set Share Metadata. /// /// /// Custom metadata to set for this share. @@ -1330,7 +1389,9 @@ public virtual Response SetMetadata( /// The operation sets user-defined /// metadata for the specified share as one or more name-value pairs. /// - /// For more information, see Set Share Metadata. + /// For more information, see + /// + /// Set Share Metadata. /// /// /// Custom metadata to set for this share. @@ -1360,7 +1421,9 @@ await SetMetadataInternal( /// The operation sets user-defined /// metadata for the specified share as one or more name-value pairs. /// - /// For more information, see Set Share Metadata. + /// For more information, see + /// + /// Set Share Metadata. /// /// /// Custom metadata to set for this share. @@ -1422,7 +1485,9 @@ private async Task> SetMetadataInternal( /// permissions for this share. The permissions indicate whether /// share data may be accessed publicly. /// - /// For more information, see Get Share ACL. + /// For more information, see + /// + /// Get Share ACL. /// /// /// Optional to propagate @@ -1448,7 +1513,9 @@ public virtual Response> GetAccessPolicy( /// permissions for this share. The permissions indicate whether /// share data may be accessed publicly. /// - /// For more information, see Get Share ACL. + /// For more information, see + /// + /// Get Share ACL. /// /// /// Optional to propagate @@ -1474,7 +1541,9 @@ await GetAccessPolicyInternal( /// permissions for this share. The permissions indicate whether /// share data may be accessed publicly. /// - /// For more information, see Get Share ACL. + /// For more information, see + /// + /// Get Share ACL. /// /// /// Whether to invoke the operation asynchronously. @@ -1531,7 +1600,9 @@ private async Task>> GetAccessPolicy /// permissions for the specified share. The permissions indicate /// whether share data may be accessed publicly. /// - /// For more information, see Set Share ACL. + /// For more information, see + /// + /// Set Share ACL. /// /// /// Stored access policies that you can use to provide fine grained @@ -1563,7 +1634,9 @@ public virtual Response SetAccessPolicy( /// permissions for the specified share. The permissions indicate /// whether share data may be accessed publicly. /// - /// For more information, see Set Share ACL. + /// For more information, see + /// + /// Set Share ACL. /// /// /// Stored access policies that you can use to provide fine grained @@ -1595,7 +1668,9 @@ await SetAccessPolicyInternal( /// permissions for the specified share. The permissions indicate /// whether share data may be accessed publicly. /// - /// For more information, see Set Share ACL. + /// For more information, see + /// + /// Set Share ACL. /// /// /// Stored access policies that you can use to provide fine grained @@ -1656,7 +1731,9 @@ private async Task> SetAccessPolicyInternal( /// /// Retrieves statistics related to the share. /// - /// For more information, see Get Share Stats. + /// For more information, see + /// + /// Get Share Stats. /// /// /// Optional to propagate @@ -1680,7 +1757,9 @@ public virtual Response GetStatistics( /// /// Retrieves statistics related to the share. /// - /// For more information, see Get Share Stats. + /// For more information, see + /// + /// Get Share Stats. /// /// /// Optional to propagate @@ -1704,7 +1783,9 @@ await GetStatisticsInternal( /// /// Retrieves statistics related to the share. /// - /// For more information, see Get Share Stats. + /// For more information, see + /// Get Share Stats. /// /// /// Whether to invoke the operation asynchronously. @@ -1965,7 +2046,9 @@ private async Task> CreatePermissionInternal( /// The operation creates a new /// directory in this share. /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// T /// The name of the directory to create. @@ -2014,7 +2097,9 @@ public virtual Response CreateDirectory( /// The operation creates a new /// directory in this share. /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// T /// The name of the directory to create. @@ -2065,7 +2150,9 @@ public virtual async Task> CreateDirectoryAsync( /// The operation removes the specified empty /// directory. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// T /// The name of the directory to delete. @@ -2093,7 +2180,9 @@ public virtual Response DeleteDirectory( /// The operation removes the specified empty /// directory. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// T /// The name of the directory to delete. diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/ShareClientOptions.cs b/sdk/storage/Azure.Storage.Files.Shares/src/ShareClientOptions.cs index e6df4bbf27f09..6f38161609859 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/ShareClientOptions.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/ShareClientOptions.cs @@ -19,19 +19,23 @@ public class ShareClientOptions : ClientOptions /// /// The versions of Azure File Storage supported by this client /// library. For more, see - /// . + /// + /// Versioning for the Azure Storage services. /// public enum ServiceVersion { #pragma warning disable CA1707 // Identifiers should not contain underscores /// /// The 2019-02-02 service version described at - /// + /// + /// Version 2019-02-02 /// V2019_02_02 = 1, /// - /// The 2019-07-07 service version. + /// The 2019-07-07 service version described at + /// + /// Version 2019-07-07 /// V2019_07_07 = 2, @@ -45,7 +49,8 @@ public enum ServiceVersion /// /// Gets the of the service API used when /// making requests. For more, see - /// . + /// + /// Versioning for the Azure Storage services. /// public ServiceVersion Version { get; } diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/ShareDirectoryClient.cs b/sdk/storage/Azure.Storage.Files.Shares/src/ShareDirectoryClient.cs index ac6eb516f2cee..40c4d21650256 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/ShareDirectoryClient.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/ShareDirectoryClient.cs @@ -148,7 +148,9 @@ protected ShareDirectoryClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the share in the storage account to reference. @@ -169,7 +171,9 @@ public ShareDirectoryClient(string connectionString, string shareName, string di /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings /// /// /// The name of the share in the storage account to reference. @@ -298,7 +302,9 @@ internal ShareDirectoryClient(Uri directoryUri, HttpPipeline pipeline, ShareClie /// class with an identical source but the specified /// timestamp. /// - /// For more information, see Snapshot Share. + /// For more information, see + /// + /// Snapshot Share. /// /// /// Pass null or empty string to remove the snapshot returning a URL to the base directory. @@ -373,7 +379,9 @@ private void SetNameFieldsIfNull() /// The operation creates a new directory /// at the specified . /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// /// Optional custom metadata to set for this directory. @@ -413,7 +421,9 @@ public virtual Response Create( /// The operation creates a new directory /// at the specified . /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// /// Optional custom metadata to set for this directory. @@ -453,7 +463,9 @@ await CreateInternal( /// The operation creates a new directory /// at the specified . /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// /// Optional custom metadata to set for this directory. @@ -542,7 +554,9 @@ internal async Task> CreateInternal( /// if it does not already exists. If the directory already exists, it is not /// modified. /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// /// Optional custom metadata to set for this directory. @@ -582,7 +596,9 @@ public virtual Response CreateIfNotExists( /// if it does not already exists. If the directory already exists, it is not /// modified. /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// /// Optional custom metadata to set for this directory. @@ -622,7 +638,9 @@ await CreateIfNotExistsInternal( /// if it does not already exists. If the directory already exists, it is not /// modified. /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// /// Optional custom metadata to set for this directory. @@ -804,7 +822,9 @@ private async Task> ExistsInternal( /// The operation removes the specified /// empty directory, if it exists. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// /// Optional to propagate @@ -826,7 +846,9 @@ public virtual Response DeleteIfExists( /// The operation removes the specified /// empty directory, if it exists. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// /// Optional to propagate @@ -848,7 +870,9 @@ await DeleteIfExistsInternal( /// The operation removes the specified /// empty directory, if it exists. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// /// Whether to invoke the operation asynchronously. @@ -908,7 +932,9 @@ internal async Task> DeleteIfExistsInternal( /// /// The operation removes the specified empty directory. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// /// Optional to propagate @@ -930,7 +956,9 @@ public virtual Response Delete( /// /// The operation removes the specified empty directory. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// /// Optional to propagate @@ -953,7 +981,9 @@ await DeleteInternal( /// The operation removes the specified /// empty directory. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// /// Whether to invoke the operation asynchronously. @@ -1013,7 +1043,9 @@ internal async Task DeleteInternal( /// directory. The data returned does not include the directory's /// list of subdirectories or files. /// - /// For more information, see Get Directory Properties. + /// For more information, see + /// + /// Get Directory Properties. /// /// /// Optional to propagate @@ -1040,7 +1072,9 @@ public virtual Response GetProperties( /// directory. The data returned does not include the directory's /// list of subdirectories or files. /// - /// For more information, see Get Directory Properties. + /// For more information, see + /// + /// Get Directory Properties. /// /// /// Optional to propagate @@ -1067,7 +1101,9 @@ await GetPropertiesInternal( /// directory. The data returned does not include the directory's /// list of subdirectories or files. /// - /// For more information, see Get Directory Properties. + /// For more information, see + /// + /// Get Directory Properties. /// /// /// Whether to invoke the operation asynchronously. @@ -1133,7 +1169,9 @@ private async Task> GetPropertiesInternal( /// The operation sets system /// properties on the directory. /// - /// For more information, see Set Directory Properties. + /// For more information, see + /// + /// Set Directory Properties. /// /// /// Optional SMB properties to set for the directory. @@ -1203,7 +1241,9 @@ await SetHttpHeadersInternal( /// The operation sets system /// properties on the directory. /// - /// For more information, see Set Directory Properties. + /// For more information, see + /// + /// Set Directory Properties. /// /// /// Optional SMB properties to set for the directory. @@ -1283,7 +1323,9 @@ private async Task> SetHttpHeadersInternal( /// The operation sets one or more /// user-defined name-value pairs for the specified directory. /// - /// For more information, see Set Directory Metadata. + /// For more information, see + /// + /// Set Directory Metadata. /// /// /// Custom metadata to set for this directory. @@ -1312,7 +1354,9 @@ public virtual Response SetMetadata( /// The operation sets one or more /// user-defined name-value pairs for the specified directory. /// - /// For more information, see Set Directory Metadata. + /// For more information, see + /// + /// Set Directory Metadata. /// /// /// Custom metadata to set for this directory. @@ -1341,7 +1385,9 @@ await SetMetadataInternal( /// The operation sets one or more /// user-defined name-value pairs for the specified directory. /// - /// For more information, see Set Directory Metadata. + /// For more information, see + /// + /// Set Directory Metadata. /// /// /// Custom metadata to set for this directory. @@ -1405,7 +1451,9 @@ private async Task> SetMetadataInternal( /// Enumerating the files and directories may make multiple requests /// to the service while fetching all the values. /// - /// For more information, see List Directories and Files. + /// For more information, see + /// + /// List Directories and Files. /// /// /// Optional string that filters the results to return only @@ -1434,7 +1482,9 @@ public virtual Pageable GetFilesAndDirectories( /// Enumerating the files and directories may make multiple requests /// to the service while fetching all the values. /// - /// For more information, see List Directories and Files. + /// For more information, see + /// + /// List Directories and Files. /// /// /// Optional string that filters the results to return only @@ -1462,7 +1512,9 @@ public virtual AsyncPageable GetFilesAndDirectoriesAsync( /// single segment of files and subdirectories in this directory, starting /// from the specified . /// - /// For more information, see List Directories and Files. + /// For more information, see + /// + /// List Directories and Files. /// /// /// An optional string value that identifies the segment of the list @@ -1546,7 +1598,9 @@ internal async Task> GetFilesAndDirectories /// handles may make multiple requests to the service while fetching /// all the values. /// - /// For more information, see List Handles. + /// For more information, see + /// + /// List Handles. /// /// /// Optional. A boolean value that specifies if the operation should also apply to the files and subdirectories of the directory specified. @@ -1574,7 +1628,9 @@ public virtual Pageable GetHandles( /// Enumerating the handles may make multiple requests to the service /// while fetching all the values. /// - /// For more information, see List Handles. + /// For more information, see + /// + /// List Handles. /// /// /// Optional. A boolean value that specifies if the operation should also apply to the files and subdirectories of the directory specified. @@ -1600,7 +1656,9 @@ public virtual AsyncPageable GetHandlesAsync( /// The operation returns a list of open /// handles on a directory or a file. /// - /// For more information, see List Handles. + /// For more information, see + /// + /// List Handles. /// /// /// An optional string value that identifies the segment of the list @@ -1687,7 +1745,9 @@ internal async Task> GetHandlesInternal( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Specifies the handle ID to be closed. @@ -1732,7 +1792,9 @@ public virtual Response ForceCloseHandle( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Specifies the handle ID to be closed. @@ -1778,7 +1840,9 @@ public virtual async Task> ForceCloseHandleAsync( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Optional. A boolean value that specifies if the operation should also apply to the files and subdirectories of the directory specified. @@ -1815,7 +1879,9 @@ public virtual CloseHandlesResult ForceCloseAllHandles( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// FFor more information, see + /// + /// Force Close Handles. /// /// /// Optional. A boolean value that specifies if the operation should also apply to the files and subdirectories of the directory specified. @@ -1852,7 +1918,9 @@ await ForceCloseAllHandlesInternal( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Optional. A boolean value that specifies if the operation should also apply to the files and subdirectories of the directory specified. @@ -1915,7 +1983,9 @@ await ForceCloseHandlesInternal( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Optional. Specifies the handle ID to be closed. If not specified, or if equal to "*", will close all handles. @@ -2000,7 +2070,9 @@ private async Task> ForceCloseHandlesInter /// The operation creates a new /// subdirectory under this directory. /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// The name of the subdirectory. /// @@ -2045,7 +2117,9 @@ public virtual Response CreateSubdirectory( /// The operation creates a new /// subdirectory under this directory. /// - /// For more information, see Create Directory. + /// For more information, see + /// + /// Create Directory. /// /// The name of the subdirectory. /// @@ -2093,7 +2167,9 @@ public virtual async Task> CreateSubdirectoryAsyn /// The operation removes the /// specified empty subdirectory. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// The name of the subdirectory. /// @@ -2116,7 +2192,9 @@ public virtual Response DeleteSubdirectory( /// The operation removes the /// specified empty subdirectory. /// - /// For more information, see Delete Directory. + /// For more information, see + /// + /// Delete Directory. /// /// The name of the subdirectory. /// @@ -2142,7 +2220,9 @@ await GetSubdirectoryClient(subdirectoryName) /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -2205,7 +2285,9 @@ public virtual Response CreateFile( /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -2266,7 +2348,9 @@ public virtual Response CreateFile( /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -2329,7 +2413,9 @@ public virtual async Task> CreateFileAsync( /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -2393,7 +2479,9 @@ public virtual async Task> CreateFileAsync( /// The /// operation immediately removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// The name of the file. /// @@ -2424,7 +2512,9 @@ public virtual Response DeleteFile( /// The /// operation immediately removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// The name of the file. /// @@ -2453,7 +2543,9 @@ public virtual Response DeleteFile( /// The /// operation immediately removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// The name of the file. /// @@ -2486,7 +2578,9 @@ await GetFileClient(fileName) /// The /// operation immediately removesthe file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// The name of the file. /// diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/ShareFileClient.cs b/sdk/storage/Azure.Storage.Files.Shares/src/ShareFileClient.cs index 4a3beb83201e4..5046edb233734 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/ShareFileClient.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/ShareFileClient.cs @@ -162,7 +162,9 @@ protected ShareFileClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, see + /// + /// Configure Azure Storage connection strings /// /// /// The name of the share in the storage account to reference. @@ -183,7 +185,9 @@ public ShareFileClient(string connectionString, string shareName, string filePat /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, see + /// + /// Configure Azure Storage connection strings /// /// /// The name of the share in the storage account to reference. @@ -308,7 +312,9 @@ internal ShareFileClient(Uri fileUri, HttpPipeline pipeline, ShareClientOptions. /// class with an identical source but the specified /// timestamp. /// - /// For more information, see Snapshot Share. + /// For more information, see + /// + /// Snapshot Share. /// /// /// Pass null or empty string to remove the snapshot returning a URL to the base file. @@ -344,7 +350,9 @@ private void SetNameFieldsIfNull() /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -403,7 +411,9 @@ public virtual Response Create( /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -460,7 +470,9 @@ public virtual Response Create( /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -519,7 +531,9 @@ await CreateInternal( /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -576,7 +590,9 @@ await CreateInternal( /// /// Creates a new file or replaces an existing file. /// - /// For more information, see Create File. + /// For more information, see + /// + /// Create File. /// /// /// This method only initializes the file. @@ -802,7 +818,9 @@ private async Task> ExistsInternal( /// The operation immediately removes the file from the storage account, /// if it exists. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to add conditions @@ -832,7 +850,9 @@ public virtual Response DeleteIfExists( /// The operation immediately removes the file from the storage account, /// if it exists. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to add conditions @@ -862,7 +882,9 @@ await DeleteIfExistsInternal( /// The operation immediately removes the file from the storage account, /// if it exists. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to add conditions @@ -926,7 +948,9 @@ private async Task> DeleteIfExistsInternal( /// /// Copies a blob or file to a destination file within the storage account. /// - /// For more information, see Copy File. + /// For more information, see + /// + /// Copy File. /// /// /// Required. Specifies the URL of the source file or blob. @@ -996,7 +1020,9 @@ public virtual Response StartCopy( /// /// Copies a blob or file to a destination file within the storage account. /// - /// For more information, see Copy File. + /// For more information, see + /// + /// Copy File. /// /// /// Required. Specifies the URL of the source file or blob. @@ -1039,7 +1065,9 @@ public virtual Response StartCopy( /// /// Copies a blob or file to a destination file within the storage account. /// - /// For more information, see Copy File. + /// For more information, see + /// + /// Copy File. /// /// /// Required. Specifies the URL of the source file or blob. @@ -1109,7 +1137,9 @@ await StartCopyInternal( /// /// Copies a blob or file to a destination file within the storage account. /// - /// For more information, see Copy File. + /// For more information, see + /// + /// Copy File. /// /// /// Required. Specifies the URL of the source file or blob. @@ -1152,7 +1182,9 @@ await StartCopyInternal( /// /// Copies a blob or file to a destination file within the storage account. /// - /// For more information, see Copy File. + /// For more information, see + /// + /// Copy File. /// /// /// Required. Specifies the URL of the source file or blob. @@ -1260,7 +1292,9 @@ private async Task> StartCopyInternal( /// /// Attempts to cancel a pending copy that was previously started and leaves a destination file with zero length and full metadata. /// - /// For more information, see Abort Copy File. + /// For more information, see + /// + /// Abort Copy File. /// /// /// String identifier for the copy operation. @@ -1294,7 +1328,9 @@ public virtual Response AbortCopy( /// /// Attempts to cancel a pending copy that was previously started and leaves a destination file with zero length and full metadata. /// - /// For more information, see Abort Copy File. + /// For more information, see + /// + /// Abort Copy File. /// /// /// String identifier for the copy operation. @@ -1326,7 +1362,9 @@ public virtual Response AbortCopy( /// /// Attempts to cancel a pending copy that was previously started and leaves a destination file with zero length and full metadata. /// - /// For more information, see Abort Copy File. + /// For more information, see + /// + /// Abort Copy File. /// /// /// String identifier for the copy operation. @@ -1360,7 +1398,9 @@ await AbortCopyInternal( /// /// Attempts to cancel a pending copy that was previously started and leaves a destination file with zero length and full metadata. /// - /// For more information, see Abort Copy File. + /// For more information, see + /// + /// Abort Copy File. /// /// /// String identifier for the copy operation. @@ -1392,7 +1432,9 @@ await AbortCopyInternal( /// /// Attempts to cancel a pending copy that was previously started and leaves a destination file with zero length and full metadata. /// - /// For more information, see Abort Copy File. + /// For more information, see + /// + /// Abort Copy File. /// /// /// String identifier for the copy operation. @@ -1460,7 +1502,9 @@ private async Task AbortCopyInternal( /// The /// operation reads or downloads a file from the system, including its metadata and properties. /// - /// For more information, Get File. + /// For more information, see + /// + /// Get File. /// /// /// Optional. Only download the bytes of the file in the specified @@ -1508,7 +1552,9 @@ public virtual Response Download( /// The operation reads /// or downloads a file from the system, including its metadata and properties. /// - /// For more information Get File. + /// For more information, see + /// + /// Get File. /// /// /// Optional. Only download the bytes of the file in the specified @@ -1554,7 +1600,9 @@ public virtual Response Download( /// The /// operation reads or downloads a file from the system, including its metadata and properties. /// - /// For more information Get File. + /// For more information, see + /// + /// Get File. /// /// /// Optional. Only download the bytes of the file in the specified @@ -1602,7 +1650,9 @@ await DownloadInternal( /// The operation reads /// or downloads a file from the system, including its metadata and properties. /// - /// For more information Get File. + /// For more information, see + /// + /// Get File. /// /// /// Optional. Only download the bytes of the file in the specified @@ -1647,7 +1697,9 @@ await DownloadInternal( /// /// The operation reads or downloads a file from the system, including its metadata and properties. /// - /// For more information Get File. + /// For more information, see + /// + /// Get File. /// /// /// Optional. Only download the bytes of the file in the specified @@ -1753,7 +1805,9 @@ private async Task> DownloadInternal( /// /// The operation starts to read or downloads a file from the system, including its metadata and properties. /// - /// For more information, see Get File. + /// For more information, see + /// + /// Get File. /// /// /// Optional. Only download the bytes of the file in the specified @@ -2052,7 +2106,9 @@ internal async Task OpenReadInteral( /// The /// operation immediately removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to add conditions @@ -2082,7 +2138,9 @@ public virtual Response Delete( /// The operation immediately /// removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to propagate @@ -2110,7 +2168,9 @@ public virtual Response Delete( /// The operation /// immediately removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to add conditions @@ -2140,7 +2200,9 @@ await DeleteInternal( /// The operation /// immediately removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to propagate @@ -2167,7 +2229,9 @@ await DeleteInternal( /// /// The operation immediately removes the file from the storage account. /// - /// For more information, see Delete File. + /// For more information, see + /// + /// Delete File. /// /// /// Optional to add conditions @@ -2234,7 +2298,9 @@ private async Task DeleteInternal( /// and system properties for the file. It does not return the content of the /// file. /// - /// For more information, see Get File Properties. + /// For more information, see + /// + /// Get File Properties. /// /// /// Optional to add conditions @@ -2267,7 +2333,9 @@ public virtual Response GetProperties( /// and system properties for the file. It does not return the /// content of the file. /// - /// For more information, see Get File Properties + /// For more information, see + /// + /// Get File Properties. /// /// /// Optional to propagate @@ -2297,7 +2365,9 @@ public virtual Response GetProperties( /// operation returns all user-defined metadata, standard HTTP properties, and system /// properties for the file. It does not return the content of the file. /// - /// For more information, see Get File Properties + /// For more information, see + /// + /// Get File Properties. /// /// /// Optional to add conditions @@ -2330,7 +2400,9 @@ await GetPropertiesInternal( /// properties for the file. It does not return the content of the /// file. /// - /// For more information, see Get File Properties + /// For more information, see + /// + /// Get File Properties. /// /// /// Optional to propagate @@ -2361,7 +2433,9 @@ await GetPropertiesInternal( /// properties for the file. It does not return the content of the /// file. /// - /// For more information, see Get File Properties + /// For more information, see + /// + /// Get File Properties. /// /// /// Optional to add conditions @@ -2433,7 +2507,9 @@ private async Task> GetPropertiesInternal( /// The /// operation sets system properties on the file. /// - /// For more information, see Set File Properties. + /// For more information, see + /// + /// Set File Properties. /// /// /// Optional. Resizes a file to the specified size. @@ -2488,7 +2564,9 @@ public virtual Response SetHttpHeaders( /// operation sets system /// properties on the file. /// - /// For more information, see Set File Properties. + /// For more information, see + /// + /// Set File Properties. /// /// /// Optional. Resizes a file to the specified size. @@ -2540,7 +2618,9 @@ public virtual Response SetHttpHeaders( /// The /// operation sets system properties on the file. /// - /// For more information, see Set File Properties. + /// For more information, see + /// + /// Set File Properties. /// /// /// Optional. Resizes a file to the specified size. @@ -2594,7 +2674,9 @@ await SetHttpHeadersInternal( /// The /// operation sets system properties on the file. /// - /// For more information, see Set File Properties. + /// For more information, see + /// + /// Set File Properties. /// /// /// Optional. Resizes a file to the specified size. @@ -2646,7 +2728,9 @@ await SetHttpHeadersInternal( /// The operation sets system /// properties on the file. /// - /// For more information, see Set File Properties. + /// For more information, see + /// + /// Set File Properties. /// /// /// Optional. Resizes a file to the specified size. @@ -2752,7 +2836,9 @@ private async Task> SetHttpHeadersInternal( /// The operation sets user-defined /// metadata for the specified file as one or more name-value pairs. /// - /// For more information, see Set File Metadata. + /// For more information, see + /// + /// Set File Metadata. /// /// /// Custom metadata to set for this file. @@ -2788,7 +2874,9 @@ public virtual Response SetMetadata( /// The operation sets user-defined /// metadata for the specified file as one or more name-value pairs. /// - /// For more information, see Set File Metadata. + /// For more information, see + /// + /// Set File Metadata. /// /// /// Custom metadata to set for this file. @@ -2822,7 +2910,9 @@ public virtual Response SetMetadata( /// The operation sets user-defined /// metadata for the specified file as one or more name-value pairs. /// - /// For more information, see Set File Metadata. + /// For more information, see + /// + /// Set File Metadata. /// /// /// Custom metadata to set for this file. @@ -2858,7 +2948,9 @@ await SetMetadataInternal( /// The operation sets user-defined /// metadata for the specified file as one or more name-value pairs. /// - /// For more information, see Set File Metadata. + /// For more information, see + /// + /// Set File Metadata. /// /// /// Custom metadata to set for this file. @@ -2892,7 +2984,9 @@ await SetMetadataInternal( /// The operation sets user-defined /// metadata for the specified file as one or more name-value pairs. /// - /// For more information, see Set File Metadata. + /// For more information, see + /// + /// Set File Metadata. /// /// /// Custom metadata to set for this file. @@ -2961,7 +3055,9 @@ private async Task> SetMetadataInternal( /// The /// operation clears the of a file. /// - /// For more information, see Put Range. + /// For more information, see + /// + /// Put Range. /// /// /// Specifies the range of bytes to be cleared. Both the start and end of the range must be specified. @@ -2998,7 +3094,9 @@ public virtual Response ClearRange( /// The /// operation clears the of a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// Specifies the range of bytes to be cleared. Both the start and end of the range must be specified. @@ -3034,9 +3132,10 @@ await ClearRangeInternal( /// The operation clears the /// of a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// - /// /// Specifies the range of bytes to be cleated. Both the start and end of the range must be specified. /// @@ -3109,7 +3208,9 @@ private async Task> ClearRangeInternal( /// The /// operation writes to a of a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// Specifies the range of bytes to be written. Both the start and end of the range must be specified. @@ -3167,7 +3268,9 @@ public virtual Response UploadRange( /// The /// operation writes to a of a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// Specifies the range of bytes to be written. Both the start and end of the range must be specified. @@ -3225,7 +3328,9 @@ await UploadRangeInternal( /// The /// operation writes to a of a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// Required. Specifies whether to update or clear the range. /// @@ -3282,7 +3387,9 @@ public virtual Response UploadRange( /// The /// operation writes to a of a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// Required. Specifies whether to update or clear the range. /// @@ -3339,9 +3446,10 @@ await UploadRangeInternal( /// The operation writes /// to a of a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// - /// /// Specifies the range of bytes to be written. Both the start and end of the range must be specified. /// @@ -3703,7 +3811,9 @@ private async Task> UploadRangeFromUriInternal( /// The /// operation writes to a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// A containing the content of the file to upload. @@ -3747,7 +3857,9 @@ public virtual Response Upload( /// The /// operation writes to a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// A containing the content of the file to upload. @@ -3789,7 +3901,9 @@ public virtual Response Upload( /// The operation writes /// to a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// A containing the content of the file to upload. @@ -3833,7 +3947,9 @@ await UploadInternal( /// The operation writes /// to a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// A containing the content of the file to upload. @@ -3875,7 +3991,9 @@ await UploadInternal( /// The operation writes /// to a file. /// - /// For more information, see Put Range + /// For more information, see + /// + /// Put Range. /// /// /// A containing the content to upload. @@ -4001,7 +4119,9 @@ await content.ReadAsync(segment.Array, 0, singleRangeThreshold, cancellationToke /// /// Returns the list of valid ranges for a file. /// - /// For more information, see List Ranges. + /// For more information, see + /// + /// List Ranges. /// /// /// Optional. Specifies the range of bytes over which to list ranges, inclusively. @@ -4037,7 +4157,9 @@ public virtual Response GetRangeList( /// /// Returns the list of valid ranges for a file. /// - /// For more information, see List Ranges. + /// For more information, see + /// + /// List Ranges. /// /// /// Optional. Specifies the range of bytes over which to list ranges, inclusively. @@ -4071,7 +4193,9 @@ public virtual Response GetRangeList( /// /// Returns the list of valid ranges for a file. /// - /// For more information, see List Ranges. + /// For more information, see + /// + /// List Ranges. /// /// /// Optional. Specifies the range of bytes over which to list ranges, inclusively. @@ -4107,7 +4231,9 @@ await GetRangeListInternal( /// /// Returns the list of valid ranges for a file. /// - /// For more information, see List Ranges. + /// For more information, see + /// + /// List Ranges. /// /// /// Optional. Specifies the range of bytes over which to list ranges, inclusively. @@ -4141,7 +4267,9 @@ await GetRangeListInternal( /// /// Returns the list of valid ranges for a file. /// - /// For more information, see List Ranges. + /// For more information, see + /// + /// List Ranges. /// /// /// Optional. Specifies the range of bytes over which to list ranges, inclusively. @@ -4213,7 +4341,9 @@ private async Task> GetRangeListInternal( /// handles may make multiple requests to the service while fetching /// all the values. /// - /// For more information, see List Handles. + /// For more information, see + /// + /// List Handles. /// /// /// Optional to propagate @@ -4237,7 +4367,9 @@ public virtual Pageable GetHandles( /// Enumerating the handles may make multiple requests to the service /// while fetching all the values. /// - /// For more information, see List Handles. + /// For more information, see + /// + /// List Handles. /// /// /// Optional to propagate @@ -4259,7 +4391,9 @@ public virtual AsyncPageable GetHandlesAsync( /// The operation returns a list of open /// handles on the file. /// - /// For more information, see List Handles. + /// For more information, see + /// + /// List Handles. /// /// /// @@ -4341,7 +4475,9 @@ internal async Task> GetHandlesInternal( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Specifies the handle ID to be closed. @@ -4385,7 +4521,9 @@ public virtual Response ForceCloseHandle( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Specifies the handle ID to be closed. @@ -4429,7 +4567,9 @@ public virtual async Task> ForceCloseHandleAsync( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Optional to propagate @@ -4460,7 +4600,9 @@ public virtual CloseHandlesResult ForceCloseAllHandles( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Optional to propagate @@ -4491,7 +4633,9 @@ await ForceCloseAllHandlesInternal( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Whether to invoke the operation asynchronously. @@ -4543,7 +4687,9 @@ private async Task ForceCloseAllHandlesInternal( /// errors due to failed attempts to read or write files. This API is not intended for use as a replacement /// or alternative for SMB close. /// - /// For more information, see Force Close Handles. + /// For more information, see + /// + /// Force Close Handles. /// /// /// Optional. Specifies the handle ID to be closed. If not specified, or if equal to "*", will close all handles. diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/ShareServiceClient.cs b/sdk/storage/Azure.Storage.Files.Shares/src/ShareServiceClient.cs index a32a2cf5d9ab8..cfb444df24305 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/ShareServiceClient.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/ShareServiceClient.cs @@ -101,7 +101,9 @@ protected ShareServiceClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings. /// public ShareServiceClient(string connectionString) : this(connectionString, null) @@ -117,7 +119,9 @@ public ShareServiceClient(string connectionString) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, + /// + /// Configure Azure Storage connection strings. /// /// /// Optional client options that define the transport pipeline @@ -218,7 +222,9 @@ public virtual ShareClient GetShareClient(string shareName) => /// make multiple requests to the service while fetching all the /// values. /// - /// For more information, List Shares. + /// For more information, see + /// + /// List Shares. /// /// /// Specifies traits to include in the s. @@ -255,7 +261,9 @@ public virtual Pageable GetShares( /// make multiple requests to the service while fetching all the /// values. /// - /// For more information, List Shares. + /// For more information, see + /// + /// List Shares. /// /// /// Specifies traits to include in the s. @@ -295,7 +303,9 @@ public virtual AsyncPageable GetSharesAsync( /// empty to make subsequent calls to /// to continue enumerating the shares segment by segment. /// - /// For more information, List Shares. + /// For more information, see + /// + /// List Shares. /// /// /// An optional string value that identifies the segment of the list @@ -394,7 +404,9 @@ internal async Task> GetSharesInternal( /// of a storage account’s file service, including properties for /// Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. /// - /// For more information, see . + /// For more information, see + /// + /// Get File Service Properties. /// /// /// Optional to propagate @@ -420,7 +432,9 @@ public virtual Response GetProperties( /// of a storage account’s file service, including properties for /// Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. /// - /// For more information, see . + /// For more information, see + /// + /// Get File Service Properties. /// /// /// Optional to propagate @@ -446,7 +460,9 @@ await GetPropertiesInternal( /// of a storage account’s file service, including properties for /// Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. /// - /// For more information, see . + /// For more information, see + /// + /// Get File Service Properties. /// /// /// Whether to invoke the operation asynchronously. @@ -506,7 +522,9 @@ private async Task> GetPropertiesInternal( /// the default request version for all incoming requests to the File /// service that do not have a version specified. /// - /// For more information, see Set File Service Properties. + /// For more information, see + /// + /// Set File Service Properties. /// /// The file service properties. /// @@ -537,7 +555,9 @@ public virtual Response SetProperties( /// the default request version for all incoming requests to the File /// service that do not have a version specified. /// - /// For more information, see Set File Service Properties. + /// For more information, see + /// + /// Set File Service Properties. /// /// The file service properties. /// @@ -568,7 +588,9 @@ await SetPropertiesInternal( /// the default request version for all incoming requests to the File /// service that do not have a version specified. /// - /// For more information, see Set File Service Properties. + /// For more information, see + /// + /// Set File Service Properties. /// /// The file service properties. /// @@ -627,7 +649,9 @@ private async Task SetPropertiesInternal( /// under the specified account. If a share with the same name /// already exists, the operation fails. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// The name of the share to create. @@ -674,7 +698,9 @@ public virtual Response CreateShare( /// under the specified account. If a share with the same name /// already exists, the operation fails. /// - /// For more information, see Create Share. + /// For more information, see + /// + /// Create Share. /// /// /// The name of the share to create. @@ -722,9 +748,12 @@ public virtual async Task> CreateShareAsync( /// Marks the specified share or share snapshot for deletion. /// The share or share snapshot and any files contained within it are later deleted during garbage collection. /// - /// Currently, this method will always delete snapshots. There's no way to specify a separate value for x-ms-delete-snapshots. + /// Currently, this method will always delete snapshots. + /// There's no way to specify a separate value for x-ms-delete-snapshots. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// The name of the share to delete. @@ -761,7 +790,9 @@ public virtual Response DeleteShare( /// /// Currently, this method will always delete snapshots. There's no way to specify a separate value for x-ms-delete-snapshots. /// - /// For more information, see Delete Share. + /// For more information, see + /// + /// Delete Share. /// /// /// The name of the share to delete. diff --git a/sdk/storage/Azure.Storage.Files.Shares/src/ShareUriBuilder.cs b/sdk/storage/Azure.Storage.Files.Shares/src/ShareUriBuilder.cs index 8a646304177e9..a578ddbb48ad0 100644 --- a/sdk/storage/Azure.Storage.Files.Shares/src/ShareUriBuilder.cs +++ b/sdk/storage/Azure.Storage.Files.Shares/src/ShareUriBuilder.cs @@ -16,7 +16,9 @@ namespace Azure.Storage.Files.Shares /// modify the contents of a instance to point to /// different Azure Storage resources like an account, share, or file. /// - /// For more information, see . + /// For more information, see + /// + /// Naming and Referencing Shares, Directories, Files, and Metadata. /// public class ShareUriBuilder { diff --git a/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs b/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs index 4c2371129d603..ae9ae421c07a3 100644 --- a/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs +++ b/sdk/storage/Azure.Storage.Queues/src/QueueClient.cs @@ -150,7 +150,9 @@ protected QueueClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, see + /// + /// Configure Azure Storage connection strings. /// /// /// The name of the queue in the storage account to reference. @@ -169,7 +171,9 @@ public QueueClient(string connectionString, string queueName) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, see + /// + /// Configure Azure Storage connection strings. /// /// /// The name of the queue in the storage account to reference. @@ -343,7 +347,9 @@ private void SetNameFieldsIfNull() /// /// Creates a queue. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// Optional . @@ -366,7 +372,9 @@ public virtual Response Create( /// /// Creates a queue. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// Optional . @@ -389,7 +397,9 @@ await CreateInternal( /// /// Creates a queue. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// Optional . @@ -446,10 +456,12 @@ private async Task CreateInternal( #region CreateIfNotExists /// /// The - /// operation creates a new queue under the specified account. If the queue already exists, it is - /// not changed. + /// operation creates a new queue under the specified account. + /// If the queue already exists, it is not changed. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// Optional custom metadata to set for this queue. @@ -476,10 +488,12 @@ public virtual Response CreateIfNotExists( /// /// The - /// operation creates a new queue under the specified account. If the queue already exists, it is - /// not changed. + /// operation creates a new queue under the specified account. + /// If the queue already exists, it is not changed. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// Optional custom metadata to set for this queue. @@ -506,10 +520,12 @@ await CreateIfNotExistsInternal( /// /// The - /// operation creates a new queue under the specified account. If the queue already exists, it is - /// not changed. + /// operation creates a new queue under the specified account. + /// If the queue already exists, it is not changed. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// Optional custom metadata to set for this queue. @@ -683,7 +699,9 @@ private async Task> ExistsInternal( /// The operation deletes the specified /// queue if it exists. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Queue. /// /// /// Optional to propagate @@ -707,7 +725,9 @@ public virtual Response DeleteIfExists( /// The operation deletes the specified /// queue if it exists. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Queue. /// /// /// Optional to propagate @@ -731,7 +751,9 @@ await DeleteIfExistsInternal( /// The operation deletes the specified /// queue if it exists. /// - /// For more information, see . + /// For more information, see + /// + /// Delete Queue. /// /// /// Whether to invoke the operation asynchronously. @@ -788,7 +810,10 @@ private async Task> DeleteIfExistsInternal( #region Delete /// /// Deletes a queue. - /// For more information, see Delete Queue. + /// + /// For more information, see + /// + /// Delete Queue. /// /// /// @@ -805,7 +830,10 @@ public virtual Response Delete( /// /// Deletes a queue. - /// For more information, see Delete Queue. + /// + /// For more information, see + /// + /// Delete Queue. /// /// /// @@ -822,7 +850,10 @@ await DeleteInternal( /// /// Deletes a queue. - /// For more information, see Delete Queue. + /// + /// For more information, see + /// + /// Delete Queue. /// /// /// Whether to invoke the operation asynchronously. @@ -875,7 +906,10 @@ private async Task DeleteInternal( /// /// Retrieves queue properties and user-defined metadata and properties on the specified queue. /// Metadata is associated with the queue as name-values pairs. - /// For more information, see Get Queue Metadata. + /// + /// For more information, see + /// + /// Get Queue Metadata. /// /// /// @@ -893,7 +927,10 @@ public virtual Response GetProperties( /// /// Retrieves queue properties and user-defined metadata and properties on the specified queue. /// Metadata is associated with the queue as name-values pairs. - /// For more information, see Get Queue Metadata. + /// + /// For more information, see + /// + /// Get Queue Metadata. /// /// /// @@ -911,7 +948,10 @@ await GetPropertiesInternal( /// /// Retrieves queue properties and user-defined metadata and properties on the specified queue. /// Metadata is associated with the queue as name-values pairs. - /// For more information, see Get Queue Metadata. + /// + /// For more information, see + /// + /// Get Queue Metadata. /// /// /// Whether to invoke the operation asynchronously. @@ -963,7 +1003,10 @@ private async Task> GetPropertiesInternal( #region SetMetadata /// /// Sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. - /// For more information, see Set Queue Metadata. + /// + /// For more information, see + /// + /// Set Queue Metadata. /// /// /// @@ -985,7 +1028,10 @@ public virtual Response SetMetadata( /// /// Sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. - /// For more information, see Set Queue Metadata. + /// + /// For more information, see + /// + /// Set Queue Metadata. /// /// /// @@ -1007,7 +1053,10 @@ await SetMetadataInternal( /// /// Sets user-defined metadata on the specified queue. Metadata is associated with the queue as name-value pairs. - /// For more information, see Set Queue Metadata. + /// + /// For more information, see + /// + /// Set Queue Metadata. /// /// /// @@ -1060,7 +1109,10 @@ private async Task SetMetadataInternal( /// /// Returns details about any stored access policies specified on the queue that may be used with /// Shared Access Signatures. - /// For more information, see Get Queue ACL. + /// + /// For more information, see + /// + /// Get Queue ACL. /// /// /// @@ -1078,7 +1130,10 @@ public virtual Response> GetAccessPolicy( /// /// Returns details about any stored access policies specified on the queue that may be used with /// Shared Access Signatures. - /// For more information, see Get Queue ACL. + /// + /// For more information, see + /// + /// Get Queue ACL. /// /// /// @@ -1096,7 +1151,10 @@ await GetAccessPolicyInternal( /// /// Returns details about any stored access policies specified on the queue that may be used with /// Shared Access Signatures. - /// For more information, see Get Queue ACL. + /// + /// For more information, see + /// + /// Get Queue ACL. /// /// /// Whether to invoke the operation asynchronously. @@ -1143,7 +1201,10 @@ private async Task>> GetAccessPolicy #region SetAccessPolicy /// /// SetAccessPolicyAsync sets stored access policies for the queue that may be used with Shared Access Signatures. - /// For more information, see Set Queue ACL. + /// + /// For more information, see + /// + /// Set Queue ACL. /// /// /// IEnumerable of @@ -1165,7 +1226,10 @@ public virtual Response SetAccessPolicy( /// /// SetAccessPolicyAsync sets stored access policies for the queue that may be used with Shared Access Signatures. - /// For more information, see Set Queue ACL. + /// + /// For more information, see + /// + /// Set Queue ACL. /// /// /// IEnumerable of @@ -1187,7 +1251,10 @@ await SetAccessPolicyInternal( /// /// SetAccessPolicyInternal sets stored access policies for the queue that may be used with Shared Access Signatures. - /// For more information, see Set Queue ACL. + /// + /// For more information, see + /// + /// Set Queue ACL. /// /// /// IEnumerable of @@ -1239,7 +1306,10 @@ private async Task SetAccessPolicyInternal( #region ClearMessages /// /// Deletes all messages from a queue. - /// For more information, see Clear Messages. + /// + /// For more information, see + /// + /// Clear Messages. /// /// /// . @@ -1256,7 +1326,10 @@ public virtual Response ClearMessages( /// /// Deletes all messages from a queue. - /// For more information, see Clear Messages. + /// + /// For more information, see + /// + /// Clear Messages. /// /// /// . @@ -1273,7 +1346,10 @@ await ClearMessagesInternal( /// /// Deletes all messages from a queue. - /// For more information, see Clear Messages. + /// + /// For more information, see + /// + /// Clear Messages. /// /// /// Whether to invoke the operation asynchronously. @@ -1322,7 +1398,10 @@ private async Task ClearMessagesInternal( /// /// Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible /// to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Put Message. + /// + /// For more information, see + /// + /// Put Message. /// /// /// Message text. @@ -1338,7 +1417,10 @@ public virtual Response SendMessage(string messageText) => /// /// Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible /// to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Put Message. + /// + /// For more information, see + /// + /// Put Message. /// /// /// Message text. @@ -1355,7 +1437,10 @@ await SendMessageAsync( /// /// Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible /// to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Put Message. + /// + /// For more information, see + /// + /// Put Message. /// /// /// Message text. @@ -1375,7 +1460,10 @@ public virtual Response SendMessage(string messageText, Cancellatio /// /// Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible /// to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Put Message. + /// + /// For more information, see + /// + /// Put Message. /// /// /// Message text. @@ -1395,7 +1483,10 @@ await SendMessageAsync(messageText, /// /// Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible /// to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Put Message. + /// + /// For more information, see + /// + /// Put Message. /// /// /// Message text. @@ -1428,7 +1519,10 @@ public virtual Response SendMessage( /// /// Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible /// to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Put Message. + /// + /// For more information, see + /// + /// Put Message. /// /// /// Message text. @@ -1461,7 +1555,10 @@ await SendMessageInternal( /// /// Adds a new message to the back of a queue. The visibility timeout specifies how long the message should be invisible /// to Dequeue and Peek operations. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Put Message. + /// + /// For more information, see + /// + /// Put Message. /// /// /// Message text. @@ -1536,7 +1633,10 @@ await QueueRestClient.Messages.EnqueueAsync( #region ReceiveMessages /// /// Receives one or more messages from the front of the queue. - /// For more information, see Get Messages. + /// + /// For more information, see + /// + /// Get Messages. /// /// /// where T is an array of @@ -1545,7 +1645,10 @@ await QueueRestClient.Messages.EnqueueAsync( /// /// Retrieves one or more messages from the front of the queue. - /// For more information, see Get Messages. + /// + /// For more information, see + /// + /// Get Messages. /// /// /// where T is an array of @@ -1556,7 +1659,10 @@ public virtual async Task> ReceiveMessagesAsync() => /// /// Receives one or more messages from the front of the queue. - /// For more information, see Get Messages. + /// + /// For more information, see + /// + /// Get Messages. /// /// /// Optional @@ -1571,7 +1677,10 @@ public virtual Response ReceiveMessages(CancellationToken cancel /// /// Retrieves one or more messages from the front of the queue. - /// For more information, see Get Messages. + /// + /// For more information, see + /// + /// Get Messages. /// /// /// Optional @@ -1587,7 +1696,10 @@ await ReceiveMessagesAsync( /// /// Receives one or more messages from the front of the queue. - /// For more information, see Get Messages. + /// + /// For more information, see + /// + /// Get Messages. /// /// /// Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. @@ -1615,7 +1727,10 @@ public virtual Response ReceiveMessages( /// /// Retrieves one or more messages from the front of the queue. - /// For more information, see Get Messages. + /// + /// For more information, see + /// + /// Get Messages. /// /// /// Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. @@ -1643,7 +1758,10 @@ await ReceiveMessagesInternal( /// /// Retrieves one or more messages from the front of the queue. - /// For more information, see Get Messages. + /// + /// For more information, see + /// + /// Get Messages. /// /// /// Optional. A nonzero integer value that specifies the number of messages to retrieve from the queue, up to a maximum of 32. @@ -1722,7 +1840,10 @@ private async Task> ReceiveMessagesInternal( #region PeekMessages /// /// Retrieves one or more messages from the front of the queue but does not alter the visibility of the message. - /// For more information, see Peek Messages. + /// + /// For more information, see + /// + /// Peek Messages. /// /// /// Optional. A nonzero integer value that specifies the number of messages to peek from the queue, up to a maximum of 32. @@ -1745,7 +1866,10 @@ public virtual Response PeekMessages( /// /// Retrieves one or more messages from the front of the queue but does not alter the visibility of the message. - /// For more information, see Peek Messages. + /// + /// For more information, see + /// + /// Peek Messages. /// /// /// Optional. A nonzero integer value that specifies the number of messages to peek from the queue, up to a maximum of 32. @@ -1768,7 +1892,10 @@ await PeekMessagesInternal( /// /// Retrieves one or more messages from the front of the queue but does not alter the visibility of the message. - /// For more information, see Peek Messages. + /// + /// For more information, see + /// + /// Peek Messages. /// /// /// Optional. A nonzero integer value that specifies the number of messages to peek from the queue, up to a maximum of 32. @@ -1849,7 +1976,10 @@ private Uri GetMessageUri(string messageId) => #region DeleteMessage /// /// Permanently removes the specified message from its queue. - /// For more information, see Delete Message. + /// + /// For more information, see + /// + /// Delete Message. /// /// ID of the message to delete. /// @@ -1874,7 +2004,10 @@ public virtual Response DeleteMessage( /// /// Permanently removes the specified message from its queue. - /// For more information, see Delete Message. + /// + /// For more information, see + /// + /// Delete Message. /// /// ID of the message to delete. /// @@ -1899,7 +2032,10 @@ await DeleteMessageInternal( /// /// Permanently removes the specified message from its queue. - /// For more information, see Delete Message. + /// + /// For more information, see + /// + /// Delete Message. /// /// ID of the message to delete. /// @@ -1957,7 +2093,10 @@ private async Task DeleteMessageInternal( #region UpdateMessage /// /// Changes a message's visibility timeout and contents. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Update Message. + /// + /// For more information, see + /// + /// Update Message. /// /// ID of the message to update. /// @@ -1994,7 +2133,10 @@ public virtual Response UpdateMessage( /// /// Changes a message's visibility timeout and contents. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Update Message. + /// + /// For more information, see + /// + /// Update Message. /// /// ID of the message to update. /// @@ -2031,7 +2173,10 @@ await UpdateMessageInternal( /// /// Changes a message's visibility timeout and contents. The message content must be a UTF-8 encoded string that is up to 64KB in size. - /// For more information, see Update Message. + /// + /// For more information, see + /// + /// Update Message. /// /// /// Updated message text. diff --git a/sdk/storage/Azure.Storage.Queues/src/QueueClientOptions.cs b/sdk/storage/Azure.Storage.Queues/src/QueueClientOptions.cs index b96e39829dd7f..75659092ce537 100644 --- a/sdk/storage/Azure.Storage.Queues/src/QueueClientOptions.cs +++ b/sdk/storage/Azure.Storage.Queues/src/QueueClientOptions.cs @@ -21,20 +21,26 @@ public class QueueClientOptions : ClientOptions /// /// The versions of Azure Queue Storage supported by this client - /// library. For more, see - /// . + /// library. + /// + /// For more information, see + /// + /// Versioning for the Azure Storage services. /// public enum ServiceVersion { #pragma warning disable CA1707 // Identifiers should not contain underscores /// /// The 2019-02-02 service version described at - /// + /// + /// Version 2019-02-02. /// V2019_02_02 = 1, /// - /// The 2019-07-07 service version. + /// The 2019-07-07 service version described at + /// + /// Version 2019-07-07. /// V2019_07_07 = 2, @@ -48,7 +54,9 @@ public enum ServiceVersion /// /// Gets the of the service API used when /// making requests. For more, see - /// . + /// For more information, see + /// + /// Versioning for the Azure Storage services. /// public ServiceVersion Version { get; } diff --git a/sdk/storage/Azure.Storage.Queues/src/QueueServiceClient.cs b/sdk/storage/Azure.Storage.Queues/src/QueueServiceClient.cs index 0c168aa966aee..f2a54117ec1c4 100644 --- a/sdk/storage/Azure.Storage.Queues/src/QueueServiceClient.cs +++ b/sdk/storage/Azure.Storage.Queues/src/QueueServiceClient.cs @@ -109,7 +109,9 @@ protected QueueServiceClient() /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, see + /// + /// Configure Azure Storage connection strings. /// public QueueServiceClient(string connectionString) : this(connectionString, null) @@ -125,7 +127,9 @@ public QueueServiceClient(string connectionString) /// required for your application to access data in an Azure Storage /// account at runtime. /// - /// For more information, Configure Azure Storage connection strings + /// For more information, see + /// + /// Configure Azure Storage connection strings. /// /// /// Optional client options that define the transport pipeline @@ -253,7 +257,9 @@ public virtual QueueClient GetQueueClient(string queueName) /// queues may make multiple requests to the service while fetching /// all the values. Queue names are returned in lexicographic order. /// - /// For more information, see List Queues + /// For more information, see + /// + /// List Queues. /// /// /// Optional trait options for shaping the queues. @@ -280,7 +286,9 @@ public virtual Pageable GetQueues( /// queues may make multiple requests to the service while fetching /// all the values. Queue names are returned in lexicographic order. /// - /// For more information, see List Queues + /// For more information, see + /// + /// List Queues. /// /// /// Optional trait options for shaping the queues. @@ -307,7 +315,10 @@ public virtual AsyncPageable GetQueuesAsync( /// /// Returns a single segment of containers starting from the specified marker. - /// For more information, see List Queues + /// + /// For more information, see + /// + /// List Queues. /// /// /// Marker from the previous request. @@ -393,7 +404,10 @@ internal async Task> GetQueuesInternal( #region GetProperties /// /// Gets the properties of the queue service. - /// For more information, see Get Queue Service Properties. + /// + /// For more information, see + /// + /// Get Queue Service Properties. /// /// /// @@ -410,7 +424,10 @@ public virtual Response GetProperties( /// /// Gets the properties of the queue service. - /// For more information, see Get Queue Service Properties. + /// + /// For more information, see + /// + /// Get Queue Service Properties. /// /// /// @@ -427,7 +444,10 @@ await GetPropertiesInternal( /// /// Gets the properties of the queue service. - /// For more information, see Get Queue Service Properties. + /// + /// For more information, see + /// + /// Get Queue Service Properties. /// /// /// Whether to invoke the operation asynchronously. @@ -474,7 +494,10 @@ private async Task> GetPropertiesInternal( #region SetProperties /// /// Sets the properties of the queue service. - /// For more information, see Set Queue Service Properties. + /// + /// For more information, see + /// + /// Set Queue Service Properties. /// /// /// @@ -496,7 +519,9 @@ public virtual Response SetProperties( /// /// Sets the properties of the queue service. - /// For more information, see Set Queue Service Properties. + /// + /// For more information, see + /// Set Queue Service Properties. /// /// /// @@ -518,7 +543,10 @@ await SetPropertiesInternal( /// /// Sets the properties of the queue service. - /// For more information, see Set Queue Service Properties. + /// + /// For more information, see + /// + /// Set Queue Service Properties. /// /// /// @@ -574,7 +602,10 @@ private async Task SetPropertiesInternal( /// Retrieves statistics related to replication for the Blob service. It is /// only available on the secondary location endpoint when read-access /// geo-redundant replication is enabled for the storage account. - /// For more information, see Get Queue Service Stats. + /// + /// For more information, see + /// + /// Get Queue Service Stats. /// /// /// @@ -593,7 +624,10 @@ public virtual Response GetStatistics( /// Retrieves statistics related to replication for the Blob service. It is /// only available on the secondary location endpoint when read-access /// geo-redundant replication is enabled for the storage account. - /// For more information, see Get Queue Service Stats. + /// + /// For more information, see + /// + /// Get Queue Service Stats. /// /// /// @@ -612,7 +646,10 @@ await GetStatisticsInternal( /// Retrieves statistics related to replication for the Blob service. It is /// only available on the secondary location endpoint when read-access /// geo-redundant replication is enabled for the storage account. - /// For more information, see Get Queue Service Stats. + /// + /// For more information, see + /// + /// Get Queue Service Stats. /// /// /// Whether to invoke the operation asynchronously. @@ -660,7 +697,9 @@ private async Task> GetStatisticsInternal( /// /// Creates a queue. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// The name of the queue to create. @@ -688,7 +727,9 @@ public virtual Response CreateQueue( /// /// Creates a queue. /// - /// For more information, see Create Queue. + /// For more information, see + /// + /// Create Queue. /// /// /// The name of the queue to create. @@ -718,7 +759,9 @@ public virtual async Task> CreateQueueAsync( /// /// Deletes a queue. /// - /// For more information, see Delete Queue. + /// For more information, see + /// + /// Delete Queue. /// /// /// The name of the queue to delete. @@ -738,7 +781,9 @@ public virtual Response DeleteQueue( /// /// Deletes a queue. /// - /// For more information, see Delete Queue. + /// For more information, see + /// + /// Delete Queue. /// /// /// The name of the queue to delete. diff --git a/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs b/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs index fb3cf0a4a143b..1ba93320e726e 100644 --- a/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs +++ b/sdk/storage/Azure.Storage.Queues/src/QueueUriBuilder.cs @@ -14,7 +14,9 @@ namespace Azure.Storage.Queues /// modify the contents of a instance to point to /// different Azure Storage resources like an account, queue, or message. /// - /// For more information, see Addressing Queue Service Resources. + /// For more information, see + /// + /// Addressing Queue Service Resources. /// public class QueueUriBuilder { diff --git a/sdk/storage/Azure.Storage.Queues/src/Sas/QueueSasBuilder.cs b/sdk/storage/Azure.Storage.Queues/src/Sas/QueueSasBuilder.cs index 46c22f838bcf9..faa10a595ec1c 100644 --- a/sdk/storage/Azure.Storage.Queues/src/Sas/QueueSasBuilder.cs +++ b/sdk/storage/Azure.Storage.Queues/src/Sas/QueueSasBuilder.cs @@ -12,7 +12,10 @@ namespace Azure.Storage.Sas /// /// is used to generate a Shared Access /// Signature (SAS) for an Azure Storage queue. - /// For more information, see . + /// + /// For more information, see + /// + /// Create a Service SAS. /// public class QueueSasBuilder {