B2.NET is a C# client for the Backblaze B2 Cloud Storage service.
B2.NET is still in Beta, so use it in production at your own risk.
- Full implementation of the B2 REST API (except Keys management)
- Support for file FriendlyURL's (this functionality is not part of the supported B2 api and may break at any time)
- UFT-8 and Url Encoding support
- Fully Async
- Full test coverage
- Targets .NET 4.5 and .NET Standard 1.5
- You cannot manage keys with this library, just use already existing ones.
Install-Package B2Net
// the B2Client will default to the bucketId provided here// for all subsequent calls if you set PersistBucket to true.varoptions=newB2Options(){KeyId="YOUR APPLICATION KEYID",ApplicationKey="YOUR APPLICATION KEY",BucketId="OPTIONAL BUCKET ID",PersistBucket=true/false};varclient=newB2Client(options);The options object returned from the Authorize method will contain the authorizationToken necessary for subsequent
calls to the B2 API. This will automatically be handled by the library when necessary. You do not have to keep this object around.
The options object requires KeyId and ApplicationKey to authorize.
If you set authorizeOnInitialize to false the B2Client will not call the B2 API until you tell it to. This requires that you call Initialize() before making any other calls with the client. The client WILL NOT automatically call this if needed, you MUST call it yourself.
Application Keys are supported for use, but you cannot manage them with this library. If you want to use an application key you must specify your KeyId, and ApplicationKey for the application key that you want to use.
// This is the prefered way of authenticating. (Use this method if you want to use PersistBucket)varclient=newB2Client(options,authorizeOnInitialize=true);// OR (Use this method if you want to use PersistBucket)varclient=newB2Client(B2Client.Authorize(options));// ORvarclient=newB2Client(B2Client.Authorize("KEYID","APPLICATIONKEY"));// ORvarclient=newB2Client("KEYID","APPLICATIONKEY","OPTIONAL REQUESTTIMEOUT");Once authenticated the capabilities of your Key are available on your B2ClientCapabilities property:
varbucketId=client.Capabilities.BucketName;varcapabilities=client.Capabilities.Capabilities;// See here for available capabilities: [https://www.backblaze.com/b2/docs/application_keys.html](https://www.backblaze.com/b2/docs/application_keys.html)NOTE: You must call Authorize or have an Authorized client instance before you can access Capabilities. This is because only Backblaze knows the capabilities of a key and that information is returned in the Authorization response.
varclient=newB2Client("KEYID","APPLICATIONKEY");varbucketList=awaitclient.Buckets.GetList();// [// { BucketId: "",// BucketName: "",// BucketType: "",// BucketInfo: Dictionary<string,string>,// LifecycleRules: List<B2BucketLifecycleRule>,// CORSRules: List<B2CORSRule>,// Revision: int }// ]varclient=newB2Client("KEYID","APPLICATIONKEY");varbucket=awaitclient.Buckets.Create("BUCKETNAME","OPTIONAL_BUCKET_TYPE");// { BucketId: "",// BucketName: "",// BucketType: "",// BucketInfo: Dictionary<string,string>,// LifecycleRules: List<B2BucketLifecycleRule>,// CORSRules: List<B2CORSRule>,// Revision: int }varclient=newB2Client("KEYID","APPLICATIONKEY");varbucket=awaitclient.Buckets.Create("BUCKETNAME",newB2BucketOptions(){CacheControl=300,LifecycleRules=newSystem.Collections.Generic.List<B2BucketLifecycleRule>(){newB2BucketLifecycleRule(){DaysFromHidingToDeleting=30,DaysFromUploadingToHiding=null,FileNamePrefix=""}},CORSRules=newList<B2CORSRule>(){newB2CORSRule(){CorsRuleName="corsRule",AllowedOrigins=newstring[],AllowedOperations=newstring[],AllowedHeaders=newstring[],ExposeHeaders=newstring[],MaxAgeSeconds=1200}},});// { BucketId: "",// BucketName: "",// BucketType: "",// BucketInfo: Dictionary<string,string>,// LifecycleRules: List<B2BucketLifecycleRule>,// CORSRules: List<B2CORSRule>,// Revision: int }varclient=newB2Client("KEYID","APPLICATIONKEY");varbucket=awaitclient.Buckets.Update("BUCKETID","BUCKETYPE");// { BucketId: "",// BucketName: "",// BucketInfo: Dictionary<string,string>,// LifecycleRules: List<B2BucketLifecycleRule>,// CORSRules: List<B2CORSRule>,// Revision: int }varclient=newB2Client("KEYID","APPLICATIONKEY");varbucket=awaitclient.Buckets.Update(newB2BucketOptions(){CacheControl=300,LifecycleRules=newList<B2BucketLifecycleRule>(){newB2BucketLifecycleRule(){DaysFromHidingToDeleting=30,DaysFromUploadingToHiding=null,FileNamePrefix=""}},CORSRules=newList<B2CORSRule>(){newB2CORSRule(){CorsRuleName="corsRule",AllowedOrigins=newstring[],AllowedOperations=newstring[],AllowedHeaders=newstring[],ExposeHeaders=newstring[],MaxAgeSeconds=1200}},},"BUCKETID");// { BucketId: "",// BucketName: "",// BucketType: "",// BucketInfo: Dictionary<string,string>,// LifecycleRules: List<B2BucketLifecycleRule>,// CORSRules: List<B2CORSRule>,// Revision: int }allPrivate
allPublic
varclient=newB2Client("KEYID","APPLICATIONKEY");varbucket=awaitclient.Buckets.Delete("BUCKETID");// { BucketId: "",// BucketName: "",// BucketType: "" }varclient=newB2Client("KEYID","APPLICATIONKEY");varfileList=awaitclient.Files.GetList("BUCKETID","FILENAME");// Using optional prefix and delimitervarfileList=awaitclient.Files.GetList("BUCKETID","FILENAME",prefix:"PREFIX",delimiter:"DELIMITER");// {// NextFileName: "",// [// { FileId: "",// FileName: "",// ContentLength: "",// ContentSHA1: "",// ContentType: "" }// ]// }varclient=newB2Client("KEYID","APPLICATIONKEY");varuploadUrl=awaitclient.Files.GetUploadUrl("BUCKETID");varfile=awaitclient.Files.Upload("FILEDATABYTES","FILENAME",uploadUrl,"AUTORETRY","BUCKETID","FILEINFOATTRS");// { FileId: "",// FileName: "",// ContentLength: "",// ContentSHA1: "",// ContentType: "",// FileInfo: Dictionary<string,string> }varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=awaitclient.Files.DownloadById("FILEID");// { FileId: "",// FileName: "",// ContentLength: "",// ContentSHA1: "",// ContentType: "",// FileData: byte[],// FileInfo: Dictionary<string,string> }varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=awaitclient.Files.DownloadName("FILENAME","BUCKETNAME");// { FileId: "",// FileName: "",// ContentLength: "",// ContentSHA1: "",// ContentType: "",// FileData: byte[],// FileInfo: Dictionary<string,string> }varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=awaitclient.Files.Copy("FILEID","NEWFILENAME");// { FileId: "",// FileName: "",// ContentLength: "",// ContentSHA1: "",// ContentType: "",// FileData: byte[],// FileInfo: Dictionary<string,string> }varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=awaitclient.Files.Copy("FILEID","NEWFILENAME",B2MetadataDirective.REPLACE,"CONTENT/TYPE");// { FileId: "",// FileName: "",// ContentLength: "",// ContentSHA1: "",// ContentType: "",// FileData: byte[],// FileInfo: Dictionary<string,string> }varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=awaitclient.Files.GetVersions("FILENAME","FILEID");// {// NextFileName: "",// NextFileId: "",// [// { FileId: "",// FileName: "",// Action: "",// Size: "",// UploadTimestamp: "" }// ]// }varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=awaitclient.Files.Delete("FILEID","FILENAME");// { FileId: "",// FileName: ""}varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=awaitclient.Files.Hide("FILEID","BUCKETID");// { FileId: "",// FileName: "",// Action: "",// Size: "",// UploadTimestamp: ""}varclient=newB2Client("KEYID","APPLICATIONKEY");varfile=client.Files.GetInfo("FILEID").Result;// { FileId: "",// FileName: "",// ContentSHA1: "",// BucketId: "",// ContentLength: "",// ContentType: "",// FileInfo: Dictionary<string,string> }varclient=newB2Client("KEYID","APPLICATIONKEY");vardownloadAuth=awaitclient.Files.GetDownloadAuthorization("FILENAMEPREFIX","VALIDDURATION","BUCKETNAME","CONTENTDISPOSITION");// { FileNamePrefix: "",// BucketId: "",// AuthorizationToken: "" }See the Large File tests for usage details.
Certain errors returned by B2 point to a temporary error with the upload or download of a file.
If one of these errors are encountered during an upload or download then the B2Exception that
is returned will have the ShouldRetryRequest flag marked true. This is an indication that you
should retry the request if you are so inclined.
- 0.7.2 Async the authorize method, Added initialize path that does not call the API until told.
- 0.7.1 Updated documentation and API for removal of AccountId, which is no longer needed. (thanks @seertenedos)
- 0.7.0 Fixed bug with encoding file names with /, All B2Client constructors will auto authorize with Backblaze, Capabilities surfaced to property on the B2Client, File copy API added.
- 0.6.1 Made Capabilities on the B2 Client read only, as they define what an application key can do and should not be mutable.
- 0.6.0 Preliminary support for the v2 Keys API
- 0.5.32 Fixed bug preventing the use of Keys API keys
- 0.5.31 Fixed upload bug introduced in 0.5.21
- 0.5.3 Fixed incorrect property names for B2UploadPart and added GetDownloadAuthorization
- 0.5.21 Fixed bug with formatting POST requests
- 0.5.2 Implemented Interfaces for easier testing (from @mattdewn) and fixed tests
- 0.5.0 Large file management apis (version mix up as well)
- 0.4.9 static Authorize
- 0.4.6 Configureable HttpClient timeout
- 0.4.5 File prefix and delimiter support
- 0.4.0 Added Large File support
- 0.2.5 Support for .NET 4.5 and .NET Standard 1.5 and FriendlyURL's for files
- 0.1.92 Fixed Lifecycle Rules null issue.
- 0.1.9 Added Lifecycle Rules and Cache Control to bucket creation and updating.
- 0.1.81 Switch targeting to netstandard1.3 and updated B2 endpoint
- 0.1.7 Merged changes for file name encoding and maxFileCount from tomvoros
- 0.1.6 Started URL Encoding file names.
- 0.1.5 File info attributes support.
- 0.1.0 Initial Alpha release.
From the src directory run
dotnet pack -o ..\tests\
From the tests directory run
dotnet restore
dotnet test