ApplicationTokenCertificateCredentials class

Pakiet:

@azure/ms-rest-nodeauth

Rozszerzenie

ApplicationTokenCredentialsBase

Konstruktory

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

Tworzy nowy obiekt ApplicationTokenCredentials. Aby uzyskać szczegółowe instrukcje dotyczące tworzenia aplikacji usługi Azure Active Directory, zobacz przewodnik Szybki start Active Directory dla platformy .Net.

Właściwości

certificate
thumbprint

Właściwości dziedziczone

authContext
clientId
domain
environment
tokenAudience
tokenCache

Metody

create(string, string, string, AzureTokenCredentialsOptions)	Tworzy nowe wystąpienie klasy ApplicationTokenCertificateCredentials.
getToken()	Początkowo próbuje pobrać token z pamięci podręcznej. Jeśli to się nie powiedzie, spróbuje pobrać token z biblioteki ADAL.

Metody dziedziczone

setDomain(string)
signRequest(WebResource)	Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie).

Szczegóły konstruktora

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

Tworzy nowy obiekt ApplicationTokenCredentials. Aby uzyskać szczegółowe instrukcje dotyczące tworzenia aplikacji usługi Azure Active Directory, zobacz przewodnik Szybki start Active Directory dla platformy .Net.

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

Parametry

clientId

string

Identyfikator klienta aplikacji usługi Active Directory.

domain

string

Identyfikator domeny lub dzierżawy zawierający tę aplikację.

certificate

string

Zakodowany klucz prywatny certyfikatu PEM.

thumbprint

string

Kodowany szesnastkowy odcisk palca certyfikatu.

tokenAudience

TokenAudience

Odbiorcy, dla których żądano tokenu. Prawidłowe wartości to "graph", "batch" lub dowolny inny zasób, taki jak "https://vault.azure.net/". Jeśli tokenAudience ma wartość "graph", należy również podać domenę, a jej wartość nie powinna być domyślną dzierżawą "common". Musi to być ciąg (preferowanie w formacie guid).

environment

Environment

Środowisko platformy Azure do uwierzytelniania za pomocą polecenia.

tokenCache

TokenCache

Pamięć podręczna tokenów. Wartość domyślna to obiekt MemoryCache z biblioteki adal.

Szczegóły właściwości

certificate

certificate: string

Wartość właściwości

string

thumbprint

thumbprint: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

authContext

authContext: AuthenticationContext

Wartość właściwości

AuthenticationContext

dziedziczone z ApplicationTokenCredentialsBase.authContext

clientId

clientId: string

Wartość właściwości

string

dziedziczone z ApplicationTokenCredentialsBase.clientId

domain

domain: string

Wartość właściwości

string

dziedziczone z ApplicationTokenCredentialsBase.domain

environment

environment: Environment

Wartość właściwości

Environment

dziedziczone z ApplicationTokenCredentialsBase.environment

tokenAudience

tokenAudience?: string

Wartość właściwości

string

dziedziczone z ApplicationTokenCredentialsBase.tokenAudience

tokenCache

tokenCache: TokenCache

Wartość właściwości

TokenCache

dziedziczone z ApplicationTokenCredentialsBase.tokenCache

Szczegóły metody

create(string, string, string, AzureTokenCredentialsOptions)

Tworzy nowe wystąpienie klasy ApplicationTokenCertificateCredentials.

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

Parametry

clientId

string

Identyfikator klienta aplikacji usługi Active Directory znany również jako nazwa SPN (servicePrincipal Name). Zobacz Przewodnik Szybki start dotyczący usługi Active Directory dla platformy .Net, aby zapoznać się z przykładem.

certificateStringOrFilePath

string

Zakodowany certyfikat PEM i klucz prywatny LUB bezwzględna ścieżka pliku do pliku pem zawierającego te informacje. Na przykład:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: ścieżki pliku bezwzględnego pliku pem.

domain

string

Identyfikator domeny lub dzierżawy zawierający tę aplikację.

options

AzureTokenCredentialsOptions

AzureTokenCredentialsOptions — obiekt reprezentujący parametry opcjonalne.

Zwraca

ApplicationTokenCertificateCredentials

ApplicationTokenCertificateCredentials

getToken()

Początkowo próbuje pobrać token z pamięci podręcznej. Jeśli to się nie powiedzie, spróbuje pobrać token z biblioteki ADAL.

function getToken(): Promise<TokenResponse>

Zwraca

Promise<TokenResponse>

Obietnica, która rozwiązuje problem z tokenemResponse i odrzuca błąd.

Szczegóły metody dziedziczonej

setDomain(string)

function setDomain(domain: string)

Parametry

domain

string

dziedziczone z ApplicationTokenCredentialsBase.setDomain

signRequest(WebResource)

Podpisuje żądanie z nagłówkiem Authentication (Uwierzytelnianie).

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

Parametry

webResource

WebResource

Element WebResource do podpisania.

Zwraca

Promise<WebResource>

dziedziczone z ApplicationTokenCredentialsBase.signRequest