@azure/ms-rest-nodeauth package

Classes

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Décrit les informations d’identification en récupérant le jeton via Azure CLI.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Fournit des informations sur les informations d’identification de jeton d’identité de service managé dans un environnement App Service.
MSITokenCredentials	Fournit des informations sur les informations d’identification de jeton d’identité de service managé. Cet objet ne peut être utilisé que pour acquérir un jeton sur une machine virtuelle approvisionnée dans Azure avec une identité de service managé.
MSIVmTokenCredentials	Fournit des informations sur les informations d’identification de jeton d’identité de service managé sur une machine virtuelle provisionnée dans Azure.
TokenCredentialsBase
UserTokenCredentials

Interfaces

AuthResponse	Décrit la réponse d’authentification.
AzureTokenCredentialsOptions	Décrit les paramètres facultatifs pour l’authentification servicePrincipal/secret.
CliAccessToken	Décrit le jeton d’accès récupéré à partir d’Azure CLI.
InteractiveLoginOptions	Décrit les paramètres facultatifs pour l’authentification interactive.
LinkedSubscription	Fournit des informations sur l’abonnement trouvé pendant le processus d’authentification. La structure de ce type est différente de l’objet d’abonnement que l’on obtient en effectuant une requête à l’API ResourceManager.
LinkedUser	Fournit des informations sur un utilisateur du point de vue de l’authentification.
ListAllSubscriptionOptions	Décrit les options qui peuvent être fournies lors de la liste de tous les abonnements/comptes via Azure CLI.
LoginWithAuthFileOptions	Décrit les paramètres facultatifs de connexion avecAuthFile.
LoginWithUsernamePasswordOptions	Décrit les paramètres facultatifs pour l’authentification par nom d’utilisateur/mot de passe.
MSIAppServiceOptions	Définit les paramètres facultatifs pour l’authentification avec MSI pour AppService.
MSIOptions	Définit les paramètres facultatifs pour l’authentification avec MSI.
MSITokenResponse	Décrit msiTokenResponse.
MSIVmOptions	Définit les paramètres facultatifs pour l’authentification avec MSI pour la machine virtuelle.

Alias de type

TokenAudience
UserType	Fournit des informations sur le type d’utilisateur. Il peut actuellement être « utilisateur » ou « servicePrincipal ».

Functions

