@azure/ms-rest-nodeauth package

Klasserna

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Beskriver autentiseringsuppgifterna genom att hämta token via Azure CLI.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Innehåller information om autentiseringsuppgifter för hanterad tjänstidentitetstoken i en App Service-miljö.
MSITokenCredentials	Innehåller information om autentiseringsuppgifter för hanterad tjänstidentitetstoken. Det här objektet kan bara användas för att hämta token på en virtuell dator som etablerats i Azure med hanterad tjänstidentitet.
MSIVmTokenCredentials	Innehåller information om autentiseringsuppgifter för hanterad tjänstidentitetstoken på en virtuell dator som etablerats i Azure.
TokenCredentialsBase
UserTokenCredentials

Gränssnitt

AuthResponse	Beskriver autentiseringssvaret.
AzureTokenCredentialsOptions	Beskriver valfria parametrar för servicePrincipal-/hemlig autentisering.
CliAccessToken	Beskriver den åtkomsttoken som hämtats från Azure CLI.
InteractiveLoginOptions	Beskriver valfria parametrar för interaktiv autentisering.
LinkedSubscription	Innehåller information om prenumerationen som hittades under autentiseringsprocessen. Strukturen för den här typen skiljer sig från prenumerationsobjektet som en hämtar genom att göra en begäran till ResourceManager-API:et.
LinkedUser	Innehåller information om en användare ur autentiseringsperspektivet.
ListAllSubscriptionOptions	Beskriver de alternativ som kan anges när du listar alla prenumerationer/konton via Azure CLI.
LoginWithAuthFileOptions	Beskriver valfria parametrar för inloggning medAuthFile.
LoginWithUsernamePasswordOptions	Beskriver valfria parametrar för autentisering med användarnamn/lösenord.
MSIAppServiceOptions	Definierar de valfria parametrarna för autentisering med MSI för AppService.
MSIOptions	Definierar de valfria parametrarna för autentisering med MSI.
MSITokenResponse	Beskriver MSITokenResponse.
MSIVmOptions	Definierar de valfria parametrarna för autentisering med MSI för virtuell dator.

Typaliaser

TokenAudience
UserType	Innehåller information om användartyp. Det kan för närvarande vara "användare" eller "servicePrincipal".

Funktioner

buildTenantList(TokenCredentialsBase, string)	Skapar en matris med tenantIds.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	Innehåller en URL och kod som måste kopieras och klistras in i en webbläsare och autentiseras där borta. Om det lyckas får användaren ett DeviceTokenCredentials-objekt och en lista över prenumerationer som är associerade med det userId för alla tillämpliga klienter. När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	Innehåller en URL och kod som måste kopieras och klistras in i en webbläsare och autentiseras där borta. Om det lyckas får användaren ett DeviceTokenCredentials-objekt och en lista över prenumerationer som är associerade med det userId för alla tillämpliga klienter. När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
loginWithAppServiceMSI()	Autentisera med hjälp av App Service MSI.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Innan du använder den här metoden installerar du az cli från https://github.com/Azure/azure-cli/releases. Kör sedan az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Om du vill skapa sp för ett annat moln/en annan miljö kör du: AZ Cloud List az cloud set –n <namnet på miljön> az ad sp create-for-rbac --sdk-auth > auth.json // create sp med hemlig ELLER az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Om tjänstens huvudnamn redan har skapats loggar du in med information om tjänstens huvudnamn: az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> AZ-konto visar --SDK-auth > auth.json Autentiserar med hjälp av informationen om tjänstens huvudnamn som anges i autentiseringsfilen. Den här metoden anger subscriptionId från autentiseringsfilen till miljövariabeln som användaren angav i alternativparametern eller standardvärdet "AZURE_SUBSCRIPTION_ID".
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Innan du använder den här metoden installerar du az cli från https://github.com/Azure/azure-cli/releases. Kör sedan az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Om du vill skapa sp för ett annat moln/en annan miljö kör du: AZ Cloud List az cloud set –n <namnet på miljön> az ad sp create-for-rbac --sdk-auth > auth.json // create sp med hemlig ELLER az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Om tjänstens huvudnamn redan har skapats loggar du in med information om tjänstens huvudnamn: az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> AZ-konto visar --SDK-auth > auth.json Autentiserar med hjälp av informationen om tjänstens huvudnamn som anges i autentiseringsfilen. Den här metoden anger subscriptionId från autentiseringsfilen till miljövariabeln som användaren angav i alternativparametern eller standardvärdet "AZURE_SUBSCRIPTION_ID".
loginWithServicePrincipalCertificate(string, string, string)	Tillhandahåller ett ApplicationTokenCertificateCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter. När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
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)	Tillhandahåller ett ApplicationTokenCertificateCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter. När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
loginWithServicePrincipalSecret(string, string, string)	Innehåller ett ApplicationTokenCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter. När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
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)	Innehåller ett ApplicationTokenCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter. När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
loginWithUsernamePassword(string, string)	Innehåller ett UserTokenCredentials-objekt och en lista över prenumerationer som är associerade med det användar-ID:et för alla tillämpliga klienter. Den här metoden gäller endast för organisations-ID:er som inte är 2FA-aktiverade, annars använder du interaktiv inloggning. När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	Innehåller ett UserTokenCredentials-objekt och en lista över prenumerationer som är associerade med det användar-ID:et för alla tillämpliga klienter. Den här metoden gäller endast för organisations-ID:er som inte är 2FA-aktiverade, annars använder du interaktiv inloggning. När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.
loginWithVmMSI()	Innan du använder den här metoden installerar du az cli från https://github.com/Azure/azure-cli/releases. Om du har en virtuell Azure-dator etablerad med az cli och har MSI aktiverat kan du använda den här metoden för att hämta autentiseringstoken från den virtuella datorn. Om du vill skapa en ny virtuell dator aktiverar du MSI genom att köra det här kommandot: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Obs! Kommandot ovan aktiverar en tjänstslutpunkt på värden med standardporten 50342 Om du vill aktivera MSI på en redan etablerad virtuell dator kör du följande kommando: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number> Om du vill veta mer om det här kommandot kör du: az vm --assign-identity -h Autentiserar med hjälp av identitetstjänsten som körs på en virtuell Azure-dator. Den här metoden skickar en begäran till den autentiseringstjänst som finns på den virtuella datorn och hämtar tillbaka en åtkomsttoken.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Variabler

