Condividi tramite


@azure/ms-rest-nodeauth package

Classi

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials

Descrive le credenziali recuperando il token tramite l'interfaccia della riga di comando di Azure.

DeviceTokenCredentials
MSIAppServiceTokenCredentials

Fornisce informazioni sulle credenziali del token di identità del servizio gestito in un ambiente del servizio app.

MSITokenCredentials

Fornisce informazioni sulle credenziali del token di identità del servizio gestito. Questo oggetto può essere usato solo per acquisire il token in una macchina virtuale di cui è stato effettuato il provisioning in Azure con identità del servizio gestito.

MSIVmTokenCredentials

Fornisce informazioni sulle credenziali del token di identità del servizio gestito in una macchina virtuale di cui è stato effettuato il provisioning in Azure.

TokenCredentialsBase
UserTokenCredentials

Interfacce

AuthResponse

Descrive la risposta di autenticazione.

AzureTokenCredentialsOptions

Descrive i parametri facoltativi per l'autenticazione servicePrincipal/secret.

CliAccessToken

Descrive il token di accesso recuperato dall'interfaccia della riga di comando di Azure.

InteractiveLoginOptions

Descrive i parametri facoltativi per l'autenticazione interattiva.

LinkedSubscription

Fornisce informazioni sulla sottoscrizione trovata durante il processo di autenticazione. La struttura di questo tipo è diversa dall'oggetto sottoscrizione ottenuto eseguendo una richiesta all'API ResourceManager.

LinkedUser

Fornisce informazioni su un utente dal punto di vista dell'autenticazione.

ListAllSubscriptionOptions

Descrive le opzioni che è possibile specificare durante l'elenco di tutte le sottoscrizioni/account tramite l'interfaccia della riga di comando di Azure.

LoginWithAuthFileOptions

Descrive i parametri facoltativi per l'accesso conAuthFile.

LoginWithUsernamePasswordOptions

Descrive i parametri facoltativi per l'autenticazione con nome utente/password.

MSIAppServiceOptions

Definisce i parametri facoltativi per l'autenticazione con MSI per AppService.

MSIOptions

Definisce i parametri facoltativi per l'autenticazione con MSI.

MSITokenResponse

Descrive MSITokenResponse.

MSIVmOptions

Definisce i parametri facoltativi per l'autenticazione con l'identità del servizio gestito per la macchina virtuale.

Alias tipo

TokenAudience
UserType

Fornisce informazioni sul tipo di utente. Attualmente può essere "utente" o "servicePrincipal".

Funzioni

buildTenantList(TokenCredentialsBase, string)

Compila una matrice di tenantId.

createAuthenticator(MSITokenCredentials)
interactiveLogin()

Fornisce un URL e un codice che devono essere copiati e incollati in un browser e autenticati in questa posizione. In caso di esito positivo, l'utente otterrà un oggetto DeviceTokenCredentials e l'elenco di sottoscrizioni associate a tale userId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Fornisce un URL e un codice che devono essere copiati e incollati in un browser e autenticati in questa posizione. In caso di esito positivo, l'utente otterrà un oggetto DeviceTokenCredentials e l'elenco di sottoscrizioni associate a tale userId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

loginWithAppServiceMSI()

Eseguire l'autenticazione con l'identità del servizio app.

loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()

Prima di usare questo metodo, installare az cli da https://github.com/Azure/azure-cli/releases. Eseguire quindi az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se si vuole creare sp per un ambiente/cloud diverso, eseguire:

  1. az cloud list
  2. az cloud set –n
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp con certificato Se l'entità servizio è già stata creata, accedere con le informazioni sull'entità servizio:
  5. az login --service-principal -u -p -t
  6. az account show --sdk-auth > auth.json

Esegue l'autenticazione usando le informazioni sull'entità servizio fornite nel file di autenticazione. Questo metodo imposta il valore subscriptionId dal file di autenticazione alla variabile di ambiente fornita dall'utente nel parametro options o il valore predefinito "AZURE_SUBSCRIPTION_ID".

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

Prima di usare questo metodo, installare az cli da https://github.com/Azure/azure-cli/releases. Eseguire quindi az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se si vuole creare sp per un ambiente/cloud diverso, eseguire:

  1. az cloud list
  2. az cloud set –n
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp con certificato Se l'entità servizio è già stata creata, accedere con le informazioni sull'entità servizio:
  5. az login --service-principal -u -p -t
  6. az account show --sdk-auth > auth.json

