diff --git a/src/Storage/Storage.Management/Common/AzureContextAdapterExtensions.cs b/src/Storage/Storage.Management/Common/AzureContextAdapterExtensions.cs index 8253ce7d9053..4cbe80ce7d32 100644 --- a/src/Storage/Storage.Management/Common/AzureContextAdapterExtensions.cs +++ b/src/Storage/Storage.Management/Common/AzureContextAdapterExtensions.cs @@ -29,6 +29,7 @@ public static class AzureContextAdapterExtensions /// Get the current storage account. /// /// The current Azure context. + /// The storage service provider to retrieve storage service details /// The current storage account, or null, if no current storage account is set. public static CloudStorageAccount GetCurrentStorageAccount(this IAzureContext context, IStorageServiceProvider provider) { @@ -91,7 +92,8 @@ public static IStorageContext GetStorageContext(this IStorageService service) /// Get a CloudStorageAccount client for the given storage service using the given storage service provider /// /// The storage service provider to retrieve storage service details - /// The storage accoutn name + /// The storage account name + /// The resource group name /// A CloudStorageAccount client for storage data plane tasks public static CloudStorageAccount GetCloudStorageAccount(this IStorageServiceProvider provider, string accountName, string resourceGroupName = null) { diff --git a/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlob.cs b/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlob.cs index 73bbdb5e77d1..f6757037e534 100644 --- a/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlob.cs +++ b/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlob.cs @@ -194,8 +194,12 @@ public GetAzureStorageBlobCommand(IStorageBlobManagement channel) /// /// list blobs by blob name and container name /// + /// Task id + /// IStorageBlobManagement channel object /// container name /// blob name pattern + /// + /// /// An enumerable collection of IListBlobItem internal async Task ListBlobsByName(long taskId, IStorageBlobManagement localChannel, string containerName, string blobName, bool includeDeleted = false, bool includeVersion = false) { @@ -276,8 +280,13 @@ internal async Task ListBlobsByName(long taskId, IStorageBlobManagement localCha /// /// list blobs by blob prefix and container name /// + /// Task id + /// IStorageBlobManagement channel object /// container name /// blob preifx + /// + /// + /// /// An enumerable collection of IListBlobItem internal async Task ListBlobsByPrefix(long taskId, IStorageBlobManagement localChannel, string containerName, string prefix, Func blobFilter = null, bool includeDeleted = false, bool includeVersion = false) { diff --git a/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlobContent.cs b/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlobContent.cs index b513a8cd5fe2..4c00a2d903c7 100644 --- a/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlobContent.cs +++ b/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageBlobContent.cs @@ -141,6 +141,8 @@ public GetAzureStorageBlobContentCommand(IStorageBlobManagement channel) /// /// Download blob to local file /// + /// Task id + /// IStorageBlobManagement channel object /// Source blob object /// Destination file path internal virtual async Task DownloadBlob(long taskId, IStorageBlobManagement localChannel, CloudBlob blob, string filePath) @@ -178,6 +180,8 @@ await DataMovementTransferHelper.DoTransfer(() => /// /// Download blob to local file /// + /// Task id + /// IStorageBlobManagement channel object /// Source blob object /// Destination file path internal virtual async Task DownloadBlob(long taskId, IStorageBlobManagement localChannel, BlobBaseClient blob, string filePath) diff --git a/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageContainer.cs b/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageContainer.cs index 94964de44637..10ad5f93a476 100644 --- a/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageContainer.cs +++ b/src/Storage/Storage/Blob/Cmdlet/GetAzureStorageContainer.cs @@ -164,6 +164,7 @@ internal IEnumerable> ListCo /// List containers by container name prefix /// /// Container name prefix + /// /// An enumerable collection of cloudblobcontainer internal IEnumerable> ListContainersByPrefix(string prefix, Func containerFilter = null) { diff --git a/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageBlobSasToken.cs b/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageBlobSasToken.cs index 6a044e5f8246..b76b02c54eaf 100644 --- a/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageBlobSasToken.cs +++ b/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageBlobSasToken.cs @@ -281,6 +281,9 @@ public override void ExecuteCmdlet() /// CloudBlob object /// SharedAccessBlobPolicy object /// The existing policy identifier. + /// + /// + /// /// private string GetBlobSharedAccessSignature(CloudBlob blob, SharedAccessBlobPolicy accessPolicy, string policyIdentifier, SharedAccessProtocol? protocol, IPAddressOrRange iPAddressOrRange, bool generateUserDelegationSas) { @@ -299,7 +302,7 @@ private string GetBlobSharedAccessSignature(CloudBlob blob, SharedAccessBlobPoli /// /// Update the access policy /// - /// Access policy object + /// Access policy object /// Should set the default expiry time private void SetupAccessPolicy(SharedAccessBlobPolicy accessPolicy, bool shouldSetExpiryTime) { diff --git a/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageContainer.cs b/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageContainer.cs index 43c563301a4c..a9d48f35de10 100644 --- a/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageContainer.cs +++ b/src/Storage/Storage/Blob/Cmdlet/NewAzureStorageContainer.cs @@ -106,7 +106,10 @@ public NewAzureStorageContainerCommand(IStorageBlobManagement channel) /// /// create a new azure container /// + /// Task id + /// IStorageBlobManagement channel object /// container name + /// access level in ("off", "blob", "container") internal async Task CreateAzureContainer(long taskId, IStorageBlobManagement localChannel, string name, BlobContainerPublicAccessType accesslevel) { if (!NameUtil.IsValidContainerName(name)) diff --git a/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageBlob.cs b/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageBlob.cs index 6015b33f3811..a0b3067decd1 100644 --- a/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageBlob.cs +++ b/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageBlob.cs @@ -136,8 +136,10 @@ public RemoveStorageAzureBlobCommand(IStorageBlobManagement channel) /// /// remove the azure blob /// - /// Cloudblob object - /// whether the Cloudblob parameter is validated + /// Task id + /// IStorageBlobManagement channel object + /// CloudBlob object + /// whether the CloudBlob parameter is validated /// true if the blob is removed successfully, false if user cancel the remove operation internal async Task RemoveAzureBlob(long taskId, IStorageBlobManagement localChannel, CloudBlob blob, bool isValidBlob) { @@ -212,8 +214,10 @@ internal async Task RemoveAzureBlob(long taskId, IStorageBlobManagement localCha /// /// remove the azure blob with Track2 SDK /// + /// Task id + /// IStorageBlobManagement channel object /// BlobBaseClient object - /// whether the Cloudblob parameter is validated + /// whether the CloudBlob parameter is validated /// true if the blob is removed successfully, false if user cancel the remove operation internal async Task RemoveAzureBlobTrack2(long taskId, IStorageBlobManagement localChannel, BlobBaseClient blob, bool isValidBlob) { @@ -326,6 +330,8 @@ internal async Task DeleteCloudAsyncTrack2(long taskId, IStorageBlobManagement l /// /// remove azure blob /// + /// Task id + /// IStorageBlobManagement channel object /// CloudBlobContainer object /// blob name /// true if the blob is removed successfully, false if user cancel the remove operation @@ -387,6 +393,8 @@ internal async Task RemoveAzureBlob(long taskId, IStorageBlobManagement localCha /// /// remove azure blob /// + /// Task id + /// IStorageBlobManagement channel object /// container name /// blob name /// true if the blob is removed successfully, false if user cancel the remove operation diff --git a/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageContainer.cs b/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageContainer.cs index c2a7e13df203..f0ead7632b90 100644 --- a/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageContainer.cs +++ b/src/Storage/Storage/Blob/Cmdlet/RemoveAzureStorageContainer.cs @@ -74,6 +74,8 @@ public RemoveAzureStorageContainerCommand(IStorageBlobManagement channel) /// /// remove azure container by container name /// + /// Task id + /// IStorageBlobManagement channel object /// container name internal async Task RemoveAzureContainer(long taskId, IStorageBlobManagement localChannel, string name) { diff --git a/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageBlobContent.cs b/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageBlobContent.cs index f33dffcbcacc..322fd92db3b9 100644 --- a/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageBlobContent.cs +++ b/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageBlobContent.cs @@ -244,6 +244,7 @@ public SetAzureBlobContentCommand(IStorageBlobManagement channel) /// upload file to azure blob /// /// Task id + /// IStorageBlobManagement channel object /// local file path /// destination azure blob object internal virtual async Task Upload2Blob(long taskId, IStorageBlobManagement localChannel, string filePath, StorageBlob.CloudBlob blob) @@ -330,7 +331,6 @@ internal string GetFullSendFilePath(string fileName) /// set azure blob content /// /// local file path - /// container name /// blob name /// null if user cancel the overwrite operation, otherwise return destination blob object internal void SetAzureBlobContent(string fileName, string blobName) @@ -406,9 +406,10 @@ protected override void DoEndProcessing() /// /// set blob AccessTier /// - /// CloudBlob object - /// Block Blob Tier + /// IStorageBlobManagement channel object + /// CloudBlob object /// Page Blob Tier + /// Access condition to source if it's file/blob in azure. private async Task SetBlobTier(IStorageBlobManagement localChannel, StorageBlob.CloudBlob blob, PremiumPageBlobTier? pageBlobTier = null, StandardBlobTier? standardBlobTier = null) { if (pageBlobTier == null && standardBlobTier == null) diff --git a/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerAcl.cs b/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerAcl.cs index f9a749628495..03f5654a6c2b 100644 --- a/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerAcl.cs +++ b/src/Storage/Storage/Blob/Cmdlet/SetAzureStorageContainerAcl.cs @@ -74,6 +74,8 @@ public SetAzureStorageContainerAclCommand(IStorageBlobManagement channel) /// /// set the access level of specified container /// + /// Task id + /// IStorageBlobManagement channel object /// container name /// access level in ("off", "blob", "container") internal async Task SetContainerAcl(long taskId, IStorageBlobManagement localChannel, string name, BlobContainerPublicAccessType accessLevel) diff --git a/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobCopy.cs b/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobCopy.cs index 14ae459027ec..a7616033d877 100644 --- a/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobCopy.cs +++ b/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobCopy.cs @@ -481,6 +481,7 @@ public override void ExecuteCmdlet() /// /// Start copy operation by source and destination CloudBlob object /// + /// IStorageBlobManagement channel object /// Source CloudBlob object /// Destination CloudBlob object /// Destination CloudBlob object @@ -513,6 +514,7 @@ private void StartCopyBlob(IStorageBlobManagement destChannel, BlobBaseClient sr /// /// Start copy operation by source CloudBlob object /// + /// IStorageBlobManagement channel object /// Source CloudBlob object /// Destinaion container name /// Destination blob name @@ -544,9 +546,11 @@ private void StartCopyBlob(IStorageBlobManagement destChannel, BlobBaseClient sr /// /// Start copy operation by source uri /// - /// Source uri + /// IStorageBlobManagement channel object + /// Source uri /// Destinaion container name /// Destination blob name + /// a cloud blob object /// Destination CloudBlob object private void StartCopyBlob(IStorageBlobManagement destChannel, string srcUri, string destContainer, string destBlobName, AzureStorageContext context) { @@ -592,9 +596,11 @@ private void StartCopyBlob(IStorageBlobManagement destChannel, string srcUri, st /// /// Start copy operation by container name and blob name /// + /// + /// /// Source container name /// Source blob name - /// Destinaion container name + /// Destinaion container name /// Destination blob name /// Destination CloudBlob object private void StartCopyBlob(IStorageBlobManagement SrcChannel, IStorageBlobManagement destChannel, string srcContainerName, string srcBlobName, string destContainerName, string destBlobName) @@ -878,9 +884,10 @@ private BlobBaseClient GetDestBlob(IStorageBlobManagement destChannel, string de /// /// Start copy using transfer mangager by source CloudBlob object /// - /// Source CloudBlob object - /// Destination CloudBlobContainer object - /// Destination blob name + /// Task id + /// IStorageBlobManagement channel object + /// Source CloudBlob object + /// Destination CloudBlob object /// Destination CloudBlob object private async Task StartCopyAsync(long taskId, IStorageBlobManagement destChannel, CloudBlob sourceBlob, CloudBlob destBlob) { @@ -903,6 +910,8 @@ private async Task StartCopyAsync(long taskId, IStorageBlobManagement destChanne /// /// Start copy using transfer mangager by source uri /// + /// Task id + /// IStorageBlobManagement channel object /// source uri /// Destination CloudBlobContainer object /// Destination blob name @@ -935,9 +944,9 @@ private async Task StartCopyAsync(long taskId, IStorageBlobManagement destChanne /// /// Get DestinationBlob with specified copy id /// + /// IStorageBlobManagement channel object /// CloudBlobContainer object /// Blob name - /// Current CopyId /// Destination CloudBlob object private CloudBlob GetDestinationBlobWithCopyId(IStorageBlobManagement destChannel, CloudBlobContainer container, string blobName) { diff --git a/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobIncrementalCopy.cs b/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobIncrementalCopy.cs index ef8d3417e436..ced138994246 100644 --- a/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobIncrementalCopy.cs +++ b/src/Storage/Storage/Blob/Cmdlet/StartAzureStorageBlobIncrementalCopy.cs @@ -247,6 +247,7 @@ public override void ExecuteCmdlet() /// /// Start copy operation by source and destination CloudBlob object /// + /// /// Source CloudBlob object /// Destination CloudBlob object /// Destination CloudBlob object @@ -261,6 +262,7 @@ private void StartCopyBlob(IStorageBlobManagement destChannel, CloudPageBlob src /// /// Start copy operation by source CloudBlob object /// + /// /// Source CloudBlob object /// Destinaion container name /// Destination blob name @@ -280,9 +282,11 @@ private void StartCopyBlob(IStorageBlobManagement destChannel, CloudPageBlob src /// /// Start copy operation by source uri /// - /// Source uri + /// + /// Source uri /// Destinaion container name /// Destination blob name + /// a cloud blob object /// Destination CloudBlob object private void StartCopyBlob(IStorageBlobManagement destChannel, string srcUri, string destContainer, string destBlobName, AzureStorageContext context) { @@ -328,9 +332,12 @@ private void StartCopyBlob(IStorageBlobManagement destChannel, string srcUri, st /// /// Start copy operation by container name and blob name /// + /// + /// /// Source container name /// Source blob name - /// Destinaion container name + /// + /// Destinaion container name /// Destination blob name /// Destination CloudBlob object private void StartCopyBlob(IStorageBlobManagement SrcChannel, IStorageBlobManagement destChannel, string srcContainerName, string srcBlobName, DateTimeOffset? SrcBlobSnapshotTime, string destContainerName, string destBlobName) @@ -395,9 +402,10 @@ private CloudPageBlob GetDestBlob(IStorageBlobManagement destChannel, string des /// /// Start copy using transfer mangager by source CloudBlob object /// - /// Source CloudBlob object - /// Destination CloudBlobContainer object - /// Destination blob name + /// Task id + /// IStorageBlobManagement channel object + /// Source blob + /// Destination blob /// Destination CloudBlob object private async Task StartCopyAsync(long taskId, IStorageBlobManagement destChannel, CloudPageBlob sourceBlob, CloudPageBlob destBlob) { @@ -411,6 +419,8 @@ private async Task StartCopyAsync(long taskId, IStorageBlobManagement destChanne /// /// Start copy using transfer mangager by source uri /// + /// Task id + /// IStorageBlobManagement channel object /// source uri /// Destination CloudBlobContainer object /// Destination blob name @@ -440,9 +450,9 @@ private async Task StartCopyAsync(long taskId, IStorageBlobManagement destChanne /// /// Get DestinationBlob with specified copy id /// + /// IStorageBlobManagement channel object /// CloudBlobContainer object /// Blob name - /// Current CopyId /// Destination CloudBlob object private CloudPageBlob GetDestinationBlobWithCopyId(IStorageBlobManagement destChannel, CloudBlobContainer container, string blobName) { diff --git a/src/Storage/Storage/Blob/Cmdlet/StopAzureStorageBlobCopy.cs b/src/Storage/Storage/Blob/Cmdlet/StopAzureStorageBlobCopy.cs index a56112fc5966..c609a4281933 100644 --- a/src/Storage/Storage/Blob/Cmdlet/StopAzureStorageBlobCopy.cs +++ b/src/Storage/Storage/Blob/Cmdlet/StopAzureStorageBlobCopy.cs @@ -143,6 +143,8 @@ public override void ExecuteCmdlet() /// /// Stop copy operation by name /// + /// Task id + /// IStorageBlobManagement channel object /// Container name /// Blob name /// copy id @@ -155,6 +157,8 @@ private async Task StopCopyBlob(long taskId, IStorageBlobManagement localChannel /// /// Stop copy operation by CloudBlobContainer /// + /// Task id + /// IStorageBlobManagement channel object /// CloudBlobContainer object /// Blob name /// Copy id @@ -173,8 +177,11 @@ private async Task StopCopyBlob(long taskId, IStorageBlobManagement localChannel /// /// Stop copy operation by CloudBlob object /// + /// Task id + /// IStorageBlobManagement channel object /// CloudBlob object /// Copy id + /// private async Task StopCopyBlob(long taskId, IStorageBlobManagement localChannel, CloudBlob blob, string copyId, bool fetchCopyIdFromBlob = false) { ValidateBlobType(blob); diff --git a/src/Storage/Storage/Blob/StorageCloudBlobCmdletBase.cs b/src/Storage/Storage/Blob/StorageCloudBlobCmdletBase.cs index 9228a4f47fd2..ef1bcf8c1778 100644 --- a/src/Storage/Storage/Blob/StorageCloudBlobCmdletBase.cs +++ b/src/Storage/Storage/Blob/StorageCloudBlobCmdletBase.cs @@ -318,7 +318,7 @@ protected override IStorageBlobManagement CreateChannel() /// /// Get a service channel object using specified storage account /// - /// Cloud storage account object + /// Cloud storage account object /// IStorageBlobManagement channel object protected IStorageBlobManagement CreateChannel(AzureStorageContext context) { @@ -338,8 +338,10 @@ internal bool IsSnapshot(CloudBlob blob) /// /// Write CloudBlob to output using specified service channel /// - /// The output CloudBlob object + /// Task id /// IStorageBlobManagement channel object + /// A CloudBlob object + /// Continuation token. internal void WriteCloudBlobObject(long taskId, IStorageBlobManagement channel, CloudBlob blob, BlobContinuationToken continuationToken = null) { AzureStorageBlob azureBlob = new AzureStorageBlob(blob, channel.StorageContext, ClientOptions); @@ -388,8 +390,12 @@ internal void WriteDataLakeGen2Item(IStorageBlobManagement channel, PathItem ite /// /// Write CloudBlob to output using specified service channel /// - /// The output CloudBlob object + /// + /// Task id /// IStorageBlobManagement channel object + /// A CloudBlobContainer object + /// permissions of container + /// Continuation token. internal void WriteCloudContainerObject(long taskId, IStorageBlobManagement channel, CloudBlobContainer container, BlobContainerPermissions permissions, BlobContinuationToken continuationToken = null) { @@ -463,7 +469,9 @@ public static bool isDirectory(PathProperties fileProperties) /// /// get the CloudBlobContainer object by name if container exists /// + /// IStorageBlobManagement channel object /// container name + /// /// return CloudBlobContianer object if specified container exists, otherwise throw an exception internal async Task GetCloudBlobContainerByName(IStorageBlobManagement localChannel, string containerName, bool skipCheckExists = false) { @@ -487,8 +495,10 @@ internal async Task GetCloudBlobContainerByName(IStorageBlob /// /// Get an Exist DataLakeGen2Item, return true is the item is a folder, return false if it's File /// - /// the blob container + /// /// the path of the Items + /// + /// /// return true if the item is a folder, else false public static bool GetExistDataLakeGen2Item(DataLakeFileSystemClient fileSystem, string path, out DataLakeFileClient fileClient, out DataLakeDirectoryClient dirClient) { @@ -590,7 +600,7 @@ protected static PathHttpHeaders SetDatalakegen2ItemProperties(DataLakePathClien /// /// Set Metadata to a datalake gen2 item /// - /// datalake gen2 item + /// datalake gen2 item /// Metadata to set /// True will set to server, false only set to the local Datalakegen2Item object protected static IDictionary SetDatalakegen2ItemMetaData(DataLakePathClient item, Hashtable Metadata, bool setToServer = true) @@ -668,7 +678,9 @@ protected static string GetDataLakeItemUriWithoutSas(DataLakePathClient item) /// /// get the DataLakeFileSystemClient object by name if DataLakeFileSystem exists /// + /// IStorageBlobManagement channel object /// DataLakeFileSystem name + /// /// return DataLakeFileSystemClient object if specified DataLakeFileSystem exists, otherwise throw an exception internal DataLakeFileSystemClient GetFileSystemClientByName(IStorageBlobManagement localChannel, string fileSystemName, bool skipCheckExists = false) { @@ -737,8 +749,8 @@ protected void ValidateBlobProperties(Hashtable properties) /// /// set blob properties to a blob object /// - /// CloudBlob object - /// blob properties hashtable + /// CloudBlob object + /// blob properties hashtable protected static void SetBlobProperties(CloudBlob blob, Hashtable properties) { if (properties == null) @@ -762,7 +774,7 @@ protected static void SetBlobProperties(CloudBlob blob, Hashtable properties) /// /// set blob metadata to a blob object /// - /// CloudBlob object + /// CloudBlob object /// meta data hashtable protected static void SetBlobMeta(CloudBlob blob, Hashtable meta) { diff --git a/src/Storage/Storage/Blob/StorageDataMovementCmdletBase.cs b/src/Storage/Storage/Blob/StorageDataMovementCmdletBase.cs index 16abd9040f1a..67698e3552dd 100644 --- a/src/Storage/Storage/Blob/StorageDataMovementCmdletBase.cs +++ b/src/Storage/Storage/Blob/StorageDataMovementCmdletBase.cs @@ -71,7 +71,8 @@ public SwitchParameter Force /// /// Confirm the overwrite operation /// - /// Confirmation message + /// Indicating the source. + /// Indicating the destination. /// True if the opeation is confirmed, otherwise return false protected bool ConfirmOverwrite(object source, object destination) { @@ -82,7 +83,8 @@ protected bool ConfirmOverwrite(object source, object destination) /// /// Confirm the overwrite operation /// - /// Confirmation message + /// Indicating the source. + /// Indicating the destination. /// True if the opeation is confirmed, otherwise return false protected async Task ConfirmOverwriteAsync(object source, object destination) { diff --git a/src/Storage/Storage/Common/AccessPolicyHelper.cs b/src/Storage/Storage/Common/AccessPolicyHelper.cs index 8cdb03c98c7d..9b1007b3dcd5 100644 --- a/src/Storage/Storage/Common/AccessPolicyHelper.cs +++ b/src/Storage/Storage/Common/AccessPolicyHelper.cs @@ -37,6 +37,8 @@ internal class AccessPolicyHelper /// start time of the policy /// end time of the policy /// the permission of the policy + /// + /// internal static void SetupAccessPolicy(T policy, DateTime? startTime, DateTime? expiryTime, string permission, bool noStartTime = false, bool noExpiryTime = false) { if (!(typeof(T) == typeof(SharedAccessTablePolicy) || diff --git a/src/Storage/Storage/Common/AzureDataLakeGen2Item.cs b/src/Storage/Storage/Common/AzureDataLakeGen2Item.cs index 77b01eff2b94..d5e32267c44c 100644 --- a/src/Storage/Storage/Common/AzureDataLakeGen2Item.cs +++ b/src/Storage/Storage/Common/AzureDataLakeGen2Item.cs @@ -111,7 +111,7 @@ public class AzureDataLakeGen2Item : AzureStorageBase /// /// Azure DataLakeGen2 Item constructor /// - /// CloudBlockBlob blob object + /// CloudBlockBlob blob object public AzureDataLakeGen2Item(DataLakeFileClient fileClient) { Name = fileClient.Name; @@ -146,7 +146,7 @@ public AzureDataLakeGen2Item(DataLakeFileClient fileClient) /// /// Azure DataLakeGen2 Item constructor /// - /// Cloud blob Directory object + /// Cloud blob Directory object public AzureDataLakeGen2Item(DataLakeDirectoryClient directoryClient) { Name = directoryClient.Name; @@ -191,6 +191,8 @@ public AzureDataLakeGen2Item(DataLakeDirectoryClient directoryClient) /// Azure DataLakeGen2 Item constructor /// /// datalake gen2 listout item + /// + /// public AzureDataLakeGen2Item(PathItem item, DataLakeFileSystemClient fileSystem, bool fetchProperties = false) { this.Name = item.Name; diff --git a/src/Storage/Storage/Common/AzureStorageBlob.cs b/src/Storage/Storage/Common/AzureStorageBlob.cs index a9d55befe043..1b96d7757a78 100644 --- a/src/Storage/Storage/Common/AzureStorageBlob.cs +++ b/src/Storage/Storage/Common/AzureStorageBlob.cs @@ -213,6 +213,8 @@ public long TagCount /// Azure storage blob constructor /// /// ICloud blob object + /// Storage context containing account information used to construct BlobClient. + /// Blob client options which should contain powershell user agent. public AzureStorageBlob(CloudBlob blob, AzureStorageContext storageContext, BlobClientOptions options = null) { Name = blob.Name; @@ -234,7 +236,10 @@ public AzureStorageBlob(CloudBlob blob, AzureStorageContext storageContext, Blob /// /// Azure storage blob constructor /// - /// ICloud blob object + /// + /// Storage context containing account information used to construct BlobClient. + /// Blob client options which should contain powershell user agent. + /// public AzureStorageBlob(BlobBaseClient track2BlobClient, AzureStorageContext storageContext, BlobClientOptions options = null, BlobItem listBlobItem = null) { if (listBlobItem == null) @@ -288,6 +293,10 @@ public AzureStorageBlob(BlobBaseClient track2BlobClient, AzureStorageContext sto /// Azure storage blob constructor /// /// ICloud blob object + /// Storage context containing account information used to construct BlobClient. + /// Continuation token. + /// Blob client options which should contain powershell user agent. + /// public AzureStorageBlob(TaggedBlobItem blob, AzureStorageContext storageContext, string continuationToken = null, BlobClientOptions options = null, bool getProperties = false) { // Get Track2 blob client @@ -387,6 +396,8 @@ private void SetProperties(BlobBaseClient track2BlobClient, AzureStorageContext /// Will return null if it's a Blob version, since Track1 not support blob version /// /// + /// + /// Azure storage blob type public static CloudBlob GetTrack1Blob(BlobBaseClient track2BlobClient, StorageCredentials credentials, global::Azure.Storage.Blobs.Models.BlobType? blobType = null) { if ((Util.GetVersionIdFromBlobUri(track2BlobClient.Uri) != null) diff --git a/src/Storage/Storage/Common/AzureStorageContainer.cs b/src/Storage/Storage/Common/AzureStorageContainer.cs index 3702ce4bd403..72b342680e37 100644 --- a/src/Storage/Storage/Common/AzureStorageContainer.cs +++ b/src/Storage/Storage/Common/AzureStorageContainer.cs @@ -281,6 +281,7 @@ public static BlobContainerClient GetTrack2BlobContainerClient(CloudBlobContaine /// Get Track1 Blob Container Object /// /// + /// public static CloudBlobContainer GetTrack1BlobContainer(BlobContainerClient track2BlobContainerClient, StorageCredentials credentials) { if (credentials.IsSAS) // the Uri already contains credentail. diff --git a/src/Storage/Storage/Common/AzureStorageContext.cs b/src/Storage/Storage/Common/AzureStorageContext.cs index 08021a22a88f..eb82f49b159c 100644 --- a/src/Storage/Storage/Common/AzureStorageContext.cs +++ b/src/Storage/Storage/Common/AzureStorageContext.cs @@ -142,6 +142,9 @@ public string ConnectionString { /// Create a storage context usign cloud storage account /// /// cloud storage account + /// Storage account name + /// + /// public AzureStorageContext(CloudStorageAccount account, string accountName = null, IAzureContext DefaultContext = null, DebugLogWriter logWriter = null) { StorageAccount = account; diff --git a/src/Storage/Storage/Common/AzureStorageFile.cs b/src/Storage/Storage/Common/AzureStorageFile.cs index d5beeec07a94..4defca4e6522 100644 --- a/src/Storage/Storage/Common/AzureStorageFile.cs +++ b/src/Storage/Storage/Common/AzureStorageFile.cs @@ -93,6 +93,8 @@ public ShareFileClient ShareFileClient /// Azure storage file constructor from track1 file object /// /// Cloud file object + /// + /// public AzureStorageFile(CloudFile file, AzureStorageContext storageContext, ShareClientOptions clientOptions = null) { Name = file.Name; @@ -106,7 +108,10 @@ public AzureStorageFile(CloudFile file, AzureStorageContext storageContext, Shar /// /// Azure storage file constructor from Track2 list file item /// - /// Cloud file object + /// + /// + /// + /// public AzureStorageFile(ShareFileClient shareFileClient, AzureStorageContext storageContext, ShareFileItem shareFileItem, ShareClientOptions clientOptions = null) { Name = shareFileClient.Name; @@ -131,7 +136,10 @@ public AzureStorageFile(ShareFileClient shareFileClient, AzureStorageContext sto /// /// Azure storage file constructor from Track2 get file properties output /// - /// Cloud file object + /// + /// + /// + /// public AzureStorageFile(ShareFileClient shareFileClient, AzureStorageContext storageContext, ShareFileProperties shareFileProperties = null, ShareClientOptions clientOptions = null) { Name = shareFileClient.Name; diff --git a/src/Storage/Storage/Common/AzureStorageFileDirectory.cs b/src/Storage/Storage/Common/AzureStorageFileDirectory.cs index 301f4cb85c30..ac8d0d1406fa 100644 --- a/src/Storage/Storage/Common/AzureStorageFileDirectory.cs +++ b/src/Storage/Storage/Common/AzureStorageFileDirectory.cs @@ -85,7 +85,9 @@ public ShareDirectoryClient ShareDirectoryClient /// /// Azure storage file constructor /// - /// Cloud file Directory object + /// Cloud file Directory object + /// + /// public AzureStorageFileDirectory(CloudFileDirectory dir, AzureStorageContext storageContext, ShareClientOptions clientOptions = null) { Name = dir.Name; @@ -98,7 +100,10 @@ public AzureStorageFileDirectory(CloudFileDirectory dir, AzureStorageContext sto /// /// Azure storage file constructor from Track2 list file item /// - /// Cloud file object + /// + /// + /// + /// public AzureStorageFileDirectory(ShareDirectoryClient shareDirectoryClient, AzureStorageContext storageContext, ShareFileItem shareFileItem, ShareClientOptions clientOptions = null) { Name = shareDirectoryClient.Name; @@ -119,7 +124,10 @@ public AzureStorageFileDirectory(ShareDirectoryClient shareDirectoryClient, Azur /// /// Azure storage file constructor from Track2 get file properties output /// - /// Cloud file object + /// + /// + /// + /// public AzureStorageFileDirectory(ShareDirectoryClient shareDirectoryClient, AzureStorageContext storageContext, ShareDirectoryProperties shareDirectoryProperties = null, ShareClientOptions clientOptions = null) { Name = shareDirectoryClient.Name; diff --git a/src/Storage/Storage/Common/AzureStorageFileShare.cs b/src/Storage/Storage/Common/AzureStorageFileShare.cs index 83da085997b6..f64e1cedaa99 100644 --- a/src/Storage/Storage/Common/AzureStorageFileShare.cs +++ b/src/Storage/Storage/Common/AzureStorageFileShare.cs @@ -91,7 +91,8 @@ public ShareClient ShareClient /// /// Azure storage file constructor /// - /// Cloud file share object + /// Cloud file share object + /// Storage context containing account information used to construct ShareClient. public AzureStorageFileShare(CloudFileShare share, AzureStorageContext storageContext) { Name = share.Name; diff --git a/src/Storage/Storage/Common/Cmdlet/AzureContextAdapterExtensions.cs b/src/Storage/Storage/Common/Cmdlet/AzureContextAdapterExtensions.cs index 8253ce7d9053..4cbe80ce7d32 100644 --- a/src/Storage/Storage/Common/Cmdlet/AzureContextAdapterExtensions.cs +++ b/src/Storage/Storage/Common/Cmdlet/AzureContextAdapterExtensions.cs @@ -29,6 +29,7 @@ public static class AzureContextAdapterExtensions /// Get the current storage account. /// /// The current Azure context. + /// The storage service provider to retrieve storage service details /// The current storage account, or null, if no current storage account is set. public static CloudStorageAccount GetCurrentStorageAccount(this IAzureContext context, IStorageServiceProvider provider) { @@ -91,7 +92,8 @@ public static IStorageContext GetStorageContext(this IStorageService service) /// Get a CloudStorageAccount client for the given storage service using the given storage service provider /// /// The storage service provider to retrieve storage service details - /// The storage accoutn name + /// The storage account name + /// The resource group name /// A CloudStorageAccount client for storage data plane tasks public static CloudStorageAccount GetCloudStorageAccount(this IStorageServiceProvider provider, string accountName, string resourceGroupName = null) { diff --git a/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageDeleteRetentionPolicy.cs b/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageDeleteRetentionPolicy.cs index f2236f0038a7..79a0995576cc 100644 --- a/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageDeleteRetentionPolicy.cs +++ b/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageDeleteRetentionPolicy.cs @@ -44,7 +44,7 @@ public DisableAzureStorageServiceDeleteRetentionPolicyCommand() /// /// Update the specified DeleteRetentionPolicyProperties according to the input /// - /// Delete Retention Policy Properties + /// Service properties internal void DisableDeleteRetentionProperties(ServiceProperties serviceProperties) { if (serviceProperties.DeleteRetentionPolicy == null) diff --git a/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageStaticWebsite.cs b/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageStaticWebsite.cs index 72d18b7b8f96..e4a530d9c697 100644 --- a/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageStaticWebsite.cs +++ b/src/Storage/Storage/Common/Cmdlet/DisableAzureStorageStaticWebsite.cs @@ -44,7 +44,7 @@ public DisableAzureStorageServiceStaticWebsiteCommand() /// /// Update the specified StaticWebsite Properties according to the input /// - /// StaticWebsite Properties + /// Service properties internal void DisableStaticWebsiteProperties(ServiceProperties serviceProperties) { if (serviceProperties.StaticWebsite == null) diff --git a/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageDeleteRetentionPolicy.cs b/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageDeleteRetentionPolicy.cs index a0ca19963ca2..a9b59cc2880a 100644 --- a/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageDeleteRetentionPolicy.cs +++ b/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageDeleteRetentionPolicy.cs @@ -48,7 +48,7 @@ public EnableAzureStorageServiceDeleteRetentionPolicyCommand() /// /// Update the specified DeleteRetentionPolicyProperties according to the input /// - /// Delete Retention Policy Properties + /// Service properties internal void EnableDeleteRetentionProperties(ServiceProperties serviceProperties) { if (serviceProperties.DeleteRetentionPolicy == null) diff --git a/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageStaticWebsite.cs b/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageStaticWebsite.cs index c00c9d46e855..96cca037c876 100644 --- a/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageStaticWebsite.cs +++ b/src/Storage/Storage/Common/Cmdlet/EnableAzureStorageStaticWebsite.cs @@ -52,7 +52,7 @@ public EnableAzureStorageServiceStaticWebsiteCommand() /// /// Update the specified StaticWebsite Properties according to the input /// - /// StaticWebsite Properties + /// Service properties internal void EnableStaticWebsiteProperties(ServiceProperties serviceProperties) { if (serviceProperties.StaticWebsite == null) diff --git a/src/Storage/Storage/Common/Cmdlet/NewAzureStorageAccountSasToken.cs b/src/Storage/Storage/Common/Cmdlet/NewAzureStorageAccountSasToken.cs index e61cf9294f58..d71ae1679b54 100644 --- a/src/Storage/Storage/Common/Cmdlet/NewAzureStorageAccountSasToken.cs +++ b/src/Storage/Storage/Common/Cmdlet/NewAzureStorageAccountSasToken.cs @@ -126,7 +126,6 @@ public override void ExecuteCmdlet() /// /// Set up access policy permission /// - /// SharedAccessBlobPolicy object /// Permisson internal SharedAccessAccountPermissions SetupAccessPolicyPermission(string permission) { diff --git a/src/Storage/Storage/Common/Cmdlet/NewAzureStorageContext.cs b/src/Storage/Storage/Common/Cmdlet/NewAzureStorageContext.cs index 32cc5d5a2112..75133eeae201 100644 --- a/src/Storage/Storage/Common/Cmdlet/NewAzureStorageContext.cs +++ b/src/Storage/Storage/Common/Cmdlet/NewAzureStorageContext.cs @@ -463,7 +463,7 @@ internal CloudStorageAccount GetStorageAccountByOAuth( /// /// Storage account name, it's used for build end point /// - /// + /// /// A storage account internal CloudStorageAccount GetStorageAccountByOAuthFromAzureEnvironment(string storageAccountName, bool useHttps, string azureEnvironmentName = "") { diff --git a/src/Storage/Storage/Common/Cmdlet/SetAzureStorageServiceMetrics.cs b/src/Storage/Storage/Common/Cmdlet/SetAzureStorageServiceMetrics.cs index cc0e74888f20..387bd3cc56ff 100644 --- a/src/Storage/Storage/Common/Cmdlet/SetAzureStorageServiceMetrics.cs +++ b/src/Storage/Storage/Common/Cmdlet/SetAzureStorageServiceMetrics.cs @@ -63,7 +63,7 @@ public SetAzureStorageServiceMetricsCommand() /// /// Update the specified service properties according to the input /// - /// Service properties + /// internal void UpdateServiceProperties(MetricsProperties metrics) { if (Version != null) @@ -155,7 +155,7 @@ internal void UpdateServiceProperties(TableMetrics metrics) /// /// Update the specified service properties according to the input in old XSCL /// - /// Service properties + /// internal void UpdateServiceProperties(XTable.MetricsProperties metrics) { if (Version != null) diff --git a/src/Storage/Storage/Common/NameUtil.cs b/src/Storage/Storage/Common/NameUtil.cs index 5765c547f03b..894bee67d291 100644 --- a/src/Storage/Storage/Common/NameUtil.cs +++ b/src/Storage/Storage/Common/NameUtil.cs @@ -67,7 +67,7 @@ public static void ValidateContainerName(string name) } /// - /// Is valid container name + /// Is valid container name /// /// Container name /// True for valid container name, otherwise return false @@ -116,7 +116,7 @@ public static bool IsValidContainerPrefix(string containerPrefix) } /// - /// Is valid blob name + /// Is valid blob name /// /// Blob name /// True for valid blob name, otherwise return false @@ -136,9 +136,9 @@ public static bool IsValidBlobName(string blobName) } /// - /// Is valid blob prefix + /// Is valid blob prefix /// - /// Blob name + /// Blob name /// True for valid blob name, otherwise return false public static bool IsValidBlobPrefix(string blobPrefix) { @@ -147,7 +147,7 @@ public static bool IsValidBlobPrefix(string blobPrefix) /// - /// Is valid table name + /// Is valid table name /// /// Table name /// True for valid table name, otherwise return false @@ -183,7 +183,7 @@ public static bool IsValidTablePrefix(string tablePrefix) /// - /// Is valid queue name + /// Is valid queue name /// /// Queue name /// True for valid queue name, otherwise return false @@ -263,6 +263,7 @@ public static string ResolveBlobName(string blobName) /// convert blob name into valid file name /// /// blob name + /// blob snapshot time /// valid file name public static string ConvertBlobNameToFileName(string blobName, DateTimeOffset? snapshotTime) { diff --git a/src/Storage/Storage/Common/SasTokenHelper.cs b/src/Storage/Storage/Common/SasTokenHelper.cs index eac2e962f7dd..43b4f296ee2a 100644 --- a/src/Storage/Storage/Common/SasTokenHelper.cs +++ b/src/Storage/Storage/Common/SasTokenHelper.cs @@ -36,6 +36,8 @@ internal class SasTokenHelper /// /// Validate the container access policy /// + /// IStorageBlobManagement channel object + /// Container name /// SharedAccessBlobPolicy object /// The policy identifier which need to be checked. public static bool ValidateContainerAccessPolicy(IStorageBlobManagement channel, string containerName, @@ -67,8 +69,12 @@ public static bool ValidateContainerAccessPolicy(IStorageBlobManagement channel, /// /// Validate the file share access policy /// - /// SharedAccessFilePolicy object + /// IStorageFileManagement channel object + /// A string containing the name of the share. /// The policy identifier which need to be checked. + /// + /// + /// public static bool ValidateShareAccessPolicy(IStorageFileManagement channel, string shareName, string policyIdentifier, bool shouldNoPermission, bool shouldNoStartTime, bool shouldNoExpiryTime) { @@ -109,6 +115,8 @@ public static bool ValidateShareAccessPolicy(IStorageFileManagement channel, str /// /// Validate the queue access policy /// + /// IStorageQueueManagement channel object + /// Queue name /// SharedAccessBlobPolicy object /// The policy identifier which need to be checked. public static bool ValidateQueueAccessPolicy(IStorageQueueManagement channel, string queueName, @@ -139,6 +147,8 @@ public static bool ValidateQueueAccessPolicy(IStorageQueueManagement channel, st /// /// Validate the table access policy /// + /// IStorageTableManagement channel object + /// Table name /// SharedAccessBlobPolicy object /// The policy identifier which need to be checked. internal static bool ValidateTableAccessPolicy(IStorageTableManagement channel, diff --git a/src/Storage/Storage/Common/StorageCloudCmdletBase.cs b/src/Storage/Storage/Common/StorageCloudCmdletBase.cs index 1dad80d3515a..06a8963f313f 100644 --- a/src/Storage/Storage/Common/StorageCloudCmdletBase.cs +++ b/src/Storage/Storage/Common/StorageCloudCmdletBase.cs @@ -246,7 +246,6 @@ public IRequestOptions GetRequestOptions(StorageServiceType type) /// /// Get a request options /// - /// Service type /// Request options public XTable.TableRequestOptions GetTableRequestOptions() { diff --git a/src/Storage/Storage/Common/StorageExtensions.cs b/src/Storage/Storage/Common/StorageExtensions.cs index bae99817b789..e685c379b1b7 100644 --- a/src/Storage/Storage/Common/StorageExtensions.cs +++ b/src/Storage/Storage/Common/StorageExtensions.cs @@ -26,7 +26,7 @@ internal static class StorageExtensions { private const int CopySASLifeTimeInMinutes = 7 * 24 * 60; - // The Oauth delegate SAS expire time must be in 7 days. + // The Oauth delegate SAS expire time must be in 7 days. // As client and server has time difference, to make it more stable, the time will be 2 hour less than 7 days. private const int CopySASLifeTimeInMinutesOauth = 7 * 24 * 60 - 2 * 60; @@ -164,6 +164,7 @@ internal static Uri GenerateUriWithCredentials( /// Append an auto generated SAS to a blob uri. /// /// Blob to append SAS. + /// The storage context for the storage account /// Blob Uri with SAS appended. internal static Uri GenerateUriWithCredentials( this BlobBaseClient blob, AzureStorageContext context) diff --git a/src/Storage/Storage/Common/StorageNouns.cs b/src/Storage/Storage/Common/StorageNouns.cs index b232c36d1644..2399929502b9 100644 --- a/src/Storage/Storage/Common/StorageNouns.cs +++ b/src/Storage/Storage/Common/StorageNouns.cs @@ -114,6 +114,7 @@ public static class StorageNouns /// public const string ServiceDeleteRetentionPolicy = "AzureStorageDeleteRetentionPolicy"; + /// /// Azure storage Service Delete Retention Policy /// public const string ServiceStaticWebsite = "AzureStorageStaticWebsite"; diff --git a/src/Storage/Storage/Common/TransferManagerFactory.cs b/src/Storage/Storage/Common/TransferManagerFactory.cs index 53e40654a7e2..5874f8319fe5 100644 --- a/src/Storage/Storage/Common/TransferManagerFactory.cs +++ b/src/Storage/Storage/Common/TransferManagerFactory.cs @@ -44,9 +44,7 @@ public static ITransferManager CreateTransferManager(int concurrency) /// /// Sets the cached runner. This is mainly for testing purpose. /// - /// - /// Indicating the instance of the cached runner. - /// + /// internal static void SetCachedTransferManager(ITransferManager transferManager) { cachedTransferManager = transferManager; diff --git a/src/Storage/Storage/DatalakeGen2/Cmdlet/GetAzDataLakeGen2FileContent.cs b/src/Storage/Storage/DatalakeGen2/Cmdlet/GetAzDataLakeGen2FileContent.cs index c1b66d039eab..111a6466ea6b 100644 --- a/src/Storage/Storage/DatalakeGen2/Cmdlet/GetAzDataLakeGen2FileContent.cs +++ b/src/Storage/Storage/DatalakeGen2/Cmdlet/GetAzDataLakeGen2FileContent.cs @@ -104,6 +104,8 @@ public GetAzDataLakeGen2ItemContentCommand(IStorageBlobManagement channel) /// /// Download blob to local file /// + /// Task id + /// IStorageBlobManagement channel object /// Source blob object /// Destination file path internal virtual async Task DownloadBlob(long taskId, IStorageBlobManagement localChannel, CloudBlob blob, string filePath) diff --git a/src/Storage/Storage/DatalakeGen2/Cmdlet/NewAzDataLakeGen2Item.cs b/src/Storage/Storage/DatalakeGen2/Cmdlet/NewAzDataLakeGen2Item.cs index c6214b277d8c..9687b19353f8 100644 --- a/src/Storage/Storage/DatalakeGen2/Cmdlet/NewAzDataLakeGen2Item.cs +++ b/src/Storage/Storage/DatalakeGen2/Cmdlet/NewAzDataLakeGen2Item.cs @@ -293,6 +293,7 @@ internal void SetBlobContent(CloudBlockBlob blob, string fileName, bool isValidB /// upload file to azure blob /// /// Task id + /// IStorageBlobManagement channel object /// local file path /// destination azure blob object internal virtual async Task Upload2Blob(long taskId, IStorageBlobManagement localChannel, string filePath, CloudBlob blob) diff --git a/src/Storage/Storage/File/AzureStorageFileCmdletBase.cs b/src/Storage/Storage/File/AzureStorageFileCmdletBase.cs index 913036166ffa..6008faeb01a9 100644 --- a/src/Storage/Storage/File/AzureStorageFileCmdletBase.cs +++ b/src/Storage/Storage/File/AzureStorageFileCmdletBase.cs @@ -89,8 +89,9 @@ protected bool ShareIsEmpty(CloudFileShare share) /// /// Write CloudFile to output using specified service channel /// - /// The output CloudFile object + /// Task id /// IStorageFileManagement channel object + /// The output CloudFile object internal void WriteCloudFileObject(long taskId, IStorageFileManagement channel, CloudFile file) { AzureStorageFile azureFile = new AzureStorageFile(file, channel.StorageContext); @@ -101,8 +102,9 @@ internal void WriteCloudFileObject(long taskId, IStorageFileManagement channel, /// /// Write CloudFileDirectory to output using specified service channel /// - /// The output CloudFileDirectory object + /// Task id /// IStorageFileManagement channel object + /// The output CloudFileDirectory object internal void WriteCloudFileDirectoryeObject(long taskId, IStorageFileManagement channel, CloudFileDirectory fileDir) { AzureStorageFileDirectory azureFileDir = new AzureStorageFileDirectory(fileDir, channel.StorageContext); @@ -112,8 +114,9 @@ internal void WriteCloudFileDirectoryeObject(long taskId, IStorageFileManagement /// /// Write CloudFileShare to output using specified service channel /// - /// The output CloudFileShare object + /// Task id /// IStorageFileManagement channel object + /// The output CloudFileShare object internal void WriteCloudShareObject(long taskId, IStorageFileManagement channel, CloudFileShare share) { AzureStorageFileShare azureshare = new AzureStorageFileShare(share, channel.StorageContext); @@ -123,8 +126,9 @@ internal void WriteCloudShareObject(long taskId, IStorageFileManagement channel, /// /// Write IListFileItem to output using specified service channel /// - /// The output IListFileItem object + /// Task id /// IStorageFileManagement channel object + /// The output IListFileItem object internal void WriteListFileItemObject(long taskId, IStorageFileManagement channel, IListFileItem item) { if ((item as CloudFile) != null) // CloudFile diff --git a/src/Storage/Storage/File/Cmdlet/StopAzureStorageFileCopy.cs b/src/Storage/Storage/File/Cmdlet/StopAzureStorageFileCopy.cs index b58cf7ce7e1c..84e35638ffbb 100644 --- a/src/Storage/Storage/File/Cmdlet/StopAzureStorageFileCopy.cs +++ b/src/Storage/Storage/File/Cmdlet/StopAzureStorageFileCopy.cs @@ -81,7 +81,9 @@ public override void ExecuteCmdlet() /// /// Stop copy operation by CloudBlob object /// - /// CloudBlob object + /// Task id + /// IStorageFileManagement channel object + /// CloudFile object /// Copy id private async Task StopCopyFile(long taskId, IStorageFileManagement localChannel, CloudFile file, string copyId) { diff --git a/src/Storage/Storage/Model/Contract/IStorageBlobManagement.cs b/src/Storage/Storage/Model/Contract/IStorageBlobManagement.cs index 0c0aeb9518ad..44facc381827 100644 --- a/src/Storage/Storage/Model/Contract/IStorageBlobManagement.cs +++ b/src/Storage/Storage/Model/Contract/IStorageBlobManagement.cs @@ -35,8 +35,8 @@ public interface IStorageBlobManagement : IStorageManagement /// /// Container prefix /// Container listing details - /// Blob request option - /// Operation context + /// Blob request options + /// Operation context /// An enumerable collection of cloudblobcontainer IEnumerable ListContainers(string prefix, ContainerListingDetails detailsIncluded, BlobRequestOptions options, OperationContext OperationContext); @@ -45,7 +45,9 @@ public interface IStorageBlobManagement : IStorageManagement /// /// Container prefix /// Container listing details - /// Blob request option + /// Max results. + /// Continuation token. + /// Blob request options /// Operation context /// An enumerable collection of cloudblobcontainer ContainerResultSegment ListContainersSegmented(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext); @@ -55,7 +57,7 @@ public interface IStorageBlobManagement : IStorageManagement /// /// A cloudblobcontainer object /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// The container's permission BlobContainerPermissions GetContainerPermissions(CloudBlobContainer container, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null); @@ -66,7 +68,7 @@ public interface IStorageBlobManagement : IStorageManagement /// A cloudblobcontainer object /// The container's permission /// Access condition - /// Blob request option + /// Blob request options /// Operation context void SetContainerPermissions(CloudBlobContainer container, BlobContainerPermissions permissions, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null); @@ -81,13 +83,14 @@ public interface IStorageBlobManagement : IStorageManagement /// Get an BlobContainerClient instance in local /// /// Container name + /// Blob request options /// A BlobContainerClient in local memory BlobContainerClient GetBlobContainerClient(string name, BlobClientOptions options = null); /// /// Get an BlobServiceClient instance in local /// - /// Container name + /// Blob request options /// A BlobServiceClient in local memory BlobServiceClient GetBlobServiceClient(BlobClientOptions options = null); @@ -99,6 +102,7 @@ public interface IStorageBlobManagement : IStorageManagement /// Access condition /// Blob request options /// Operation context + /// Snapshot time to append. /// Return an CloudBlob if the specific blob exists on azure, otherwise return null CloudBlob GetBlobReferenceFromServer(CloudBlobContainer container, string blobName, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, DateTimeOffset? SnapshotTime = null); @@ -106,8 +110,8 @@ public interface IStorageBlobManagement : IStorageManagement /// Whether the container is exists or not /// /// A cloudblobcontainer object - /// Blob request option - /// Operation context + /// Blob request options + /// Operation context /// True if the specific container exists, otherwise return false bool DoesContainerExist(CloudBlobContainer container, BlobRequestOptions options, OperationContext OperationContext); @@ -115,8 +119,8 @@ public interface IStorageBlobManagement : IStorageManagement /// Whether the blob is exists or not /// /// A CloudBlob object - /// Blob request option - /// Operation context + /// Blob request options + /// Operation context /// True if the specific blob exists, otherwise return false bool DoesBlobExist(CloudBlob blob, BlobRequestOptions options, OperationContext OperationContext); @@ -124,8 +128,8 @@ public interface IStorageBlobManagement : IStorageManagement /// Create the container if not exists /// /// A cloudblobcontainer object - /// Blob request option - /// Operation context + /// Blob request options + /// Operation context /// True if the container did not already exist and was created; otherwise false. bool CreateContainerIfNotExists(CloudBlobContainer container, BlobRequestOptions requestOptions, OperationContext OperationContext); @@ -134,8 +138,8 @@ public interface IStorageBlobManagement : IStorageManagement /// /// A cloudblobcontainer object /// Access condition - /// Blob request option - /// Operation context + /// Blob request options + /// Operation context void DeleteContainer(CloudBlobContainer container, AccessCondition accessCondition, BlobRequestOptions options, OperationContext OperationContext); /// @@ -145,7 +149,7 @@ public interface IStorageBlobManagement : IStorageManagement /// Blob prefix /// Use flat blob listing(whether treat "container/" as directory) /// Blob listing details - /// Blob request option + /// Blob request options /// Operation context /// An enumerable collection of CloudBlob IEnumerable ListBlobs(CloudBlobContainer container, string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, BlobRequestOptions options, OperationContext operationContext); @@ -153,9 +157,10 @@ public interface IStorageBlobManagement : IStorageManagement /// /// Delete azure blob /// - /// Cloudblob object + /// CloudBlob object /// Delete snapshots option /// Access condition + /// Blob request options /// Operation context /// An enumerable collection of CloudBlob void DeleteCloudBlob(CloudBlob blob, DeleteSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext); @@ -172,6 +177,7 @@ public interface IStorageBlobManagement : IStorageManagement /// /// Fetch blob attributes /// + /// CloudBlob object /// Access condition /// Blob request options /// An object that represents the context for the current operation. @@ -208,7 +214,6 @@ public interface IStorageBlobManagement : IStorageManagement /// /// Get the service properties /// - /// Cloud storage account /// Service type /// Request options /// Operation context @@ -236,7 +241,7 @@ public interface IStorageBlobManagement : IStorageManagement /// /// A cloudblobcontainer object /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// User cancellation token /// A task object which retrieve the permission of the specified container @@ -247,7 +252,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Return a task that asynchronously check whether the specified container exists. /// /// CloudBlobContainer object - /// Blob request option + /// Blob request options /// Operation context /// Cancellation token /// A task object that asynchronously check whether the specified container exists @@ -268,6 +273,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// /// CloudBlobContainer object /// Blob name + /// Snapshot time to append. /// Access condition /// Blob request options /// Operation context @@ -302,7 +308,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// /// CloudBlobContainer object /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// Cancellation token /// Return a task that asynchronously delete the specified container. @@ -312,9 +318,9 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Return a task that asynchronously abort the blob copy operation /// /// CloudBlob object - /// Copy id + /// Copy id /// Access condition - /// Blob request options + /// Blob request options /// Operation context /// Cancellation token /// Return a task that asynchronously abort the blob copy operation @@ -329,7 +335,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. Task StartCopyAsync(CloudBlob blob, Uri source, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken); @@ -343,7 +349,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. Task StartCopyAsync(CloudPageBlob blob, Uri source, PremiumPageBlobTier premiumPageBlobTier, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken); @@ -352,12 +358,13 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// /// CloudBlockBlob object /// Uri to copying source - /// The StandardBlobTier of Destination blob /// Access condition to source if it's file/blob in azure. + /// + /// Access condition to source if it's file/blob in azure. /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. Task StartCopyAsync(CloudBlob blob, Uri source, StandardBlobTier? standardBlobTier, RehydratePriority? rehydratePriority, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken); @@ -369,7 +376,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. Task StartIncrementalCopyAsync(CloudPageBlob blob, CloudPageBlob source, AccessCondition destAccessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken); @@ -379,7 +386,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// CloudBlobContainer object /// Container permission /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// cancellation token /// Return a task that asynchronously set the container permission @@ -391,7 +398,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// CloudBlob object /// Snapshot delete option /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// Cancellation token /// Return a task that asynchronously delete the specified blob @@ -404,6 +411,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Access condition /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token Task SetBlobPropertiesAsync(CloudBlob blob, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cmdletCancellationToken); /// @@ -413,6 +421,7 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Access condition /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token Task SetBlobMetadataAsync(CloudBlob blob, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cmdletCancellationToken); ///// @@ -432,16 +441,19 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// page blob Tier /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token Task SetPageBlobTierAsync(CloudPageBlob blob, PremiumPageBlobTier tier, BlobRequestOptions options, OperationContext operationContext, CancellationToken cmdletCancellationToken); /// /// Return a task that asynchronously set block blob Tier /// /// CloudBlockBlob object - /// block blob Tier /// Access condition + /// block blob Tier + /// /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token Task SetStandardBlobTierAsync(CloudBlockBlob blob, AccessCondition accessCondition, StandardBlobTier tier, RehydratePriority? rehydratePriority, BlobRequestOptions options, OperationContext operationContext, CancellationToken cmdletCancellationToken); /// @@ -451,13 +463,17 @@ Task GetContainerPermissionsAsync(CloudBlobContainer c /// Blob prefix /// Use flat blob listing(whether treat "container/" as directory) /// Blob listing details - /// Blob request option + /// Max results. + /// Current token. + /// Blob request options /// Operation context + /// Cancellation token Task ListBlobsSegmentedAsync(CloudBlobContainer container, string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken); /// /// List part of blobs. /// + /// A cloudblobcontainer object /// Blob prefix /// Use flat blob listing /// Blob listing details. @@ -482,7 +498,7 @@ BlobResultSegment ListBlobsSegmented(CloudBlobContainer container, string prefix /// The key valid start time /// The key valid end time /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// The UserDelegationKey UserDelegationKey GetUserDelegationKey(DateTimeOffset? keyStart, DateTimeOffset? keyEnd, AccessCondition accessCondition = null, BlobRequestOptions options = null, OperationContext operationContext = null); diff --git a/src/Storage/Storage/Model/Contract/IStorageFileManagement.cs b/src/Storage/Storage/Model/Contract/IStorageFileManagement.cs index 9545da40b75f..d82f2f270d68 100644 --- a/src/Storage/Storage/Model/Contract/IStorageFileManagement.cs +++ b/src/Storage/Storage/Model/Contract/IStorageFileManagement.cs @@ -30,15 +30,16 @@ public interface IStorageFileManagement : IStorageManagement /// object with the specified name. /// /// A string containing the name of the share. + /// Snapshot time to append. /// A reference to a share. CloudFileShare GetShareReference(string shareName, DateTimeOffset? snapshotTime = null); /// /// Get share permissions. /// - /// A CloudFileShare instance. + /// A CloudFileShare instance. /// Access condition - /// File request option + /// File request options /// Operation context /// The share's permission FileSharePermissions GetSharePermissions(CloudFileShare share, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null); @@ -46,10 +47,10 @@ public interface IStorageFileManagement : IStorageManagement /// /// Set share permissions. /// - /// A CloudFileShare object. + /// A CloudFileShare object. /// The share's permission. /// Access condition - /// File request option + /// File request options /// Operation context void SetSharePermissions(CloudFileShare share, FileSharePermissions permissions, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null); @@ -138,7 +139,7 @@ public interface IStorageFileManagement : IStorageManagement /// Enumerates the shares for a given prefix. /// /// Indicating the prefix. - /// + /// /// A value that indicates whether to return share metadata with the listing. /// /// Indicating the action for enumerated items. @@ -310,6 +311,7 @@ public interface IStorageFileManagement : IStorageManagement /// /// Indicating the reference of the share to be deleted. /// + /// /// /// A Microsoft.WindowsAzure.Storage.AccessCondition object that represents /// the access conditions for the share. If null, no condition is used. @@ -361,9 +363,9 @@ public interface IStorageFileManagement : IStorageManagement /// /// Async get share permissions. /// - /// A CloudFileShare instance. + /// A CloudFileShare instance. /// Access condition - /// File request option + /// File request options /// Operation context /// User cancellation token /// A task object which retrieve the permission of the specified container @@ -400,7 +402,7 @@ Task GetSharePermissionsAsync(CloudFileShare share, Access /// Return a task that asynchronously abort the file copy operation /// /// CloudFile object - /// Copy id + /// Copy id /// Access condition /// File request options /// Operation context diff --git a/src/Storage/Storage/Model/Contract/IStorageQueueManagement.cs b/src/Storage/Storage/Model/Contract/IStorageQueueManagement.cs index e23f9039f217..0015517169ee 100644 --- a/src/Storage/Storage/Model/Contract/IStorageQueueManagement.cs +++ b/src/Storage/Storage/Model/Contract/IStorageQueueManagement.cs @@ -81,6 +81,7 @@ IEnumerable ListQueues(string prefix, QueueListingDetails queueListi /// /// Get queue permission /// + /// Cloud queue object /// Queue request options /// Operation context /// QueuePermissions object diff --git a/src/Storage/Storage/Model/Contract/IStorageTableManagement.cs b/src/Storage/Storage/Model/Contract/IStorageTableManagement.cs index 366f4d2eb53f..cd4dbb4aa009 100644 --- a/src/Storage/Storage/Model/Contract/IStorageTableManagement.cs +++ b/src/Storage/Storage/Model/Contract/IStorageTableManagement.cs @@ -145,7 +145,6 @@ public interface IStorageTableManagement : IStorageManagement /// /// Get the Table service properties /// - /// Cloud storage account /// Request options /// Operation context /// The service properties of the specified service type @@ -154,7 +153,6 @@ public interface IStorageTableManagement : IStorageManagement /// /// Set Table service properties /// - /// Cloud storage account /// Service properties /// Request options /// Operation context @@ -182,7 +180,7 @@ public interface IStorageTableManagement : IStorageManagement /// /// Returns only entities that satisfy the specified OData filter. For example, "PartitionKey eq 'foo'". /// The maximum number of entities that will be returned per page. - /// An IEnumerable of entity property names that selects which set of entity properties to return in the result set. + /// An IEnumerable<T> of entity property names that selects which set of entity properties to return in the result set. /// A CancellationToken controlling the request lifetime. /// IEnumerable QueryTableEntities(string tableName, string filter, int maxPerPage, IEnumerable selects, CancellationToken cancellationToken) diff --git a/src/Storage/Storage/Model/Contract/StorageBlobManagement.cs b/src/Storage/Storage/Model/Contract/StorageBlobManagement.cs index d8970709860b..497b4adbaf99 100644 --- a/src/Storage/Storage/Model/Contract/StorageBlobManagement.cs +++ b/src/Storage/Storage/Model/Contract/StorageBlobManagement.cs @@ -81,20 +81,20 @@ public AzureStorageContext StorageContext /// /// Init blob management /// - /// a cloud blob object + /// a cloud blob object public StorageBlobManagement(AzureStorageContext context) { internalStorageContext = context; } /// - /// Get a list of cloudblobcontainer in azure + /// Get a list of CloudBlobContainer in azure /// /// Container prefix /// Container listing details - /// Blob request option + /// Blob request options /// Operation context - /// An enumerable collection of cloudblobcontainer + /// An enumerable collection of CloudBlobContainer public IEnumerable ListContainers(string prefix, ContainerListingDetails detailsIncluded, BlobRequestOptions options, XSCL.OperationContext operationContext) { //https://ahmet.im/blog/azure-listblobssegmentedasync-listcontainerssegmentedasync-how-to/ @@ -119,9 +119,9 @@ public IEnumerable ListContainers(string prefix, ContainerLi /// /// Get container presssions /// - /// A cloudblobcontainer object + /// A CloudBlobContainer object /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// The container's permission public BlobContainerPermissions GetContainerPermissions(CloudBlobContainer container, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext) @@ -150,6 +150,7 @@ public CloudBlobContainer GetContainerReference(string name) /// Get an BlobContainerClient instance in local /// /// Container name + /// Blob request options /// A BlobContainerClient in local memory public BlobContainerClient GetBlobContainerClient(string name, BlobClientOptions options = null) { @@ -159,7 +160,7 @@ public BlobContainerClient GetBlobContainerClient(string name, BlobClientOptions /// /// Get an BlobServiceClient instance in local /// - /// Container name + /// Blob request options /// A BlobServiceClient in local memory public BlobServiceClient GetBlobServiceClient(BlobClientOptions options = null) { @@ -171,7 +172,7 @@ public BlobServiceClient GetBlobServiceClient(BlobClientOptions options = null) } else if (this.StorageContext.StorageAccount.Credentials.IsSharedKey) //Shared Key { - blobServiceClient = new BlobServiceClient(this.StorageContext.StorageAccount.BlobEndpoint, + blobServiceClient = new BlobServiceClient(this.StorageContext.StorageAccount.BlobEndpoint, new StorageSharedKeyCredential(this.StorageContext.StorageAccountName, this.StorageContext.StorageAccount.Credentials.ExportBase64EncodedKey()), options); } else //sas, Anonymous @@ -186,8 +187,8 @@ public BlobServiceClient GetBlobServiceClient(BlobClientOptions options = null) /// /// Create the container if not exists /// - /// A cloudblobcontainer object - /// Blob request option + /// A CloudBlobContainer object + /// Blob request options /// Operation context /// True if the container did not already exist and was created; otherwise false. public bool CreateContainerIfNotExists(CloudBlobContainer container, BlobRequestOptions requestOptions, XSCL.OperationContext operationContext) @@ -205,9 +206,9 @@ public bool CreateContainerIfNotExists(CloudBlobContainer container, BlobRequest /// /// Delete container /// - /// A cloudblobcontainer object + /// A CloudBlobContainer object /// Access condition - /// Blob request option + /// Blob request options /// Operation context public void DeleteContainer(CloudBlobContainer container, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext) { @@ -224,10 +225,10 @@ public void DeleteContainer(CloudBlobContainer container, AccessCondition access /// /// Set container permissions /// - /// A cloudblobcontainer object + /// A CloudBlobContainer object /// The container's permission /// Access condition - /// Blob request option + /// Blob request options /// Operation context public void SetContainerPermissions(CloudBlobContainer container, BlobContainerPermissions permissions, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext) { @@ -244,11 +245,12 @@ public void SetContainerPermissions(CloudBlobContainer container, BlobContainerP /// /// Get blob reference with properties and meta data from server /// - /// A cloudblobcontainer object + /// A CloudBlobContainer object /// Blob name /// Access condition /// Blob request options /// Operation context + /// Snapshot time to append. /// Return an CloudBlob if the specific blob exists on azure, otherwise return null public CloudBlob GetBlobReferenceFromServer(CloudBlobContainer container, string blobName, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, DateTimeOffset? SnapshotTime = null) { @@ -273,11 +275,11 @@ public CloudBlob GetBlobReferenceFromServer(CloudBlobContainer container, string /// /// List all blobs in specified containers /// - /// A cloudblobcontainer object + /// A CloudBlobContainer object /// Blob prefix /// Use flat blob listing(whether treat "container/" as directory) /// Blob listing details - /// Blob request option + /// Blob request options /// Operation context /// An enumerable collection of CloudBlob public IEnumerable ListBlobs(CloudBlobContainer container, string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, BlobRequestOptions options, XSCL.OperationContext operationContext) @@ -297,8 +299,8 @@ public IEnumerable ListBlobs(CloudBlobContainer container, string /// /// Whether the container exists or not /// - /// A cloudblobcontainer object - /// Blob request option + /// A CloudBlobContainer object + /// Blob request options /// Operation context /// True if the specific container exists, otherwise return false public bool DoesContainerExist(CloudBlobContainer container, BlobRequestOptions options, XSCL.OperationContext operationContext) @@ -324,7 +326,7 @@ public bool DoesContainerExist(CloudBlobContainer container, BlobRequestOptions /// Whether the blob is exists or not /// /// An CloudBlob object - /// Blob request option + /// Blob request options /// Operation context /// True if the specific blob exists, otherwise return false public bool DoesBlobExist(CloudBlob blob, BlobRequestOptions options, XSCL.OperationContext operationContext) @@ -349,9 +351,10 @@ public bool DoesBlobExist(CloudBlob blob, BlobRequestOptions options, XSCL.Opera /// /// Delete azure blob /// - /// Cloudblob object + /// CloudBlob object /// Delete snapshots option /// Access condition + /// Blob request options /// Operation context /// An enumerable collection of CloudBlob public void DeleteCloudBlob(CloudBlob blob, DeleteSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext) @@ -388,6 +391,7 @@ public void FetchContainerAttributes(CloudBlobContainer container, AccessConditi /// /// Fetch blob attributes /// + /// CloudBlob object /// Access condition /// Blob request options /// An object that represents the context for the current operation. @@ -406,6 +410,7 @@ public void FetchBlobAttributes(CloudBlob blob, AccessCondition accessCondition, /// /// Set blob properties /// + /// CloudBlob object /// Access condition /// Blob request options /// An object that represents the context for the current operation. @@ -483,7 +488,6 @@ public void AbortCopy(CloudBlob blob, string copyId, AccessCondition accessCondi /// /// Get the service properties /// - /// Cloud storage account /// Service type /// Request options /// Operation context @@ -520,7 +524,6 @@ public XSCLProtocol.ServiceProperties GetStorageServiceProperties(StorageService /// /// Set service properties /// - /// Cloud storage account /// Service type /// Service properties /// Request options @@ -573,9 +576,9 @@ public string GetStorageAccountSASToken(XSCL.SharedAccessAccountPolicy sharedAcc /// /// Async Get container presssions /// - /// A cloudblobcontainer object + /// A CloudBlobContainer object /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// User cancellation token /// A task object which retrieve the permission of the specified container @@ -590,9 +593,9 @@ public Task GetContainerPermissionsAsync(CloudBlobCont /// Return a task that asynchronously check whether the specified container exists. /// /// CloudBlobContainer object - /// Blob request option + /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// A task object that asynchronously check whether the specified container exists public Task DoesContainerExistAsync(CloudBlobContainer container, BlobRequestOptions requestOptions, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -604,10 +607,11 @@ public Task DoesContainerExistAsync(CloudBlobContainer container, BlobRequ /// /// CloudBlobContainer object /// Blob name + /// Snapshot time to append. /// Access condition /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// A task object that asynchronously get the blob reference from server public async Task GetBlobReferenceFromServerAsync(CloudBlobContainer container, string blobName, DateTimeOffset? snapshotTime, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -638,7 +642,7 @@ public async Task GetBlobReferenceFromServerAsync(CloudBlobContainer /// Access condition /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return a task that asynchronously fetch blob attributes public Task FetchBlobAttributesAsync(CloudBlob blob, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -652,7 +656,7 @@ public Task FetchBlobAttributesAsync(CloudBlob blob, AccessCondition accessCondi /// Blob container public access type /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return a task that asynchronously create a container if it doesn't exist. public Task CreateContainerIfNotExistsAsync(CloudBlobContainer container, BlobContainerPublicAccessType accessType, BlobRequestOptions requestOptions, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -664,9 +668,9 @@ public Task CreateContainerIfNotExistsAsync(CloudBlobContainer container, /// /// CloudBlobContainer object /// Access condition - /// Blob request option + /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return a task that asynchronously delete the specified container. public Task DeleteContainerAsync(CloudBlobContainer container, AccessCondition accessCondition, BlobRequestOptions requestOptions, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -677,11 +681,11 @@ public Task DeleteContainerAsync(CloudBlobContainer container, AccessCondition a /// Return a task that asynchronously abort the blob copy operation /// /// CloudBlob object - /// Copy id + /// Copy id /// Access condition - /// Blob request options + /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return a task that asynchronously abort the blob copy operation public Task AbortCopyAsync(CloudBlob blob, string copyId, AccessCondition accessCondition, BlobRequestOptions requestOptions, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -694,9 +698,9 @@ public Task AbortCopyAsync(CloudBlob blob, string copyId, AccessCondition access /// CloudBlobContainer object /// Container permission /// Access condition - /// Blob request option + /// Blob request options /// Operation context - /// cancellation token + /// cancellation token /// Return a task that asynchronously set the container permission public Task SetContainerPermissionsAsync(CloudBlobContainer container, BlobContainerPermissions permissions, AccessCondition accessCondition, BlobRequestOptions requestOptions, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -709,9 +713,9 @@ public Task SetContainerPermissionsAsync(CloudBlobContainer container, BlobConta /// CloudBlob object /// Snapshot delete option /// Access condition - /// Blob request option + /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return a task that asynchronously delete the specified blob public Task DeleteCloudBlobAsync(CloudBlob blob, DeleteSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, BlobRequestOptions requestOptions, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -738,6 +742,7 @@ public Task DoesBlobExistAsync(CloudBlob blob, BlobRequestOptions options, /// Access condition /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token public Task SetBlobPropertiesAsync(CloudBlob blob, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cmdletCancellationToken) { @@ -751,31 +756,36 @@ public Task SetBlobPropertiesAsync(CloudBlob blob, AccessCondition accessConditi /// Access condition /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token public Task SetBlobMetadataAsync(CloudBlob blob, AccessCondition accessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cmdletCancellationToken) { return blob.SetMetadataAsync(accessCondition, options, operationContext, cmdletCancellationToken); } - + + /// /// Return a task that asynchronously set Premium page blob Tier /// /// CloudPageBlob object /// Premium pageblob Tier /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token public Task SetPageBlobTierAsync(CloudPageBlob blob, PremiumPageBlobTier tier, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cmdletCancellationToken) { return blob.SetPremiumBlobTierAsync(tier, options, operationContext, cmdletCancellationToken); } - + /// /// Return a task that asynchronously set block blob Tier /// /// CloudBlockBlob object - /// block blob Tier /// Access condition + /// block blob Tier + /// /// Blob request options /// An object that represents the context for the current operation. + /// Cancellation token public Task SetStandardBlobTierAsync(CloudBlockBlob blob, AccessCondition accessCondition, StandardBlobTier tier, RehydratePriority? rehydratePriority, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cmdletCancellationToken) { return blob.SetStandardBlobTierAsync(tier, rehydratePriority, accessCondition, options, operationContext, cmdletCancellationToken); @@ -784,19 +794,24 @@ public Task SetStandardBlobTierAsync(CloudBlockBlob blob, AccessCondition access /// /// List the blobs segmented in specified containers /// - /// A cloudblobcontainer object + /// A CloudBlobContainer object /// Blob prefix /// Use flat blob listing(whether treat "container/" as directory) /// Blob listing details - /// Blob request option + /// Max results. + /// Current token. + /// Blob request options /// Operation context + /// Cancellation token public Task ListBlobsSegmentedAsync(CloudBlobContainer container, string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { return container.ListBlobsSegmentedAsync(prefix, useFlatBlobListing, blobListingDetails, maxResults, currentToken, options, operationContext, cancellationToken); } + /// /// List part of blobs. /// + /// A CloudBlobContainer object /// Blob prefix /// Use flat blob listing /// Blob listing details. @@ -819,13 +834,15 @@ public BlobResultSegment ListBlobsSegmented(CloudBlobContainer container, string } /// - /// Get a list of cloudblobcontainer in azure + /// Get a list of CloudBlobContainer in azure /// /// Container prefix /// Container listing details - /// Blob request option + /// Max results. + /// Current token. + /// Blob request options /// Operation context - /// An enumerable collection of cloudblobcontainer + /// An enumerable collection of CloudBlobContainer public ContainerResultSegment ListContainersSegmented(string prefix, ContainerListingDetails detailsIncluded, int? maxResults, BlobContinuationToken currentToken, BlobRequestOptions options, XSCL.OperationContext operationContext) { try @@ -847,7 +864,7 @@ public ContainerResultSegment ListContainersSegmented(string prefix, ContainerLi /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. public Task StartCopyAsync(CloudBlob blob, Uri source, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -864,7 +881,7 @@ public Task StartCopyAsync(CloudBlob blob, Uri source, AccessCondition s /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. public Task StartCopyAsync(CloudPageBlob blob, Uri source, PremiumPageBlobTier premiumPageBlobTier, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -876,12 +893,13 @@ public Task StartCopyAsync(CloudPageBlob blob, Uri source, PremiumPageBl /// /// CloudBlob object whcih is a Block blob /// Uri to copying source - /// The StandardBlobTier of Destination blob /// Access condition to source if it's file/blob in azure. + /// + /// Access condition to source if it's file/blob in azure. /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. public Task StartCopyAsync(CloudBlob blob, Uri source, StandardBlobTier? standardBlobTier, RehydratePriority? rehydratePriority, AccessCondition sourceAccessCondition, AccessCondition destAccessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -896,7 +914,7 @@ public Task StartCopyAsync(CloudBlob blob, Uri source, StandardBlobTier? /// Access condition to Destination blob. /// Blob request options /// Operation context - /// Cancellation token + /// Cancellation token /// Return copy id if succeeded. public Task StartIncrementalCopyAsync(CloudPageBlob blob, CloudPageBlob source, AccessCondition destAccessCondition, BlobRequestOptions options, XSCL.OperationContext operationContext, CancellationToken cancellationToken) { @@ -918,7 +936,7 @@ public XSCLProtocol.AccountProperties GetAccountProperties() /// The key valid start time /// The key valid end time /// Access condition - /// Blob request option + /// Blob request options /// Operation context /// The UserDelegationKey public UserDelegationKey GetUserDelegationKey(DateTimeOffset? keyStart, DateTimeOffset? keyEnd, AccessCondition accessCondition = null, BlobRequestOptions options = null, XSCL.OperationContext operationContext = null) diff --git a/src/Storage/Storage/Model/Contract/StorageQueueManagement.cs b/src/Storage/Storage/Model/Contract/StorageQueueManagement.cs index 63040a6e6e7d..6305531cb12c 100644 --- a/src/Storage/Storage/Model/Contract/StorageQueueManagement.cs +++ b/src/Storage/Storage/Model/Contract/StorageQueueManagement.cs @@ -51,7 +51,7 @@ public AzureStorageContext StorageContext /// /// Queue management constructor /// - /// Cloud queue client + /// Cloud queue client public StorageQueueManagement(AzureStorageContext context) { internalStorageContext = context; @@ -202,7 +202,8 @@ public bool DoesQueueExist(CloudQueue queue, QueueRequestOptions requestOptions, /// /// Get queue permission /// - /// Queue request options + /// Cloud queue object + /// Queue request options /// Operation context /// QueuePermissions object public QueuePermissions GetPermissions(CloudQueue queue, QueueRequestOptions options, OperationContext operationContext) diff --git a/src/Storage/Storage/Model/Contract/StorageTableManagement.cs b/src/Storage/Storage/Model/Contract/StorageTableManagement.cs index 7d4cda7dfec6..28147f254a4a 100644 --- a/src/Storage/Storage/Model/Contract/StorageTableManagement.cs +++ b/src/Storage/Storage/Model/Contract/StorageTableManagement.cs @@ -62,7 +62,7 @@ public bool IsTokenCredential /// /// Storage table management constructor /// - /// Cloud table client + /// Cloud table client public StorageTableManagement(AzureStorageContext context) { internalStorageContext = context; @@ -244,7 +244,6 @@ public Task SetTablePermissionsAsync(CloudTable table, TablePermissions tablePer /// /// Get the Table service properties /// - /// Cloud storage account /// Request options /// Operation context /// The service properties of the specified service type @@ -264,7 +263,6 @@ public XTable.ServiceProperties GetStorageTableServiceProperties(XTable.TableReq /// /// Set Table service properties /// - /// Cloud storage account /// Service properties /// Request options /// Operation context diff --git a/src/Storage/Storage/Model/Contract/StorageTableV2Management.cs b/src/Storage/Storage/Model/Contract/StorageTableV2Management.cs index 06a796fa2b56..bf11f8e40fd9 100644 --- a/src/Storage/Storage/Model/Contract/StorageTableV2Management.cs +++ b/src/Storage/Storage/Model/Contract/StorageTableV2Management.cs @@ -111,7 +111,7 @@ public bool DeleteTable(string tableName, CancellationToken cancellationToken) /// /// Returns only entities that satisfy the specified OData filter. For example, "PartitionKey eq 'foo'". /// The maximum number of entities that will be returned per page. - /// An IEnumerable of entity property names that selects which set of entity properties to return in the result set. + /// An IEnumerable<T> of entity property names that selects which set of entity properties to return in the result set. /// A CancellationToken controlling the request lifetime. /// public IEnumerable QueryTableEntities(string tableName, string filter, int maxPerPage, IEnumerable selects, CancellationToken cancellationToken) diff --git a/src/Storage/Storage/Table/Cmdlet/GetStorageAzureTable.cs b/src/Storage/Storage/Table/Cmdlet/GetStorageAzureTable.cs index b8b4152d429e..4da4d878c36b 100644 --- a/src/Storage/Storage/Table/Cmdlet/GetStorageAzureTable.cs +++ b/src/Storage/Storage/Table/Cmdlet/GetStorageAzureTable.cs @@ -141,6 +141,7 @@ internal IEnumerable ListTablesByPrefix(string prefix) /// /// list azure table clients by full name or simple regular expression /// + /// IStorageTableManagement channel object /// table name or simple regular expression /// internal IEnumerable ListTablesByNameV2(IStorageTableManagement localChannel, string tableName) @@ -185,6 +186,7 @@ internal IEnumerable ListTablesByNameV2(IStorageTableManageme /// /// list azure table clients by prefix using track2 sdk /// + /// IStorageTableManagement channel object /// table prefix /// internal IEnumerable ListTablesByPrefixV2(IStorageTableManagement localChannel, string prefix) @@ -202,7 +204,7 @@ internal IEnumerable ListTablesByPrefixV2(IStorageTableManage /// /// list azure table clients by query /// - /// + /// IStorageTableManagement channel object /// table query string /// internal IEnumerable ListTablesByQueryV2(IStorageTableManagement localChannel, string query) diff --git a/src/Storage/Storage/Table/Cmdlet/RemoveStorageAzureTable.cs b/src/Storage/Storage/Table/Cmdlet/RemoveStorageAzureTable.cs index bf12599aaf04..2816f3b9df64 100644 --- a/src/Storage/Storage/Table/Cmdlet/RemoveStorageAzureTable.cs +++ b/src/Storage/Storage/Table/Cmdlet/RemoveStorageAzureTable.cs @@ -111,7 +111,7 @@ internal bool RemoveAzureTable(string name) /// /// remove azure table /// - /// + /// IStorageTableManagement channel object /// table name /// /// true if the table is removed, false if user has cancelled the operation,