AuthConstants

Funktionsdetaljer

buildTenantList(TokenCredentialsBase, string)

Skapar en matris med tenantIds.

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

Parametrar

credentials

TokenCredentialsBase

Autentiseringsuppgifterna.

apiVersion

string

standardvärde 2016-06-01

Returnerar

Promise<string[]>

Ett löfte som matchar en matris med tenantIds och avvisar med ett fel.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parametrar

credentials

MSITokenCredentials

Returnerar

Authenticator

interactiveLogin()

Innehåller en URL och kod som måste kopieras och klistras in i en webbläsare och autentiseras där borta. Om det lyckas får användaren ett DeviceTokenCredentials-objekt och en lista över prenumerationer som är associerade med det userId för alla tillämpliga klienter.

När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Returnerar

Promise<DeviceTokenCredentials>

Om en motringning skickades som den sista parametern returnerar den void else returnerar ett löfte. Återanropet anropas med det resulterande DeviceTokenCredentials-objektet och en lista över associerade prenumerationer för alla tillämpliga klienter.

interactiveLogin(InteractiveLoginOptions)

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

Parametrar

options

InteractiveLoginOptions

Returnerar

Promise<DeviceTokenCredentials>

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

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

Parametrar

options

InteractiveLoginOptions

callback

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

interactiveLogin(any)

function interactiveLogin(callback: any)

Parametrar

callback

any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Innehåller en URL och kod som måste kopieras och klistras in i en webbläsare och autentiseras där borta. Om det lyckas får användaren ett DeviceTokenCredentials-objekt och en lista över prenumerationer som är associerade med det userId för alla tillämpliga klienter.

När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

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

Parametrar

options

InteractiveLoginOptions

Objekt som representerar valfria parametrar.

Returnerar

Promise<AuthResponse<DeviceTokenCredentials>>

Ett löfte som matchar AuthResponse, som innehåller "autentiseringsuppgifter" och valfria "prenumerationer"-matris och avvisar med ett fel.

loginWithAppServiceMSI()

Autentisera med hjälp av App Service MSI.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Returnerar

Promise<MSIAppServiceTokenCredentials>

Om en motringning skickades som den sista parametern returnerar den void else returnerar ett löfte. Återanropet anropas med det resulterande MSIAppServiceTokenCredentials-objektet.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parametrar

options

MSIAppServiceOptions

Returnerar

Promise<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

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

Parametrar

options

MSIAppServiceOptions

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parametrar

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

Innan du använder den här metoden installerar du az cli från https://github.com/Azure/azure-cli/releases. Kör sedan az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Om du vill skapa sp för ett annat moln/en annan miljö kör du:

1. AZ Cloud List
2. az cloud set –n <namnet på miljön>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp med hemlig ELLER
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Om tjänstens huvudnamn redan har skapats loggar du in med information om tjänstens huvudnamn:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. AZ-konto visar --SDK-auth > auth.json