Esegue l'autenticazione usando le informazioni sull'entità servizio fornite nel file di autenticazione. Questo metodo imposta il valore subscriptionId dal file di autenticazione alla variabile di ambiente fornita dall'utente nel parametro options o il valore predefinito "AZURE_SUBSCRIPTION_ID".

loginWithServicePrincipalCertificate(string, string, string)

Fornisce un oggetto ApplicationTokenCertificateCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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)

Fornisce un oggetto ApplicationTokenCertificateCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

loginWithServicePrincipalSecret(string, string, string)

Fornisce un oggetto ApplicationTokenCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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)

Fornisce un oggetto ApplicationTokenCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

loginWithUsernamePassword(string, string)

Fornisce un oggetto UserTokenCredentials e l'elenco delle sottoscrizioni associate a tale userId in tutti i tenant applicabili.

Questo metodo è applicabile solo per gli ID dell'organizzazione che non sono abilitati per 2FA; in caso contrario, usare l'accesso interattivo.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Fornisce un oggetto UserTokenCredentials e l'elenco delle sottoscrizioni associate a tale userId in tutti i tenant applicabili. Questo metodo è applicabile solo per gli ID dell'organizzazione che non sono abilitati per 2FA; in caso contrario, usare l'accesso interattivo.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

loginWithVmMSI()

Prima di usare questo metodo, installare az cli da https://github.com/Azure/azure-cli/releases. Se è stato effettuato il provisioning di una macchina virtuale di Azure con az cli e l'identità del servizio gestito è abilitata, è possibile usare questo metodo per ottenere i token di autenticazione dalla macchina virtuale.

Per creare una nuova macchina virtuale, abilitare l'identità del servizio gestito, eseguire questo comando: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Nota: il comando precedente abilita un endpoint di servizio nell'host, con una porta predefinita 50342

Per abilitare l'identità del servizio gestito in una macchina virtuale già con provisioning, eseguire il comando seguente: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Per altre informazioni su questo comando, eseguire: az vm --assign-identity -h

Esegue l'autenticazione usando il servizio di identità in esecuzione in una macchina virtuale di Azure. Questo metodo effettua una richiesta al servizio di autenticazione ospitato nella macchina virtuale e restituisce un token di accesso.

loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Dettagli funzione

buildTenantList(TokenCredentialsBase, string)

Compila una matrice di tenantId.

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

Parametri

credentials
TokenCredentialsBase

Credenziali.

apiVersion

string

valore predefinito 2016-06-01

Restituisce

Promise<string[]>

Promessa che si risolve in una matrice di tenantId e rifiuta con un errore.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parametri

credentials
MSITokenCredentials

Restituisce

interactiveLogin()

Fornisce un URL e un codice che devono essere copiati e incollati in un browser e autenticati in questa posizione. In caso di esito positivo, l'utente otterrà un oggetto DeviceTokenCredentials e l'elenco di sottoscrizioni associate a tale userId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Restituisce

Se un callback è stato passato come ultimo parametro, restituisce void else restituisce una promessa. Il callback viene chiamato con l'oggetto DeviceTokenCredentials risultante e un elenco di sottoscrizioni associate in tutti i tenant applicabili.

interactiveLogin(InteractiveLoginOptions)

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

Parametri

Restituisce

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

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

Parametri

callback

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

interactiveLogin(any)

function interactiveLogin(callback: any)

Parametri

callback

any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Fornisce un URL e un codice che devono essere copiati e incollati in un browser e autenticati in questa posizione. In caso di esito positivo, l'utente otterrà un oggetto DeviceTokenCredentials e l'elenco di sottoscrizioni associate a tale userId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Parametri

options
InteractiveLoginOptions

Oggetto che rappresenta parametri facoltativi.

Restituisce

Promessa che si risolve in AuthResponse, che contiene la matrice "credentials" e facoltativa "subscriptions" e rifiuta con un errore.

loginWithAppServiceMSI()

Eseguire l'autenticazione con l'identità del servizio app.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Restituisce

Se un callback è stato passato come ultimo parametro, restituisce void else restituisce una promessa. Il callback viene chiamato con l'oggetto MSIAppServiceTokenCredentials risultante.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parametri

Restituisce

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

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

Parametri

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parametri

callback

Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

Prima di usare questo metodo, installare az cli da https://github.com/Azure/azure-cli/releases. Eseguire quindi az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se si vuole creare sp per un ambiente/cloud diverso, eseguire:

  1. az cloud list
  2. az cloud set –n
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp con certificato Se l'entità servizio è già stata creata, accedere con le informazioni sull'entità servizio:
  5. az login --service-principal -u -p -t
  6. az account show --sdk-auth > auth.json

Esegue l'autenticazione usando le informazioni sull'entità servizio fornite nel file di autenticazione. Questo metodo imposta il valore subscriptionId dal file di autenticazione alla variabile di ambiente fornita dall'utente nel parametro options o il valore predefinito "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Restituisce

Se un callback è stato passato come ultimo parametro, restituisce void else restituisce una promessa. Il callback viene chiamato con l'oggetto ApplicationTokenCredentials o ApplicationTokenCertificateCredentials risultante e un elenco di sottoscrizioni associate in tutti i tenant applicabili.

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parametri

Restituisce

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

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

Parametri

callback

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

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

Parametri

callback

any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Prima di usare questo metodo, installare az cli da https://github.com/Azure/azure-cli/releases. Eseguire quindi az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Se si vuole creare sp per un ambiente/cloud diverso, eseguire:

  1. az cloud list
  2. az cloud set –n
  3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR
  4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp con certificato Se l'entità servizio è già stata creata, accedere con le informazioni sull'entità servizio:
  5. az login --service-principal -u -p -t
  6. az account show --sdk-auth > auth.json

Esegue l'autenticazione usando le informazioni sull'entità servizio fornite nel file di autenticazione. Questo metodo imposta il valore subscriptionId dal file di autenticazione alla variabile di ambiente fornita dall'utente nel parametro options o il valore predefinito "AZURE_SUBSCRIPTION_ID".

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

Parametri

options
LoginWithAuthFileOptions

Parametri facoltativi

Restituisce

Promessa che si risolve in AuthResponse, che contiene la matrice "credentials" e facoltativa "subscriptions" e rifiuta con un errore.

loginWithServicePrincipalCertificate(string, string, string)

Fornisce un oggetto ApplicationTokenCertificateCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Parametri

clientId

string

ID client dell'applicazione active directory noto anche come NOME SPN (Nome servicePrincipal). Per un esempio, vedere guida introduttiva di Active Directory per .Net.

certificateStringOrFilePath

string

Un certificato con codifica PEM e una chiave privata OR un percorso file assoluto nel file con estensione pem contenente tali informazioni. Per esempio:

  • CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
  • CertificateFilePath: percorso del file con estensione pem assoluto.
domain

string

ID di dominio o tenant contenente l'applicazione.

Restituisce

Se un callback è stato passato come ultimo parametro, restituisce void else restituisce una promessa. Il callback viene chiamato con l'oggetto ApplicationTokenCertificateCredentials risultante e un elenco di sottoscrizioni associate in tutti i tenant applicabili.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

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

Parametri

clientId

string

certificateStringOrFilePath

string

domain

string

Restituisce

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)

Parametri

clientId

string

certificateStringOrFilePath

string

domain

string

callback

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

loginWithServicePrincipalCertificate(string, string, string, any)

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

Parametri

clientId

string

certificateStringOrFilePath

string

domain

string

callback

any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Fornisce un oggetto ApplicationTokenCertificateCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Parametri

clientId

string

ID client dell'applicazione active directory noto anche come NOME SPN (Nome servicePrincipal). Per un esempio, vedere guida introduttiva di Active Directory per .Net.

certificateStringOrFilePath

string

Un certificato con codifica PEM e una chiave privata OR un percorso file assoluto nel file con estensione pem contenente tali informazioni. Per esempio:

  • CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
  • CertificateFilePath: percorso del file con estensione pem assoluto.
domain

string

ID di dominio o tenant contenente l'applicazione.

options
AzureTokenCredentialsOptions

Oggetto che rappresenta parametri facoltativi.

Restituisce

Promessa che si risolve in AuthResponse, che contiene la matrice "credentials" e facoltativa "subscriptions" e rifiuta con un errore.

loginWithServicePrincipalSecret(string, string, string)

Fornisce un oggetto ApplicationTokenCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Parametri

clientId

string

ID client dell'applicazione active directory noto anche come NOME SPN (Nome servicePrincipal). Per un esempio, vedere guida introduttiva di Active Directory per .Net.

secret

string

Segreto dell'applicazione per l'entità servizio.

domain

string

ID di dominio o tenant contenente l'applicazione.

Restituisce