buildTenantList(TokenCredentialsBase, string)	Génère un tableau de tenantIds.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	Fournit une URL et un code qui doivent être copiés et collés dans un navigateur et authentifiés là-bas. Si elle réussit, l’utilisateur obtient un objet DeviceTokenCredentials et la liste des abonnements associés à cet userId sur tous les locataires applicables. Lorsque vous utilisez des comptes personnels, la propriété `domain` dans le paramètre `options` doit être définie sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	Fournit une URL et un code qui doivent être copiés et collés dans un navigateur et authentifiés là-bas. Si elle réussit, l’utilisateur obtient un objet DeviceTokenCredentials et la liste des abonnements associés à cet userId sur tous les locataires applicables. Lorsque vous utilisez des comptes personnels, la propriété `domain` dans le paramètre `options` doit être définie sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
loginWithAppServiceMSI()	Authentifiez-vous à l’aide de l’instance MSI d’App Service.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Avant d’utiliser cette méthode, installez az cli à partir de https://github.com/Azure/azure-cli/releases. Exécutez ensuite `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`. Si vous souhaitez créer le sp pour un autre cloud/environnement, exécutez : az Cloud List az cloud set –n <nom de l’environnement> az ad sp create-for-rbac --sdk-auth > auth.json // create sp avec secret OR az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate If the service principal is already create then login with service principal info : az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> Compte az afficher ---sdk-auth > auth.json S’authentifie à l’aide des informations de principal de service fournies dans le fichier d’authentification. Cette méthode définit l’subscriptionId du fichier d’authentification sur la variable d’environnement fournie par l’utilisateur dans le paramètre d’options ou la valeur par défaut « AZURE_SUBSCRIPTION_ID ».
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials \| ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Avant d’utiliser cette méthode, installez az cli à partir de https://github.com/Azure/azure-cli/releases. Exécutez ensuite `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`. Si vous souhaitez créer le sp pour un autre cloud/environnement, exécutez : az Cloud List az cloud set –n <nom de l’environnement> az ad sp create-for-rbac --sdk-auth > auth.json // create sp avec secret OR az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate If the service principal is already create then login with service principal info : az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> Compte az afficher ---sdk-auth > auth.json S’authentifie à l’aide des informations de principal de service fournies dans le fichier d’authentification. Cette méthode définit l’subscriptionId du fichier d’authentification sur la variable d’environnement fournie par l’utilisateur dans le paramètre d’options ou la valeur par défaut « AZURE_SUBSCRIPTION_ID ».
loginWithServicePrincipalCertificate(string, string, string)	Fournit un objet ApplicationTokenCertificateCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables. Lorsque vous utilisez des comptes personnels, le paramètre `domain` doit être défini sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)
loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithServicePrincipalCertificate(string, string, string, any)
loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)	Fournit un objet ApplicationTokenCertificateCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables. Lorsque vous utilisez des comptes personnels, le paramètre `domain` doit être défini sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
loginWithServicePrincipalSecret(string, string, string)	Fournit un objet ApplicationTokenCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables. Lorsque vous utilisez des comptes personnels, le paramètre `domain` doit être défini sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)
loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithServicePrincipalSecret(string, string, string, any)
loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)	Fournit un objet ApplicationTokenCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables. Lorsque vous utilisez des comptes personnels, le paramètre `domain` doit être défini sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
loginWithUsernamePassword(string, string)	Fournit un objet UserTokenCredentials et la liste des abonnements associés à cet userId sur tous les locataires applicables. Cette méthode s’applique uniquement aux ID d’organisation qui ne sont pas activés par 2FA sinon, utilisez la connexion interactive. Lorsque vous utilisez des comptes personnels, la propriété `domain` dans le paramètre `options` doit être définie sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	Fournit un objet UserTokenCredentials et la liste des abonnements associés à cet userId sur tous les locataires applicables. Cette méthode s’applique uniquement aux ID d’organisation qui ne sont pas activés par 2FA sinon, utilisez la connexion interactive. Lorsque vous utilisez des comptes personnels, la propriété `domain` dans le paramètre `options` doit être définie sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.
loginWithVmMSI()	Avant d’utiliser cette méthode, installez az cli à partir de https://github.com/Azure/azure-cli/releases. Si vous disposez d’une machine virtuelle Azure provisionnée avec az cli et que MSI est activé, vous pouvez ensuite utiliser cette méthode pour obtenir des jetons d’authentification à partir de la machine virtuelle. Pour créer une machine virtuelle, activez MSI, exécutez cette commande : az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Remarque : la commande ci-dessus active un point de terminaison de service sur l’hôte, avec un port par défaut 50342 Pour activer MSI sur une machine virtuelle déjà configurée, exécutez la commande suivante : az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number> Pour en savoir plus sur cette commande, exécutez : az vm --assign-identity -h Authentifie à l’aide du service d’identité s’exécutant sur une machine virtuelle Azure. Cette méthode effectue une demande au service d’authentification hébergé sur la machine virtuelle et récupère un jeton d’accès.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Variables

AuthConstants

Informations relatives à la fonction

buildTenantList(TokenCredentialsBase, string)

Génère un tableau de tenantIds.

function buildTenantList(credentials: TokenCredentialsBase, apiVersion?: string): Promise<string[]>

Paramètres

credentials: TokenCredentialsBase

Informations d’identification.

apiVersion: string

valeur par défaut 2016-06-01

Retours

Promise<string[]>

Promesse qui se résout sur un tableau de tenantIds et rejette avec une erreur.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Paramètres

credentials: MSITokenCredentials

Retours

Authenticator

interactiveLogin()

