Partager via

MSIAppServiceTokenCredentials class

Paquet:
@azure/ms-rest-nodeauth

Fournit des informations sur les informations d’identification de jeton d’identité de service managé dans un environnement App Service.

Extends
MSITokenCredentials

Constructeurs

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Crée une instance de MSIAppServiceTokenCredentials.

Propriétés

clientId

Id client de l’identité managée pour laquelle vous souhaitez obtenir le jeton. Obligatoire, si votre service d’application a des identités managées affectées par l’utilisateur.
msiApiVersion

Version api de l’agent MSI local. La valeur par défaut est « 2017-09-01 ».
msiEndpoint

URL locale à partir de laquelle votre application peut demander des jetons. Sauf si cette propriété est spécifiée, l’une des deux variables d’environnement IDENTITY_ENDPOINT ou MSI_ENDPOINT sera utilisée comme valeur par défaut.
msiSecret

Secret utilisé dans la communication entre votre code et l’agent MSI local. Sauf si cette propriété est spécifiée, l’une des deux variables d’environnement IDENTITY_SECRET ou MSI_SECRET sera utilisée comme valeur par défaut.

Propriétés héritées

resource

Points de terminaison de ressources Azure.

  • Valeur par défaut d’Azure Resource Manager à partir de l’environnement : AzureCloud. "https://management.azure.com/" ;
  • Pour ServiceManagement (ASM) : «https://management.core.windows.net/"
  • Pour Azure KeyVault : «https://vault.azure.net"
  • Pour Azure Batch : «https://batch.core.windows.net"
  • Pour Azure Active Directory Graph : «https://graph.windows.net"

Méthodes

getToken()

Prépare et envoie une requête GET à un point de terminaison de service indiqué par le service d’application, qui répond avec le jeton d’accès.

Méthodes héritées

parseTokenResponse(string)

Analyse une chaîne json tokenResponse en objet et convertit les propriétés du premier niveau en camelCase. Cette méthode tente de normaliser le tokenResponse
signRequest(WebResource)

Signe une demande avec l’en-tête d’authentification.

Détails du constructeur

MSIAppServiceTokenCredentials(MSIAppServiceOptions)

Crée une instance de MSIAppServiceTokenCredentials.

new MSIAppServiceTokenCredentials(options?: MSIAppServiceOptions)

Paramètres

options
MSIAppServiceOptions

Détails de la propriété

clientId

Id client de l’identité managée pour laquelle vous souhaitez obtenir le jeton. Obligatoire, si votre service d’application a des identités managées affectées par l’utilisateur.

clientId?: string

Valeur de propriété

string

msiApiVersion

Version api de l’agent MSI local. La valeur par défaut est « 2017-09-01 ».

msiApiVersion?: string

Valeur de propriété

string

msiEndpoint

URL locale à partir de laquelle votre application peut demander des jetons. Sauf si cette propriété est spécifiée, l’une des deux variables d’environnement IDENTITY_ENDPOINT ou MSI_ENDPOINT sera utilisée comme valeur par défaut.

msiEndpoint: string

Valeur de propriété

string

msiSecret

Secret utilisé dans la communication entre votre code et l’agent MSI local. Sauf si cette propriété est spécifiée, l’une des deux variables d’environnement IDENTITY_SECRET ou MSI_SECRET sera utilisée comme valeur par défaut.

msiSecret: string

Valeur de propriété

string

Détails de la propriété héritée

resource

Points de terminaison de ressources Azure.

  • Valeur par défaut d’Azure Resource Manager à partir de l’environnement : AzureCloud. "https://management.azure.com/" ;
  • Pour ServiceManagement (ASM) : «https://management.core.windows.net/"
  • Pour Azure KeyVault : «https://vault.azure.net"
  • Pour Azure Batch : «https://batch.core.windows.net"
  • Pour Azure Active Directory Graph : «https://graph.windows.net"
resource: string

Valeur de propriété

string

héritée deMSITokenCredentials.resource

Détails de la méthode

getToken()

Prépare et envoie une requête GET à un point de terminaison de service indiqué par le service d’application, qui répond avec le jeton d’accès.

function getToken(): Promise<MSITokenResponse>

Retours

Promise<MSITokenResponse>

La promesse avec tokenResponse (tokenType et accessToken sont les deux propriétés importantes).

Détails de la méthode héritée

parseTokenResponse(string)

Analyse une chaîne json tokenResponse en objet et convertit les propriétés du premier niveau en camelCase. Cette méthode tente de normaliser le tokenResponse

function parseTokenResponse(body: string): TokenResponse

Paramètres

body

string

Chaîne json

Retours

TokenResponse

TokenResponse (tokenType et accessToken sont les deux propriétés importantes).

héritée deMSITokenCredentials.parseTokenResponse

signRequest(WebResource)

Signe une demande avec l’en-tête d’authentification.

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

Paramètres

webResource
WebResource

WebResource à signer.

Retours

Promise<WebResource>

Promesse avec WebResource signé.

héritée deMSITokenCredentials.signRequest