Azure::Identity::EnvironmentCredential Class Reference

Environment Credential initializes an Azure credential, based on the system environment variables being set. More...

#include <environment_credential.hpp>

Inheritance diagram for Azure::Identity::EnvironmentCredential:

Public Member Functions
	EnvironmentCredential (Core::Credentials::TokenCredentialOptions const &options=Core::Credentials::TokenCredentialOptions())
	Constructs an Environment Credential.
	EnvironmentCredential (EnvironmentCredentialOptions const &options)
	Constructs an Environment Credential.
Core::Credentials::AccessToken	GetToken (Core::Credentials::TokenRequestContext const &tokenRequestContext, Core::Context const &context) const override
	Gets an authentication token.

Detailed Description

Note

May read from the following environment variables:

• AZURE_TENANT_ID
• AZURE_CLIENT_ID
• AZURE_CLIENT_SECRET
• AZURE_CLIENT_CERTIFICATE_PATH
• AZURE_CLIENT_CERTIFICATE_PASSWORD
• AZURE_CLIENT_SEND_CERTIFICATE_CHAIN
• AZURE_USERNAME
• AZURE_PASSWORD
• AZURE_AUTHORITY_HOST

Constructor & Destructor Documentation

EnvironmentCredential() [1/2]

EnvironmentCredential::EnvironmentCredential ( Core::Credentials::TokenCredentialOptions const &  options = Core::Credentials::TokenCredentialOptions() )

explicit

Parameters

options

Options for token retrieval.

EnvironmentCredential() [2/2]

EnvironmentCredential::EnvironmentCredential ( EnvironmentCredentialOptions const &  options )

explicit

Parameters

options

Options for token retrieval.

Member Function Documentation

GetToken()

AccessToken EnvironmentCredential::GetToken ( Core::Credentials::TokenRequestContext const &  tokenRequestContext, Core::Context const &  context  ) const

override

Parameters

tokenRequestContext	A context to get the token in.
context	A context to control the request lifetime.

Exceptions

Azure::Core::Credentials::AuthenticationException

Authentication error occurred.

---

The documentation for this class was generated from the following files:

• inc/azure/identity/environment_credential.hpp
• src/environment_credential.cpp