Se un callback è stato passato come ultimo parametro, restituisce void else restituisce una promessa. Il callback viene chiamato con l'oggetto ApplicationTokenCredentials risultante e un elenco di sottoscrizioni associate in tutti i tenant applicabili.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

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

Parametri

clientId

string

secret

string

domain

string

Restituisce

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)

Parametri

clientId

string

secret

string

domain

string

callback

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

loginWithServicePrincipalSecret(string, string, string, any)

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

Parametri

clientId

string

secret

string

domain

string

callback

any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Fornisce un oggetto ApplicationTokenCredentials e l'elenco di sottoscrizioni associate a tale servicePrincipalId/clientId in tutti i tenant applicabili.

Quando si usano account personali, è necessario impostare il parametro domain sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Parametri

clientId

string

ID client dell'applicazione active directory noto anche come NOME SPN (Nome servicePrincipal). Per un esempio, vedere guida introduttiva di Active Directory per .Net.

secret

string

Segreto dell'applicazione per l'entità servizio.

domain

string

ID di dominio o tenant contenente l'applicazione.

options
AzureTokenCredentialsOptions

Oggetto che rappresenta parametri facoltativi.

Restituisce

Promessa che si risolve in AuthResponse, che contiene la matrice "credentials" e facoltativa "subscriptions" e rifiuta con un errore.

loginWithUsernamePassword(string, string)

Fornisce un oggetto UserTokenCredentials e l'elenco delle sottoscrizioni associate a tale userId in tutti i tenant applicabili.

Questo metodo è applicabile solo per gli ID dell'organizzazione che non sono abilitati per 2FA; in caso contrario, usare l'accesso interattivo.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Parametri

username

string

Nome utente per l'account ID organizzazione.

password

string

Password per l'account ID organizzazione.

Restituisce

Se un callback è stato passato come ultimo parametro, restituisce void else restituisce una promessa. Il callback viene chiamato con l'oggetto UserTokenCredentials risultante e un elenco di sottoscrizioni associate in tutti i tenant applicabili.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parametri

username

string

password

string

Restituisce

loginWithUsernamePassword(string, string, any)

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

Parametri

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)

Parametri

username

string

password

string

callback

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

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Fornisce un oggetto UserTokenCredentials e l'elenco delle sottoscrizioni associate a tale userId in tutti i tenant applicabili. Questo metodo è applicabile solo per gli ID dell'organizzazione che non sono abilitati per 2FA; in caso contrario, usare l'accesso interattivo.

Quando si usano account personali, è necessario impostare la proprietà domain nel parametro options sull'ID di un tenant per tale account. In caso contrario, le credenziali risultanti non saranno in grado di accedere alle risorse dell'account.

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

Parametri

username

string

Nome utente per l'account ID organizzazione.

password

string

Password per l'account ID organizzazione.

options
LoginWithUsernamePasswordOptions

Oggetto che rappresenta parametri facoltativi.

Restituisce

Promessa che si risolve in AuthResponse, che contiene credentials e una matrice di subscriptions facoltativa e rifiuta con un errore.

loginWithVmMSI()

Prima di usare questo metodo, installare az cli da https://github.com/Azure/azure-cli/releases. Se è stato effettuato il provisioning di una macchina virtuale di Azure con az cli e l'identità del servizio gestito è abilitata, è possibile usare questo metodo per ottenere i token di autenticazione dalla macchina virtuale.

Per creare una nuova macchina virtuale, abilitare l'identità del servizio gestito, eseguire questo comando: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Nota: il comando precedente abilita un endpoint di servizio nell'host, con una porta predefinita 50342

Per abilitare l'identità del servizio gestito in una macchina virtuale già con provisioning, eseguire il comando seguente: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Per altre informazioni su questo comando, eseguire: az vm --assign-identity -h

Esegue l'autenticazione usando il servizio di identità in esecuzione in una macchina virtuale di Azure. Questo metodo effettua una richiesta al servizio di autenticazione ospitato nella macchina virtuale e restituisce un token di accesso.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Restituisce

Se un callback è stato passato come ultimo parametro, restituisce void else restituisce una promessa. Il callback viene chiamato con l'oggetto MSIVmTokenCredentials risultante.

loginWithVmMSI(MSIVmOptions)

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

Parametri

options
MSIVmOptions

Restituisce

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

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

Parametri

options
MSIVmOptions
callback

Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parametri

callback

Callback<MSIVmTokenCredentials>