2aae6be7a3
It all started with UWP. The [docs](https://docs.microsoft.com/en-us/cpp/cppcx/crt-functions-not-supported-in-universal-windows-platform-apps?view=msvc-170) say: "`Environment variables are not available to UWP apps.`". And it truly won't work, I tried: linker error, the function is simply not present. So, for a year or so, we were `ifdef`ing everything enivoronment-related: console logger, environment credential, managed identity credential. And then just recently we wanted to enable our CI for UWP, including tests and samples. And it required to do more ifdefs (in vcpkg, we don't build samples or tests, so that problem did not exist). It just became more messy. Especially in samples - you can see how we would disable warning with `#pragma warning(disable : 4996)` or defining `_CRT_SECURE_NO_WARNINGS` already, but now came UWP, so we would have to add comment that `getenv()` is not available and make the sample compilation to either fail with clear message, or throw an exception. Plus we would have to detect that we are being compiled on UWP, which also adds visual clutter for reader. You can see how such an irrelevant (for a sample) thing as `getenv` was consuming more and more lines of sample code and reader's attention. But then! I read docs on more APIs for UWP. And I noticed that on .NET you can read environment variables. So I went and checked Win32 API docs for [GetEnvironmentVariable()](https://docs.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-getenvironmentvariable) - it says: "`Minimum supported client: ... UWP apps`". **GetEnvironmentVariable() works on UWP!** And so does `SetEnvironmentVariable()` (our tests use it, which means we can make all of them work and execute for UWP). That's good news, but now it would probably be more code: it usually takes more lines to invoke WinAPI, it is no more an one-liner to call `getenv()/setenv()`. So, I encapsulated that into `Azure::Core::_internal::Environment::GetVariable()` and `SetVariable()`. You can see how much less ifdefs is in our code now. Not to mention it works on UWP! Per team request, that API is SDK-internal. Samples use their own mini-helper project, `get-env-helper` that makes is so that `getenv()` works naturally on Linux and macOS, compiles without warnings and works on Win32, and compiles and works on UWP (using `GetEnvironmentStringsA()`) If it was for me, I would just make `Azure::Core::Environment::GetVariable()` public and simplify even further, I think it would be beneficial for sample readers (you can see that extra `get-env-helper` stuff adds just a little more visual clutter, compared to nothing). But I can see reasons against that, why team did not want to do it. |
||
|---|---|---|
| .. | ||
| azure-storage-blobs | ||
| azure-storage-common | ||
| azure-storage-files-datalake | ||
| azure-storage-files-shares | ||
| azure-storage-queues | ||
| ci.yml | ||
| CMakeLists.txt | ||
| MigrationGuide.md | ||
| README.md | ||
| test-resources-post.ps1 | ||
| test-resources.json | ||
Azure Storage Client Library for C++
The Azure Storage Client Library for C++ allows you to build applications against Microsoft Azure Storage. For an overview of Azure Storage, see Introduction to Microsoft Azure Storage.
Features
- Blobs
- Create/Delete/List Containers
- Create/Read/Update/Delete/List Blobs
- DataLake Gen 2
- Create/Delete File Systems
- Create/Delete Directories
- Create/Read/Append/Flush/Delete Files
- File Shares
- Create/Delete Shares
- Create/Delete Directories
- Create/Read/Delete Files
Getting started
For the best development experience, we recommend that developers use the CMake projects in Visual Studio to view and build the source code together with its dependencies.
Requirements
To call Azure services, you must first have an Azure subscription. Sign up for a free trial or use your MSDN subscriber benefits.
Need Help?
Be sure to check out the Azure Storage Forum on MSDN if you need help, or use StackOverflow.
Collaborate & Contribute
We gladly accept community contributions.
- Issues: Report bugs on the Issues page in GitHub. Ideally, please add an "[Storage]" prefix to the title for easier categorizing.
- Forums: Communicate with the Azure Storage development team on the Azure Storage Forum or StackOverflow.
- Source Code Contributions: Please follow the contribution guidelines for Azure open source for instructions about contributing to the source project.
For general suggestions about Azure, use our Azure feedback forum.
Download & Install
Install Dependencies
Windows
On Windows, dependencies are managed by vcpkg. You can reference the Quick Start to quickly set yourself up. After Vcpkg is initialized and bootstrapped, you can install the dependencies:
vcpkg.exe install curl:x64-windows-static
POSIX Platforms
You can use the package manager on different POSIX platforms to install the dependencies. The dependencies to be installed are:
- CMake 3.13.0 or higher.
- libxml2.
- OpenSSL.
- libcurl.
Build from Source
First, download the repository to your local folder:
git clone https://github.com/Azure/azure-sdk-for-cpp.git
Windows
Use CMake to generate the solution file
In a new folder you created under the root directory:
cmake .. -A x64 -DCMAKE_TOOLCHAIN_FILE=<YOUR_VCPKG_INSTALL_DIR>/scripts/buildsystems/vcpkg.cmake
cmake --build .
The built library will be in .\sdk\<ProjectDir>\<Configuration>\ respectively for Azure Core and Azure Storage. e.g. azure_core.lib will be in .\sdk\core\azure-core\Debug for debug configuration.
Use Visual Studio's Open by folder feature
Open the root folder of the library with Visual Studio's Open folder feature.
If Vcpkg is not globally integrated, then you need to open CMakeSettings.json and change the Make toolchain file to be <YOUR_VCPKG_INSTALL_DIR>/scripts/buildsystems/vcpkg.cmake and save.
Then you can build Azure Storage libraries by selecting the target in Visual Studio, or simply build all.
The libraries will be in <ProjectRoot>\out\build\<Configuration>\sdk\<LibraryName> respectively.
POSIX Platforms
You can run the following command in a new folder created under the downloaded code's root folder to build the code.
cmake .. -DCMAKE_BUILD_TYPE=Debug
cmake --build .
Then you can consume the built library with the header files. make/ninja install is work in progress.
Via NuGet
WIP TODO when ready.
Via vcpkg
The easiest way to acquire the C++ SDK is leveraging vcpkg package manager. See the corresponding Azure SDK for C++ readme section.
To install Azure Storage packages via vcpkg:
> vcpkg install azure-storage-blobs-cpp azure-storage-files-datalake-cpp azure-storage-files-shares-cpp
Then, use in your CMake file:
find_package(azure-storage-blobs-cpp CONFIG REQUIRED)
target_link_libraries(<your project name> PRIVATE Azure::azure-storage-blobs)
find_package(azure-storage-files-datalake-cpp CONFIG REQUIRED)
target_link_libraries(<your project name> PRIVATE Azure::azure-storage-files-datalake)
find_package(azure-storage-files-shares-cpp CONFIG REQUIRED)
target_link_libraries(<your project name> PRIVATE Azure::azure-storage-files-shares)
Dependencies
- Azure Core SDK
- libxml2
Code Samples
To get started with the coding, please visit the following code samples: