Update upper/lower/other casing (#2267)
Co-authored-by: Anton Kolesnyk <antkmsft@users.noreply.github.com>
This commit is contained in:
Anton Kolesnyk
GitHub
Родитель
00c47e8ec3
Коммит
efe4772acb
|
|
@ -25,7 +25,7 @@ RUN apt-get update \
|
|||
openssh-client \
|
||||
less \
|
||||
#
|
||||
# Azure sdk for C++ dev env
|
||||
# Azure SDK for C++ dev env
|
||||
make \
|
||||
cmake \
|
||||
build-essential \
|
||||
|
|
|
|||
|
|
@ -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 continuos 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/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.
|
||||
|
||||
```sh
|
||||
# Checking out vcpkg release version before installing dependencies
|
||||
|
|
@ -90,7 +90,7 @@ cd vcpkg
|
|||
# Checkout the vcpkg commit from the vcpkg-commit.txt file (link above)
|
||||
git checkout <vcpkg commit>
|
||||
|
||||
# build vcpkg (showing linux command, see vcpkg getting started for windows)
|
||||
# build vcpkg (showing Linux command, see vcpkg getting started for Windows)
|
||||
./bootstrap-vcpkg.sh
|
||||
./vcpkg install curl libxml2
|
||||
```
|
||||
|
|
@ -144,7 +144,7 @@ The following CMake options are available for adding/removing project features.
|
|||
</tr>
|
||||
<tr>
|
||||
<td>RUN_LONG_UNIT_TESTS</td>
|
||||
<td>Enables the special unit tests which takes more than 3 minutes to run. THis tests are for some specific features like the connection pool for curl transport adapter.</td>
|
||||
<td>Enables the special unit tests which takes more than 3 minutes to run. These tests are for some specific features like the connection pool for libcurl transport adapter.</td>
|
||||
<td>OFF</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -154,7 +154,7 @@ The following CMake options are available for adding/removing project features.
|
|||
</tr>
|
||||
<tr>
|
||||
<td>BUILD_TRANSPORT_CURL</td>
|
||||
<td>Build the curl http transport adapter. When building on Posix systems, if no other transport adapter is built, this option will be automatically turned ON</td>
|
||||
<td>Build the libcurl HTTP transport adapter. When building on POSIX systems, if no other transport adapter is built, this option will be automatically turned ON</td>
|
||||
<td>OFF</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -191,7 +191,7 @@ ctest -V
|
|||
# Use -N to list test that are part of test set
|
||||
ctest -N
|
||||
# Use -R to use a regular exp for what to run
|
||||
ctest -R Http # runs only Http tests
|
||||
ctest -R Http # runs only HTTP tests
|
||||
```
|
||||
|
||||
#### Generating Code Coverage reports
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@ Here's an example application to help you get started:
|
|||
|
||||
using namespace Azure::Storage::Blobs;
|
||||
|
||||
// Get the required connection string/key from an environment variable or Azure KeyVault.
|
||||
// Get the required connection string/key from an environment variable or Azure Key Vault.
|
||||
std::string GetConnectionString();
|
||||
|
||||
int main()
|
||||
|
|
@ -154,7 +154,7 @@ The following SDK library releases are available on [vcpkg](https://github.com/m
|
|||
|
||||
- For reference documentation visit the [Azure SDK for C++ documentation](https://azure.github.io/azure-sdk-for-cpp).
|
||||
- For tutorials, samples, quick starts and other documentation, visit [Azure for C++ Developers](https://docs.microsoft.com/azure/).
|
||||
- File an issue via [Github Issues](https://github.com/Azure/azure-sdk-for-cpp/issues/new/choose).
|
||||
- File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-cpp/issues/new/choose).
|
||||
|
||||
## Navigating the repository
|
||||
|
||||
|
|
@ -164,7 +164,7 @@ The master branch has the most recent code with new features and bug fixes. It d
|
|||
|
||||
### 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.
|
||||
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).
|
||||
|
||||
## Contributing
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
## Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
## SPDX-License-Identifier: MIT
|
||||
|
||||
############# TRANSPORT ADAPTER BUILD #####################
|
||||
# Default: If no option is explicitly added, curl will be used for POSIX and WIN HTTP for Windows #
|
||||
# Windows: Both CURL and WIN_HTTP can be built to be used. #
|
||||
# POSIX: Only CURL is acceptable. If WIN_HTTP is set, generate step will fail for user #
|
||||
############## TRANSPORT ADAPTER BUILD ######################
|
||||
# Default: If no option is explicitly added, libcurl will be used for POSIX and WinHTTP for Windows #
|
||||
# Windows: Both CURL and WINHTTP can be built to be used. #
|
||||
# POSIX: Only CURL is acceptable. If WINHTTP is set, generate step will fail for user #
|
||||
|
||||
if (BUILD_TRANSPORT_CUSTOM)
|
||||
message("Using the user-defined transport adapter. Make sure `AzureSdkGetCustomHttpTransport` is implemented and linked.")
|
||||
|
|
@ -14,7 +14,7 @@ endif()
|
|||
# Defines `BUILD_TRANSPORT_WINHTTP_ADAPTER` and `BUILD_CURL_HTTP_TRANSPORT_ADAPTER` for source code
|
||||
|
||||
# On Windows: Make sure to build WinHTTP either if it was user-requested or no transport was selected at all.
|
||||
# On Unix: Make sure to build Curl either if it was user-requested or no transport was selected at all.
|
||||
# On POSIX: Make sure to build Curl either if it was user-requested or no transport was selected at all.
|
||||
if (WIN32 OR MINGW OR MSYS OR CYGWIN)
|
||||
if (BUILD_TRANSPORT_CURL)
|
||||
add_compile_definitions(BUILD_CURL_HTTP_TRANSPORT_ADAPTER)
|
||||
|
|
@ -28,10 +28,10 @@ if (WIN32 OR MINGW OR MSYS OR CYGWIN)
|
|||
endif()
|
||||
elseif (UNIX)
|
||||
if (BUILD_TRANSPORT_WINHTTP)
|
||||
message(FATAL_ERROR "WinHTTP transport adapter is not supported for Unix platforms.")
|
||||
message(FATAL_ERROR "WinHTTP transport adapter is not supported for POSIX platforms.")
|
||||
endif()
|
||||
if (BUILD_TRANSPORT_CURL OR (NOT BUILD_TRANSPORT_CUSTOM))
|
||||
message("By default, if no option is selected, on Unix, CURL transport adapter is used.")
|
||||
message("By default, if no option is selected, on POSIX, libcurl transport adapter is used.")
|
||||
add_compile_definitions(BUILD_CURL_HTTP_TRANSPORT_ADAPTER)
|
||||
if(AZ_ALL_LIBRARIES)
|
||||
SET(BUILD_TRANSPORT_CURL ON)
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
set(AZ_ROOT_DIR "${CMAKE_CURRENT_LIST_DIR}/..")
|
||||
|
||||
macro(az_vcpkg_integrate)
|
||||
# VCPKG Integration
|
||||
# vcpkg Integration
|
||||
if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
|
||||
set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "")
|
||||
|
|
@ -42,7 +42,7 @@ macro(az_vcpkg_portfile_prep targetName fileName contentToRemove)
|
|||
file (WRITE "${CMAKE_BINARY_DIR}/vcpkg_prep/${targetName}/${fileName}" ${fileContents})
|
||||
unset(fileContents)
|
||||
|
||||
# Produce the files to help with the VcPkg release.
|
||||
# Produce the files to help with the vcpkg release.
|
||||
# Go to the /out/build/<cfg>/vcpkg directory, and copy (merge) "ports" folder to the vcpkg repo.
|
||||
# Then, update the portfile.cmake file SHA512 from "1" to the actual hash (a good way to do it is to uninstall a package,
|
||||
# clean vcpkg/downloads, vcpkg/buildtrees, run "vcpkg install <pkg>", and get the SHA from the error message).
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The Azure SDK for C++ provides two HTTP transport adapters as part of the azure-
|
|||
| --- |
|
||||
| Linux |
|
||||
| Windows |
|
||||
| MacOS |
|
||||
| macOS |
|
||||
|
||||
</center>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Libcurl Transport Adapter
|
||||
|
||||
The Azure SDK for C++ provides an http transport adapter implementation using the well known libcurl library. There are some general guidelines that you should know if you decide to use this implementation.
|
||||
The Azure SDK for C++ provides an HTTP transport adapter implementation using the well known libcurl library. There are some general guidelines that you should know if you decide to use this implementation.
|
||||
|
||||
## Global init and clean up
|
||||
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ auto operationResult = client.StartLongRunningOperation(...);
|
|||
|
||||
while (true)
|
||||
{
|
||||
// Get a read-only ref to the Http raw response after polling. Poll will update the status.
|
||||
// Get a read-only ref to the HTTP raw response after polling. Poll will update the status.
|
||||
auto& response = operationResult.Poll();
|
||||
|
||||
if(operationResult.IsDone()) {
|
||||
|
|
@ -74,7 +74,7 @@ while (true)
|
|||
break;
|
||||
}
|
||||
|
||||
// Read the http headers in the response
|
||||
// Read the HTTP headers in the response
|
||||
for (auto& header : response.GetHeaders()) {
|
||||
// ... consumer-code
|
||||
}
|
||||
|
|
@ -93,11 +93,11 @@ auto valueT = operationResult.Value();
|
|||
|
||||
## Operation\<T> lifetime
|
||||
|
||||
The `Operation<T>` holds an Http raw response. Each Operation\<T> derived class defines the moment when the Http raw response is moved to the Operation. This means that an Operation can be created without initially holding an Http raw response. In this case, calling `GetRawResponse` method from the Operation will `throw` as no http raw response has been set for it yet.
|
||||
The `Operation<T>` holds an HTTP raw response. Each Operation\<T> derived class defines the moment when the HTTP raw response is moved to the Operation. This means that an Operation can be created without initially holding an HTTP raw response. In this case, calling `GetRawResponse` method from the Operation will `throw` as no HTTP raw response has been set for it yet.
|
||||
|
||||
The concrete Operation class defines since when the `GetRawResponse` can be called, we need to review each derived class to know at what time it is valid or not to call `GetRawResponse`.
|
||||
|
||||
The code below show two examples of Operation derive classes. The first one requires an http raw response to be created, ensuring that `GetRawResponse` can be called at any moment after the Operation is created. The second class does not set an http raw response when it is init, which means that `GetRawResponse` can only be called after calling `Poll`, otherwise it will throw.
|
||||
The code below show two examples of Operation derive classes. The first one requires an HTTP raw response to be created, ensuring that `GetRawResponse` can be called at any moment after the Operation is created. The second class does not set an HTTP raw response when it is init, which means that `GetRawResponse` can only be called after calling `Poll`, otherwise it will throw.
|
||||
|
||||
```cpp
|
||||
/**
|
||||
|
|
@ -105,30 +105,30 @@ The code below show two examples of Operation derive classes. The first one requ
|
|||
*
|
||||
*/
|
||||
|
||||
// The operation can only be constructed based on an http raw response.
|
||||
// The operation can only be constructed based on an HTTP raw response.
|
||||
class OperationA : public Azure::Core::Operation<Model> {
|
||||
public:
|
||||
OperationA(Azure::Core::Http::RawResponse rawResponse);
|
||||
};
|
||||
|
||||
// This operation can be created with empty http raw response.
|
||||
// This operation can be created with empty HTTP raw response.
|
||||
class OperationB : public Azure::Core::Operation<Model> {
|
||||
public:
|
||||
OperationB();
|
||||
};
|
||||
|
||||
void main() {
|
||||
// Getting the Http raw response from OperationA is safe all the time.
|
||||
// Getting the HTTP raw response from OperationA is safe all the time.
|
||||
OperationA operationA(Azure::Core::Http::RawResponse(...));
|
||||
auto& httpRawResponse = operationA.GetRawResponse();
|
||||
|
||||
// But operationB will throw
|
||||
OperationB operationB();
|
||||
// will throw, http raw response not yet set.
|
||||
// will throw, HTTP raw response not yet set.
|
||||
auto& httpRawResponse = operationB.GetRawResponse();
|
||||
}
|
||||
```
|
||||
|
||||
The reason why the Operation\<T> is not asking all derived classes to be init based on an Http raw response is by design to allow each concrete operation to define its behavior up to the first `Poll()` call.
|
||||
The reason why the Operation\<T> is not asking all derived classes to be init based on an HTTP raw response is by design to allow each concrete operation to define its behavior up to the first `Poll()` call.
|
||||
|
||||
The Operation\<T> will maintain the ownership of the Http raw response and the value (once created). This means that `Extract` is not supported by the operation and calling `GetRawResponse()` and `Value()` will return read-only reference to its internal members.
|
||||
The Operation\<T> will maintain the ownership of the HTTP raw response and the value (once created). This means that `Extract` is not supported by the operation and calling `GetRawResponse()` and `Value()` will return read-only reference to its internal members.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED True)
|
|||
#
|
||||
include(FetchContent)
|
||||
FetchContent_Declare(azuresdkforcpp
|
||||
# Set the SDK url path and release TAG
|
||||
# Set the SDK URL path and release tag
|
||||
GIT_REPOSITORY https://github.com/Azure/azure-sdk-for-cpp.git
|
||||
GIT_TAG azure-storage-files-datalake_12.0.0-beta.6)
|
||||
FetchContent_GetProperties(azuresdkforcpp)
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ mkdir build
|
|||
cd build
|
||||
|
||||
# Generate and build
|
||||
# This code assumes that the SDK dependencies were installed with VCPKG
|
||||
# This code assumes that the SDK dependencies were installed with vcpkg
|
||||
cmake -DCMAKE_TOOLCHAIN_FILE=path/to/vcpkg/scripts/buildsystems/vcpkg.cmake ..
|
||||
cmake -build .
|
||||
```
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ int main(int argc, char* argv[])
|
|||
(void)argc;
|
||||
(void)argv;
|
||||
|
||||
/**************** Container sdk client ************************/
|
||||
/**************** Container SDK client ************************/
|
||||
/**************** Create container ************************/
|
||||
try
|
||||
{
|
||||
|
|
@ -30,8 +30,8 @@ int main(int argc, char* argv[])
|
|||
|
||||
containerClient.CreateIfNotExists();
|
||||
|
||||
/**************** Container sdk client ************************/
|
||||
/**************** list Blobs (one page) ******************/
|
||||
/**************** Container SDK client ************************/
|
||||
/**************** list blobs (one page) ******************/
|
||||
auto response = containerClient.ListBlobsSinglePage();
|
||||
auto blobListPage = response.Value;
|
||||
for (auto blob : blobListPage.Items)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
# VCPKG integration.
|
||||
# vcpkg integration.
|
||||
if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
|
||||
set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "")
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Integrating the Azure SDK for C++ into your application using VCPKG
|
||||
# Integrating the Azure SDK for C++ into your application using vcpkg
|
||||
|
||||
This application shows how to integrate the Azure SDK for C++ in your application. It uses VCPKG to adquire and build the Azure SDK for C++ client libraries. Your CMake project needs to link the libraries from VCPKG by setting the toolchain file to VCPKG (shown below).
|
||||
This application shows how to integrate the Azure SDK for C++ in your application. It uses vcpkg to adquire and build the Azure SDK for C++ client libraries. Your CMake project needs to link the libraries from vcpkg by setting the toolchain file to vcpkg (shown below).
|
||||
|
||||
## Pre-requisites
|
||||
|
||||
|
|
@ -15,17 +15,17 @@ Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-
|
|||
|
||||
### Container
|
||||
|
||||
The sample provides a .devcontainer folder which can be used by VSCode to build and run a docker container with the required C++ build tools and with VCPKG installed.
|
||||
The sample provides a .devcontainer folder which can be used by VS Code to build and run a docker container with the required C++ build tools and with vcpkg installed.
|
||||
|
||||
This method requires VSCode + [Remote Container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to be installed in the system. Also make sure to have Docker installed and running. This method works for any operating system where Docker and VSCode is supported like Windows, Linux and MacOS. The development environment will be Linux debian 10.
|
||||
This method requires VS Code + [Remote Container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to be installed in the system. Also make sure to have Docker installed and running. This method works for any operating system where Docker and VSCode is supported like Windows, Linux and macOS. The development environment will be Debian 10.
|
||||
|
||||
- Open vcpkg folder in VSCode.
|
||||
- VSCode will detect the `devcontainer` configuration and ask you if you would like to re-open the folder in a container. Click Yes.
|
||||
- If VSCode did not ask, you can press F1 and type `Reopen in container` option.
|
||||
- Open vcpkg folder in VS Code.
|
||||
- VS Code will detect the `devcontainer` configuration and ask you if you would like to re-open the folder in a container. Click Yes.
|
||||
- If VS Code did not ask, you can press F1 and type `Reopen in container` option.
|
||||
|
||||
Once VSCode builds and run the container, open the terminal and continue to build step.
|
||||
Once VS Code builds and run the container, open the terminal and continue to build step.
|
||||
|
||||
> Note: The container is set up to automatically link VCPKG to CMake projects by setting env variables that the CMake sample project will use to set the toolchain.
|
||||
> Note: The container is set up to automatically link vcpkg to CMake projects by setting env variables that the CMake sample project will use to set the toolchain.
|
||||
|
||||
## Build
|
||||
|
||||
|
|
@ -42,7 +42,7 @@ mkdir build
|
|||
cd build
|
||||
|
||||
# Generate and build
|
||||
# This code assumes that the SDK dependencies were installed with VCPKG
|
||||
# This code assumes that the SDK dependencies were installed with vcpkg
|
||||
# When using docker provided container, the TOOLCHAIN option is not required (cmake ..).
|
||||
cmake -DCMAKE_TOOLCHAIN_FILE=path/to/vcpkg/scripts/buildsystems/vcpkg.cmake ..
|
||||
cmake -build .
|
||||
|
|
@ -50,7 +50,7 @@ cmake -build .
|
|||
|
||||
### Windows VS
|
||||
|
||||
If you are using Visual Studio, the toolchain to link VCPKG is set with `CMakeSettings.json`. Upate this file and set the VCPKG toolchain file for VCPKG (VCPKG_ROO\scripts\buildsystems\vcpkg.cmake). After setting the toolchain, VS can generate and build the sample. Use VS to open the sample folder only.
|
||||
If you are using Visual Studio, the toolchain to link vcpkg is set with `CMakeSettings.json`. Upate this file and set the vcpkg toolchain file for vcpkg (VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake). After setting the toolchain, VS can generate and build the sample. Use VS to open the sample folder only.
|
||||
|
||||
## Run application
|
||||
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@
|
|||
* to create, get, update, delete and purge a key.
|
||||
*
|
||||
* @remark The following environment variables must be set before running the sample.
|
||||
* - AZURE_KEYVAULT_URL: To the KeyVault account url.
|
||||
* - AZURE_TENANT_ID: Tenant id for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The client id to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The secret id from the client id.
|
||||
* - AZURE_KEYVAULT_URL: To the Key Vault account URL.
|
||||
* - AZURE_TENANT_ID: Tenant ID for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The Client ID to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The client secret.
|
||||
*
|
||||
*/
|
||||
#include <azure/core.hpp>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
# SPDX-License-Identifier: MIT
|
||||
|
||||
# VCPKG integration.
|
||||
# vcpkg integration.
|
||||
if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
|
||||
set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "")
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Integrating the Azure SDK for C++ into your application using VCPKG
|
||||
# Integrating the Azure SDK for C++ into your application using vcpkg
|
||||
|
||||
This application shows how to integrate the Azure SDK for C++ in your application. It uses VCPKG to adquire and build the Azure SDK for C++ client libraries. Your CMake project needs to link the libraries from VCPKG by setting the toolchain file to VCPKG (shown below).
|
||||
This application shows how to integrate the Azure SDK for C++ in your application. It uses vcpkg to adquire and build the Azure SDK for C++ client libraries. Your CMake project needs to link the libraries from vcpkg by setting the toolchain file to vcpkg (shown below).
|
||||
|
||||
## Pre-requisites
|
||||
|
||||
|
|
@ -15,17 +15,17 @@ Install the [Azure SDK for C++ dependencies](https://github.com/Azure/azure-sdk-
|
|||
|
||||
### Container
|
||||
|
||||
The sample provides a .devcontainer folder which can be used by VSCode to build and run a docker container with the required C++ build tools and with VCPKG installed.
|
||||
The sample provides a .devcontainer folder which can be used by VS Code to build and run a docker container with the required C++ build tools and with vcpkg installed.
|
||||
|
||||
This method requires VSCode + [Remote Container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to be installed in the system. Also make sure to have Docker installed and running. This method works for any operating system where Docker and VSCode is supported like Windows, Linux and MacOS. The development environment will be Linux debian 10.
|
||||
This method requires VS Code + [Remote Container](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to be installed in the system. Also make sure to have Docker installed and running. This method works for any operating system where Docker and VS Code is supported like Windows, Linux and macOS. The development environment will be Debian 10.
|
||||
|
||||
- Open vcpkg folder in VSCode.
|
||||
- VSCode will detect the `devcontainer` configuration and ask you if you would like to re-open the folder in a container. Click Yes.
|
||||
- If VSCode did not ask, you can press F1 and type `Reopen in container` option.
|
||||
- Open vcpkg folder in VS Code.
|
||||
- VS Code will detect the `devcontainer` configuration and ask you if you would like to re-open the folder in a container. Click Yes.
|
||||
- If VS Code did not ask, you can press F1 and type `Reopen in container` option.
|
||||
|
||||
Once VSCode builds and run the container, open the terminal and continue to build step.
|
||||
Once VS Code builds and run the container, open the terminal and continue to build step.
|
||||
|
||||
> Note: The container is set up to automatically link VCPKG to CMake projects by setting env variables that the CMake sample project will use to set the toolchain.
|
||||
> Note: The container is set up to automatically link vcpkg to CMake projects by setting env variables that the CMake sample project will use to set the toolchain.
|
||||
|
||||
## Build
|
||||
|
||||
|
|
@ -42,7 +42,7 @@ mkdir build
|
|||
cd build
|
||||
|
||||
# Generate and build
|
||||
# This code assumes that the SDK dependencies were installed with VCPKG
|
||||
# This code assumes that the SDK dependencies were installed with vcpkg
|
||||
# When using docker provided container, the TOOLCHAIN option is not required (cmake ..).
|
||||
cmake -DCMAKE_TOOLCHAIN_FILE=path/to/vcpkg/scripts/buildsystems/vcpkg.cmake ..
|
||||
cmake -build .
|
||||
|
|
@ -50,7 +50,7 @@ cmake -build .
|
|||
|
||||
### Windows VS
|
||||
|
||||
If you are using Visual Studio, the toolchain to link VCPKG is set with `CMakeSettings.json`. Upate this file and set the VCPKG toolchain file for VCPKG (VCPKG_ROO\scripts\buildsystems\vcpkg.cmake). After setting the toolchain, VS can generate and build the sample. Use VS to open the sample folder only.
|
||||
If you are using Visual Studio, the toolchain to link vcpkg is set with `CMakeSettings.json`. Upate this file and set the vcpkg toolchain file for vcpkg (VCPKG_ROOT\scripts\buildsystems\vcpkg.cmake). After setting the toolchain, VS can generate and build the sample. Use VS to open the sample folder only.
|
||||
|
||||
## Run application
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@
|
|||
// is being built as a DLL, AZ_xxx_DLL is defined. It is also being propagated to any code that
|
||||
// consumes Azure SDK code via CMake, i.e. anything in the build tree of the Azure SDK when building
|
||||
// the entire SDK, OR if a customer code consumes SDK via fetchcontent. In case that the SDK is
|
||||
// being distributed as a package, i.e. VcPkg, the install step (defined in az_vcpkg_export()) will
|
||||
// being distributed as a package, i.e. vcpkg, the install step (defined in az_vcpkg_export()) will
|
||||
// take care of patching the installed header to carry the knowledge that the library was built as
|
||||
// DLL (and if it was built as both static and dynamic library, there will be no collision because
|
||||
// each installation has its own header installation directory).
|
||||
|
|
|
|||
|
|
@ -24,43 +24,43 @@ namespace Azure { namespace Core {
|
|||
class RequestFailedException : public std::runtime_error {
|
||||
public:
|
||||
/**
|
||||
* @brief The Http response code.
|
||||
* @brief The HTTP response code.
|
||||
*
|
||||
*/
|
||||
Azure::Core::Http::HttpStatusCode StatusCode = Azure::Core::Http::HttpStatusCode::None;
|
||||
|
||||
/**
|
||||
* @brief The Http reason phrase from the response.
|
||||
* @brief The HTTP reason phrase from the response.
|
||||
*
|
||||
*/
|
||||
std::string ReasonPhrase;
|
||||
|
||||
/**
|
||||
* @brief The client request header from the Http response.
|
||||
* @brief The client request header from the HTTP response.
|
||||
*
|
||||
*/
|
||||
std::string ClientRequestId;
|
||||
|
||||
/**
|
||||
* @brief The request id header from the Http response.
|
||||
* @brief The request ID header from the HTTP response.
|
||||
*
|
||||
*/
|
||||
std::string RequestId;
|
||||
|
||||
/**
|
||||
* @brief The error code from service returned in the Http response.
|
||||
* @brief The error code from service returned in the HTTP response.
|
||||
*
|
||||
*/
|
||||
std::string ErrorCode;
|
||||
|
||||
/**
|
||||
* @brief The error message from the service returned in the Http response.
|
||||
* @brief The error message from the service returned in the HTTP response.
|
||||
*
|
||||
*/
|
||||
std::string Message;
|
||||
|
||||
/**
|
||||
* @brief The entire Http raw response.
|
||||
* @brief The entire HTTP raw response.
|
||||
*
|
||||
*/
|
||||
std::unique_ptr<Azure::Core::Http::RawResponse> RawResponse;
|
||||
|
|
@ -68,7 +68,7 @@ namespace Azure { namespace Core {
|
|||
/**
|
||||
* @brief Construct a new Request Failed Exception object.
|
||||
*
|
||||
* @remark An Exception without an Http raw response represent an exception happend
|
||||
* @remark An Exception without an HTTP raw response represent an exception happend
|
||||
* before sending the request to the server. There is no response yet.
|
||||
*
|
||||
* @param message The error description.
|
||||
|
|
@ -79,15 +79,15 @@ namespace Azure { namespace Core {
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Construct a new Request Failed Exception object with an Http raw response.
|
||||
* @brief Construct a new Request Failed Exception object with an HTTP raw response.
|
||||
*
|
||||
* @remark The Http raw response is parsed to get the always expected information for all Azure
|
||||
* Services like the status code, reason phrase and some headers like the request id. A concrete
|
||||
* Service exception which derives from this exception uses its constructor to parse the Http
|
||||
* @remark The HTTP raw response is parsed to get the always expected information for all Azure
|
||||
* Services like the status code, reason phrase and some headers like the request ID. A concrete
|
||||
* Service exception which derives from this exception uses its constructor to parse the HTTP
|
||||
* raw response and assing the service specific values to the exception.
|
||||
*
|
||||
* @param message The error description.
|
||||
* @param rawResponse The Http raw response from the service.
|
||||
* @param rawResponse The HTTP raw response from the service.
|
||||
*/
|
||||
explicit RequestFailedException(
|
||||
const std::string& message,
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@
|
|||
namespace Azure { namespace Core { namespace Http {
|
||||
|
||||
/**
|
||||
* @brief The available options to set libcurl ssl options.
|
||||
* @brief The available options to set libcurl SSL options.
|
||||
*
|
||||
* @remark The SDK will map the enum option to libcurl's specific option. See more info here:
|
||||
* https://curl.haxx.se/libcurl/c/CURLOPT_SSL_OPTIONS.html
|
||||
|
|
@ -26,7 +26,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
/**
|
||||
* @brief This option can enable the revocation list check.
|
||||
*
|
||||
* @remark Libcurl does revocation list check by default for ssl backends that supports this
|
||||
* @remark Libcurl does revocation list check by default for SSL backends that supports this
|
||||
* feature. However, the Azure SDK overrides libcurl's behavior and disables the revocation list
|
||||
* check by default.
|
||||
*
|
||||
|
|
@ -35,7 +35,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
};
|
||||
|
||||
/**
|
||||
* @brief Set the curl connection options like a proxy and CA path.
|
||||
* @brief Set the libcurl connection options like a proxy and CA path.
|
||||
*
|
||||
*/
|
||||
struct CurlTransportOptions final
|
||||
|
|
@ -72,7 +72,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
*/
|
||||
bool HttpKeepAlive = true;
|
||||
/**
|
||||
* @brief This option determines whether curl verifies the authenticity of the peer's
|
||||
* @brief This option determines whether libcurl verifies the authenticity of the peer's
|
||||
* certificate.
|
||||
*
|
||||
* @remark The default value is `true`. More about this option:
|
||||
|
|
@ -101,7 +101,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
|
||||
public:
|
||||
/**
|
||||
* @brief Construct a new Curl Transport object.
|
||||
* @brief Construct a new CurlTransport object.
|
||||
*
|
||||
* @param options Optional parameter to override the default options.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ namespace Azure { namespace Core { namespace Http { namespace Policies {
|
|||
* and receive requests and responses over the wire.
|
||||
*
|
||||
* @remark When no option is set, the default transport adapter on non-Windows platforms is
|
||||
* the curl transport adapter and winhttp transport adapter on Windows.
|
||||
* the libcurl transport adapter and WinHTTP transport adapter on Windows.
|
||||
*
|
||||
* @remark When using a custom transport adapter, the implementation for
|
||||
* `AzureSdkGetCustomHttpTransport` must be linked in the end-user application.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
/**
|
||||
* @file
|
||||
* @brief Define the Http raw response.
|
||||
* @brief Define the HTTP raw response.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
|
@ -108,7 +108,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
*/
|
||||
void SetBody(std::vector<uint8_t> body) { this->m_body = std::move(body); }
|
||||
|
||||
// adding getters for version and stream body. Clang will complain on Mac if we have unused
|
||||
// adding getters for version and stream body. Clang will complain on macOS if we have unused
|
||||
// fields in a class
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
};
|
||||
|
||||
/**
|
||||
* @brief Concrete implementation of an HTTP transport that uses WinHttp when sending and
|
||||
* @brief Concrete implementation of an HTTP transport that uses WinHTTP when sending and
|
||||
* receiving requests and responses over the wire.
|
||||
*
|
||||
*/
|
||||
|
|
@ -157,7 +157,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
|
||||
public:
|
||||
/**
|
||||
* @brief Construct a new WinHttp Transport object.
|
||||
* @brief Construct a new WinHTTP Transport object.
|
||||
*
|
||||
* @param options Optional parameter to override the default settings.
|
||||
*/
|
||||
|
|
@ -167,7 +167,7 @@ namespace Azure { namespace Core { namespace Http {
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Implements the Http transport interface to send an HTTP Request and produce an HTTP
|
||||
* @brief Implements the HTTP transport interface to send an HTTP Request and produce an HTTP
|
||||
* RawResponse.
|
||||
*
|
||||
* @param context #Azure::Core::Context so that operation can be cancelled.
|
||||
|
|
|
|||
|
|
@ -31,13 +31,13 @@ namespace Azure { namespace Core { namespace _internal {
|
|||
virtual ~ClientOptions() = default;
|
||||
|
||||
/**
|
||||
* @brief Define policies to be called one time for every Http request from an sdk client.
|
||||
* @brief Define policies to be called one time for every HTTP request from an SDK client.
|
||||
*
|
||||
*/
|
||||
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> PerOperationPolicies;
|
||||
|
||||
/**
|
||||
* @brief Define policies to be called each time and sdk client tries to send the Http request.
|
||||
* @brief Define policies to be called each time and SDK client tries to send the HTTP request.
|
||||
*
|
||||
*/
|
||||
std::vector<std::unique_ptr<Azure::Core::Http::Policies::HttpPolicy>> PerRetryPolicies;
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ namespace Azure { namespace Core { namespace Http { namespace _internal {
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Construct a new Http Pipeline object from clientOptions.
|
||||
* @brief Construct a new HTTP Pipeline object from clientOptions.
|
||||
*
|
||||
* @remark The client options includes per retry and per call policies which are merged with the
|
||||
* service-specific per retry policies.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
|
||||
/**
|
||||
* @file
|
||||
* @brief A null body stream for Http requests without a payload.
|
||||
* @brief A null body stream for HTTP requests without a payload.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@
|
|||
// meant to detect as fully-featured Win32 API (i.e. registry access, FileOpen() etc.) = "NOT UWP"
|
||||
// (4.) "#else" you are on "UWP" (*)
|
||||
// 5. Some features (i.e. WinHTTP) may have support for some non-traditional-Win32 desktops, yet not
|
||||
// the entirety of "UWP"(*). For example, WinHttp would currently compile and work on the following:
|
||||
// the entirety of "UWP"(*). For example, WinHTTP would currently compile and work on the following:
|
||||
// WINAPI_PARTITION_DESKTOP, WINAPI_PARTITION_SYSTEM, WINAPI_PARTITION_GAMES, so more complex
|
||||
// conditions are possible (****).
|
||||
//
|
||||
|
|
@ -34,12 +34,12 @@
|
|||
// 10 desktop, it has a "Full WIn32 API", it has WINAPI_PARTITION_DESKTOP defined, and
|
||||
// WINAPI_PARTITION_DESKTOP evaluates to 1. Otherwise, it is a UWP, which also has
|
||||
// WINAPI_PARTITION_DESKTOP defined, but it evaluates as 0.
|
||||
// (****) - VcPkg could be limiting the default option, because at the moment it only distinguishes
|
||||
// (****) - vcpkg could be limiting the default option, because at the moment it only distinguishes
|
||||
// between "UWP" and "Not UWP". So, if we have a default option indicating whether to build WinHTTP,
|
||||
// the best we can do is to enable build by default on (windows&!uwp). We can't remove the "!uwp"
|
||||
// part, because on some partitions compilation will fail. However, there is always an option for
|
||||
// the customer to run "vcpkg install azure-core-cpp[winhttp]" manually, and the build attempt will
|
||||
// be made (even if targeting Mac or Linux).
|
||||
// be made (even if targeting macOS or Linux).
|
||||
|
||||
#pragma once
|
||||
|
||||
|
|
|
|||
|
|
@ -203,7 +203,7 @@ namespace Azure { namespace Core {
|
|||
/**
|
||||
* @brief Get the port number set for the URL.
|
||||
*
|
||||
* @remark If the port was not set for the url, the returned port is 0. An HTTP request cannot
|
||||
* @remark If the port was not set for the URL, the returned port is 0. An HTTP request cannot
|
||||
* be performed to port zero, an HTTP client is expected to set the default port depending on
|
||||
* the request's schema when the port was not defined in the URL.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -336,7 +336,7 @@ CURLcode CurlSession::Perform(Context const& context)
|
|||
// Set the session state
|
||||
m_sessionState = SessionState::PERFORM;
|
||||
|
||||
// LibCurl settings after connection is open (headers)
|
||||
// libcurl settings after connection is open (headers)
|
||||
{
|
||||
auto headers = this->m_request.GetHeaders();
|
||||
auto hostHeader = headers.find("Host");
|
||||
|
|
@ -424,7 +424,7 @@ static std::unique_ptr<RawResponse> CreateHTTPResponse(
|
|||
uint8_t const* const begin,
|
||||
uint8_t const* const last)
|
||||
{
|
||||
// set response code, http version and reason phrase (i.e. HTTP/1.1 200 OK)
|
||||
// set response code, HTTP version and reason phrase (i.e. HTTP/1.1 200 OK)
|
||||
auto start = begin + 5; // HTTP = 4, / = 1, moving to 5th place for version
|
||||
auto end = std::find(start, last, '.');
|
||||
auto majorVersion = std::stoi(std::string(start, end));
|
||||
|
|
@ -442,7 +442,7 @@ static std::unique_ptr<RawResponse> CreateHTTPResponse(
|
|||
auto reasonPhrase = std::string(start, end); // remove \r
|
||||
|
||||
// allocate the instance of response to heap with shared ptr
|
||||
// So this memory gets delegated outside Curl Transport as a shared ptr so memory will be
|
||||
// So this memory gets delegated outside CurlTransport as a shared_ptr so memory will be
|
||||
// eventually released
|
||||
return std::make_unique<RawResponse>(
|
||||
static_cast<uint16_t>(majorVersion),
|
||||
|
|
@ -547,7 +547,7 @@ CURLcode CurlSession::UploadBody(Context const& context)
|
|||
return sendResult;
|
||||
}
|
||||
|
||||
// custom sending to wire an http request
|
||||
// custom sending to wire an HTTP request
|
||||
CURLcode CurlSession::SendRawHttp(Context const& context)
|
||||
{
|
||||
// something like GET /path HTTP1.0 \r\nheaders\r\n
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ using namespace Azure::Core::Http::Policies::_internal;
|
|||
|
||||
std::shared_ptr<HttpTransport> Azure::Core::Http::Policies::_detail::GetTransportAdapter()
|
||||
{
|
||||
// The order of these checks is important so that WinHttp is picked over Curl on Windows, when
|
||||
// The order of these checks is important so that WinHTTP is picked over libcurl on Windows, when
|
||||
// both are defined.
|
||||
#if defined(BUILD_TRANSPORT_CUSTOM_ADAPTER)
|
||||
return ::AzureSdkGetCustomHttpTransport();
|
||||
|
|
|
|||
|
|
@ -56,7 +56,7 @@ Url::Url(const std::string& url)
|
|||
|
||||
if (pos != url.end() && (*pos != '/') && (*pos != '?'))
|
||||
{
|
||||
// only char `\` or `?` is valid after the port (or the end of the url). Any other char is an
|
||||
// only char `\` or `?` is valid after the port (or the end of the URL). Any other char is an
|
||||
// invalid input
|
||||
throw std::invalid_argument("The port number contains invalid characters.");
|
||||
}
|
||||
|
|
@ -105,7 +105,7 @@ std::string Url::Decode(const std::string& value)
|
|||
{
|
||||
if (i + 2 >= value.size() || hexTable[value[i + 1]] < 0 || hexTable[value[i + 2]] < 0)
|
||||
{
|
||||
throw std::runtime_error("failed when decoding url component");
|
||||
throw std::runtime_error("failed when decoding URL component");
|
||||
}
|
||||
int v = (hexTable[value[i + 1]] << 4) + hexTable[value[i + 2]];
|
||||
decodedValue += static_cast<std::string::value_type>(v);
|
||||
|
|
|
|||
|
|
@ -98,7 +98,7 @@ add_executable (
|
|||
global_context.cpp
|
||||
)
|
||||
if (MSVC)
|
||||
# Disable gtest warnings for msvc
|
||||
# Disable gtest warnings for MSVC
|
||||
target_compile_options(azure-core-global-context-test PUBLIC /wd26495 /wd26812 /wd6326 /wd28204 /wd28020 /wd6330 /wd4389)
|
||||
endif()
|
||||
target_link_libraries(azure-core-global-context-test PRIVATE azure-core gtest_main)
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@
|
|||
|
||||
// The next includes are from Azure Core private headers.
|
||||
// That's why the path starts from `private/`
|
||||
// They are included to test the connection pool from the curl transport adapter implementation.
|
||||
// They are included to test the connection pool from the libcurl transport adapter implementation.
|
||||
#include <private/curl_connection.hpp>
|
||||
#include <private/curl_connection_pool.hpp>
|
||||
#include <private/curl_session.hpp>
|
||||
|
|
@ -285,7 +285,7 @@ namespace Azure { namespace Core { namespace Test {
|
|||
|
||||
#endif
|
||||
// Test max connections in pool. Try to add 2k connections to the pool.
|
||||
// Using fake connections to avoid opening real http connections :)
|
||||
// Using fake connections to avoid opening real HTTP connections :)
|
||||
// {
|
||||
// using ::testing::_;
|
||||
// using ::testing::Return;
|
||||
|
|
|
|||
|
|
@ -190,7 +190,7 @@ namespace Azure { namespace Core { namespace Test {
|
|||
policies.emplace_back(std::move(transportPolicy));
|
||||
Azure::Core::Http::_internal::HttpPipeline pipeline(policies);
|
||||
|
||||
// Use https
|
||||
// Use HTTPS
|
||||
Azure::Core::Url url(AzureSdkHttpbinServer::Get());
|
||||
Azure::Core::Http::Request request(Azure::Core::Http::HttpMethod::Get, url);
|
||||
|
||||
|
|
@ -222,7 +222,7 @@ namespace Azure { namespace Core { namespace Test {
|
|||
policies.emplace_back(std::move(transportPolicy));
|
||||
Azure::Core::Http::_internal::HttpPipeline pipeline(policies);
|
||||
|
||||
// Use https
|
||||
// Use HTTPS
|
||||
Azure::Core::Url url(AzureSdkHttpbinServer::Get());
|
||||
Azure::Core::Http::Request request(Azure::Core::Http::HttpMethod::Get, url);
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
* @file
|
||||
* @brief The base class for the common bahavior of the transport adapter tests.
|
||||
*
|
||||
* @brief Any http transport adapter can be used for this tests.
|
||||
* @brief Any HTTP transport adapter can be used for this tests.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -48,7 +48,7 @@ namespace Azure { namespace Core { namespace Test {
|
|||
* this is why we need to duplicate each case based on the transport adapters built.
|
||||
*/
|
||||
#if defined(BUILD_TRANSPORT_WINHTTP_ADAPTER) && defined(BUILD_CURL_HTTP_TRANSPORT_ADAPTER)
|
||||
/* WinHttp + LibCurl */
|
||||
/* WinHTTP + libcurl */
|
||||
INSTANTIATE_TEST_SUITE_P(
|
||||
Test,
|
||||
TransportAdapter,
|
||||
|
|
@ -58,7 +58,7 @@ namespace Azure { namespace Core { namespace Test {
|
|||
GetSuffix);
|
||||
|
||||
#elif defined(BUILD_TRANSPORT_WINHTTP_ADAPTER)
|
||||
/* WinHttp */
|
||||
/* WinHTTP */
|
||||
INSTANTIATE_TEST_SUITE_P(
|
||||
Test,
|
||||
TransportAdapter,
|
||||
|
|
@ -67,7 +67,7 @@ namespace Azure { namespace Core { namespace Test {
|
|||
GetSuffix);
|
||||
|
||||
#elif defined(BUILD_CURL_HTTP_TRANSPORT_ADAPTER)
|
||||
/* LibCurl */
|
||||
/* libcurl */
|
||||
INSTANTIATE_TEST_SUITE_P(
|
||||
Test,
|
||||
TransportAdapter,
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
],
|
||||
"features": {
|
||||
"curl": {
|
||||
"description": "LibCURL HTTP transport implementation",
|
||||
"description": "Libcurl HTTP transport implementation",
|
||||
"dependencies": [
|
||||
{
|
||||
"name": "azure-core-cpp",
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ Once building is completed, a performance test application will be created insid
|
|||
./sdk/core/perf/test/azure-perf-test
|
||||
```
|
||||
|
||||
>Note: When building the code with windows using Visual Studio, use the [cmake project view](https://docs.microsoft.com/cpp/build/cmake-projects-in-visual-studio?view=msvc-160) to run the performance tests. Find the tests directly in the tests folder from the cmake tree next to all other test cmake projects.
|
||||
>Note: When building the code with Windows using Visual Studio, use the [CMake project view](https://docs.microsoft.com/cpp/build/cmake-projects-in-visual-studio?view=msvc-160) to run the performance tests. Find the tests directly in the tests folder from the cmake tree next to all other test cmake projects.
|
||||
|
||||
#### Options for running
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ namespace Azure { namespace Perf { namespace Test {
|
|||
CurlHttpClientGetTest(Azure::Perf::TestOptions options) : HttpClientGetTest(options) {}
|
||||
|
||||
/**
|
||||
* @brief Set up the http client
|
||||
* @brief Set up the HTTP client
|
||||
*
|
||||
*/
|
||||
void GlobalSetup() override
|
||||
|
|
@ -50,7 +50,7 @@ namespace Azure { namespace Perf { namespace Test {
|
|||
{
|
||||
return {
|
||||
"curlHttpClientGet",
|
||||
"Send an Http Get request to a configurable url using libcurl.",
|
||||
"Send an HTTP GET request to a configurable URL using libcurl.",
|
||||
[](Azure::Perf::TestOptions options) {
|
||||
return std::make_unique<Azure::Perf::Test::CurlHttpClientGetTest>(options);
|
||||
}};
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ namespace Azure { namespace Perf { namespace Test {
|
|||
HttpClientGetTest(Azure::Perf::TestOptions options) : PerfTest(options) {}
|
||||
|
||||
/**
|
||||
* @brief Get and set the url option
|
||||
* @brief Get and set the URL option
|
||||
*
|
||||
*/
|
||||
void Setup() override
|
||||
|
|
@ -70,7 +70,7 @@ namespace Azure { namespace Perf { namespace Test {
|
|||
*/
|
||||
std::vector<Azure::Perf::TestOption> GetTestOptions() override
|
||||
{
|
||||
return {{"url", {"--url"}, "Url to send the http request. *Required parameter.", 1, true}};
|
||||
return {{"url", {"--url"}, "Url to send the HTTP request. *Required parameter.", 1, true}};
|
||||
}
|
||||
};
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ namespace Azure { namespace Perf { namespace Test {
|
|||
WinHttpClientGetTest(Azure::Perf::TestOptions options) : HttpClientGetTest(options) {}
|
||||
|
||||
/**
|
||||
* @brief Set up the http client
|
||||
* @brief Set up the HTTP client
|
||||
*
|
||||
*/
|
||||
void GlobalSetup() override
|
||||
|
|
@ -46,7 +46,7 @@ namespace Azure { namespace Perf { namespace Test {
|
|||
{
|
||||
return {
|
||||
"winHttpClientGet",
|
||||
"Send an Http Get request to a configurable url using winHttp.",
|
||||
"Send an HTTP GET request to a configurable URL using WinHTTP.",
|
||||
[](Azure::Perf::TestOptions options) {
|
||||
return std::make_unique<Azure::Perf::Test::WinHttpClientGetTest>(options);
|
||||
}};
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ namespace Azure { namespace Identity {
|
|||
|
||||
/**
|
||||
* @brief This class is used by Azure SDK clients to authenticate with the Azure service using a
|
||||
* tenant ID, client ID and client secret.
|
||||
* Tenant ID, Client ID and client secret.
|
||||
*/
|
||||
class ClientSecretCredential final : public Core::Credentials::TokenCredential {
|
||||
private:
|
||||
|
|
@ -59,7 +59,7 @@ namespace Azure { namespace Identity {
|
|||
*
|
||||
* @param tenantId Tenant ID.
|
||||
* @param clientId Client ID.
|
||||
* @param clientSecret Client Secret.
|
||||
* @param clientSecret Client secret.
|
||||
* @param options #Azure::Identity::ClientSecretCredentialOptions.
|
||||
*/
|
||||
explicit ClientSecretCredential(
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ For general suggestions about Azure, use our [Azure feedback forum](https://feed
|
|||
|
||||
#### Windows
|
||||
|
||||
#### Unix Platforms
|
||||
#### POSIX Platforms
|
||||
|
||||
### Build from Source
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
// SPDX-License-Identifier: MIT
|
||||
|
||||
/**
|
||||
* @brief Provides helper method for base64url.
|
||||
* @brief Provides helper method for Base64URL.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
@ -16,7 +16,7 @@
|
|||
namespace Azure { namespace Security { namespace KeyVault { namespace _internal {
|
||||
|
||||
/**
|
||||
* @brief Provides conversion methods for base64url.
|
||||
* @brief Provides conversion methods for Base64URL.
|
||||
*
|
||||
*/
|
||||
struct Base64Url final
|
||||
|
|
@ -52,7 +52,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace _internal
|
|||
base64url.append("=");
|
||||
break;
|
||||
default:
|
||||
throw new std::invalid_argument("Unexpected base64 encoding in the http response.");
|
||||
throw new std::invalid_argument("Unexpected Base64URL encoding in the HTTP response.");
|
||||
}
|
||||
return Azure::Core::Convert::Base64Decode(base64url);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@
|
|||
namespace Azure { namespace Security { namespace KeyVault { namespace _internal {
|
||||
|
||||
/**
|
||||
* @brief The HTTP pipeline used by KeyVault clients.
|
||||
* @brief The HTTP pipeline used by Key Vault clients.
|
||||
*
|
||||
*/
|
||||
class KeyVaultPipeline final {
|
||||
|
|
@ -57,7 +57,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace _internal
|
|||
std::vector<std::string> const& path) const;
|
||||
|
||||
/**
|
||||
* @brief Start the http transfer based on the \p request.
|
||||
* @brief Start the HTTP transfer based on the \p request.
|
||||
*
|
||||
* @param context The context for per-operation options or cancellation.
|
||||
* @param request The HTTP request to be sent.
|
||||
|
|
@ -71,9 +71,9 @@ namespace Azure { namespace Security { namespace KeyVault { namespace _internal
|
|||
/**
|
||||
* @brief Construct a new Key Vault Pipeline.
|
||||
*
|
||||
* @param vaultUrl The url address for the Key Vault.
|
||||
* @param apiVersion The service Api version.
|
||||
* @param pipeline The Http pipeline for sending requests with.
|
||||
* @param vaultUrl The URL address for the Key Vault.
|
||||
* @param apiVersion The service API version.
|
||||
* @param pipeline The HTTP pipeline for sending requests with.
|
||||
*/
|
||||
explicit KeyVaultPipeline(
|
||||
Azure::Core::Url vaultUrl,
|
||||
|
|
@ -173,9 +173,9 @@ namespace Azure { namespace Security { namespace KeyVault { namespace _internal
|
|||
* checking the respone code.
|
||||
*
|
||||
* @param context A context for cancellation.
|
||||
* @param method The Http method for the request.
|
||||
* @param method The HTTP method for the request.
|
||||
* @param path The path for the request.
|
||||
* @return A unique ptr to an Http raw response.
|
||||
* @return A unique ptr to an HTTP raw response.
|
||||
*/
|
||||
std::unique_ptr<Azure::Core::Http::RawResponse> Send(
|
||||
Azure::Core::Context const& context,
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
// SPDX-License-Identifier: MIT
|
||||
|
||||
/**
|
||||
* @brief Provides helper method for using unix time.
|
||||
* @brief Provides helper method for using POSIX time.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
@ -15,16 +15,16 @@
|
|||
namespace Azure { namespace Security { namespace KeyVault { namespace _internal {
|
||||
|
||||
/**
|
||||
* @brief Provides convertion methods for unix time to Azure Core Datetime.
|
||||
* @brief Provides convertion methods for POSIX time to Azure Core #Azure::Core::DateTime.
|
||||
*
|
||||
*/
|
||||
class UnixTimeConverter final {
|
||||
public:
|
||||
/**
|
||||
* @brief Converts unix time to a #Azure::Core::Datetime.
|
||||
* @brief Converts POSIX time to a #Azure::Core::Datetime.
|
||||
*
|
||||
* @param unixTime The number of seconds since 1970.
|
||||
* @return Calculated Datetime.
|
||||
* @return Calculated #Azure::Core::DateTime.
|
||||
*/
|
||||
static inline Azure::DateTime UnixTimeToDatetime(uint64_t unixTime)
|
||||
{
|
||||
|
|
@ -32,13 +32,13 @@ namespace Azure { namespace Security { namespace KeyVault { namespace _internal
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Converts a #Azure::Core::Datetime to unix time.
|
||||
* @brief Converts an #Azure::Core::DateTime to POSIX time.
|
||||
*
|
||||
* @param dateTime The date time to convert.
|
||||
*/
|
||||
static inline uint64_t DatetimeToUnixTime(Azure::DateTime dateTime)
|
||||
{
|
||||
// This count starts at the Unix Epoch which was January 1st, 1970 at UTC.
|
||||
// This count starts at the Unix epoch which is January 1st, 1970 UTC.
|
||||
auto secondsSince1970
|
||||
= std::chrono::duration_cast<std::chrono::seconds>(dateTime - Azure::DateTime(1970));
|
||||
return secondsSince1970.count();
|
||||
|
|
|
|||
|
|
@ -17,15 +17,15 @@
|
|||
|
||||
namespace Azure { namespace Security { namespace KeyVault { namespace _detail {
|
||||
/**
|
||||
* @brief Container for static methods to parse keyvault payloads to Azure Core Exception.
|
||||
* @brief Container for static methods to parse Key Vault payloads to Azure Core Exception.
|
||||
*
|
||||
*/
|
||||
struct KeyVaultException final
|
||||
{
|
||||
/**
|
||||
* @brief Parsed the http payload into an #Azure::Core::RequestFailedException
|
||||
* @brief Parsed the HTTP payload into an #Azure::Core::RequestFailedException
|
||||
*
|
||||
* @param rawResponse The Http raw response.
|
||||
* @param rawResponse The HTTP raw response.
|
||||
* @return Azure::Core::RequestFailedException
|
||||
*/
|
||||
static Azure::Core::RequestFailedException CreateException(
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
"version-semver": "@AZ_LIBRARY_VERSION@",
|
||||
"description": [
|
||||
"Microsoft Azure Common Key Vault SDK for C++",
|
||||
"This library provides common Azure KeyVault-related abstractions for Azure SDK."
|
||||
"This library provides common Azure Key Vault related abstractions for Azure SDK."
|
||||
],
|
||||
"homepage": "https://github.com/Azure/azure-sdk-for-cpp/tree/master/sdk/keyvault/azure-security-keyvault-common",
|
||||
"license": "MIT",
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
|
|||
struct DeletedKey final : public KeyVaultKey
|
||||
{
|
||||
/**
|
||||
* @brief A recovery url that can be used to recover it.
|
||||
* @brief A recovery URL that can be used to recover it.
|
||||
*
|
||||
*/
|
||||
std::string RecoveryId;
|
||||
|
|
|
|||
|
|
@ -22,15 +22,15 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys { nam
|
|||
/***************** KeyVault Key *****************/
|
||||
struct KeyVaultKeySerializer final
|
||||
{
|
||||
// Creates a new key based on a name and an http raw response.
|
||||
// Creates a new key based on a name and an HTTP raw response.
|
||||
static KeyVaultKey KeyVaultKeyDeserialize(
|
||||
std::string const& name,
|
||||
Azure::Core::Http::RawResponse const& rawResponse);
|
||||
|
||||
// Create from http raw response only.
|
||||
// Create from HTTP raw response only.
|
||||
static KeyVaultKey KeyVaultKeyDeserialize(Azure::Core::Http::RawResponse const& rawResponse);
|
||||
|
||||
// Updates a Key based on an Http raw response.
|
||||
// Updates a Key based on an HTTP raw response.
|
||||
static void KeyVaultKeyDeserialize(
|
||||
KeyVaultKey& key,
|
||||
Azure::Core::Http::RawResponse const& rawResponse);
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
|
|||
/**
|
||||
* @brief Construct a new Key Client object
|
||||
*
|
||||
* @param vaultUrl The url address where the client will send the requests to.
|
||||
* @param vaultUrl The URL address where the client will send the requests to.
|
||||
* @param credential The authentication method to use.
|
||||
* @param options The options to customize the client behavior.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
|
|||
/**
|
||||
* @brief Get the Key identifier.
|
||||
*
|
||||
* @return The key id.
|
||||
* @return The key ID.
|
||||
*/
|
||||
std::string const& Id() const { return Key.Id; }
|
||||
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
|
|||
*
|
||||
* @param keyProperties A previously created #KeyPropertiesPageResult that is used to init this
|
||||
* instance.
|
||||
* @param rawResponse The Http raw response from where the #KeyPropertiesPageResult was parsed.
|
||||
* @param rawResponse The HTTP raw response from where the #KeyPropertiesPageResult was parsed.
|
||||
* @param keyClient A key client required for getting the next pages.
|
||||
* @param keyName When \p keyName is set, the response is listing key versions. Otherwise, the
|
||||
* response is for listing keys from the Key Vault.
|
||||
|
|
@ -92,7 +92,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
|
|||
*
|
||||
* @param deletedKeyProperties A previously created #DeletedKeyPageResult that is used to init
|
||||
* this new instance.
|
||||
* @param rawResponse The Http raw response from where the #DeletedKeyPageResult was parsed.
|
||||
* @param rawResponse The HTTP raw response from where the #DeletedKeyPageResult was parsed.
|
||||
* @param keyClient A key client required for getting the next pages.
|
||||
* @param keyName When \p keyName is set, the response is listing key versions. Otherwise, the
|
||||
* response is for listing keys from the Key Vault.
|
||||
|
|
|
|||
|
|
@ -93,7 +93,7 @@ namespace Azure { namespace Security { namespace KeyVault { namespace Keys {
|
|||
/**
|
||||
* @brief Get the #Azure::Security::KeyVault::Keys::KeyVaultKey object.
|
||||
*
|
||||
* @remark The deleted key contains the recovery id if the key can be recovered.
|
||||
* @remark The deleted key contains the recovery ID if the key can be recovered.
|
||||
*
|
||||
* @return A deleted key object.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ To create a new `KeyClient` to create, get, update, or delete keys, you need the
|
|||
|
||||
Key Vault Keys client for C++ currently supports the `ClientSecretCredential` for authenticating.
|
||||
|
||||
In the sample below, you can create a credential by setting the tenant id, client id and client secret as environment variables.
|
||||
In the sample below, you can create a credential by setting the Tenant ID, Client ID and client secret as environment variables.
|
||||
|
||||
```cpp Snippet:KeysSample1CreateCredential
|
||||
auto tenantId = std::getenv("AZURE_TENANT_ID");
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ To create a new `KeyClient` to create, get, update, or delete keys, you need the
|
|||
|
||||
Key Vault Keys client for C++ currently supports the `ClientSecretCredential` for authenticating.
|
||||
|
||||
In the sample below, you can create a credential by setting the tenant id, client id and client secret as environment variables.
|
||||
In the sample below, you can create a credential by setting the Tenant ID, Client ID and client secret as environment variables.
|
||||
|
||||
```cpp Snippet:KeysSample1CreateCredential
|
||||
auto tenantId = std::getenv("AZURE_TENANT_ID");
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ To create a new `KeyClient` to create, get, update, or delete keys, you need the
|
|||
|
||||
Key Vault Keys client for C++ currently supports the `ClientSecretCredential` for authenticating.
|
||||
|
||||
In the sample below, you can create a credential by setting the tenant id, client id and client secret as environment variables.
|
||||
In the sample below, you can create a credential by setting the Tenant ID, Client ID and client secret as environment variables.
|
||||
|
||||
```cpp Snippet:KeysSample1CreateCredential
|
||||
auto tenantId = std::getenv("AZURE_TENANT_ID");
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ RemoteCryptographyClient::RemoteCryptographyClient(
|
|||
CryptographyClientOptions options)
|
||||
{
|
||||
auto apiVersion = options.Version.ToString();
|
||||
// Remote client is init with the url to a key vault key.
|
||||
// Remote client is init with the URL to a key vault key.
|
||||
KeyId = Azure::Core::Url(keyId);
|
||||
std::vector<std::unique_ptr<HttpPolicy>> perRetrypolicies;
|
||||
{
|
||||
|
|
@ -51,7 +51,7 @@ RemoteCryptographyClient::RemoteCryptographyClient(
|
|||
Azure::Response<KeyVaultKey> RemoteCryptographyClient::GetKey(
|
||||
Azure::Core::Context const& context) const
|
||||
{
|
||||
// The remote crypto client is created with a key vault key url, hence, no path is required to get
|
||||
// The remote crypto client is created with a Key Vault key URL, hence, no path is required to get
|
||||
// the key from the server.
|
||||
return Pipeline->SendRequest<KeyVaultKey>(
|
||||
context,
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ Azure::Security::KeyVault::Keys::DeleteKeyOperation::PollInternal(
|
|||
}
|
||||
|
||||
// To ensure the success of calling Poll multiple times, even after operation is completed, a
|
||||
// copy of the raw http response is returned instead of transfering the ownership of the raw
|
||||
// copy of the raw HTTP response is returned instead of transfering the ownership of the raw
|
||||
// response inside the Operation.
|
||||
return rawResponse;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -37,8 +37,8 @@ static inline RequestWithContinuationToken BuildRequestFromContinuationToken(
|
|||
request.Path = defaultPath;
|
||||
if (options.NextPageToken)
|
||||
{
|
||||
// Using a continuation token requires to send the request to the continuation token url instead
|
||||
// of the default url which is used only for the first page.
|
||||
// Using a continuation token requires to send the request to the continuation token URL instead
|
||||
// of the default URL which is used only for the first page.
|
||||
Azure::Core::Url nextPageUrl(options.NextPageToken.Value());
|
||||
request.Query
|
||||
= std::make_unique<std::map<std::string, std::string>>(nextPageUrl.GetQueryParameters());
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ Azure::Security::KeyVault::Keys::RecoverDeletedKeyOperation::PollInternal(
|
|||
}
|
||||
|
||||
// To ensure the success of calling Poll multiple times, even after operation is completed, a
|
||||
// copy of the raw http response is returned instead of transfering the ownership of the raw
|
||||
// copy of the raw HTTP response is returned instead of transfering the ownership of the raw
|
||||
// response inside the Operation.
|
||||
return rawResponse;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@
|
|||
* to create, get, update, delete and purge a key.
|
||||
*
|
||||
* @remark The following environment variables must be set before running the sample.
|
||||
* - AZURE_KEYVAULT_URL: To the KeyVault account url.
|
||||
* - AZURE_TENANT_ID: Tenant id for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The client id to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The secret id from the client id.
|
||||
* - AZURE_KEYVAULT_URL: To the Key Vault account URL.
|
||||
* - AZURE_TENANT_ID: Tenant ID for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The Client ID to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The client secret.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ int main()
|
|||
}
|
||||
catch (Azure::Core::RequestFailedException const& e)
|
||||
{
|
||||
std::cout << "KeyVault Client Exception happened:" << std::endl << e.Message << std::endl;
|
||||
std::cout << "Key Vault Client Exception happened:" << std::endl << e.Message << std::endl;
|
||||
return 1;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@
|
|||
* to back up and restore a key.
|
||||
*
|
||||
* @remark The following environment variables must be set before running the sample.
|
||||
* - AZURE_KEYVAULT_URL: To the KeyVault account url.
|
||||
* - AZURE_TENANT_ID: Tenant id for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The client id to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The secret id from the client id.
|
||||
* - AZURE_KEYVAULT_URL: To the Key Vault account URL.
|
||||
* - AZURE_TENANT_ID: Tenant ID for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The Client ID to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The client secret.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@
|
|||
* Vault.
|
||||
*
|
||||
* @remark The following environment variables must be set before running the sample.
|
||||
* - AZURE_KEYVAULT_URL: To the KeyVault account url.
|
||||
* - AZURE_TENANT_ID: Tenant id for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The client id to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The secret id from the client id.
|
||||
* - AZURE_KEYVAULT_URL: To the Key Vault account URL.
|
||||
* - AZURE_TENANT_ID: Tenant ID for the Azure account.
|
||||
* - AZURE_CLIENT_ID: The Client ID to authenticate the request.
|
||||
* - AZURE_CLIENT_SECRET: The client secret.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
@ -110,8 +110,8 @@ int main()
|
|||
}
|
||||
}
|
||||
|
||||
// If the keyvault is soft-delete enabled, then for permanent deletion, deleted keys needs to be
|
||||
// purged.
|
||||
// If the Key Vault is soft-delete enabled, then for permanent deletion, deleted keys needs to
|
||||
// be purged.
|
||||
keyClient.PurgeDeletedKey(rsaKeyName);
|
||||
keyClient.PurgeDeletedKey(ecKeyName);
|
||||
}
|
||||
|
|
@ -122,7 +122,7 @@ int main()
|
|||
}
|
||||
catch (Azure::Core::RequestFailedException const& e)
|
||||
{
|
||||
std::cout << "KeyVault Client Exception happened:" << std::endl << e.Message << std::endl;
|
||||
std::cout << "Key Vault Client Exception happened:" << std::endl << e.Message << std::endl;
|
||||
return 1;
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ TEST_F(KeyVaultClientTest, RemoteEncrypt)
|
|||
rsaKeyOptions.KeySize = 2048;
|
||||
auto rsaKey = keyClient.CreateRsaKey(rsaKeyOptions).Value;
|
||||
|
||||
// init crypto client from key id. The remote client will get the key and try to create a local
|
||||
// init crypto client from key ID. The remote client will get the key and try to create a local
|
||||
// crypto client.
|
||||
CryptographyClient cryptoClient(rsaKey.Id(), m_credential);
|
||||
|
||||
|
|
@ -58,7 +58,7 @@ TEST_F(KeyVaultClientTest, RemoteWrap)
|
|||
rsaKeyOptions.KeySize = 2048;
|
||||
auto rsaKey = keyClient.CreateRsaKey(rsaKeyOptions).Value;
|
||||
|
||||
// init crypto client from key id. The remote client will get the key and try to create a local
|
||||
// init crypto client from key ID. The remote client will get the key and try to create a local
|
||||
// crypto client.
|
||||
CryptographyClient cryptoClient(rsaKey.Id(), m_credential);
|
||||
|
||||
|
|
@ -87,7 +87,7 @@ TEST_F(KeyVaultClientTest, RemoteSignVerifyRSA256)
|
|||
rsaKeyOptions.KeySize = 2048;
|
||||
auto rsaKey = keyClient.CreateRsaKey(rsaKeyOptions).Value;
|
||||
|
||||
// init crypto client from key id. The remote client will get the key and try to create a local
|
||||
// init crypto client from key ID. The remote client will get the key and try to create a local
|
||||
// crypto client.
|
||||
CryptographyClient cryptoClient(rsaKey.Id(), m_credential);
|
||||
std::string digestSource("A single block of plaintext");
|
||||
|
|
@ -191,7 +191,7 @@ TEST_F(KeyVaultClientTest, RemoteSignVerifyRSA384)
|
|||
rsaKeyOptions.KeySize = 2048;
|
||||
auto rsaKey = keyClient.CreateRsaKey(rsaKeyOptions).Value;
|
||||
|
||||
// init crypto client from key id. The remote client will get the key and try to create a local
|
||||
// init crypto client from key ID. The remote client will get the key and try to create a local
|
||||
// crypto client.
|
||||
CryptographyClient cryptoClient(rsaKey.Id(), m_credential);
|
||||
std::string digestSource("A single block of plaintext");
|
||||
|
|
@ -242,7 +242,7 @@ TEST_F(KeyVaultClientTest, RemoteSignVerifyDataRSA256)
|
|||
rsaKeyOptions.KeySize = 2048;
|
||||
auto rsaKey = keyClient.CreateRsaKey(rsaKeyOptions).Value;
|
||||
|
||||
// init crypto client from key id. The remote client will get the key and try to create a local
|
||||
// init crypto client from key ID. The remote client will get the key and try to create a local
|
||||
// crypto client.
|
||||
CryptographyClient cryptoClient(rsaKey.Id(), m_credential);
|
||||
uint8_t dataSource[] = "A single block of plaintext";
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ TEST_F(MockedTransportAdapterTest, keyvaultTelemetryId)
|
|||
// The fake response from the mocked transport adapter is good for parsing a Key back
|
||||
auto response = m_client->GetKey("name");
|
||||
|
||||
// The response is an echo of the sent headers. Let's find the telemetry id
|
||||
// The response is an echo of the sent headers. Let's find the telemetry ID
|
||||
auto foundHeader = false;
|
||||
for (auto& header : response.RawResponse->GetHeaders())
|
||||
{
|
||||
|
|
|
|||
|
|
@ -50,9 +50,9 @@ After Vcpkg is initialized and bootstrapped, you can install the dependencies:
|
|||
vcpkg.exe install libxml2:x64-windows-static curl:x64-windows-static
|
||||
```
|
||||
|
||||
#### Unix Platforms
|
||||
#### POSIX Platforms
|
||||
|
||||
You can use the package manager on different Unix platforms to install the dependencies. The dependencies to be installed are:
|
||||
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.
|
||||
|
|
@ -85,7 +85,7 @@ If Vcpkg is not globally integrated, then you need to open CMakeSettings.json an
|
|||
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.
|
||||
|
||||
#### Unix Platforms
|
||||
#### POSIX Platforms
|
||||
|
||||
You can run the following command in a new folder created under the downloaded code's root folder to build the code.
|
||||
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
const BlobClientOptions& options = BlobClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Initializes a new instance of the AppendBlobClient class with an identical url
|
||||
* @brief Initializes a new instance of the AppendBlobClient class with an identical URL
|
||||
* source but the specified snapshot timestamp.
|
||||
*
|
||||
* @param snapshot The snapshot
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlobClient.
|
||||
*
|
||||
* @param blobUrl A url referencing the blob that includes the name of the account, the name of
|
||||
* @param blobUrl A URL referencing the blob that includes the name of the account, the name of
|
||||
* the container, and the name of the blob.
|
||||
* @param credential The shared key credential used to sign requests.
|
||||
* @param options Optional client options that define the transport pipeline
|
||||
|
|
@ -73,7 +73,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlobClient.
|
||||
*
|
||||
* @param blobUrl A url referencing the blob that includes the name of the account, the name of
|
||||
* @param blobUrl A URL referencing the blob that includes the name of the account, the name of
|
||||
* the container, and the name of the blob.
|
||||
* @param credential The token credential used to sign requests.
|
||||
* @param options Optional client options that define the transport pipeline policies for
|
||||
|
|
@ -87,7 +87,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlobClient.
|
||||
*
|
||||
* @param blobUrl A url referencing the blob that includes the name of the account, the name of
|
||||
* @param blobUrl A URL referencing the blob that includes the name of the account, the name of
|
||||
* the container, and the name of the blob, and possibly also a SAS token.
|
||||
* @param options Optional client
|
||||
* options that define the transport pipeline policies for authentication, retries, etc., that
|
||||
|
|
@ -98,7 +98,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
const BlobClientOptions& options = BlobClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Creates a new BlockBlobClient object with the same url as this BlobClient. The
|
||||
* @brief Creates a new BlockBlobClient object with the same URL as this BlobClient. The
|
||||
* new BlockBlobClient uses the same request policy pipeline as this BlobClient.
|
||||
*
|
||||
*
|
||||
|
|
@ -107,7 +107,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
BlockBlobClient AsBlockBlobClient() const;
|
||||
|
||||
/**
|
||||
* @brief Creates a new AppendBlobClient object with the same url as this BlobClient.
|
||||
* @brief Creates a new AppendBlobClient object with the same URL as this BlobClient.
|
||||
* The new AppendBlobClient uses the same request policy pipeline as this BlobClient.
|
||||
*
|
||||
* @return A new AppendBlobClient instance.
|
||||
|
|
@ -115,7 +115,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
AppendBlobClient AsAppendBlobClient() const;
|
||||
|
||||
/**
|
||||
* @brief Creates a new PageBlobClient object with the same url as this BlobClient.
|
||||
* @brief Creates a new PageBlobClient object with the same URL as this BlobClient.
|
||||
* The new PageBlobClient uses the same request policy pipeline as this BlobClient.
|
||||
*
|
||||
* @return A new PageBlobClient instance.
|
||||
|
|
@ -123,14 +123,14 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
PageBlobClient AsPageBlobClient() const;
|
||||
|
||||
/**
|
||||
* @brief Gets the blob's primary url endpoint.
|
||||
* @brief Gets the blob's primary URL endpoint.
|
||||
*
|
||||
* @return The blob's primary url endpoint.
|
||||
* @return The blob's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_blobUrl.GetAbsoluteUrl(); }
|
||||
|
||||
/**
|
||||
* @brief Initializes a new instance of the BlobClient class with an identical url
|
||||
* @brief Initializes a new instance of the BlobClient class with an identical URL
|
||||
* source but the specified snapshot timestamp.
|
||||
*
|
||||
* @param snapshot The snapshot identifier.
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
const BlobClientOptions& options = BlobClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Create a new BlobClient object by appending blobName to the end of url. The
|
||||
* @brief Create a new BlobClient object by appending blobName to the end of URL. The
|
||||
* new BlobClient uses the same request policy pipeline as this BlobContainerClient.
|
||||
*
|
||||
* @param blobName The name of the blob.
|
||||
|
|
@ -89,7 +89,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
BlobClient GetBlobClient(const std::string& blobName) const;
|
||||
|
||||
/**
|
||||
* @brief Create a new BlockBlobClient object by appending blobName to the end of url.
|
||||
* @brief Create a new BlockBlobClient object by appending blobName to the end of URL.
|
||||
* The new BlockBlobClient uses the same request policy pipeline as this BlobContainerClient.
|
||||
*
|
||||
* @param blobName The name of the blob.
|
||||
|
|
@ -98,7 +98,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
BlockBlobClient GetBlockBlobClient(const std::string& blobName) const;
|
||||
|
||||
/**
|
||||
* @brief Create a new AppendBlobClient object by appending blobName to the end of url.
|
||||
* @brief Create a new AppendBlobClient object by appending blobName to the end of URL.
|
||||
* The new AppendBlobClient uses the same request policy pipeline as this BlobContainerClient.
|
||||
*
|
||||
* @param blobName The name of the blob.
|
||||
|
|
@ -107,7 +107,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
AppendBlobClient GetAppendBlobClient(const std::string& blobName) const;
|
||||
|
||||
/**
|
||||
* @brief Create a new PageBlobClient object by appending blobName to the end of url.
|
||||
* @brief Create a new PageBlobClient object by appending blobName to the end of URL.
|
||||
* The new PageBlobClient uses the same request policy pipeline as this BlobContainerClient.
|
||||
*
|
||||
* @param blobName The name of the blob.
|
||||
|
|
@ -116,10 +116,10 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
PageBlobClient GetPageBlobClient(const std::string& blobName) const;
|
||||
|
||||
/**
|
||||
* @brief Gets the container's primary url endpoint.
|
||||
* @brief Gets the container's primary URL endpoint.
|
||||
*
|
||||
* @return The
|
||||
* container's primary url endpoint.
|
||||
* container's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_blobContainerUrl.GetAbsoluteUrl(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -224,7 +224,7 @@ namespace Azure { namespace Storage { namespace Sas {
|
|||
std::string Snapshot;
|
||||
|
||||
/**
|
||||
* @brief The id of the blob version being made accessible, or empty for a container
|
||||
* @brief The ID of the blob version being made accessible, or empty for a container
|
||||
* SAS, blob SAS and blob snapshot SAS.
|
||||
*/
|
||||
std::string BlobVersionId;
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlobServiceClient.
|
||||
*
|
||||
* @param serviceUrl A url referencing the blob that includes the name of the account.
|
||||
* @param serviceUrl A URL referencing the blob that includes the name of the account.
|
||||
* @param credential The shared key credential used to sign requests.
|
||||
* @param options Optional client options that define the transport pipeline policies for
|
||||
* authentication, retries, etc., that are applied to every request.
|
||||
|
|
@ -48,7 +48,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlobServiceClient.
|
||||
*
|
||||
* @param serviceUrl A url referencing the blob that includes the name of the account.
|
||||
* @param serviceUrl A URL referencing the blob that includes the name of the account.
|
||||
* @param credential The token credential used to sign requests.
|
||||
* @param options Optional client options that define the transport pipeline policies for
|
||||
* authentication, retries, etc., that are applied to every request.
|
||||
|
|
@ -61,7 +61,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlobServiceClient.
|
||||
*
|
||||
* @param serviceUrl A url referencing the blob that includes the name of the account, and
|
||||
* @param serviceUrl A URL referencing the blob that includes the name of the account, and
|
||||
* possibly also a SAS token.
|
||||
* @param options Optional client options that define the transport pipeline policies for
|
||||
* authentication, retries, etc., that are applied to every request.
|
||||
|
|
@ -71,7 +71,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
const BlobClientOptions& options = BlobClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Creates a new BlobContainerClient object with the same url as this BlobServiceClient.
|
||||
* @brief Creates a new BlobContainerClient object with the same URL as this BlobServiceClient.
|
||||
* The new BlobContainerClient uses the same request policy pipeline as this BlobServiceClient.
|
||||
*
|
||||
* @return A new BlobContainerClient instance.
|
||||
|
|
@ -79,9 +79,9 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
BlobContainerClient GetBlobContainerClient(const std::string& blobContainerName) const;
|
||||
|
||||
/**
|
||||
* @brief Gets the blob service's primary url endpoint.
|
||||
* @brief Gets the blob service's primary URL endpoint.
|
||||
*
|
||||
* @return the blob service's primary url endpoint.
|
||||
* @return the blob service's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_serviceUrl.GetAbsoluteUrl(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlockBlobClient.
|
||||
*
|
||||
* @param blobUrl A url
|
||||
* @param blobUrl A URL
|
||||
* referencing the blob that includes the name of the account, the name of the container, and
|
||||
* the name of the blob.
|
||||
* @param credential The shared key credential used to sign
|
||||
|
|
@ -66,7 +66,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlockBlobClient.
|
||||
*
|
||||
* @param blobUrl A url
|
||||
* @param blobUrl A URL
|
||||
* referencing the blob that includes the name of the account, the name of the container, and
|
||||
* the name of the blob.
|
||||
* @param credential The token credential used to sign requests.
|
||||
|
|
@ -81,7 +81,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of BlockBlobClient.
|
||||
*
|
||||
* @param blobUrl A url
|
||||
* @param blobUrl A URL
|
||||
* referencing the blob that includes the name of the account, the name of the container, and
|
||||
* the name of the blob, and possibly also a SAS token.
|
||||
* @param options Optional client
|
||||
|
|
@ -93,7 +93,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
const BlobClientOptions& options = BlobClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Initializes a new instance of the BlockBlobClient class with an identical url
|
||||
* @brief Initializes a new instance of the BlockBlobClient class with an identical URL
|
||||
* source but the specified snapshot timestamp.
|
||||
*
|
||||
* @param snapshot The snapshot
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of PageBlobClient.
|
||||
*
|
||||
* @param blobUrl A url
|
||||
* @param blobUrl A URL
|
||||
* referencing the blob that includes the name of the account, the name of the container, and
|
||||
* the name of the blob.
|
||||
* @param credential The shared key credential used to sign
|
||||
|
|
@ -58,7 +58,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of PageBlobClient.
|
||||
*
|
||||
* @param blobUrl A url
|
||||
* @param blobUrl A URL
|
||||
* referencing the blob that includes the name of the account, the name of the container, and
|
||||
* the name of the blob.
|
||||
* @param credential The token credential used to sign requests.
|
||||
|
|
@ -73,7 +73,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
/**
|
||||
* @brief Initialize a new instance of PageBlobClient.
|
||||
*
|
||||
* @param blobUrl A url
|
||||
* @param blobUrl A URL
|
||||
* referencing the blob that includes the name of the account, the name of the container, and
|
||||
* the name of the blob, and possibly also a SAS token.
|
||||
* @param options Optional client
|
||||
|
|
@ -85,7 +85,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
const BlobClientOptions& options = BlobClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Initializes a new instance of the PageBlobClient class with an identical url
|
||||
* @brief Initializes a new instance of the PageBlobClient class with an identical URL
|
||||
* source but the specified snapshot timestamp.
|
||||
*
|
||||
* @param snapshot The snapshot
|
||||
|
|
@ -237,7 +237,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
const Azure::Core::Context& context = Azure::Core::Context()) const;
|
||||
|
||||
/**
|
||||
* @brief Returns the list of page ranges that differ between a previous snapshot url and this
|
||||
* @brief Returns the list of page ranges that differ between a previous snapshot URL and this
|
||||
* page blob. Changes include both updated and cleared pages. This API only works with managed
|
||||
* disk storage accounts.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
struct BlobBlock final
|
||||
{
|
||||
/**
|
||||
* Base64 encoded block id.
|
||||
* Base64 encoded block ID.
|
||||
*/
|
||||
std::string Name;
|
||||
/**
|
||||
|
|
@ -994,7 +994,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
*/
|
||||
Azure::Nullable<std::string> CopySource;
|
||||
/**
|
||||
* State of the copy operation identified by the copy id. Possible values include success,
|
||||
* State of the copy operation identified by the copy ID. Possible values include success,
|
||||
* pending, aborted, failed etc. This value is null if this blob has never been the
|
||||
* destination of a copy operation, or if this blob has been modified after a concluded copy
|
||||
* operation.
|
||||
|
|
@ -1368,7 +1368,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
*/
|
||||
Azure::Nullable<std::string> CopySource;
|
||||
/**
|
||||
* State of the copy operation identified by the copy id. Possible values include success,
|
||||
* State of the copy operation identified by the copy ID. Possible values include success,
|
||||
* pending, aborted, failed etc. This value is null if this blob has never been the
|
||||
* destination of a copy operation, or if this blob has been modified after a concluded copy
|
||||
* operation.
|
||||
|
|
@ -2647,7 +2647,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
*/
|
||||
std::string CopyId;
|
||||
/**
|
||||
* State of the copy operation identified by the copy id. Possible values include success,
|
||||
* State of the copy operation identified by the copy ID. Possible values include success,
|
||||
* pending, aborted, failed etc. This value is null if this blob has never been the
|
||||
* destination of a copy operation, or if this blob has been modified after a concluded copy
|
||||
* operation.
|
||||
|
|
@ -2681,7 +2681,7 @@ namespace Azure { namespace Storage { namespace Blobs {
|
|||
*/
|
||||
std::string CopyId;
|
||||
/**
|
||||
* State of the copy operation identified by the copy id. Possible values include success,
|
||||
* State of the copy operation identified by the copy ID. Possible values include success,
|
||||
* pending, aborted, failed etc. This value is null if this blob has never been the
|
||||
* destination of a copy operation, or if this blob has been modified after a concluded copy
|
||||
* operation.
|
||||
|
|
|
|||
|
|
@ -218,7 +218,7 @@ namespace Azure { namespace Storage { namespace Test {
|
|||
Blobs::StartBlobCopyFromUriOptions options;
|
||||
options.SourceAccessConditions.LeaseId = Blobs::BlobLeaseClient::CreateUniqueLeaseId();
|
||||
/*
|
||||
don't know why, the copy operation also succeeds even if the lease id doesn't match.
|
||||
don't know why, the copy operation also succeeds even if the lease ID doesn't match.
|
||||
EXPECT_THROW(
|
||||
destBlobClient.StartCopyFromUri(sourceBlobClient.GetUrl(), options), StorageException);
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ namespace Azure { namespace Storage {
|
|||
|
||||
/**
|
||||
* @brief Specify this header to perform the operation only if the resource has an
|
||||
* active lease mathing this id.
|
||||
* active lease mathing this ID.
|
||||
*/
|
||||
Azure::Nullable<std::string> LeaseId;
|
||||
};
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ namespace Azure { namespace Storage { namespace _internal {
|
|||
int64_t length,
|
||||
int64_t chunkSize,
|
||||
int concurrency,
|
||||
// offset, length, chunk id, number of chunks
|
||||
// offset, length, chunk ID, number of chunks
|
||||
std::function<void(int64_t, int64_t, int64_t, int64_t)> transferFunc)
|
||||
{
|
||||
std::atomic<int> numWorkingThreads{concurrency};
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ namespace Azure { namespace Storage { namespace _internal {
|
|||
* ReliableStream uses an HTTPGetter callback (provided on constructor) to get a bodyStream
|
||||
* starting on last known offset to resume a fail Read() operation.
|
||||
*
|
||||
* @remark An HTTPGetter callback is expected to verify the initial `eTag` from first http request
|
||||
* @remark An HTTPGetter callback is expected to verify the initial `eTag` from first HTTP request
|
||||
* to ensure read operation will continue on the same content.
|
||||
*
|
||||
* @remark An HTTPGetter callback is expected to calculate and set the range header based on the
|
||||
|
|
|
|||
|
|
@ -81,10 +81,10 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
DataLakeDirectoryClient GetSubdirectoryClient(const std::string& subdirectoryName) const;
|
||||
|
||||
/**
|
||||
* @brief Gets the directory's primary url endpoint. This is the endpoint used for blob
|
||||
* @brief Gets the directory's primary URL endpoint. This is the endpoint used for blob
|
||||
* storage available features in DataLake.
|
||||
*
|
||||
* @return The directory's primary url endpoint.
|
||||
* @return The directory's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_blobClient.GetUrl(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -68,10 +68,10 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
const DataLakeClientOptions& options = DataLakeClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Gets the file's primary url endpoint. This is the endpoint used for blob
|
||||
* @brief Gets the file's primary URL endpoint. This is the endpoint used for blob
|
||||
* storage available features in DataLake.
|
||||
*
|
||||
* @return The file's primary url endpoint.
|
||||
* @return The file's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_blobClient.GetUrl(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -83,10 +83,10 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
DataLakeDirectoryClient GetDirectoryClient(const std::string& directoryName) const;
|
||||
|
||||
/**
|
||||
* @brief Gets the filesystem's primary url endpoint. This is the endpoint used for blob
|
||||
* @brief Gets the filesystem's primary URL endpoint. This is the endpoint used for blob
|
||||
* storage available features in DataLake.
|
||||
*
|
||||
* @return The filesystem's primary url endpoint.
|
||||
* @return The filesystem's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_blobContainerClient.GetUrl(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -56,9 +56,9 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
AZ_STORAGE_FILES_DATALAKE_DLLEXPORT const static std::chrono::seconds InfiniteLeaseDuration;
|
||||
|
||||
/**
|
||||
* @brief Get lease id of this lease client.
|
||||
* @brief Get lease ID of this lease client.
|
||||
*
|
||||
* @return Lease id of this lease client.
|
||||
* @return Lease ID of this lease client.
|
||||
*/
|
||||
std::string GetLeaseId() { return m_blobLeaseClient.GetLeaseId(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -287,7 +287,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
Azure::Nullable<Storage::ContentHash> ContentHash;
|
||||
|
||||
/**
|
||||
* Specify the http headers for this path.
|
||||
* Specify the HTTP headers for this path.
|
||||
*/
|
||||
Models::PathHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
@ -371,7 +371,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
struct CreatePathOptions final
|
||||
{
|
||||
/**
|
||||
* Specify the http headers for this path.
|
||||
* Specify the HTTP headers for this path.
|
||||
*/
|
||||
Models::PathHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
|
|||
|
|
@ -75,10 +75,10 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
const DataLakeClientOptions& options = DataLakeClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Gets the path's primary url endpoint. This is the endpoint used for blob
|
||||
* @brief Gets the path's primary URL endpoint. This is the endpoint used for blob
|
||||
* storage available features in DataLake.
|
||||
*
|
||||
* @return The path's primary url endpoint.
|
||||
* @return The path's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_blobClient.GetUrl(); }
|
||||
|
||||
|
|
@ -172,11 +172,11 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
|
||||
/**
|
||||
* @brief Sets the properties of a resource the path points to.
|
||||
* @param options Optional parameters to set the http headers to the resource the path points
|
||||
* @param options Optional parameters to set the HTTP headers to the resource the path points
|
||||
* to.
|
||||
* @param context Context for cancelling long running operations.
|
||||
* @return Azure::Response<SetPathHttpHeadersResult> containing the information
|
||||
* returned when setting the path's Http headers.
|
||||
* returned when setting the path's HTTP headers.
|
||||
* @remark This request is sent to blob endpoint.
|
||||
*/
|
||||
Azure::Response<Models::SetPathHttpHeadersResult> SetHttpHeaders(
|
||||
|
|
|
|||
|
|
@ -216,7 +216,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
std::string Type;
|
||||
|
||||
/**
|
||||
* The id of the ACL.
|
||||
* The ID of the ACL.
|
||||
*/
|
||||
std::string Id;
|
||||
|
||||
|
|
@ -300,7 +300,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
Azure::Nullable<Models::LeaseStatus> LeaseStatus;
|
||||
|
||||
/**
|
||||
* The common http headers of the path.
|
||||
* The common HTTP headers of the path.
|
||||
*/
|
||||
PathHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
@ -417,7 +417,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
};
|
||||
|
||||
/**
|
||||
* @brief The information returned when setting the path's Http headers.
|
||||
* @brief The information returned when setting the path's HTTP headers.
|
||||
*/
|
||||
struct SetPathHttpHeadersResult final
|
||||
{
|
||||
|
|
@ -513,7 +513,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
Models::LeaseStatus LeaseStatus;
|
||||
|
||||
/**
|
||||
* The common Http headers of the file.
|
||||
* The common HTTP headers of the file.
|
||||
*/
|
||||
PathHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
|
|||
|
|
@ -71,10 +71,10 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
DataLakeFileSystemClient GetFileSystemClient(const std::string& fileSystemName) const;
|
||||
|
||||
/**
|
||||
* @brief Gets the datalake service's primary url endpoint. This is the endpoint used for blob
|
||||
* @brief Gets the datalake service's primary URL endpoint. This is the endpoint used for blob
|
||||
* storage available features in DataLake.
|
||||
*
|
||||
* @return The datalake service's primary url endpoint.
|
||||
* @return The datalake service's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_blobServiceClient.GetUrl(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -502,7 +502,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
Azure::Nullable<std::string> AcceptRanges;
|
||||
|
||||
/**
|
||||
* The Http Headers of the object.
|
||||
* The HTTP headers of the object.
|
||||
*/
|
||||
PathHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
@ -526,7 +526,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake {
|
|||
/**
|
||||
* The user-defined properties associated with the file or directory, in the format of a
|
||||
* comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a
|
||||
* base64 encoded string. Note that the string may only contain ASCII characters in the
|
||||
* Base64 encoded string. Note that the string may only contain ASCII characters in the
|
||||
* ISO-8859-1 character set.
|
||||
*/
|
||||
Azure::Nullable<std::string> Properties;
|
||||
|
|
|
|||
|
|
@ -341,7 +341,7 @@ namespace Azure { namespace Storage { namespace Test {
|
|||
}
|
||||
|
||||
{
|
||||
// Http headers works.
|
||||
// HTTP headers works.
|
||||
auto httpHeader = GetInterestingHttpHeaders();
|
||||
std::vector<Files::DataLake::DataLakeDirectoryClient> directoryClient;
|
||||
for (int32_t i = 0; i < 2; ++i)
|
||||
|
|
|
|||
|
|
@ -192,7 +192,7 @@ namespace Azure { namespace Storage { namespace Test {
|
|||
}
|
||||
|
||||
{
|
||||
// Http headers works.
|
||||
// HTTP headers works.
|
||||
auto httpHeader = GetInterestingHttpHeaders();
|
||||
std::vector<Files::DataLake::DataLakeFileClient> fileClient;
|
||||
for (int32_t i = 0; i < 2; ++i)
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@ namespace Azure { namespace Storage { namespace Test {
|
|||
TEST_F(DataLakePathClientTest, PathHttpHeaders)
|
||||
{
|
||||
{
|
||||
// Http headers works with create.
|
||||
// HTTP headers works with create.
|
||||
auto httpHeader = GetInterestingHttpHeaders();
|
||||
std::vector<Files::DataLake::DataLakePathClient> pathClient;
|
||||
for (int32_t i = 0; i < 2; ++i)
|
||||
|
|
@ -145,7 +145,7 @@ namespace Azure { namespace Storage { namespace Test {
|
|||
}
|
||||
|
||||
{
|
||||
// Http headers works with SetHttpHeaders.
|
||||
// HTTP headers works with SetHttpHeaders.
|
||||
auto httpHeader = GetInterestingHttpHeaders();
|
||||
std::vector<Files::DataLake::DataLakePathClient> pathClient;
|
||||
for (int32_t i = 0; i < 2; ++i)
|
||||
|
|
@ -166,7 +166,7 @@ namespace Azure { namespace Storage { namespace Test {
|
|||
}
|
||||
|
||||
{
|
||||
// Set http headers work with last modified access condition.
|
||||
// Set HTTP headers work with last modified access condition.
|
||||
auto response = m_pathClient->GetProperties();
|
||||
Files::DataLake::SetPathHttpHeadersOptions options1;
|
||||
options1.AccessConditions.IfModifiedSince = response.Value.LastModified;
|
||||
|
|
@ -178,7 +178,7 @@ namespace Azure { namespace Storage { namespace Test {
|
|||
}
|
||||
|
||||
{
|
||||
// Set http headers work with last modified access condition.
|
||||
// Set HTTP headers work with last modified access condition.
|
||||
auto response = m_pathClient->GetProperties();
|
||||
Files::DataLake::SetPathHttpHeadersOptions options1;
|
||||
options1.AccessConditions.IfNoneMatch = response.Value.ETag;
|
||||
|
|
|
|||
|
|
@ -578,7 +578,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
struct SignedIdentifier final
|
||||
{
|
||||
/**
|
||||
* A unique id.
|
||||
* A unique ID.
|
||||
*/
|
||||
std::string Id;
|
||||
|
||||
|
|
@ -1186,7 +1186,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
int64_t FileSize = int64_t();
|
||||
|
||||
/**
|
||||
* The Http Headers of the object.
|
||||
* The HTTP headers of the object.
|
||||
*/
|
||||
FileHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
@ -1593,7 +1593,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
constexpr static const char* HeaderTransactionalContentHashCrc64 = "x-ms-content-crc64";
|
||||
|
||||
/**
|
||||
* @brief Only update is supported: - Update: Writes the bytes downloaded from the source url
|
||||
* @brief Only update is supported: - Update: Writes the bytes downloaded from the source URL
|
||||
* into the specified range.
|
||||
*/
|
||||
class FileRangeWriteFromUrl final {
|
||||
|
|
@ -1951,7 +1951,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
Azure::Nullable<std::string> ContinuationToken;
|
||||
|
||||
/**
|
||||
* The Http Headers of the object.
|
||||
* The HTTP headers of the object.
|
||||
*/
|
||||
FileHttpHeaders HttpHeaders;
|
||||
};
|
||||
|
|
@ -1969,7 +1969,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
Azure::Nullable<std::string> ContinuationToken;
|
||||
|
||||
/**
|
||||
* The Http Headers of the object.
|
||||
* The HTTP headers of the object.
|
||||
*/
|
||||
FileHttpHeaders HttpHeaders;
|
||||
};
|
||||
|
|
@ -2010,7 +2010,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
Storage::Metadata Metadata;
|
||||
|
||||
/**
|
||||
* The Http Headers of the object.
|
||||
* The HTTP headers of the object.
|
||||
*/
|
||||
FileHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
@ -2234,7 +2234,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
Azure::Nullable<std::string> ContinuationToken;
|
||||
|
||||
/**
|
||||
* The Http Headers of the object.
|
||||
* The HTTP headers of the object.
|
||||
*/
|
||||
FileHttpHeaders HttpHeaders;
|
||||
};
|
||||
|
|
|
|||
|
|
@ -54,14 +54,14 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
const ShareClientOptions& options = ShareClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Gets the share's primary url endpoint.
|
||||
* @brief Gets the share's primary URL endpoint.
|
||||
*
|
||||
* @return The share's primary url endpoint.
|
||||
* @return The share's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_shareUrl.GetAbsoluteUrl(); }
|
||||
|
||||
/**
|
||||
* @brief Initializes a new instance of the ShareClient class with an identical url
|
||||
* @brief Initializes a new instance of the ShareClient class with an identical URL
|
||||
* source but the specified share snapshot timestamp.
|
||||
*
|
||||
* @param snapshot The snapshot identifier.
|
||||
|
|
|
|||
|
|
@ -58,9 +58,9 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
const ShareClientOptions& options = ShareClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Gets the directory's primary url endpoint.
|
||||
* @brief Gets the directory's primary URL endpoint.
|
||||
*
|
||||
* @return The directory's primary url endpoint.
|
||||
* @return The directory's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_shareDirectoryUrl.GetAbsoluteUrl(); }
|
||||
|
||||
|
|
@ -82,7 +82,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
ShareFileClient GetFileClient(const std::string& fileName) const;
|
||||
|
||||
/**
|
||||
* @brief Initializes a new instance of the ShareDirectoryClient class with an identical url
|
||||
* @brief Initializes a new instance of the ShareDirectoryClient class with an identical URL
|
||||
* source but the specified share snapshot timestamp.
|
||||
*
|
||||
* @param shareSnapshot The snapshot identifier for a share snapshot.
|
||||
|
|
|
|||
|
|
@ -57,14 +57,14 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
const ShareClientOptions& options = ShareClientOptions());
|
||||
|
||||
/**
|
||||
* @brief Gets the file's primary url endpoint.
|
||||
* @brief Gets the file's primary URL endpoint.
|
||||
*
|
||||
* @return The file's primary url endpoint.
|
||||
* @return The file's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_shareFileUrl.GetAbsoluteUrl(); }
|
||||
|
||||
/**
|
||||
* @brief Initializes a new instance of the ShareFileClient class with an identical url
|
||||
* @brief Initializes a new instance of the ShareFileClient class with an identical URL
|
||||
* source but the specified share snapshot timestamp.
|
||||
*
|
||||
* @param shareSnapshot The snapshot identifier for the share snapshot.
|
||||
|
|
@ -231,7 +231,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
|
||||
/**
|
||||
* @brief Sets the properties of the file, or resize a file specifying NewSize in options.
|
||||
* @param httpHeaders The Http headers to be set to the file.
|
||||
* @param httpHeaders The HTTP headers to be set to the file.
|
||||
* @param smbProperties The SMB properties to be set to the file.
|
||||
* @param options Optional parameters to set this file's properties.
|
||||
* @param context Context for cancelling long running operations.
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
AZ_STORAGE_FILES_SHARES_DLLEXPORT static const std::chrono::seconds InfiniteLeaseDuration;
|
||||
|
||||
/**
|
||||
* @brief Get lease id of this lease client.
|
||||
* @brief Get lease ID of this lease client.
|
||||
*
|
||||
* @return Lease id of this lease client.
|
||||
* @return Lease ID of this lease client.
|
||||
*/
|
||||
const std::string& GetLeaseId()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -418,7 +418,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
|
||||
/**
|
||||
* Specifies the option to copy file security descriptor from source file or to set it
|
||||
* using the value which is defined by the smb properties.
|
||||
* using the value which is defined by the SMB properties.
|
||||
*/
|
||||
Azure::Nullable<Models::PermissionCopyMode> PermissionCopyMode;
|
||||
|
||||
|
|
|
|||
|
|
@ -127,7 +127,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
Nullable<Storage::ContentHash> TransactionalContentHash;
|
||||
|
||||
/**
|
||||
* The common Http headers of the file.
|
||||
* The common HTTP headers of the file.
|
||||
*/
|
||||
FileHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
@ -174,7 +174,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
Azure::Core::Http::HttpRange ContentRange;
|
||||
|
||||
/**
|
||||
* The common Http headers of the file.
|
||||
* The common HTTP headers of the file.
|
||||
*/
|
||||
FileHttpHeaders HttpHeaders;
|
||||
|
||||
|
|
|
|||
|
|
@ -60,9 +60,9 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares {
|
|||
ShareClient GetShareClient(const std::string& shareName) const;
|
||||
|
||||
/**
|
||||
* @brief Gets the file share service's primary url endpoint.
|
||||
* @brief Gets the file share service's primary URL endpoint.
|
||||
*
|
||||
* @return The file share service's primary url endpoint.
|
||||
* @return The file share service's primary URL endpoint.
|
||||
*/
|
||||
std::string GetUrl() const { return m_serviceUrl.GetAbsoluteUrl(); }
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Azure Template Package client library for C++
|
||||
|
||||
Azure Template Package client library for C++ (`azure-template`) matches necessary patterns that the development team has established to create a unified sdk written in the C++ programming language. These libraries follow the Azure SDK Design Guidelines for C++.
|
||||
Azure Template Package client library for C++ (`azure-template`) matches necessary patterns that the development team has established to create a unified SDK written in the C++ programming language. 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.
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче