{"id":248,"date":"2023-11-27T11:44:18","date_gmt":"2023-11-27T10:44:18","guid":{"rendered":"https:\/\/france.magicsoftware.com\/blog\/?p=248"},"modified":"2025-12-14T16:21:30","modified_gmt":"2025-12-14T15:21:30","slug":"azure-storage","status":"publish","type":"post","link":"https:\/\/france.magicsoftware.com\/blog\/magic-xpi\/azure-storage\/","title":{"rendered":"Azure Storage – Magic xpi : How to Get the Content list of a Blob Container and Download BlockBlobs locally using REST API"},"content":{"rendered":"\n

Goal : List a container blob storage and download and save each content (blockblob) in a file locally<\/p>\n\n\n\n

Describe the different steps for connecting Magic xpi with Azure Storage using REST API<\/p>\n\n\n\n

1\/ Check that you can call the Azure Storage REST API using Postman with your credentials using Shared Key<\/pre>\n\n\n\n
(*) Instead of Shared Key, Authorization can be done with Azure Active Directory(Microsoft Entra ID<\/a>)<\/p>\n\n\n\n
For example, the URL should be in this format : https:\/\/{{azure_storage_account}}.blob.core.windows.net\/devtest\/?restype=container&comp=list<\/em><\/p>\n\n\n\n
to get the containers list<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
You need to set {{azure_storage_account}}, {{header_date}} and {{header_authorization}}<\/strong>   variables.<\/p>\n\n\n\n
(*) The main difficulty is to generate the {{header_authorization}} key that must be in the format :  SharedKey<space>{{AccountName}}:{{SignatureEncoded}}<\/em><\/strong><\/p>\n\n\n\n
example : SharedKey stmagictrfdevtest:+t5tQFW23cZ63NUZt4gQMuBUSBPSh52qa+Q5NOoFCEI=<\/p>\n\n\n\n
In the Postman project, you can use the Pre-request Script to set the 3 parameters below<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
You can use Microsoft Azure Storage Explorer to retrieve your azure storage account and check that you can list the content of a blob container.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
2\/ In other to set the {{header_authorization}}<\/em><\/strong> with Magic xpi, a solution is to use a powershell script<\/em><\/strong> that generates the signature and the header_date for the right operation (GET, PUT, LIST)<\/p>\n\n\n\n
Example for downloading a blob :<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
In this powershell script, we redirect the encoded signature and the header_date in the magic xpi project directory<\/p>\n\n\n\n
(*) Be aware that you need to have a different signature for listing (LIST), downloading (GET) or uploading (PUT)<\/em><\/strong><\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
(*) Documentation reference : https:\/\/kb.sos-berlin.com\/display\/PKB\/Feature+Proposal+-+Azure+Blob+Storage+-+Shared+Key+Authentication#FeatureProposalAzureBlobStorageSharedKeyAuthentication-Example<\/a><\/p>\n\n\n\n
3\/ Use a FlowData component to update a flow variable for the AccountName<\/p>\n\n\n\n
4\/ Drag and Drop a FileManagement component and use Command Line method to call a bat file that will call your powershell script<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
4\/ Use a FlowData component to update 3 flow variables (F.signatureEncoded, F.Auth and F.UTCdate<\/p>\n\n\n\n
F.Auth will hold the {{header_authorization}}<\/em><\/strong><\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
F.SignatureEncoded<\/strong> with : UTF8FromAnsi (RepStr (RepStr (File2Blb (‘<magic xpi installation directory>\\Runtime\\projects\\AzureStorage2\\AzureStorage2\\signatureencoded\\token.txt’),ASCIIChr (13),\u00a0\u00bb),ASCIIChr (10),\u00a0\u00bb))<\/p>\n\n\n\n
F.Auth<\/strong> with : ‘SharedKey ‘&Trim (F.AccountName)&’:’&Trim (F.SignatureEncoded)<\/p>\n\n\n\n
F.UtCdate<\/strong> with : File2Blb (‘<magic xpi installation directory>\\Runtime\\projects\\AzureStorage2\\AzureStorage2\\signatureencoded\\date.txt’)<\/p>\n\n\n\n
5\/ Create a REST Client Magic xpi resource to call Azure Storage (Project=>Settings=>Resources)<\/p>\n\n\n\n
Define 4 header parameters (Authorization, x-ms-date, x-ms-version, x-ms-blob-type) and 2 query parameters (restype, comp)<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
6\/ Use a REST Client connector to make the call to azure storage REST API.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
7\/ Now you need to parse the xml result with the Datamapper component and make a loop to download each blockblob<\/strong><\/p>\n\n\n\n
Drag and Drop a Datamapper component and configure an XML as a source and a CallFlow as destination<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
8\/ In the called Flow, you need to generate a signature for the desired blockblob you want to download<\/p>\n\n\n\n
Like in step 2\/, you can call a powershell and pass the blockblob name to generate the signature.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
in the bat file, you call the powershell script :<\/p>\n\n\n\n
C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe -ExecutionPolicy Bypass .\\sas2download.ps1 %1<\/p>\n\n\n\n
Powershell should be like this to receive the parameter.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
9\/ After getting the tokendownload.txt and the datedownload.txt, you can proceed like in step 4\/ to update the Authorization<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
10\/ Add a path in the REST Client Magic xpi resource to call Azure Storage Download (Project=>Settings=>Resources)<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
11\/  Use the REST Client connector to make the call using Get operation.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
12\/ Drag & Drop Filemanagement Component to save the content on a file locally with a timestamp.<\/p>\n\n\n\n
Assume that the Response of the previous step (REST Client Download) goes into C.UserBlob.<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
13\/ Document reference : https:\/\/learn.microsoft.com\/en-us\/rest\/api\/storageservices\/list-containers2?tabs=shared-key<\/a><\/p>\n\n\n\n
Documentation reference : https:\/\/kb.sos-berlin.com\/display\/PKB\/Feature+Proposal+-+Azure+Blob+Storage+-+Shared+Key+Authentication#FeatureProposalAzureBlobStorageSharedKeyAuthentication-Example<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Goal : List a container blob storage and download and save each content (blockblob) in a file locally Describe the different steps for connecting Magic xpi with Azure Storage using REST API 1\/ Check that you can call the Azure Storage REST API using Postman with your credentials using Shared Key (*) Instead of Shared […]<\/p>\n","protected":false},"author":1,"featured_media":249,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[31,93,4,28],"tags":[11,14],"class_list":["post-248","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-azure","category-azure-storage","category-magic-xpi","category-microsoft","tag-azure","tag-magic-xpi"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t