Compartilhar via

ApplicationTokenCertificateCredentials class

  • Referência
Pacote:
@azure/ms-rest-nodeauth
Extends

ApplicationTokenCredentialsBase

Construtores

ApplicationTokenCertificateCredentials(string, string, string, string, TokenAudience, Environment, TokenCache)

Cria um novo objeto ApplicationTokenCredentials. Consulte Início Rápido do Active Directory para .Net para obter instruções detalhadas sobre como criar um aplicativo do Azure Active Directory.

Propriedades

certificate
thumbprint

Propriedades herdadas

authContext
clientId
domain
environment
tokenAudience
tokenCache

Métodos

create(string, string, string, AzureTokenCredentialsOptions)

Cria uma nova instância de ApplicationTokenCertificateCredentials.
getToken()

Tenta obter o token do cache inicialmente. Se isso não for bem-sucedido, ele tentará obter o token da ADAL.

Métodos herdados

setDomain(string)
signRequest(WebResource)

Assina uma solicitação com o cabeçalho autenticação.

Detalhes do construtor

ApplicationTokenCertificateCredentials(string, string, string, string, TokenAudience, Environment, TokenCache)

Cria um novo objeto ApplicationTokenCredentials. Consulte Início Rápido do Active Directory para .Net para obter instruções detalhadas sobre como criar um aplicativo do Azure Active Directory.

new ApplicationTokenCertificateCredentials(clientId: string, domain: string, certificate: string, thumbprint: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)

Parâmetros

clientId

string

A ID do cliente do aplicativo active directory.

domain

string

A ID de domínio ou locatário que contém este aplicativo.

certificate

string

Uma chave privada de certificado codificado em PEM.

thumbprint

string

Uma impressão digital codificada em hex do certificado.

tokenAudience
TokenAudience

O público-alvo para o qual o token é solicitado. Os valores válidos são 'graph', 'batch' ou qualquer outro recurso como 'https://vault.azure.net/'. Se tokenAudience for 'graph', o domínio também deverá ser fornecido e seu valor não deve ser o locatário 'comum' padrão. Deve ser uma cadeia de caracteres (preferencialmente em um formato guid).

environment
Environment

O ambiente do azure com o qual autenticar.

tokenCache

TokenCache

O cache de token. O valor padrão é o objeto MemoryCache da adal.

Detalhes da propriedade

certificate 

certificate: string

Valor da propriedade

string

thumbprint 

thumbprint: string

Valor da propriedade

string

Detalhes das propriedades herdadas

authContext 

authContext: AuthenticationContext

Valor da propriedade

AuthenticationContext

herdado de ApplicationTokenCredentialsBase.authContext

clientId 

clientId: string

Valor da propriedade

string

Herdado de ApplicationTokenCredentialsBase.clientId

domain 

domain: string

Valor da propriedade

string

herdado de ApplicationTokenCredentialsBase.domain

environment 

environment: Environment

Valor da propriedade

Environment

herdado de ApplicationTokenCredentialsBase.environment

tokenAudience 

tokenAudience?: string

Valor da propriedade

string

herdado de ApplicationTokenCredentialsBase.tokenAudience

tokenCache 

tokenCache: TokenCache

Valor da propriedade

TokenCache

herdado de ApplicationTokenCredentialsBase.tokenCache

Detalhes do método

create(string, string, string, AzureTokenCredentialsOptions)

Cria uma nova instância de ApplicationTokenCertificateCredentials.

static function create(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): ApplicationTokenCertificateCredentials

Parâmetros

clientId

string

A ID do cliente do aplicativo active directory também conhecida como SPN (Nome ServicePrincipal). Consulte Início Rápido do Active Directory para .Net para obter um exemplo.

certificateStringOrFilePath

string

Um certificado codificado em PEM e uma chave privada OU um caminho de arquivo absoluto para o arquivo .pem que contém essas informações. Por exemplo:

  • CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
  • CertificateFilePath: caminho de arquivo absoluto do arquivo .pem.
domain

string

A ID de domínio ou locatário que contém este aplicativo.

options
AzureTokenCredentialsOptions

AzureTokenCredentialsOptions – Objeto que representa parâmetros opcionais.

Retornos

ApplicationTokenCertificateCredentials

ApplicationTokenCertificateCredentials

getToken()

Tenta obter o token do cache inicialmente. Se isso não for bem-sucedido, ele tentará obter o token da ADAL.

function getToken(): Promise<TokenResponse>

Retornos

Promise<TokenResponse>

Uma promessa que resolve para TokenResponse e rejeita com um Erro.

Detalhes do método herdado

setDomain(string) 

function setDomain(domain: string)

Parâmetros

domain

string

Herdado de ApplicationTokenCredentialsBase.setDomain

signRequest(WebResource)

Assina uma solicitação com o cabeçalho autenticação.

function signRequest(webResource: WebResource): Promise<WebResource>

Parâmetros

webResource
WebResource

O WebResource a ser assinado.

Retornos

Promise<WebResource>

herdado de ApplicationTokenCredentialsBase.signRequest