How can I use Azurite in a command line application?

Question

How can I use Azurite in a command line application?

David Thielen 3,211

For my unit tests I want to use Azurite to create & verify BLOBs. The instructions only show how to do this for an ASP.NET app. How can I do it for a command line app?

thanks - dave

Sumarigo-MSFT 47,466 Reputation points Microsoft Employee Moderator

2023-09-04T13:29:57.86+00:00

@David Thielen Just checking in to see if the below answer helped. If this answers your query, do click "Accept the answer” for the same, which might be beneficial to other community members reading this thread. And, if you have any further query do let us know.

1 answer

Your answer

Sumarigo-MSFT 47,466 Reputation points Microsoft Employee Moderator

2023-09-04T13:29:57.86+00:00

@David Thielen Just checking in to see if the below answer helped. If this answers your query, do click "Accept the answer” for the same, which might be beneficial to other community members reading this thread. And, if you have any further query do let us know.

Answer 1

shiva patpi 13,366 Microsoft Employee Moderator

@David Thielen

I just tried out opening the Azurite in the command line and by default it started listening to their default ports:

User's image

and the rest of the APIs interactions are same as mentioned in the above document:

https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite?tabs=visual-studio#azure-sdks

David Thielen 3,211 Reputation points

2023-08-09T18:58:10.97+00:00

I'm getting an error when I try to run it from the command line:

C:\Program Files\Microsoft Visual Studio\2022\Professional\Common7\IDE\Extensions\Microsoft\Azure Storage Emulator>azuri te Azurite Blob service is starting at http://127.0.0.1:10000 Exit due to unhandled error: Error: EPERM: operation not permitted, open 'C:\Program Files\Microsoft Visual Studio\2022\Professional\Common7\IDE\Extensions\Microsoft\Azure Storage Emulator_azurite_db_blob_.json~' C:\Program Files\Microsoft Visual Studio\2022\Professional\Common7\IDE\Extensions\Microsoft\Azure Storage Emulator>

Also, is there a way to have the app run it when it starts? Like it is set for my Blazor app?

thanks - dave
shiva patpi 13,366 Reputation points Microsoft Employee Moderator

2023-08-09T19:01:46.67+00:00

@shiva patpi

Open the command prompt in an Admin mode , then you will be able to run it with out errors
shiva patpi 13,366 Reputation points Microsoft Employee Moderator

2023-08-09T19:07:37.11+00:00

@David Thielen ,

Open the command prompt in an Admin mode , then you will be able to run it with out errors
David Thielen 3,211 Reputation points

2023-08-09T19:15:26.8566667+00:00

Ok, that ran but when I try to access it, I get the following. And note that I am able to use Azurite fine from my Blazor app running on Visual Studio.

Looking at the properties for Azurite.exe it lists:

File version: 14.20.0.0

Product version: 3.22.0

Any ideas?

thanks - dave

David Thielen 3,211

And it ate the exception listing in my comment - here it is (again)

Azure.RequestFailedException
  HResult=0x80131500
  Message=The API version 2023-01-03 is not supported by Azurite. Please upgrade Azurite to latest version and retry. If you are using Azurite in Visual Studio, please check you have installed latest Visual Studio patch. Azurite command line parameter "--skipApiVersionCheck" or Visual Studio Code configuration "Skip Api Version Check" can skip this error. 
RequestId:974bb4c7-8639-4c9e-b029-56bec63cf7fe
Time:2023-08-09T19:06:28.440Z
Status: 400 (The API version 2023-01-03 is not supported by Azurite. Please upgrade Azurite to latest version and retry. If you are using Azurite in Visual Studio, please check you have installed latest Visual Studio patch. Azurite command line parameter "--skipApiVersionCheck" or Visual Studio Code configuration "Skip Api Version Check" can skip this error. )
ErrorCode: InvalidHeaderValue

shiva patpi 13,366 Reputation points Microsoft Employee Moderator

2023-08-09T19:52:10.0166667+00:00

