MSIAppServiceTokenCredentials class

Paket:

@azure/ms-rest-nodeauth

Stellt Informationen zu Anmeldeinformationen für verwaltete Dienstidentitätstoken in einer App Service-Umgebung bereit.

Extends

MSITokenCredentials

Konstruktoren

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Erstellt eine Instanz von MSIAppServiceTokenCredentials.

Eigenschaften

clientId	Die Client-ID der verwalteten Identität, für die Sie das Token verwenden möchten. Erforderlich, wenn Ihr App-Dienst über vom Benutzer zugewiesene verwaltete Identitäten verfügt.
msiApiVersion	Die API-Version des lokalen MSI-Agents. Der Standardwert ist "2017-09-01".
msiEndpoint	Die lokale URL, von der Ihre App Token anfordern kann. Sofern diese Eigenschaft nicht angegeben ist, werden alle beiden Umgebungsvariablen IDENTITY_ENDPOINT oder MSI_ENDPOINT als Standardwert verwendet.
msiSecret	Der geheime Schlüssel, der in der Kommunikation zwischen Ihrem Code und dem lokalen MSI-Agent verwendet wird. Sofern diese Eigenschaft nicht angegeben ist, werden alle beiden Umgebungsvariablen IDENTITY_SECRET oder MSI_SECRET als Standardwert verwendet.

Geerbte Eigenschaften

resource

Azure-Ressourcenendpunkte. Der Standardwert ist Azure Resource Manager aus der Umgebung: AzureCloud. „https://management.azure.com/" Für ServiceManagement (ASM): "https://management.core.windows.net/" Für Azure KeyVault: "https://vault.azure.net" Für Azure Batch: "https://batch.core.windows.net" Für Azure Active Directory Graph: "https://graph.windows.net"

Methoden

getToken()

Bereitet eine GET-Anforderung an einen vom App-Dienst angegebenen Dienstendpunkt vor und sendet sie an diesen, der mit dem Zugriffstoken antwortet.

Geerbte Methoden

parseTokenResponse(string)	Analysiert eine tokenResponse-JSON-Zeichenfolge in ein Objekt und konvertiert Eigenschaften auf der ersten Ebene in camelCase. Diese Methode versucht, das tokenResponse zu standardisieren.
signRequest(WebResource)	Signiert eine Anforderung mit dem Authentifizierungsheader.

Details zum Konstruktor

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Erstellt eine Instanz von MSIAppServiceTokenCredentials.

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

Parameter

options

MSIAppServiceOptions

Details zur Eigenschaft

clientId

Die Client-ID der verwalteten Identität, für die Sie das Token verwenden möchten. Erforderlich, wenn Ihr App-Dienst über vom Benutzer zugewiesene verwaltete Identitäten verfügt.

clientId?: string

Eigenschaftswert

string

msiApiVersion

Die API-Version des lokalen MSI-Agents. Der Standardwert ist "2017-09-01".

msiApiVersion?: string

Eigenschaftswert

string

msiEndpoint

Die lokale URL, von der Ihre App Token anfordern kann. Sofern diese Eigenschaft nicht angegeben ist, werden alle beiden Umgebungsvariablen IDENTITY_ENDPOINT oder MSI_ENDPOINT als Standardwert verwendet.

msiEndpoint: string

Eigenschaftswert

string

msiSecret

Der geheime Schlüssel, der in der Kommunikation zwischen Ihrem Code und dem lokalen MSI-Agent verwendet wird. Sofern diese Eigenschaft nicht angegeben ist, werden alle beiden Umgebungsvariablen IDENTITY_SECRET oder MSI_SECRET als Standardwert verwendet.

msiSecret: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

resource

Azure-Ressourcenendpunkte.

• Der Standardwert ist Azure Resource Manager aus der Umgebung: AzureCloud. „https://management.azure.com/"
• Für ServiceManagement (ASM): "https://management.core.windows.net/"
• Für Azure KeyVault: "https://vault.azure.net"
• Für Azure Batch: "https://batch.core.windows.net"
• Für Azure Active Directory Graph: "https://graph.windows.net"

resource: string

Eigenschaftswert

string

geerbt vonMSITokenCredentials.resource

Details zur Methode

getToken()

Bereitet eine GET-Anforderung an einen vom App-Dienst angegebenen Dienstendpunkt vor und sendet sie an diesen, der mit dem Zugriffstoken antwortet.

function getToken(): Promise<MSITokenResponse>

Gibt zurück

Promise<MSITokenResponse>

Zusage mit tokenResponse (tokenType und accessToken sind die beiden wichtigen Eigenschaften).

Details zur geerbten Methode

parseTokenResponse(string)

Analysiert eine tokenResponse-JSON-Zeichenfolge in ein Objekt und konvertiert Eigenschaften auf der ersten Ebene in camelCase. Diese Methode versucht, das tokenResponse zu standardisieren.

function parseTokenResponse(body: string): TokenResponse

Parameter

body

string

Eine JSON-Zeichenfolge

Gibt zurück

TokenResponse

TokenResponse (tokenType und accessToken sind die beiden wichtigen Eigenschaften).

geerbt vonMSITokenCredentials.parseTokenResponse

signRequest(WebResource)

Signiert eine Anforderung mit dem Authentifizierungsheader.

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

Parameter

webResource

WebResource

Die zu signierte WebResource.

Gibt zurück

Promise<WebResource>

Zusage mit signierter WebResource.

vonMSITokenCredentials.signRequest