Loading [MathJax]/extensions/tex2jax.js
azure-identity
All Classes Files Functions Variables Typedefs Pages
Public Member Functions | List of all members
Azure::Identity::WorkloadIdentityCredential Class Referencefinal

Workload Identity Credential supports Azure workload identity authentication on Kubernetes and other hosts supporting workload identity. See the Azure Kubernetes Service documentation at https://learn.microsoft.com/azure/aks/workload-identity-overview for more information. More...

#include <workload_identity_credential.hpp>

Inheritance diagram for Azure::Identity::WorkloadIdentityCredential:

Public Member Functions

 WorkloadIdentityCredential (Core::Credentials::TokenCredentialOptions const &options=Core::Credentials::TokenCredentialOptions())
 Constructs a Workload Identity Credential.
 
 WorkloadIdentityCredential (WorkloadIdentityCredentialOptions const &options)
 Constructs a Workload Identity Credential.
 
 ~WorkloadIdentityCredential () override
 Destructs WorkloadIdentityCredential.
 
Core::Credentials::AccessToken GetToken (Core::Credentials::TokenRequestContext const &tokenRequestContext, Core::Context const &context) const override
 Gets an authentication token.
 

Detailed Description

Constructor & Destructor Documentation

◆ WorkloadIdentityCredential() [1/2]

WorkloadIdentityCredential::WorkloadIdentityCredential ( Core::Credentials::TokenCredentialOptions const &  options = Core::Credentials::TokenCredentialOptions())
explicit
Parameters
optionsOptions for token retrieval.

◆ WorkloadIdentityCredential() [2/2]

WorkloadIdentityCredential::WorkloadIdentityCredential ( WorkloadIdentityCredentialOptions const &  options)
explicit
Parameters
optionsOptions for token retrieval.

◆ ~WorkloadIdentityCredential()

WorkloadIdentityCredential::~WorkloadIdentityCredential ( )
overridedefault

Member Function Documentation

◆ GetToken()

AccessToken WorkloadIdentityCredential::GetToken ( Core::Credentials::TokenRequestContext const &  tokenRequestContext,
Core::Context const &  context 
) const
override
Parameters
tokenRequestContextA context to get the token in.
contextA context to control the request lifetime.
Exceptions
Azure::Core::Credentials::AuthenticationExceptionAuthentication error occurred.

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