github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
abc2ec2943
azure-sdk-for-cpp/sdk/core/azure-core
History
JinmingHu dc8c9182e1
fix build error introduced in PR #1297 and #1298 (#1303) 
# Pull Request Checklist

Please leverage this checklist as a reminder to address commonly occurring feedback when submitting a pull request to make sure your PR can be reviewed quickly:

See the detailed list in the [contributing guide](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests).

- [x] [C++ Guidelines](https://azure.github.io/azure-sdk/cpp_introduction.html)
- [x] Doxygen docs
- [x] Unit tests
- [x] No unwanted commits/changes
- [x] Descriptive title/description
  - [x] PR is single purpose
  - [x] Related issue listed
- [x] Comments in source
- [x] No typos
- [x] Update changelog
- [x] Not work-in-progress
- [x] External references or docs updated
- [x] Self review of PR done
- [x] Any breaking changes?
2021-01-11 03:40:48 +00:00
..
inc/azure Add Base64 encoding and decoding utility APIs to the Azure::Core namespace available from azure/core/base64.hpp. (#1297) 2021-01-08 21:20:44 -08:00
src Remove Base64 encode and decode methods from Azure::Storage and move the string-based helper to Internal. Update storage call sites. (#1298) 2021-01-09 08:12:06 +00:00
test/ut Remove Base64 encode and decode methods from Azure::Storage and move the string-based helper to Internal. Update storage call sites. (#1298) 2021-01-09 08:12:06 +00:00
vcpkg Add copyright and license comments to CONTROL files (#1296) 2021-01-08 18:15:42 -08:00
cgmanifest.json Update cg manifest files and move the declaration of the nlohmann json dependency to core. (#1295) 2021-01-08 19:31:15 -08:00
CHANGELOG.md Add Base64 encoding and decoding utility APIs to the Azure::Core namespace available from azure/core/base64.hpp. (#1297) 2021-01-08 21:20:44 -08:00
CMakeLists.txt fix build error introduced in PR #1297 and #1298 (#1303) 2021-01-11 03:40:48 +00:00
LICENSE
NOTICE.txt Update Notice and add cgmanifest.json (#839) 2020-11-18 11:44:22 -08:00
README.md docs for the HTTP transport adapter (#1285) 2021-01-08 16:16:09 -08:00

README.md

Azure SDK Core Library for C++

Azure::Core (azure-core) provides shared primitives, abstractions, and helpers for modern Azure SDK client libraries written in the C++. These libraries follow the Azure SDK Design Guidelines for C++.

The library allows client libraries to expose common functionality in a consistent fashion. Once you learn how to use these APIs in one client library, you will know how to use them in other client libraries.

Getting started

Typically, you will not need to download azure-core; it will be downloaded for you as a dependency of the client libraries. In case you want to download it explicitly (to implement your own client library, for example), you can find the source in here.

Key concepts

The main shared concepts of Azure::Core include:

  • Configuring service cliesnt, e.g. configuring retries, logging, etc.. (ClientOptions)
  • Accessing HTTP response details (Response, Response<T>)
  • Polling long-running operations
  • Exceptions for reporting errors from service requests in a consistent fashion (RequestFailedException)
  • Abstractions for Azure SDK Credentials (TokenCredential)

HTTP Transport adapter

Out of the box, the Azure SDK for C++ supports the libcurl and WinHTTP libraries as HTTP stacks for communicating with Azure services over the network. The SDK also provides a mechanism for customer-implemented HTTP transport adapter.

Troubleshooting

Three main ways of troubleshooting failures are:

  • Inspecting exceptions
  • Enabling logging (Available in future release)
  • Distributed tracing (Available in future release)

Next steps

Explore and install available Azure SDK libraries.

Contributing

For details on contributing to this repository, see the contributing guide.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Additional Helpful Links for Contributors

Many people all over the world have helped make this project better. You'll want to check out:

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

License

Azure SDK for C++ is licensed under the MIT license.