Autentiserar med hjälp av informationen om tjänstens huvudnamn som anges i autentiseringsfilen. Den här metoden anger subscriptionId från autentiseringsfilen till miljövariabeln som användaren angav i alternativparametern eller standardvärdet "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Returnerar

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Om en motringning skickades som den sista parametern returnerar den void else returnerar ett löfte. Återanropet anropas med det resulterande ApplicationTokenCredentials- eller ApplicationTokenCertificateCredentials-objektet och en lista över associerade prenumerationer för alla tillämpliga klienter.

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parametrar

options

LoginWithAuthFileOptions

Returnerar

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)

Parametrar

options

LoginWithAuthFileOptions

callback

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

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

Parametrar

callback

any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Innan du använder den här metoden installerar du az cli från https://github.com/Azure/azure-cli/releases. Kör sedan az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Om du vill skapa sp för ett annat moln/en annan miljö kör du:

1. AZ Cloud List
2. az cloud set –n <namnet på miljön>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp med hemlig ELLER
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Om tjänstens huvudnamn redan har skapats loggar du in med information om tjänstens huvudnamn:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. AZ-konto visar --SDK-auth > auth.json

Autentiserar med hjälp av informationen om tjänstens huvudnamn som anges i autentiseringsfilen. Den här metoden anger subscriptionId från autentiseringsfilen till miljövariabeln som användaren angav i alternativparametern eller standardvärdet "AZURE_SUBSCRIPTION_ID".

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

Parametrar

options

LoginWithAuthFileOptions

Valfria parametrar

Returnerar

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Ett löfte som matchar AuthResponse, som innehåller "autentiseringsuppgifter" och valfria "prenumerationer"-matris och avvisar med ett fel.

loginWithServicePrincipalCertificate(string, string, string)

Tillhandahåller ett ApplicationTokenCertificateCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter.

När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

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

Parametrar

clientId

string

Active Directory-programklient-ID:t kallas även SPN (ServicePrincipal Name). Ett exempel finns i Active Directory-snabbstart för .Net.

certificateStringOrFilePath

string

Ett PEM-kodat certifikat och en privat nyckel ELLER en absolut filsökväg till .pem-filen som innehåller den informationen. Till exempel:

• CertificateString: "-----BEGIN PRIVATE KEY <-----\nxxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE <-----\nyyyyy>\n-----END CERTIFICATE-----\n"
• CertificateFilePath: Absolut filsökväg för .pem-filen.

domain

string

Domänen eller klient-ID:t som innehåller det här programmet.

Returnerar

Promise<ApplicationTokenCertificateCredentials>

Om en motringning skickades som den sista parametern returnerar den void else returnerar ett löfte. Återanropet anropas med det resulterande ApplicationTokenCertificateCredentials-objektet och en lista över associerade prenumerationer för alla tillämpliga klienter.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

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

Parametrar

clientId

string

certificateStringOrFilePath

string

domain

string

options

AzureTokenCredentialsOptions

Returnerar

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)

Parametrar

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)

Parametrar

clientId

string

certificateStringOrFilePath

string

domain

string

callback

any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Tillhandahåller ett ApplicationTokenCertificateCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter.

När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

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

Parametrar

clientId

string

Active Directory-programklient-ID:t kallas även SPN (ServicePrincipal Name). Ett exempel finns i Active Directory-snabbstart för .Net.

certificateStringOrFilePath

string

Ett PEM-kodat certifikat och en privat nyckel ELLER en absolut filsökväg till .pem-filen som innehåller den informationen. Till exempel:

• CertificateString: "-----BEGIN PRIVATE KEY <-----\nxxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE <-----\nyyyyy>\n-----END CERTIFICATE-----\n"
• CertificateFilePath: Absolut filsökväg för .pem-filen.

domain

string

Domänen eller klient-ID:t som innehåller det här programmet.

options

AzureTokenCredentialsOptions

Objekt som representerar valfria parametrar.

Returnerar

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Ett löfte som matchar AuthResponse, som innehåller "autentiseringsuppgifter" och valfria "prenumerationer"-matris och avvisar med ett fel.

loginWithServicePrincipalSecret(string, string, string)

Innehåller ett ApplicationTokenCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter.

När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

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

Parametrar

clientId

string

Active Directory-programklient-ID:t kallas även SPN (ServicePrincipal Name). Ett exempel finns i Active Directory-snabbstart för .Net.

secret

string

Programhemligheten för tjänstens huvudnamn.

domain

string

Domänen eller klient-ID:t som innehåller det här programmet.

Returnerar

Promise<ApplicationTokenCredentials>