@David Thielen

When you say when you try to access it , what exactly you are trying to do after you run the azurite in the commandline ?
David Thielen 3,211 Reputation points

2023-08-09T23:23:08.2633333+00:00

I have a command line app I use to populate my database and BLOB storage with the system items. So there's ~ 30 BLOBs the application assumes exist. It writes those.

It's a plain old C# command line app that uses the Azure.Storage.Blobs library.

When I call BlobClient.UploadAsync() it does not return for about a minute, then times out.

The same code works fine running from my Blazor application.

thanks - dave
shiva patpi 13,366 Reputation points Microsoft Employee Moderator

2023-08-11T16:16:29.5066667+00:00

@David Thielen ,

Will you be able to post the complete C#.net code which I can test it out from my end ?

Regards,

Shiva.
David Thielen 3,211 Reputation points

2023-08-11T21:32:13.1+00:00

Here you go. Try running this on a system that has Azurite installed, but is not being run by another application.

BlobExample.zip

shiva patpi 13,366 Microsoft Employee Moderator

David Thielen,

I just tried below piece of code in C#.net to upload a blob using azurite !

  public static void UploadUsingAzurite()
        {
            try
            {
                string file_extension, filename_withExtension,  connectionString;
                Stream file;

                //Copy the storage account connection string from Azure portal     
                connectionString = "AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;DefaultEndpointsProtocol=http;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;QueueEndpoint=http://127.0.0.1:10001/devstoreaccount1;TableEndpoint=http://127.0.0.1:10002/devstoreaccount1;";
                string fileToUpload = "C:\\azure\\data.txt";
                string strContainerName = "test2";
                // << reading the file as filestream from local machine >>    
                file = new FileStream(fileToUpload, FileMode.Open);

                CloudStorageAccount mycloudStorageAccount = CloudStorageAccount.Parse(connectionString);
                CloudBlobClient blobClient = mycloudStorageAccount.CreateCloudBlobClient();
                CloudBlobContainer container = blobClient.GetContainerReference(strContainerName);

                //checking the container exists or not  
                if (container.CreateIfNotExists())
                {

                    container.SetPermissionsAsync(new BlobContainerPermissions
                    {
                        PublicAccess =
                      BlobContainerPublicAccessType.Blob
                    });

                }

                //reading file name & file extention    
                file_extension = Path.GetExtension(fileToUpload);
                filename_withExtension = Path.GetFileName(fileToUpload);

                CloudBlockBlob cloudBlockBlob = container.GetBlockBlobReference(filename_withExtension);
                cloudBlockBlob.Properties.ContentType = file_extension;
                cloudBlockBlob.Metadata.Add("RetentionDays", "1");
                cloudBlockBlob.UploadFromStream(file); // << Uploading the file to the blob >>  

                Console.WriteLine("Upload Completed!");

            }
            catch(Exception ex)
            {
                Console.WriteLine($"{ex.Message}"); 
            }
        }

Below is the output:

User's image

Azuritecommand line debug messages:

User's image

David Thielen 3,211 Reputation points

2023-08-14T22:09:11.04+00:00

The connection string in your example is connecting to Azure BLOB storage. Are you sure it hit locally? (Also, you should delete that before someone uses it for their own storage.)

And was this a command line app and you had no ASP.NET app running which fired up Azurite?

thanks - dave
shiva patpi 13,366 Reputation points Microsoft Employee Moderator

2023-08-15T04:08:48.6233333+00:00

David Thielen,

If you see my screen shot above in storage explorer , it is going to local-1 which is my local one.

Yes, this is a small C#.net console based application !

regards,

Shiva.
David Thielen 3,211 Reputation points

2023-08-15T13:48:25.35+00:00

@shiva patpi Weird. I can get this if I have my ASP.NET app run first to start Azurite. But if I run the command line app first, no Azurite.

Oh well, I can live with running the ASP.NET app first.

thanks - dave

Share via

How can I use Azurite in a command line application?

1 answer

Your answer