azure-identity
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Azure::Identity::AzurePipelinesCredential Class Referencefinal

Credential which authenticates using an Azure Pipelines service connection. More...

#include <azure_pipelines_credential.hpp>

Inheritance diagram for Azure::Identity::AzurePipelinesCredential:

Public Member Functions

 AzurePipelinesCredential (std::string tenantId, std::string clientId, std::string serviceConnectionId, std::string systemAccessToken, AzurePipelinesCredentialOptions const &options={})
 Constructs an Azure Pipelines Credential.
 
 ~AzurePipelinesCredential () override
 Destructs AzurePipelinesCredential.
 
Core::Credentials::AccessToken GetToken (Core::Credentials::TokenRequestContext const &tokenRequestContext, Core::Context const &context) const override
 Gets an authentication token.
 

Detailed Description

Constructor & Destructor Documentation

◆ AzurePipelinesCredential()

AzurePipelinesCredential::AzurePipelinesCredential ( std::string  tenantId,
std::string  clientId,
std::string  serviceConnectionId,
std::string  systemAccessToken,
AzurePipelinesCredentialOptions const &  options = {} 
)
explicit
Parameters
tenantIdThe tenant ID for the service connection.
clientIdThe client ID for the service connection.
serviceConnectionIdThe service connection ID for the service connection associated with the pipeline.
systemAccessTokenThe pipeline's System.AccessToken value. See https://learn.microsoft.com/azure/devops/pipelines/build/variables?view=azure-devops%26tabs=yaml#systemaccesstoken for more details.
optionsOptions for token retrieval.

◆ ~AzurePipelinesCredential()

AzurePipelinesCredential::~AzurePipelinesCredential ( )
overridedefault

Member Function Documentation

◆ GetToken()

AccessToken AzurePipelinesCredential::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: