Update links from master to main (#2488)
* Update links from master to main * Upate other references from master to main
This commit is contained in:
Wes Haggard
GitHub
parent
187fc867f4
commit
015c34a029
2
.github/CODEOWNERS
vendored
2
.github/CODEOWNERS
vendored
@ -1,5 +1,5 @@
|
||||
# Instructions for CODEOWNERS file format and automatic build failure notifications:
|
||||
# https://github.com/Azure/azure-sdk/blob/master/docs/policies/opensource.md#codeowners
|
||||
# https://github.com/Azure/azure-sdk/blob/main/docs/policies/opensource.md#codeowners
|
||||
|
||||
###########
|
||||
# SDK
|
||||
|
||||
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
@ -2,7 +2,7 @@
|
||||
|
||||
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).
|
||||
See the detailed list in the [contributing guide](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pull-requests).
|
||||
|
||||
- [ ] [C++ Guidelines](https://azure.github.io/azure-sdk/cpp_introduction.html)
|
||||
- [ ] Doxygen docs
|
||||
|
||||
@ -48,13 +48,13 @@ Codespaces is new technology that allows you to use a container as your developm
|
||||
### GitHub Codespaces
|
||||
|
||||
1. From the Azure SDK GitHub repo, click on the "Code -> Open with Codespaces" button.
|
||||
1. Open a Terminal. The development environment will be ready for you. Continue to [Building and Testing](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#building-and-testing).
|
||||
1. Open a Terminal. The development environment will be ready for you. Continue to [Building and Testing](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#building-and-testing).
|
||||
|
||||
#### VS Code Codespaces
|
||||
|
||||
1. Install the [VS Code Remote Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack)
|
||||
1. When you open the Azure SDK for C++ repo in VS Code, it will prompt you to open the project in the Dev Container. If it does not prompt you, then hit CTRL+P, and select "Remote-Containers: Open Folder in Container..."
|
||||
1. Open a Terminal. The development environment will be ready for you. Continue to [Building and Testing](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#building-and-testing).
|
||||
1. Open a Terminal. The development environment will be ready for you. Continue to [Building and Testing](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#building-and-testing).
|
||||
|
||||
### Full Local Setup
|
||||
|
||||
@ -80,7 +80,7 @@ Follow [vcpkg install guide](https://github.com/microsoft/vcpkg#getting-started)
|
||||
|
||||
When using vcpkg, you can set the `VCPKG_ROOT` environment variable to the vcpkg Git repository folder. This would automatically set the CMake variable `CMAKE_TOOLCHAIN_FILE` for you, enabling the project to use any library installed with vcpkg.
|
||||
|
||||
The Azure SDK for C++ uses [this vcpkg release version](https://github.com/Azure/azure-sdk-for-cpp/blob/master/eng/vcpkg-commit.txt) for continuous integration (CI) building and testing. Make sure to checkout this version when following the next steps for building and running the Azure SDK for C++. Using a newer vcpkg version might still work, however, if it is tested.
|
||||
The Azure SDK for C++ uses [this vcpkg release version](https://github.com/Azure/azure-sdk-for-cpp/blob/main/eng/vcpkg-commit.txt) for continuous integration (CI) building and testing. Make sure to checkout this version when following the next steps for building and running the Azure SDK for C++. Using a newer vcpkg version might still work, however, if it is tested.
|
||||
|
||||
```sh
|
||||
# Checking out vcpkg release version before installing dependencies
|
||||
|
||||
20
README.md
20
README.md
@ -1,6 +1,6 @@
|
||||
# Azure SDK for C++
|
||||
|
||||
[](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1611&branchName=master)
|
||||
[](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1611&branchName=main)
|
||||
|
||||
This repository is for active development of the Azure SDK for C++. For consumers of the SDK we recommend visiting our [developer docs](https://azure.github.io/azure-sdk-for-cpp).
|
||||
|
||||
@ -8,7 +8,7 @@ This repository is for active development of the Azure SDK for C++. For consumer
|
||||
|
||||
For the best development experience, we recommend developers use [CMake projects in Visual Studio](https://docs.microsoft.com/cpp/build/cmake-projects-in-visual-studio?view=vs-2019) to view and build the source code together with its dependencies. You can also use any other text editor of your choice, such as [VS Code](https://code.visualstudio.com/), along with the command line for building your application with the SDK.
|
||||
|
||||
You can find additional information for specific libraries by navigating to the appropriate folder in the `/sdk` directory. See the **README.md** file located in the library's project folder, for example, the [Azure Storage client library](https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/storage#azure-storage-client-library-for-c).
|
||||
You can find additional information for specific libraries by navigating to the appropriate folder in the `/sdk` directory. See the **README.md** file located in the library's project folder, for example, the [Azure Storage client library](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/storage#azure-storage-client-library-for-c).
|
||||
|
||||
For API reference docs, tutorials, samples, quick starts, and other documentation, go to [Azure SDK for C++ Developer Docs](https://azure.github.io/azure-sdk-for-cpp).
|
||||
|
||||
@ -211,7 +211,7 @@ To call Azure services, you must first have an Azure subscription. Sign up for a
|
||||
|
||||
## Packages available
|
||||
|
||||
Each service might have a number of libraries available. These libraries follow the [Azure SDK Design Guidelines for C++](https://azure.github.io/azure-sdk/cpp_introduction.html) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features at [Azure::Core](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/core/azure-core/README.md).
|
||||
Each service might have a number of libraries available. These libraries follow the [Azure SDK Design Guidelines for C++](https://azure.github.io/azure-sdk/cpp_introduction.html) and share a number of core features such as HTTP retries, logging, transport protocols, authentication protocols, etc., so that once you learn how to use these features in one client library, you will know how to use them in other client libraries. You can learn about these shared features at [Azure::Core](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/core/azure-core/README.md).
|
||||
|
||||
The client libraries can be identified by the naming used for their folder, package, and namespace. Each will start with `azure`, followed by the service category, and then the name of the service. For example `azure-storage-blobs`.
|
||||
|
||||
@ -239,18 +239,18 @@ The following SDK library releases are available on [vcpkg](https://github.com/m
|
||||
|
||||
## Navigating the repository
|
||||
|
||||
### Master branch
|
||||
### Main branch
|
||||
|
||||
The master branch has the most recent code with new features and bug fixes. It does **not** represent latest released **beta** or **GA** SDK.
|
||||
The main branch has the most recent code with new features and bug fixes. It does **not** represent latest released **beta** or **GA** SDK.
|
||||
|
||||
### Release branches (Release tagging)
|
||||
|
||||
For each package we release there will be a unique Git tag created that contains the name and the version of the package to mark the commit of the code that produced the package. This tag will be used for servicing via hotfix branches as well as debugging the code for a particular beta or stable release version.
|
||||
Format of the release tags are `<package-name>_<package-version>`. For more information please see [our branching strategy](https://github.com/Azure/azure-sdk/blob/master/docs/policies/repobranching.md#release-tagging).
|
||||
Format of the release tags are `<package-name>_<package-version>`. For more information please see [our branching strategy](https://github.com/Azure/azure-sdk/blob/main/docs/policies/repobranching.md#release-tagging).
|
||||
|
||||
## Contributing
|
||||
|
||||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md).
|
||||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md).
|
||||
|
||||
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, view [Microsoft's CLA](https://cla.microsoft.com).
|
||||
|
||||
@ -263,8 +263,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
||||
Many people all over the world have helped make this project better. You'll want to check out:
|
||||
|
||||
- [What are some good first issues for new contributors to the repo?](https://github.com/azure/azure-sdk-for-cpp/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22)
|
||||
- [How to build and test your change](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#developer-guide)
|
||||
- [How you can make a change happen!](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests)
|
||||
- [How to build and test your change](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#developer-guide)
|
||||
- [How you can make a change happen!](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pull-requests)
|
||||
- Frequently Asked Questions (FAQ) and Conceptual Topics in the detailed [Azure SDK for C++ wiki](https://github.com/azure/azure-sdk-for-cpp/wiki).
|
||||
|
||||
<!-- ### Community-->
|
||||
@ -274,6 +274,6 @@ Security issues and bugs should be reported privately, via email, to the Microso
|
||||
|
||||
### License
|
||||
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/master/LICENSE.txt) license.
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/main/LICENSE.txt) license.
|
||||
|
||||
|
||||
|
||||
@ -35,7 +35,7 @@ For the simplest case, when no specific configuration is set, the default transp
|
||||
|
||||
The Azure SDK for C++ uses CMake options to define what HTTP transport adapters to build.
|
||||
|
||||
You can see [CMake options](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#cmake-build-options) to learn about all the supported options and what is the specific option required for each HTTP transport adapter.
|
||||
You can see [CMake options](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#cmake-build-options) to learn about all the supported options and what is the specific option required for each HTTP transport adapter.
|
||||
|
||||
Multiple HTTP transport adapters can be built as part of the project. This is to support scenarios where you want to send HTTP request with the libcurl transport adapter for some cases and the WinHTTP transport adapter for others.
|
||||
|
||||
@ -70,12 +70,12 @@ The example below shows how to override the default HTTP transport adapter when
|
||||
auto storageClient = BlobServiceClient(url, credential, options);
|
||||
```
|
||||
|
||||
### Re-use the HTTP Transport Adapter
|
||||
### Re-use the HTTP Transport Adapter
|
||||
|
||||
Note that the HTTP transport adapter is a `shared_ptr`. This is because you can re-use the same HTTP transport adapter for multiple clients. There are two ways of doing this. The first one is by using the same HTTP transport adapter when creating another client. The second one is when you get a specific child client from an already created parent client directly, in which case the child client inherits the same options. See the next example:
|
||||
|
||||
```cpp
|
||||
/*
|
||||
/*
|
||||
* Option 1. Init a new client with the same HTTP transport adapter.
|
||||
*/
|
||||
auto curlTransportAdapter = std::make_shared<Azure::Core::Http::CurlTransport>();
|
||||
@ -87,7 +87,7 @@ Note that the HTTP transport adapter is a `shared_ptr`. This is because you can
|
||||
optionsB.TransportOptions.Transport = curlTransportAdapter;
|
||||
auto storageClientB = BlobServiceClient(url, credential, optionsB);
|
||||
|
||||
/*
|
||||
/*
|
||||
* Option 2. Create new client from a parent client.
|
||||
*/
|
||||
auto curlTransportAdapter = std::make_shared<Azure::Core::Http::CurlTransport>();
|
||||
@ -115,7 +115,7 @@ The libcurl and WinHTTP transport adapters can also be initialized with specific
|
||||
auto curlTransportAdapter = std::make_shared<Azure::Core::Http::CurlTransport>(curlTransportOptions);
|
||||
|
||||
BlobClientOptions options;
|
||||
options.TransportOptions.Transport = curlTransportAdapter;
|
||||
options.TransportOptions.Transport = curlTransportAdapter;
|
||||
auto storageClient = BlobServiceClient(url, credential, options);
|
||||
```
|
||||
|
||||
@ -123,7 +123,7 @@ The libcurl and WinHTTP transport adapters can also be initialized with specific
|
||||
|
||||
The Azure SDK for C++ uses CMake options to define what HTTP transport adapters to build.
|
||||
|
||||
You can see [CMake options](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#cmake-build-options) to learn about all the supported options and what is the specific option required to be set when building your own HTTP transport adapter.
|
||||
You can see [CMake options](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#cmake-build-options) to learn about all the supported options and what is the specific option required to be set when building your own HTTP transport adapter.
|
||||
|
||||
Follow these steps to implement your own HTTP transport adapter:
|
||||
|
||||
@ -165,7 +165,7 @@ class CustomHttpTransportAdapterSession {
|
||||
// Keep any state like network/socket handlers here.
|
||||
SomeHttpClientLibraryHandler handler;
|
||||
SomeOtherRequiredState state;
|
||||
|
||||
|
||||
public:
|
||||
// Expose any functionality required. For example, this could
|
||||
// be the main method to produce the HTTP raw response.
|
||||
@ -205,7 +205,7 @@ At this point you have all you need to use your custom HTTP transport adapter. R
|
||||
|
||||
You can optionally set your custom HTTP transport adapter as the default to avoid explicitly setting the option every time you create a new SDK client.
|
||||
|
||||
The first step is to set the required CMake compile option that would configure the build for using a custom HTTP transport adapter. Refer to the [CMake options](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#cmake-build-options) to find out the required option for this.
|
||||
The first step is to set the required CMake compile option that would configure the build for using a custom HTTP transport adapter. Refer to the [CMake options](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#cmake-build-options) to find out the required option for this.
|
||||
|
||||
The second step is to implement the method shown below in the global unnamed namespace.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@ $Language = "cpp"
|
||||
$LanguageDisplayName = "C++"
|
||||
$PackageRepository = "CPP"
|
||||
$packagePattern = "package-info.json"
|
||||
$MetadataUri = "https://raw.githubusercontent.com/Azure/azure-sdk/master/_data/releases/latest/cpp-packages.csv"
|
||||
$MetadataUri = "https://raw.githubusercontent.com/Azure/azure-sdk/main/_data/releases/latest/cpp-packages.csv"
|
||||
$BlobStorageUrl = "https://azuresdkdocs.blob.core.windows.net/%24web?restype=container&comp=list&prefix=cpp%2F&delimiter=%2F"
|
||||
|
||||
$VersionRegex = '(#define AZURE_\w+_VERSION_MAJOR )(?<major>[0-9]+)(\s+#define AZURE_\w+_VERSION_MINOR )(?<minor>[0-9]+)(\s+#define AZURE_\w+_VERSION_PATCH )(?<patch>[0-9]+)(\s+#define AZURE_\w+_VERSION_PRERELEASE )"(?<prerelease>[a-zA-Z0-9.]*)"';
|
||||
|
||||
@ -16,7 +16,7 @@ package_version.hpp
|
||||
New version string to use. Must follow SemVer conventions.
|
||||
|
||||
.DESCRIPTION
|
||||
This script bumps up package versions following conventions defined at https://github.com/Azure/azure-sdk/blob/master/docs/policies/releases.md#incrementing-after-release-cpp
|
||||
This script bumps up package versions following conventions defined at https://github.com/Azure/azure-sdk/blob/main/docs/policies/releases.md#incrementing-after-release-cpp
|
||||
|
||||
|
||||
#>
|
||||
|
||||
@ -19,7 +19,7 @@ The Azure SDK repository is organized in the following folder structure, with th
|
||||
|
||||
## Getting Started (a.k.a. `Hello World`) Samples
|
||||
|
||||
Each package folder contains a package-specific `README.md` file. Most of these `README` files contain `Hello World` code samples illustrating basic usage of the the APIs contained in the package. For example, you can find `Hello World` samples for the `azure-storage-blobs` package [here](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/storage/README.md#code-samples).
|
||||
Each package folder contains a package-specific `README.md` file. Most of these `README` files contain `Hello World` code samples illustrating basic usage of the the APIs contained in the package. For example, you can find `Hello World` samples for the `azure-storage-blobs` package [here](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/storage/README.md#code-samples).
|
||||
|
||||
## Package Samples and How-To Guides
|
||||
|
||||
@ -31,12 +31,12 @@ Simple applications that illustrate the different approaches to integrate the Az
|
||||
|
||||
## Sample Applications
|
||||
|
||||
Sometimes we want to illustrate how several APIs or even packages work together in a context of a more complete program. For these cases, we created sample applications that you can look at, download, compile, and execute. These application samples are located on
|
||||
Sometimes we want to illustrate how several APIs or even packages work together in a context of a more complete program. For these cases, we created sample applications that you can look at, download, compile, and execute. These application samples are located on
|
||||
[https://docs.microsoft.com/samples/](https://docs.microsoft.com/samples/).
|
||||
|
||||
## How-To Guide List
|
||||
|
||||
This section lists how-to guides for the most commonly used APIs and most common scenarios, i.e. this section does not attempt to be a complete directory of guides contained in this repository.
|
||||
This section lists how-to guides for the most commonly used APIs and most common scenarios, i.e. this section does not attempt to be a complete directory of guides contained in this repository.
|
||||
|
||||
#### General How-To Guides
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ This application shows how to integrate the Azure SDK for C++ in your applicatio
|
||||
|
||||
## Pre-requisites
|
||||
|
||||
Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#third-party-dependencies).
|
||||
Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#third-party-dependencies).
|
||||
|
||||
- CMake project (min version 3.13).
|
||||
- C++ version 14 or greater.
|
||||
|
||||
@ -8,7 +8,7 @@ There are two options to set up the development environment:
|
||||
|
||||
### Manual installation
|
||||
|
||||
Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#third-party-dependencies).
|
||||
Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#third-party-dependencies).
|
||||
|
||||
- CMake project (min version 3.13).
|
||||
- C++ version 14 or greater.
|
||||
|
||||
@ -8,7 +8,7 @@ There are two options to set up the development environment:
|
||||
|
||||
### Manual installation
|
||||
|
||||
Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#third-party-dependencies).
|
||||
Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#third-party-dependencies).
|
||||
|
||||
- CMake project (min version 3.13).
|
||||
- C++ version 14 or greater.
|
||||
|
||||
@ -67,7 +67,7 @@ auto finalResult = operation.Value();
|
||||
|
||||
### 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_. [You can learn more about the transport adapter in this doc](https://github.com/Azure/azure-sdk-for-cpp/blob/master/doc/HttpTransportAdapter.md#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_. [You can learn more about the transport adapter in this doc](https://github.com/Azure/azure-sdk-for-cpp/blob/main/doc/HttpTransportAdapter.md#http-transport-adapter).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
@ -114,13 +114,13 @@ Security issues and bugs should be reported privately, via email, to the Microso
|
||||
|
||||
### License
|
||||
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/core/azure-core/LICENSE) license.
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/core/azure-core/LICENSE) license.
|
||||
|
||||
<!-- LINKS -->
|
||||
[azsdk_vcpkg_install]: https://github.com/Azure/azure-sdk-for-cpp#download--install-the-sdk
|
||||
[azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md
|
||||
[azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#developer-guide
|
||||
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests
|
||||
[azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md
|
||||
[azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#developer-guide
|
||||
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pull-requests
|
||||
[azure_sdk_cpp_development_guidelines]: https://azure.github.io/azure-sdk/cpp_introduction.html
|
||||
[azure_cli]: https://docs.microsoft.com/cli/azure
|
||||
[azure_pattern_circuit_breaker]: https://docs.microsoft.com/azure/architecture/patterns/circuit-breaker
|
||||
|
||||
@ -21,7 +21,7 @@ namespace Azure { namespace Core { namespace Diagnostics {
|
||||
* @brief Log message level.
|
||||
*
|
||||
*/
|
||||
// https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core/src/main/java/com/azure/core/util/logging/LogLevel.java
|
||||
// https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core/src/main/java/com/azure/core/util/logging/LogLevel.java
|
||||
enum class Level : int
|
||||
{
|
||||
/// Logging level for detailed troubleshooting scenarios.
|
||||
|
||||
@ -31,7 +31,7 @@
|
||||
* an HTTP transport implementation provided by Azure SDK with custom implementation.
|
||||
*
|
||||
* @note See
|
||||
* https://github.com/Azure/azure-sdk-for-cpp/blob/master/doc/HttpTransportAdapter.md#building-a-custom-http-transport-adapter.
|
||||
* https://github.com/Azure/azure-sdk-for-cpp/blob/main/doc/HttpTransportAdapter.md#building-a-custom-http-transport-adapter.
|
||||
*/
|
||||
extern std::shared_ptr<Azure::Core::Http::HttpTransport> AzureSdkGetCustomHttpTransport();
|
||||
|
||||
@ -132,7 +132,7 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
|
||||
* the libcurl transport adapter and WinHTTP transport adapter on Windows.
|
||||
*
|
||||
* @note See
|
||||
* https://github.com/Azure/azure-sdk-for-cpp/blob/master/doc/HttpTransportAdapter.md.
|
||||
* https://github.com/Azure/azure-sdk-for-cpp/blob/main/doc/HttpTransportAdapter.md.
|
||||
*
|
||||
* @remark When using a custom transport adapter, the implementation for
|
||||
* `::AzureSdkGetCustomHttpTransport()` must be linked in the end-user application.
|
||||
|
||||
@ -55,7 +55,7 @@ Logger::Level const* GetEnvironmentLogLevel()
|
||||
|
||||
// See https://github.com/Azure/azure-sdk-for-java/wiki/Logging-with-Azure-SDK
|
||||
// And
|
||||
// https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core/src/main/java/com/azure/core/util/logging/LogLevel.java
|
||||
// https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core/src/main/java/com/azure/core/util/logging/LogLevel.java
|
||||
|
||||
static Logger::Level envLogLevel = {};
|
||||
envLogLevelPtr = &envLogLevel;
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
* @brief Validates the Azure Core transport adapters with fault responses from server.
|
||||
*
|
||||
* @note This test requires the Http-fault-injector
|
||||
* (https://github.com/Azure/azure-sdk-tools/tree/master/tools/http-fault-injector) running. Follow
|
||||
* (https://github.com/Azure/azure-sdk-tools/tree/main/tools/http-fault-injector) running. Follow
|
||||
* the instructions to install and run the server before running this test.
|
||||
*
|
||||
*/
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
# Azure SDK Perf for C++
|
||||
|
||||
Azure perf for C++ (`azure-perf`) provides shared primitives, abstractions, and helpers for running performance tests for an Azure SDK clients for C++. It represent the C++ version of the [.NET original version](https://github.com/Azure/azure-sdk-for-net/tree/master/common/Perf).
|
||||
Azure perf for C++ (`azure-perf`) provides shared primitives, abstractions, and helpers for running performance tests for an Azure SDK clients for C++. It represent the C++ version of the [.NET original version](https://github.com/Azure/azure-sdk-for-net/tree/main/common/Perf).
|
||||
|
||||
## Getting started
|
||||
|
||||
See the [pre-requisites](https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pre-requisites) for building before going to the next step.
|
||||
See the [pre-requisites](https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pre-requisites) for building before going to the next step.
|
||||
|
||||
### Build
|
||||
|
||||
@ -127,11 +127,11 @@ The main source file defines the list of available tests and calls the performan
|
||||
int main(int argc, char** argv)
|
||||
{
|
||||
|
||||
/**
|
||||
/**
|
||||
* The test list is a dictionary with the name of the test as a key and
|
||||
* an std::function to define how to instantiate a new Test for the PerfTest
|
||||
* interface.
|
||||
*
|
||||
*
|
||||
* In the next example, a map called `tests` is init with two test definitions.
|
||||
*
|
||||
**/
|
||||
@ -142,12 +142,12 @@ int main(int argc, char** argv)
|
||||
tests{
|
||||
{"noOp", // Test Name
|
||||
[](Azure::Perf::TestOptions options) {
|
||||
// No Op test
|
||||
// No Op test
|
||||
return std::make_unique<Azure::Perf::Test::NoOp>(options);
|
||||
}},
|
||||
{"extendedOptions", // Test Name
|
||||
[](Azure::Perf::TestOptions options) {
|
||||
// Extended options test
|
||||
// Extended options test
|
||||
return std::make_unique<Azure::Perf::Test::ExtendedOptionsTest>(options);
|
||||
}}};
|
||||
|
||||
@ -194,7 +194,7 @@ namespace Azure { namespace Perf { namespace Test {
|
||||
// PerfTest constructor.
|
||||
NoOp(Azure::Perf::TestOptions options) : PerfTest(options) {}
|
||||
|
||||
// Override the `Run` method with the test definition
|
||||
// Override the `Run` method with the test definition
|
||||
void Run(Azure::Core::Context const& ctx) override {
|
||||
(void)ctx;
|
||||
}
|
||||
@ -234,7 +234,7 @@ namespace Azure { namespace Perf { namespace Test {
|
||||
// other test (with or without extended options).
|
||||
class ExtendedOptionsTest : public Azure::Perf::PerfTest {
|
||||
public:
|
||||
|
||||
|
||||
ExtendedOptionsTest(Azure::Perf::TestOptions options) : PerfTest(options) {}
|
||||
|
||||
// Override the `GetTestOptions` function to define the unique test options.
|
||||
@ -280,7 +280,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
### Additional Helpful Links for Contributors
|
||||
### Additional Helpful Links for Contributors
|
||||
Many people all over the world have helped make this project better. You'll want to check out:
|
||||
|
||||
* [What are some good first issues for new contributors to the repo?](https://github.com/azure/azure-sdk-for-cpp/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22)
|
||||
@ -294,4 +294,4 @@ Security issues and bugs should be reported privately, via email, to the Microso
|
||||
|
||||
### License
|
||||
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/master/LICENSE.txt) license.
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/main/LICENSE.txt) license.
|
||||
|
||||
@ -25,10 +25,10 @@ target_link_libraries(<your project name> PRIVATE Azure::azure-identity)
|
||||
## Key concepts
|
||||
### Credentials
|
||||
|
||||
A credential is a class which contains or can obtain the data needed for a service client to authenticate requests. Service clients across Azure SDK accept credentials when they are constructed, and service clients use those credentials to authenticate requests to the service.
|
||||
A credential is a class which contains or can obtain the data needed for a service client to authenticate requests. Service clients across Azure SDK accept credentials when they are constructed, and service clients use those credentials to authenticate requests to the service.
|
||||
|
||||
The Azure Identity library focuses on OAuth authentication with Azure Active directory, and it offers a variety of credential classes capable of acquiring an AAD token to authenticate service requests. All of the credential classes in this library are implementations of the `TokenCredential` abstract class in [azure-core][azure_core_library], and any of them can be used by to construct service clients capable of authenticating with a `TokenCredential`.
|
||||
|
||||
The Azure Identity library focuses on OAuth authentication with Azure Active directory, and it offers a variety of credential classes capable of acquiring an AAD token to authenticate service requests. All of the credential classes in this library are implementations of the `TokenCredential` abstract class in [azure-core][azure_core_library], and any of them can be used by to construct service clients capable of authenticating with a `TokenCredential`.
|
||||
|
||||
### Authenticating Service Principals
|
||||
|
||||
<table border="1" width="100%">
|
||||
@ -94,7 +94,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
### Additional Helpful Links for Contributors
|
||||
### Additional Helpful Links for Contributors
|
||||
Many people all over the world have helped make this project better. You'll want to check out:
|
||||
|
||||
* [What are some good first issues for new contributors to the repo?](https://github.com/azure/azure-sdk-for-cpp/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22)
|
||||
@ -109,15 +109,15 @@ Security issues and bugs should be reported privately, via email, to the Microso
|
||||
|
||||
### License
|
||||
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/core/azure-core/LICENSE) license.
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/core/azure-core/LICENSE) license.
|
||||
|
||||
<!-- LINKS -->
|
||||
[azsdk_vcpkg_install]: https://github.com/Azure/azure-sdk-for-cpp#download--install-the-sdk
|
||||
[azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md
|
||||
[azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#developer-guide
|
||||
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests
|
||||
[azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md
|
||||
[azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#developer-guide
|
||||
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pull-requests
|
||||
[azure_sdk_cpp_development_guidelines]: https://azure.github.io/azure-sdk/cpp_introduction.html
|
||||
[source]: https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/identity/azure-identity
|
||||
[source]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/identity/azure-identity
|
||||
[aad_doc]: https://docs.microsoft.com/azure/active-directory/
|
||||
[azure_core_library]: https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/core
|
||||
[azure_core_library]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/core
|
||||
[doxygen]: https://azure.github.io/azure-sdk-for-cpp/
|
||||
|
||||
@ -2,7 +2,6 @@
|
||||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
@ -17,7 +16,6 @@ trigger:
|
||||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
||||
@ -199,8 +199,8 @@ We guarantee that all client instance methods are thread-safe and independent of
|
||||
|
||||
<!-- CLIENT COMMON BAR -->
|
||||
|
||||
[Replaceable HTTP transport adapter](https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/core/azure-core#http-transport-adapter) |
|
||||
[Long-running operations](https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/core/azure-core#long-running-operations) |
|
||||
[Replaceable HTTP transport adapter](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/core/azure-core#http-transport-adapter) |
|
||||
[Long-running operations](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/core/azure-core#long-running-operations) |
|
||||
|
||||
<!-- CLIENT COMMON BAR -->
|
||||
|
||||
@ -445,30 +445,30 @@ For more information see the [Code of Conduct FAQ][coc_faq] or contact opencode@
|
||||
[azsdk_vcpkg_install]: https://github.com/Azure/azure-sdk-for-cpp#download--install-the-sdk
|
||||
[api_reference]: https://docs.microsoft.com/dotnet/api/azure.security.keyvault.keys
|
||||
[azure_cli]: https://docs.microsoft.com/cli/azure
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/identity/azure-identity
|
||||
[azure_identity]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/identity/azure-identity
|
||||
[azure_sub]: https://azure.microsoft.com/free/
|
||||
[backup_and_restore_sample]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/samples/sample2_backup_and_restore.md
|
||||
[backup_and_restore_sample]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/samples/sample2_backup_and_restore.md
|
||||
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
|
||||
[get_keys_sample]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/samples/sample3_get_keys.md
|
||||
[get_keys_sample]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/samples/sample3_get_keys.md
|
||||
|
||||
<!-- [encrypt_decrypt_sample]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample4_EncryptDecrypt.md -->
|
||||
<!-- [sign_verify_sample]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample5_SignVerify.md -->
|
||||
<!-- [wrap_unwrap_sample]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample6_WrapUnwrap.md -->
|
||||
<!-- [encrypt_decrypt_sample]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample4_EncryptDecrypt.md -->
|
||||
<!-- [sign_verify_sample]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample5_SignVerify.md -->
|
||||
<!-- [wrap_unwrap_sample]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/keyvault/Azure.Security.KeyVault.Keys/samples/Sample6_WrapUnwrap.md -->
|
||||
|
||||
[hello_world_sample]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/samples/sample1_hello_world.md
|
||||
[key_client_class]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client.hpp
|
||||
[crypto_client_class]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/src/cryptography/cryptography_client.cpp
|
||||
[hello_world_sample]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/samples/sample1_hello_world.md
|
||||
[key_client_class]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/inc/azure/keyvault/keys/key_client.hpp
|
||||
[crypto_client_class]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/src/cryptography/cryptography_client.cpp
|
||||
[key_client_vcpkg_package]: https://github.com/microsoft/vcpkg/tree/master/ports/azure-security-keyvault-keys-cpp
|
||||
[key_client_samples]: https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/keyvault/azure-security-keyvault-keys/samples
|
||||
[key_client_src]: https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/keyvault/azure-security-keyvault-keys
|
||||
[key_client_samples]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-keys/samples
|
||||
[key_client_src]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/keyvault/azure-security-keyvault-keys
|
||||
[keyvault_docs]: https://docs.microsoft.com/azure/key-vault/
|
||||
[keyvault_rest]: https://docs.microsoft.com/rest/api/keyvault/
|
||||
|
||||
<!-- [secrets_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/keyvault/Azure.Security.KeyVault.Secrets -->
|
||||
<!-- [secrets_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/keyvault/Azure.Security.KeyVault.Secrets -->
|
||||
|
||||
[soft_delete]: https://docs.microsoft.com/azure/key-vault/key-vault-ovw-soft-delete
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/identity/azure-identity#credentials
|
||||
[contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/identity/azure-identity#credentials
|
||||
[contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md
|
||||
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
|
||||
[access_control]: https://docs.microsoft.com/azure/key-vault/managed-hsm/access-control
|
||||
[rbac_guide]: https://docs.microsoft.com/azure/key-vault/general/rbac-guide
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# Creating, getting, updating, and deleting keys
|
||||
|
||||
This sample demonstrates how to create, get, update, and delete a key in Azure Key Vault.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
|
||||
## Creating a KeyClient
|
||||
|
||||
@ -96,6 +96,6 @@ keyClient.PurgeDeletedKey(rsaKeyName);
|
||||
|
||||
## Source
|
||||
|
||||
- [sample1_hello_world.cpp](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/test/samples/sample1-hello-world/sample1_hello_world.cpp)
|
||||
- [sample1_hello_world.cpp](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/test/samples/sample1-hello-world/sample1_hello_world.cpp)
|
||||
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/identity/azure-identity/README.md
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/README.md
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# Back up and restore a key
|
||||
|
||||
This sample demonstrates how to back up and restore a Key from Azure Key Vault.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
|
||||
## Creating a KeyClient
|
||||
|
||||
@ -59,6 +59,6 @@ auto restoredKey = keyClient.RestoreKeyBackup(inMemoryBackup).ExtractValue();
|
||||
|
||||
To see the full example source, see:
|
||||
|
||||
- [sample2_backup_and_restore.cpp](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/test/samples/sample2-backup-and-restore/sample2_backup_and_restore.cpp)
|
||||
- [sample2_backup_and_restore.cpp](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/test/samples/sample2-backup-and-restore/sample2_backup_and_restore.cpp)
|
||||
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/identity/azure-identity/README.md
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/README.md
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# Listing keys, key versions, and deleted keys
|
||||
|
||||
This sample demonstrates how to list keys and versions of a given key, and list deleted keys in a soft delete-enabled Key Vault.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
|
||||
## Creating a KeyClient
|
||||
|
||||
@ -166,6 +166,6 @@ for (auto keysDeletedPage = keyClient.GetDeletedKeys().ExtractValue();;)
|
||||
|
||||
To see the full example source, see:
|
||||
|
||||
- [sample3_get_keys.cpp](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/test/samples/sample3-get-keys/sample3_get_keys.cpp)
|
||||
- [sample3_get_keys.cpp](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/test/samples/sample3-get-keys/sample3_get_keys.cpp)
|
||||
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/identity/azure-identity/README.md
|
||||
[defaultazurecredential]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/identity/azure-identity/README.md
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# Encrypting and decrypt keys
|
||||
|
||||
This sample demonstrates how to encrypt and decrypt a single block of plain text with an RSA key.
|
||||
To get started, you'll need a URL to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
To get started, you'll need a URL to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
|
||||
## Creating a KeyClient
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# Signing and verifying keys
|
||||
|
||||
This sample demonstrates how to sign data with both a RSA key and an EC key.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
To get started, you'll need a URI to an Azure Key Vault. See the [README](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/keyvault/azure-security-keyvault-keys/README.md) for links and instructions.
|
||||
|
||||
## Creating a KeyClient
|
||||
|
||||
|
||||
@ -2,7 +2,6 @@
|
||||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
@ -18,7 +17,6 @@ trigger:
|
||||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
This guide intends to assist customers in migrating from legacy versions of the Azure Storage C++ library for Blobs to version 12.
|
||||
While this guide is generally applicable to older versions of the SDK, it was written with v7.5 in mind as the starting point.
|
||||
It focuses on side-by-side comparisons for similar operations between the [v7.5 package](https://github.com/Azure/azure-storage-cpp) and [v12 package](https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/storage).
|
||||
It focuses on side-by-side comparisons for similar operations between the [v7.5 package](https://github.com/Azure/azure-storage-cpp) and [v12 package](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/storage).
|
||||
Familiarity with the v7.5 client library is assumed. For those new to the Azure Storage Blobs client library for C++, please refer to the [Quickstart](https://docs.microsoft.com/azure/storage/blobs/quickstart-blobs-c-plus-plus) for the v12 library rather than this guide.
|
||||
|
||||
## Table of contents
|
||||
@ -62,7 +62,7 @@ The legacy Storage SDK contained a `bearer_token_credential` class that could be
|
||||
|
||||
v12
|
||||
|
||||
A `TokenCredential` abstract class (different API surface than v7.5) exists in the [Azure Core](https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/core/azure-core) package that all libraries of the new Azure SDK family depend on, and can be used to construct Storage clients. Implementations of this class can be found separately in the [Azure Identity](https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/identity/azure-identity) package.
|
||||
A `TokenCredential` abstract class (different API surface than v7.5) exists in the [Azure Core](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/core/azure-core) package that all libraries of the new Azure SDK family depend on, and can be used to construct Storage clients. Implementations of this class can be found separately in the [Azure Identity](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/identity/azure-identity) package.
|
||||
|
||||
```C++
|
||||
BlobServiceClient serviceClient(serviceUrl, std::make_shared<Azure::Identity::ClientSecretCredential>(tenantId, clientId, clientSecret));
|
||||
@ -139,7 +139,7 @@ If you wish to rotate the key within your `BlobServiceClient` (and any derived c
|
||||
|
||||
The modern SDK has taken a client-based approach. There are no objects designed to be representations of storage resources, but instead clients that act as your mechanism to interact with your storage resources in the cloud. **Clients hold no state of your resources.** (Lease client is an exception.) This is most noticable when looking at [blob metadata](#managing-blob-metadata).
|
||||
|
||||
The hierarchical structure of Azure Blob Storage can be understood by the following diagram:
|
||||
The hierarchical structure of Azure Blob Storage can be understood by the following diagram:
|
||||
|
||||
|
||||
In the interest of simplifying the API surface, v12 uses three top level clients to match this structure that can be used to interact with a majority of your resources: `BlobServiceClient`, `BlobContainerClient`, and `BlobClient`. Note that blob-type-specific operations can still be accessed by their specific clients, as in v7.5.
|
||||
@ -148,7 +148,7 @@ In the interest of simplifying the API surface, v12 uses three top level clients
|
||||
|
||||
Note the absence of a v12 equivalent for v7.5's `cloud_blob_directory`. Directories were an SDK-only concept that did not exist in Azure Blob Storage, and which were not brought forwards into the modern Storage SDK. As shown by the diagram in [Client Structure](#client-structure), containers only contain a flat list of blobs, but those blobs can be named and listed in ways that imply a folder-like structure. See our [Listing Blobs in a Container](#listing-blobs-in-a-container) migration samples later in this guide for more information.
|
||||
|
||||
For those whose workloads revolve around manipulating directories and heavily relied on the leagacy SDKs abstraction of this structure, consider the [pros and cons of enabling hierarchical namespace](https://docs.microsoft.com/azure/storage/blobs/data-lake-storage-namespace) on your storage account, which would allow switching to the [Data Lake Gen 2 SDK](https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/storage/azure-storage-files-datalake), whose migration is not covered in this document.
|
||||
For those whose workloads revolve around manipulating directories and heavily relied on the leagacy SDKs abstraction of this structure, consider the [pros and cons of enabling hierarchical namespace](https://docs.microsoft.com/azure/storage/blobs/data-lake-storage-namespace) on your storage account, which would allow switching to the [Data Lake Gen 2 SDK](https://github.com/Azure/azure-sdk-for-cpp/tree/main/sdk/storage/azure-storage-files-datalake), whose migration is not covered in this document.
|
||||
|
||||
#### Class Conversion Reference
|
||||
|
||||
|
||||
@ -125,15 +125,15 @@ target_link_libraries(<your project name> PRIVATE Azure::azure-storage-files-sha
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [Azure Core SDK](https://github.com/Azure/azure-sdk-for-cpp/blob/master/README.md)
|
||||
- [Azure Core SDK](https://github.com/Azure/azure-sdk-for-cpp/blob/main/README.md)
|
||||
- libxml2
|
||||
|
||||
## Code Samples
|
||||
|
||||
To get started with the coding, please visit the following code samples:
|
||||
- [How to use Blob Storage from C++](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/storage/azure-storage-blobs/sample/blob_getting_started.cpp)
|
||||
- [How to use DataLake Gen 2 Storage from C++](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/storage/azure-storage-files-datalake/sample/datalake_getting_started.cpp)
|
||||
- [How to use File Storage from C++](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/storage/azure-storage-files-shares/sample/file_share_getting_started.cpp)
|
||||
- [How to use Blob Storage from C++](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/storage/azure-storage-blobs/sample/blob_getting_started.cpp)
|
||||
- [How to use DataLake Gen 2 Storage from C++](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/storage/azure-storage-files-datalake/sample/datalake_getting_started.cpp)
|
||||
- [How to use File Storage from C++](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/storage/azure-storage-files-shares/sample/file_share_getting_started.cpp)
|
||||
|
||||
<!-- LINKS -->
|
||||
[azsdk_vcpkg_install]: https://github.com/Azure/azure-sdk-for-cpp#download--install-the-sdk
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
* @brief Validates the Azure Storage blobs SDK client with fault responses from server.
|
||||
*
|
||||
* @note This test requires the Http-fault-injector
|
||||
* (https://github.com/Azure/azure-sdk-tools/tree/master/tools/http-fault-injector) running. Follow
|
||||
* (https://github.com/Azure/azure-sdk-tools/tree/main/tools/http-fault-injector) running. Follow
|
||||
* the instructions to install and run the server before running this test.
|
||||
*
|
||||
*/
|
||||
|
||||
@ -2,7 +2,6 @@
|
||||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
@ -19,7 +18,6 @@ trigger:
|
||||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
||||
@ -6,7 +6,7 @@ The library allows client libraries to expose common functionality in a consiste
|
||||
|
||||
## Getting started
|
||||
|
||||
For a rich example of a well formatted readme, please check [here.](https://github.com/Azure/azure-sdk/blob/master/docs/policies/README-TEMPLATE.md) In addition, this is an [example readme](https://github.com/Azure/azure-sdk/blob/master/docs/policies/README-EXAMPLE.md) that should be emulated. Note that the top-level sections in this template align with that of the [template.](https://github.com/Azure/azure-sdk/blob/master/docs/policies/README-TEMPLATE.md)
|
||||
For a rich example of a well formatted readme, please check [here.](https://github.com/Azure/azure-sdk/blob/main/docs/policies/README-TEMPLATE.md) In addition, this is an [example readme](https://github.com/Azure/azure-sdk/blob/main/docs/policies/README-EXAMPLE.md) that should be emulated. Note that the top-level sections in this template align with that of the [template.](https://github.com/Azure/azure-sdk/blob/main/docs/policies/README-TEMPLATE.md)
|
||||
|
||||
# Key concepts
|
||||
|
||||
@ -39,7 +39,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
### Additional Helpful Links for Contributors
|
||||
### Additional Helpful Links for Contributors
|
||||
Many people all over the world have helped make this project better. You'll want to check out:
|
||||
|
||||
* [What are some good first issues for new contributors to the repo?](https://github.com/azure/azure-sdk-for-cpp/issues?q=is%3Aopen+is%3Aissue+label%3A%22up+for+grabs%22)
|
||||
@ -54,12 +54,12 @@ Security issues and bugs should be reported privately, via email, to the Microso
|
||||
|
||||
### License
|
||||
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/template/azure-template/LICENSE) license.
|
||||
Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/main/sdk/template/azure-template/LICENSE) license.
|
||||
|
||||
<!-- LINKS -->
|
||||
[azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md
|
||||
[azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#developer-guide
|
||||
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests
|
||||
[azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md
|
||||
[azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#developer-guide
|
||||
[azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/main/CONTRIBUTING.md#pull-requests
|
||||
[azure_cli]: https://docs.microsoft.com/cli/azure
|
||||
[azure_pattern_circuit_breaker]: https://docs.microsoft.com/azure/architecture/patterns/circuit-breaker
|
||||
[azure_pattern_retry]: https://docs.microsoft.com/azure/architecture/patterns/retry
|
||||
|
||||
@ -2,7 +2,6 @@
|
||||
trigger:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
@ -18,7 +17,6 @@ trigger:
|
||||
pr:
|
||||
branches:
|
||||
include:
|
||||
- master
|
||||
- main
|
||||
- feature/*
|
||||
- release/*
|
||||
|
||||
Loading…
Reference in New Issue
Block a user