Azure.Storage.Blobs.Specialized.BlobBaseClient
The BlobBaseClient allows you to manipulate Azure Storage
blobs.
namespace Azure.Storage.Blobs.Specialized
{
public class BlobBaseClient
{
public virtual Uri Uri { get; }
public virtual string AccountName { get; }
public virtual string BlobContainerName { get; }
public virtual string Name { get; }
public virtual bool CanGenerateSasUri { get; }
protected BlobBaseClient();
public BlobBaseClient(string connectionString, string blobContainerName, string blobName);
public BlobBaseClient(string connectionString, string blobContainerName, string blobName, BlobClientOptions options);
public BlobBaseClient(Uri blobUri, BlobClientOptions options = null);
public BlobBaseClient(Uri blobUri, StorageSharedKeyCredential credential, BlobClientOptions options = null);
public BlobBaseClient(Uri blobUri, AzureSasCredential credential, BlobClientOptions options = null);
public BlobBaseClient(Uri blobUri, TokenCredential credential, BlobClientOptions options = null);
public virtual BlobBaseClient WithSnapshot(string snapshot);
protected virtual BlobBaseClient WithSnapshotCore(string snapshot);
public virtual BlobBaseClient WithVersion(string versionId);
public virtual BlobBaseClient WithCustomerProvidedKey(CustomerProvidedKey? customerProvidedKey);
public virtual BlobBaseClient WithEncryptionScope(string encryptionScope);
protected static Task<HttpAuthorization> GetCopyAuthorizationHeaderAsync(BlobBaseClient client, CancellationToken cancellationToken = default(CancellationToken));
protected static Uri GetUriWithSas(BlobBaseClient client);
public virtual Response<BlobDownloadInfo> Download();
public virtual Task<Response<BlobDownloadInfo>> DownloadAsync();
public virtual Response<BlobDownloadInfo> Download(CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobDownloadInfo>> DownloadAsync(CancellationToken cancellationToken);
public virtual Response<BlobDownloadInfo> Download(HttpRange range = default(HttpRange), BlobRequestConditions conditions = null, bool rangeGetContentHash = false, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobDownloadInfo>> DownloadAsync(HttpRange range = default(HttpRange), BlobRequestConditions conditions = null, bool rangeGetContentHash = false, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobDownloadStreamingResult> DownloadStreaming(HttpRange range, BlobRequestConditions conditions, bool rangeGetContentHash, CancellationToken cancellationToken);
public virtual Task<Response<BlobDownloadStreamingResult>> DownloadStreamingAsync(HttpRange range, BlobRequestConditions conditions, bool rangeGetContentHash, CancellationToken cancellationToken);
public virtual Response<BlobDownloadStreamingResult> DownloadStreaming(HttpRange range, BlobRequestConditions conditions, bool rangeGetContentHash, IProgress<long> progressHandler, CancellationToken cancellationToken);
public virtual Task<Response<BlobDownloadStreamingResult>> DownloadStreamingAsync(HttpRange range, BlobRequestConditions conditions, bool rangeGetContentHash, IProgress<long> progressHandler, CancellationToken cancellationToken);
public virtual Response<BlobDownloadStreamingResult> DownloadStreaming(BlobDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobDownloadStreamingResult>> DownloadStreamingAsync(BlobDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobDownloadResult> DownloadContent();
public virtual Task<Response<BlobDownloadResult>> DownloadContentAsync();
public virtual Response<BlobDownloadResult> DownloadContent(CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobDownloadResult>> DownloadContentAsync(CancellationToken cancellationToken);
public virtual Response<BlobDownloadResult> DownloadContent(BlobRequestConditions conditions, CancellationToken cancellationToken);
public virtual Task<Response<BlobDownloadResult>> DownloadContentAsync(BlobRequestConditions conditions, CancellationToken cancellationToken);
public virtual Response<BlobDownloadResult> DownloadContent(BlobRequestConditions conditions, IProgress<long> progressHandler, HttpRange range, CancellationToken cancellationToken);
public virtual Task<Response<BlobDownloadResult>> DownloadContentAsync(BlobRequestConditions conditions, IProgress<long> progressHandler, HttpRange range, CancellationToken cancellationToken);
public virtual Response<BlobDownloadResult> DownloadContent(BlobDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobDownloadResult>> DownloadContentAsync(BlobDownloadOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response DownloadTo(Stream destination);
public virtual Response DownloadTo(string path);
public virtual Task<Response> DownloadToAsync(Stream destination);
public virtual Task<Response> DownloadToAsync(string path);
public virtual Response DownloadTo(Stream destination, CancellationToken cancellationToken);
public virtual Response DownloadTo(string path, CancellationToken cancellationToken);
public virtual Task<Response> DownloadToAsync(Stream destination, CancellationToken cancellationToken);
public virtual Task<Response> DownloadToAsync(string path, CancellationToken cancellationToken);
public virtual Response DownloadTo(Stream destination, BlobDownloadToOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response DownloadTo(string path, BlobDownloadToOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> DownloadToAsync(Stream destination, BlobDownloadToOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> DownloadToAsync(string path, BlobDownloadToOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response DownloadTo(Stream destination, BlobRequestConditions conditions = null, StorageTransferOptions transferOptions = default(StorageTransferOptions), CancellationToken cancellationToken = default(CancellationToken));
public virtual Response DownloadTo(string path, BlobRequestConditions conditions = null, StorageTransferOptions transferOptions = default(StorageTransferOptions), CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> DownloadToAsync(Stream destination, BlobRequestConditions conditions = null, StorageTransferOptions transferOptions = default(StorageTransferOptions), CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> DownloadToAsync(string path, BlobRequestConditions conditions = null, StorageTransferOptions transferOptions = default(StorageTransferOptions), CancellationToken cancellationToken = default(CancellationToken));
public virtual Stream OpenRead(BlobOpenReadOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Stream> OpenReadAsync(BlobOpenReadOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual Stream OpenRead(long position = 0, int? bufferSize = default(int?), BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Stream OpenRead(bool allowBlobModifications, long position = 0, int? bufferSize = default(int?), CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Stream> OpenReadAsync(long position = 0, int? bufferSize = default(int?), BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Stream> OpenReadAsync(bool allowBlobModifications, long position = 0, int? bufferSize = default(int?), CancellationToken cancellationToken = default(CancellationToken));
public virtual CopyFromUriOperation StartCopyFromUri(Uri source, BlobCopyFromUriOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual CopyFromUriOperation StartCopyFromUri(Uri source, IDictionary<string, string> metadata = null, AccessTier? accessTier = default(AccessTier?), BlobRequestConditions sourceConditions = null, BlobRequestConditions destinationConditions = null, RehydratePriority? rehydratePriority = default(RehydratePriority?), CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<CopyFromUriOperation> StartCopyFromUriAsync(Uri source, BlobCopyFromUriOptions options, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<CopyFromUriOperation> StartCopyFromUriAsync(Uri source, IDictionary<string, string> metadata = null, AccessTier? accessTier = default(AccessTier?), BlobRequestConditions sourceConditions = null, BlobRequestConditions destinationConditions = null, RehydratePriority? rehydratePriority = default(RehydratePriority?), CancellationToken cancellationToken = default(CancellationToken));
public virtual Response AbortCopyFromUri(string copyId, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> AbortCopyFromUriAsync(string copyId, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobCopyInfo> SyncCopyFromUri(Uri source, BlobCopyFromUriOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobCopyInfo>> SyncCopyFromUriAsync(Uri source, BlobCopyFromUriOptions options = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response Delete(DeleteSnapshotsOption snapshotsOption = DeleteSnapshotsOption.None, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> DeleteAsync(DeleteSnapshotsOption snapshotsOption = DeleteSnapshotsOption.None, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<bool> DeleteIfExists(DeleteSnapshotsOption snapshotsOption = DeleteSnapshotsOption.None, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<bool>> DeleteIfExistsAsync(DeleteSnapshotsOption snapshotsOption = DeleteSnapshotsOption.None, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<bool> Exists(CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<bool>> ExistsAsync(CancellationToken cancellationToken = default(CancellationToken));
public virtual Response Undelete(CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> UndeleteAsync(CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobProperties> GetProperties(BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobProperties>> GetPropertiesAsync(BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobInfo> SetHttpHeaders(BlobHttpHeaders httpHeaders = null, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobInfo>> SetHttpHeadersAsync(BlobHttpHeaders httpHeaders = null, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobInfo> SetMetadata(IDictionary<string, string> metadata, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobInfo>> SetMetadataAsync(IDictionary<string, string> metadata, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobSnapshotInfo> CreateSnapshot(IDictionary<string, string> metadata = null, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobSnapshotInfo>> CreateSnapshotAsync(IDictionary<string, string> metadata = null, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response SetAccessTier(AccessTier accessTier, BlobRequestConditions conditions = null, RehydratePriority? rehydratePriority = default(RehydratePriority?), CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> SetAccessTierAsync(AccessTier accessTier, BlobRequestConditions conditions = null, RehydratePriority? rehydratePriority = default(RehydratePriority?), CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<GetBlobTagResult> GetTags(BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<GetBlobTagResult>> GetTagsAsync(BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response SetTags(IDictionary<string, string> tags, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> SetTagsAsync(IDictionary<string, string> tags, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobImmutabilityPolicy> SetImmutabilityPolicy(BlobImmutabilityPolicy immutabilityPolicy, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobImmutabilityPolicy>> SetImmutabilityPolicyAsync(BlobImmutabilityPolicy immutabilityPolicy, BlobRequestConditions conditions = null, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response DeleteImmutabilityPolicy(CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response> DeleteImmutabilityPolicyAsync(CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<BlobLegalHoldResult> SetLegalHold(bool hasLegalHold, CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<BlobLegalHoldResult>> SetLegalHoldAsync(bool hasLegalHold, CancellationToken cancellationToken = default(CancellationToken));
public virtual Response<AccountInfo> GetAccountInfo(CancellationToken cancellationToken = default(CancellationToken));
public virtual Task<Response<AccountInfo>> GetAccountInfoAsync(CancellationToken cancellationToken = default(CancellationToken));
public virtual Uri GenerateSasUri(BlobSasPermissions permissions, DateTimeOffset expiresOn);
public virtual Uri GenerateSasUri(BlobSasPermissions permissions, DateTimeOffset expiresOn, out string stringToSign);
public virtual Uri GenerateSasUri(BlobSasBuilder builder);
public virtual Uri GenerateSasUri(BlobSasBuilder builder, out string stringToSign);
public virtual Uri GenerateUserDelegationSasUri(BlobSasPermissions permissions, DateTimeOffset expiresOn, UserDelegationKey userDelegationKey);
public virtual Uri GenerateUserDelegationSasUri(BlobSasPermissions permissions, DateTimeOffset expiresOn, UserDelegationKey userDelegationKey, out string stringToSign);
public virtual Uri GenerateUserDelegationSasUri(BlobSasBuilder builder, UserDelegationKey userDelegationKey);
public virtual Uri GenerateUserDelegationSasUri(BlobSasBuilder builder, UserDelegationKey userDelegationKey, out string stringToSign);
}
}