AzurePipelinesCredential class

Essa credencial foi projetada para ser usada em Azure Pipelines com conexões de serviço como configuração para federação de identidade de carga de trabalho.

Construtores

AzurePipelinesCredential(string, string, string, string, AzurePipelinesCredentialOptions)

AzurePipelinesCredential suporta Federated Identity em Azure Pipelines através de Service Connections.

Métodos

getToken(string | string[], GetTokenOptions)

Autentica com o Microsoft Entra ID e retorna um token de acesso se for bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError ou AuthenticationError será gerado com os detalhes da falha.

Detalhes do construtor

AzurePipelinesCredential(string, string, string, string, AzurePipelinesCredentialOptions)

AzurePipelinesCredential suporta Federated Identity em Azure Pipelines através de Service Connections.

new AzurePipelinesCredential(tenantId: string, clientId: string, serviceConnectionId: string, systemAccessToken: string, options?: AzurePipelinesCredentialOptions)

Parâmetros

tenantId

string

tenantId associado à conexão de serviço

clientId

string

clientId associado à conexão de serviço

serviceConnectionId

string

ID exclusiva para a conexão de serviço, conforme encontrado na chave resourceId da querystring

systemAccessToken

string

O pipeline <veja href="https://learn.microsoft.com/azure/devops/pipelines/build/variables?view=azure-devops%26tabs=yaml#systemaccesstoken">System.AccessToken</ver> valor.

options
AzurePipelinesCredentialOptions

As opções de cliente de identidade a serem usadas para autenticação.

Detalhes do método

getToken(string | string[], GetTokenOptions)

Autentica com o Microsoft Entra ID e retorna um token de acesso se for bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError ou AuthenticationError será gerado com os detalhes da falha.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parâmetros

scopes

string | string[]

A lista de escopos para os quais o token terá acesso.

options
GetTokenOptions

As opções usadas para configurar as solicitações que essa implementação do TokenCredential pode fazer.

Retornos

Promise<AccessToken>