Om en motringning skickades som den sista parametern returnerar den void else returnerar ett löfte. Återanropet anropas med det resulterande ApplicationTokenCredentials-objektet och en lista över associerade prenumerationer för alla tillämpliga klienter.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

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

Parametrar

clientId

string

secret

string

domain

string

options

AzureTokenCredentialsOptions

Returnerar

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)

Parametrar

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)

Parametrar

clientId

string

secret

string

domain

string

callback

any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Innehåller ett ApplicationTokenCredentials-objekt och en lista över prenumerationer som är associerade med servicePrincipalId/clientId för alla tillämpliga klienter.

När du använder personliga konton måste parametern domain anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

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

Parametrar

clientId

string

Active Directory-programklient-ID:t kallas även SPN (ServicePrincipal Name). Ett exempel finns i Active Directory-snabbstart för .Net.

secret

string

Programhemligheten för tjänstens huvudnamn.

domain

string

Domänen eller klient-ID:t som innehåller det här programmet.

options

AzureTokenCredentialsOptions

Objekt som representerar valfria parametrar.

Returnerar

Promise<AuthResponse<ApplicationTokenCredentials>>

Ett löfte som matchar AuthResponse, som innehåller "autentiseringsuppgifter" och valfria "prenumerationer"-matris och avvisar med ett fel.

loginWithUsernamePassword(string, string)

Innehåller ett UserTokenCredentials-objekt och en lista över prenumerationer som är associerade med det användar-ID:et för alla tillämpliga klienter.

Den här metoden gäller endast för organisations-ID:er som inte är 2FA-aktiverade, annars använder du interaktiv inloggning.

När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

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

Parametrar

username

string

Användarnamnet för organisations-ID-kontot.

password

string

Lösenordet för organisations-ID-kontot.

Returnerar

Promise<UserTokenCredentials>

Om en motringning skickades som den sista parametern returnerar den void else returnerar ett löfte. Återanropet anropas med det resulterande UserTokenCredentials-objektet och en lista över associerade prenumerationer för alla tillämpliga klienter.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parametrar

username

string

password

string

options

LoginWithUsernamePasswordOptions

Returnerar

Promise<UserTokenCredentials>

loginWithUsernamePassword(string, string, any)

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

Parametrar

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)

Parametrar

username

string

password

string

options

LoginWithUsernamePasswordOptions

callback

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

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Innehåller ett UserTokenCredentials-objekt och en lista över prenumerationer som är associerade med det användar-ID:et för alla tillämpliga klienter. Den här metoden gäller endast för organisations-ID:er som inte är 2FA-aktiverade, annars använder du interaktiv inloggning.

När du använder personliga konton måste egenskapen domain i parametern options anges till ID för en klient för det kontot. Annars kommer den resulterande autentiseringsuppgiften inte att kunna komma åt kontots resurser.

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

Parametrar

username

string

Användarnamnet för organisations-ID-kontot.

password

string

Lösenordet för organisations-ID-kontot.

options

LoginWithUsernamePasswordOptions

Objekt som representerar valfria parametrar.

Returnerar

Promise<AuthResponse<UserTokenCredentials>>

Ett löfte som matchar AuthResponse, som innehåller credentials och en valfri subscriptions-matris, och avvisar med ett fel.

loginWithVmMSI()

Innan du använder den här metoden installerar du az cli från https://github.com/Azure/azure-cli/releases. Om du har en virtuell Azure-dator etablerad med az cli och har MSI aktiverat kan du använda den här metoden för att hämta autentiseringstoken från den virtuella datorn.

Om du vill skapa en ny virtuell dator aktiverar du MSI genom att köra det här kommandot: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Obs! Kommandot ovan aktiverar en tjänstslutpunkt på värden med standardporten 50342

Om du vill aktivera MSI på en redan etablerad virtuell dator kör du följande kommando: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Om du vill veta mer om det här kommandot kör du: az vm --assign-identity -h

Autentiserar med hjälp av identitetstjänsten som körs på en virtuell Azure-dator. Den här metoden skickar en begäran till den autentiseringstjänst som finns på den virtuella datorn och hämtar tillbaka en åtkomsttoken.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Returnerar

Promise<MSIVmTokenCredentials>

Om en motringning skickades som den sista parametern returnerar den void else returnerar ett löfte. Återanropet anropas med det resulterande MSIVmTokenCredentials-objektet.

loginWithVmMSI(MSIVmOptions)

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

Parametrar

options

MSIVmOptions

Returnerar

Promise<MSIVmTokenCredentials>

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

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

Parametrar

options

MSIVmOptions

callback

Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parametrar

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 }

Typ

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