Fournit une URL et un code qui doivent être copiés et collés dans un navigateur et authentifiés là-bas. Si elle réussit, l’utilisateur obtient un objet DeviceTokenCredentials et la liste des abonnements associés à cet userId sur tous les locataires applicables.

Lorsque vous utilisez des comptes personnels, la propriété domain dans le paramètre options doit être définie sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Retours

Promise<DeviceTokenCredentials>

Si un rappel a été passé en tant que dernier paramètre, il retourne void else renvoie une promesse. Le rappel est appelé avec l’objet DeviceTokenCredentials résultant et une liste d’abonnements associés sur tous les locataires applicables.

interactiveLogin(InteractiveLoginOptions)

function interactiveLogin(options: InteractiveLoginOptions): Promise<DeviceTokenCredentials>

Paramètres

options: InteractiveLoginOptions

Retours

Promise<DeviceTokenCredentials>

interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)

function interactiveLogin(options: InteractiveLoginOptions, callback: (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

options: InteractiveLoginOptions

callback: (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void

interactiveLogin(any)

function interactiveLogin(callback: any)

Paramètres

callback: any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

function interactiveLoginWithAuthResponse(options?: InteractiveLoginOptions): Promise<AuthResponse<DeviceTokenCredentials>>

Paramètres

options: InteractiveLoginOptions

Objet représentant des paramètres facultatifs.

Retours

Promise<AuthResponse<DeviceTokenCredentials>>

Promesse qui se résout en AuthResponse, qui contient des « informations d’identification » et des « abonnements » facultatifs et rejette avec une erreur.

loginWithAppServiceMSI()

Authentifiez-vous à l’aide de l’instance MSI d’App Service.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Retours

Promise<MSIAppServiceTokenCredentials>

Si un rappel a été passé en tant que dernier paramètre, il retourne void else renvoie une promesse. Le rappel est appelé avec l’objet MSIAppServiceTokenCredentials résultant.

loginWithAppServiceMSI(MSIAppServiceOptions)

function loginWithAppServiceMSI(options: MSIAppServiceOptions): Promise<MSIAppServiceTokenCredentials>

Paramètres

options: MSIAppServiceOptions

Retours

Promise<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(options: MSIAppServiceOptions, callback: Callback<MSIAppServiceTokenCredentials>)

Paramètres

options: MSIAppServiceOptions

callback: Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Paramètres

callback: Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

Avant d’utiliser cette méthode, installez az cli à partir de https://github.com/Azure/azure-cli/releases. Exécutez ensuite az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Si vous souhaitez créer le sp pour un autre cloud/environnement, exécutez :

az Cloud List
az cloud set –n <nom de l’environnement>
az ad sp create-for-rbac --sdk-auth > auth.json // create sp avec secret OR
az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate If the service principal is already create then login with service principal info :
az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
Compte az afficher ---sdk-auth > auth.json

S’authentifie à l’aide des informations de principal de service fournies dans le fichier d’authentification. Cette méthode définit l’subscriptionId du fichier d’authentification sur la variable d’environnement fournie par l’utilisateur dans le paramètre d’options ou la valeur par défaut « AZURE_SUBSCRIPTION_ID ».

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Retours

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Si un rappel a été passé en tant que dernier paramètre, il retourne void else renvoie une promesse. Le rappel est appelé avec l’objet ApplicationTokenCredentials ou ApplicationTokenCertificateCredentials résultant et une liste d’abonnements associés sur tous les locataires applicables.

loginWithAuthFile(LoginWithAuthFileOptions)

function loginWithAuthFile(options: LoginWithAuthFileOptions): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Paramètres

options: LoginWithAuthFileOptions

Retours

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithAuthFile(options: LoginWithAuthFileOptions, callback: (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

options: LoginWithAuthFileOptions

callback: (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

Paramètres

callback: any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

az Cloud List
az cloud set –n <nom de l’environnement>
az ad sp create-for-rbac --sdk-auth > auth.json // create sp avec secret OR
az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate If the service principal is already create then login with service principal info :
az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
Compte az afficher ---sdk-auth > auth.json

function loginWithAuthFileWithAuthResponse(options?: LoginWithAuthFileOptions): Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Paramètres

options: LoginWithAuthFileOptions

Paramètres facultatifs

Retours

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Promesse qui se résout en AuthResponse, qui contient des « informations d’identification » et des « abonnements » facultatifs et rejette avec une erreur.

loginWithServicePrincipalCertificate(string, string, string)

Fournit un objet ApplicationTokenCertificateCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables.

Lorsque vous utilisez des comptes personnels, le paramètre domain doit être défini sur l’ID d’un locataire pour ce compte. Sinon, les informations d’identification résultantes ne pourront pas accéder aux ressources du compte.

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string): Promise<ApplicationTokenCertificateCredentials>

Paramètres

clientId: string

L’ID client de l’application Active Directory également appelé SPN (Nom ServicePrincipal). Consultez démarrage rapide Active Directory pour .Net pour obtenir un exemple.

certificateStringOrFilePath: string

Un certificat encodé PEM et une clé privée OR un chemin de fichier absolu vers le fichier .pem contenant ces informations. Par exemple:

CertificateString : « -----DÉBUT DE LA CLÉ PRIVÉE <-----\nxxxxx>\n-----FIN DE LA CLÉ PRIVÉE-----\n-----DÉBUT DU CERTIFICAT <-----\nyyy>\n-----FIN DU CERTIFICAT-----\n»
CertificateFilePath : chemin d’accès absolu du fichier .pem.

domain: string

ID de domaine ou de locataire contenant cette application.

Retours

Promise<ApplicationTokenCertificateCredentials>

Si un rappel a été passé en tant que dernier paramètre, il retourne void else renvoie une promesse. Le rappel est appelé avec l’objet ApplicationTokenCertificateCredentials résultant et une liste d’abonnements associés sur tous les locataires applicables.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCertificateCredentials>

Paramètres

clientId: string

certificateStringOrFilePath: string

domain: string

options: AzureTokenCredentialsOptions

Retours

Promise<ApplicationTokenCertificateCredentials>

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

clientId: string

certificateStringOrFilePath: string

domain: string

options: AzureTokenCredentialsOptions

callback: (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void

loginWithServicePrincipalCertificate(string, string, string, any)

function loginWithServicePrincipalCertificate(clientId: string, certificateStringOrFilePath: string, domain: string, callback: any)

Paramètres

clientId: string

certificateStringOrFilePath: string

domain: string

callback: any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Fournit un objet ApplicationTokenCertificateCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables.

function loginWithServicePrincipalCertificateWithAuthResponse(clientId: string, certificateStringOrFilePath: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Paramètres

clientId: string

L’ID client de l’application Active Directory également appelé SPN (Nom ServicePrincipal). Consultez démarrage rapide Active Directory pour .Net pour obtenir un exemple.

certificateStringOrFilePath: string

Un certificat encodé PEM et une clé privée OR un chemin de fichier absolu vers le fichier .pem contenant ces informations. Par exemple:

CertificateString : « -----DÉBUT DE LA CLÉ PRIVÉE <-----\nxxxxx>\n-----FIN DE LA CLÉ PRIVÉE-----\n-----DÉBUT DU CERTIFICAT <-----\nyyy>\n-----FIN DU CERTIFICAT-----\n»
CertificateFilePath : chemin d’accès absolu du fichier .pem.

domain: string

ID de domaine ou de locataire contenant cette application.

options: AzureTokenCredentialsOptions

Objet représentant des paramètres facultatifs.

Retours

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Promesse qui se résout en AuthResponse, qui contient des « informations d’identification » et des « abonnements » facultatifs et rejette avec une erreur.

loginWithServicePrincipalSecret(string, string, string)

Fournit un objet ApplicationTokenCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables.

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string): Promise<ApplicationTokenCredentials>

Paramètres

clientId: string

L’ID client de l’application Active Directory également appelé SPN (Nom ServicePrincipal). Consultez démarrage rapide Active Directory pour .Net pour obtenir un exemple.

secret: string

Secret d’application pour le principal de service.

domain: string

ID de domaine ou de locataire contenant cette application.

Retours

Promise<ApplicationTokenCredentials>

Si un rappel a été passé en tant que dernier paramètre, il retourne void else renvoie une promesse. Le rappel est appelé avec l’objet ApplicationTokenCredentials résultant et une liste d’abonnements associés sur tous les locataires applicables.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions): Promise<ApplicationTokenCredentials>

Paramètres

clientId: string

secret: string

domain: string

options: AzureTokenCredentialsOptions

Retours

Promise<ApplicationTokenCredentials>

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, options: AzureTokenCredentialsOptions, callback: (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

clientId: string

secret: string

domain: string

options: AzureTokenCredentialsOptions

callback: (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void

loginWithServicePrincipalSecret(string, string, string, any)

function loginWithServicePrincipalSecret(clientId: string, secret: string, domain: string, callback: any)

Paramètres

clientId: string

secret: string

domain: string

callback: any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Fournit un objet ApplicationTokenCredentials et la liste des abonnements associés à ce servicePrincipalId/clientId sur tous les locataires applicables.

function loginWithServicePrincipalSecretWithAuthResponse(clientId: string, secret: string, domain: string, options?: AzureTokenCredentialsOptions): Promise<AuthResponse<ApplicationTokenCredentials>>

Paramètres

clientId: string

L’ID client de l’application Active Directory également appelé SPN (Nom ServicePrincipal). Consultez démarrage rapide Active Directory pour .Net pour obtenir un exemple.

secret: string

Secret d’application pour le principal de service.

domain: string

ID de domaine ou de locataire contenant cette application.

options: AzureTokenCredentialsOptions

Objet représentant des paramètres facultatifs.

Retours

Promise<AuthResponse<ApplicationTokenCredentials>>

Promesse qui se résout en AuthResponse, qui contient des « informations d’identification » et des « abonnements » facultatifs et rejette avec une erreur.

loginWithUsernamePassword(string, string)

Fournit un objet UserTokenCredentials et la liste des abonnements associés à cet userId sur tous les locataires applicables.

Cette méthode s’applique uniquement aux ID d’organisation qui ne sont pas activés par 2FA sinon, utilisez la connexion interactive.

function loginWithUsernamePassword(username: string, password: string): Promise<UserTokenCredentials>

Paramètres

username: string

Nom d’utilisateur du compte Id d’organisation.

password: string

Mot de passe du compte Id d’organisation.

Retours

Promise<UserTokenCredentials>

Si un rappel a été passé en tant que dernier paramètre, il retourne void else renvoie une promesse. Le rappel est appelé avec l’objet UserTokenCredentials résultant et une liste d’abonnements associés sur tous les locataires applicables.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions): Promise<UserTokenCredentials>

Paramètres

username: string

password: string

options: LoginWithUsernamePasswordOptions

Retours

Promise<UserTokenCredentials>

loginWithUsernamePassword(string, string, any)

function loginWithUsernamePassword(username: string, password: string, callback: any)

Paramètres

username: string

password: string

callback: any

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)

function loginWithUsernamePassword(username: string, password: string, options: LoginWithUsernamePasswordOptions, callback: (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

username: string

password: string

options: LoginWithUsernamePasswordOptions

callback: (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Fournit un objet UserTokenCredentials et la liste des abonnements associés à cet userId sur tous les locataires applicables. Cette méthode s’applique uniquement aux ID d’organisation qui ne sont pas activés par 2FA sinon, utilisez la connexion interactive.

function loginWithUsernamePasswordWithAuthResponse(username: string, password: string, options?: LoginWithUsernamePasswordOptions): Promise<AuthResponse<UserTokenCredentials>>

Paramètres

username: string

Nom d’utilisateur du compte Id d’organisation.

password: string

Mot de passe du compte Id d’organisation.

options: LoginWithUsernamePasswordOptions

Objet représentant des paramètres facultatifs.

Retours

Promise<AuthResponse<UserTokenCredentials>>

Promesse qui se résout en AuthResponse, qui contient credentials et un tableau de subscriptions facultatif, et rejette avec une erreur.

loginWithVmMSI()

Avant d’utiliser cette méthode, installez az cli à partir de https://github.com/Azure/azure-cli/releases. Si vous disposez d’une machine virtuelle Azure provisionnée avec az cli et que MSI est activé, vous pouvez ensuite utiliser cette méthode pour obtenir des jetons d’authentification à partir de la machine virtuelle.

Pour créer une machine virtuelle, activez MSI, exécutez cette commande : az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Remarque : la commande ci-dessus active un point de terminaison de service sur l’hôte, avec un port par défaut 50342

Pour activer MSI sur une machine virtuelle déjà configurée, exécutez la commande suivante : az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Pour en savoir plus sur cette commande, exécutez : az vm --assign-identity -h

Authentifie à l’aide du service d’identité s’exécutant sur une machine virtuelle Azure. Cette méthode effectue une demande au service d’authentification hébergé sur la machine virtuelle et récupère un jeton d’accès.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Retours

Promise<MSIVmTokenCredentials>

Si un rappel a été passé en tant que dernier paramètre, il retourne void else renvoie une promesse. Le rappel est appelé avec l’objet MSIVmTokenCredentials résultant.

loginWithVmMSI(MSIVmOptions)

function loginWithVmMSI(options: MSIVmOptions): Promise<MSIVmTokenCredentials>

Paramètres

options: MSIVmOptions

Retours

Promise<MSIVmTokenCredentials>

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(options: MSIVmOptions, callback: Callback<MSIVmTokenCredentials>)

Paramètres

options: MSIVmOptions

callback: Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Paramètres

callback: Callback<MSIVmTokenCredentials>

Variable Details

AuthConstants

AuthConstants: { AAD_COMMON_TENANT: string, AZURE_AUTH_LOCATION: string, DEFAULT_ADAL_CLIENT_ID: string, DEFAULT_LANGUAGE: string, RESOURCE_MANAGER_ENDPOINT: string, SDK_INTERNAL_ERROR: string }

Type

{ AAD_COMMON_TENANT: string, AZURE_AUTH_LOCATION: string, DEFAULT_ADAL_CLIENT_ID: string, DEFAULT_LANGUAGE: string, RESOURCE_MANAGER_ENDPOINT: string, SDK_INTERNAL_ERROR: string }

Partager via

@azure/ms-rest-nodeauth package

Classes

Interfaces

Alias de type

Functions

Variables

Informations relatives à la fonction

buildTenantList(TokenCredentialsBase, string)

Paramètres

Retours

createAuthenticator(MSITokenCredentials)

Paramètres

Retours

interactiveLogin()

Retours

interactiveLogin(InteractiveLoginOptions)

Paramètres

Retours

interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

interactiveLogin(any)

Paramètres

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Paramètres

Retours

loginWithAppServiceMSI()

Retours

loginWithAppServiceMSI(MSIAppServiceOptions)

Paramètres

Retours

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

Paramètres

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

Paramètres

loginWithAuthFile()

Retours

loginWithAuthFile(LoginWithAuthFileOptions)

Paramètres

Retours

loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

loginWithAuthFile(any)

Paramètres

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Paramètres

Retours

loginWithServicePrincipalCertificate(string, string, string)

Paramètres

Retours

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

Paramètres

Retours

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

loginWithServicePrincipalCertificate(string, string, string, any)

Paramètres

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Paramètres

Retours

loginWithServicePrincipalSecret(string, string, string)

Paramètres

Retours

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

Paramètres

Retours

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions, (err: Error, credentials: ApplicationTokenCredentials, subscriptions: LinkedSubscription[]) => void)

Paramètres

loginWithServicePrincipalSecret(string, string, string, any)

Paramètres

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Paramètres

Retours

loginWithUsernamePassword(string, string)

Paramètres

Retours

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

Paramètres

Retours

loginWithUsernamePassword(string, string, any)