@azure/ms-rest-nodeauth package

Klassen

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Beschreibt die Anmeldeinformationen durch Abrufen des Tokens über Azure CLI.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Stellt Informationen zu Anmeldeinformationen für verwaltete Dienstidentitätstoken in einer App Service-Umgebung bereit.
MSITokenCredentials	Stellt Informationen zu Anmeldeinformationen für verwaltete Dienstidentitätstoken bereit. Dieses Objekt kann nur verwendet werden, um Token auf einem virtuellen Computer abzurufen, der in Azure mit verwalteter Dienstidentität bereitgestellt wird.
MSIVmTokenCredentials	Stellt Informationen zu Anmeldeinformationen für verwaltete Dienstidentitätstoken auf einem virtuellen Computer bereit, der in Azure bereitgestellt wird.
TokenCredentialsBase
UserTokenCredentials

Schnittstellen

AuthResponse	Beschreibt die Authentifizierungsantwort.
AzureTokenCredentialsOptions	Beschreibt optionale Parameter für die servicePrincipal/secret-Authentifizierung.
CliAccessToken	Beschreibt das von Azure CLI abgerufene Zugriffstoken.
InteractiveLoginOptions	Beschreibt optionale Parameter für die interaktive Authentifizierung.
LinkedSubscription	Stellt Informationen zum Abonnement bereit, das während des Authentifizierungsprozesses gefunden wurde. Die Struktur dieses Typs unterscheidet sich von dem Abonnementobjekt, das durch Senden einer Anforderung an die ResourceManager-API abgerufen wird.
LinkedUser	Stellt Informationen zu einem Benutzer aus der Authentifizierungsperspektive bereit.
ListAllSubscriptionOptions	Beschreibt die Optionen, die beim Auflisten aller Abonnements/Konten über Azure CLI bereitgestellt werden können.
LoginWithAuthFileOptions	Beschreibt optionale Parameter für die Anmeldung mitAuthFile.
LoginWithUsernamePasswordOptions	Beschreibt optionale Parameter für die Authentifizierung mit Benutzername/Kennwort.
MSIAppServiceOptions	Definiert die optionalen Parameter für die Authentifizierung mit MSI für AppService.
MSIOptions	Definiert die optionalen Parameter für die Authentifizierung mit MSI.
MSITokenResponse	Beschreibt das MSITokenResponse.
MSIVmOptions	Definiert die optionalen Parameter für die Authentifizierung mit MSI für virtuelle Computer.

Typaliase

TokenAudience
UserType	Stellt Informationen zum Benutzertyp bereit. Er kann derzeit "user" oder "servicePrincipal" sein.

Functions

buildTenantList(TokenCredentialsBase, string)	Erstellt ein Array von TenantIds.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	Stellt eine URL und einen Code bereit, der in einen Browser kopiert und eingefügt und dort authentifiziert werden muss. Bei erfolgreicher Ausführung erhält der Benutzer ein DeviceTokenCredentials-Objekt und die Liste der Abonnements, die dieser UserId zugeordnet sind, über alle anwendbaren Mandanten hinweg. Bei Verwendung von persönlichen Konten muss die `domain`-Eigenschaft im parameter `options` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	Stellt eine URL und einen Code bereit, der in einen Browser kopiert und eingefügt und dort authentifiziert werden muss. Bei erfolgreicher Ausführung erhält der Benutzer ein DeviceTokenCredentials-Objekt und die Liste der Abonnements, die dieser UserId zugeordnet sind, über alle anwendbaren Mandanten hinweg. Bei Verwendung von persönlichen Konten muss die `domain`-Eigenschaft im parameter `options` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
loginWithAppServiceMSI()	Authentifizieren Sie sich mithilfe der App Service-MSI.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Bevor Sie diese Methode verwenden, installieren Sie az cli von https://github.com/Azure/azure-cli/releases. Führen Sie dann `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`aus. Wenn Sie den SP für eine andere Cloud/Umgebung erstellen möchten, führen Sie folgendes aus: AZ Cloud List az cloud set –n <Name der Umgebung> az ad sp create-for-rbac --sdk-auth > auth.json // create sp mit geheimen ODER az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // SP mit Zertifikat erstellen Wenn der Dienstprinzipal bereits erstellt wurde, melden Sie sich mit den Informationen zum Dienstprinzipal an: az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> az account show --sdk-auth > auth.json Authentifiziert sich mithilfe der Dienstprinzipalinformationen, die in der Authentifizierungsdatei bereitgestellt werden. Diese Methode legt die subscriptionId aus der Authentifizierungsdatei auf die vom Benutzer bereitgestellte Umgebungsvariable im Optionsparameter oder die Standardeinstellung "AZURE_SUBSCRIPTION_ID" fest.
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials \| ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Bevor Sie diese Methode verwenden, installieren Sie az cli von https://github.com/Azure/azure-cli/releases. Führen Sie dann `az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}`aus. Wenn Sie den SP für eine andere Cloud/Umgebung erstellen möchten, führen Sie folgendes aus: AZ Cloud List az cloud set –n <Name der Umgebung> az ad sp create-for-rbac --sdk-auth > auth.json // create sp mit geheimen ODER az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // SP mit Zertifikat erstellen Wenn der Dienstprinzipal bereits erstellt wurde, melden Sie sich mit den Informationen zum Dienstprinzipal an: az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId> az account show --sdk-auth > auth.json Authentifiziert sich mithilfe der Dienstprinzipalinformationen, die in der Authentifizierungsdatei bereitgestellt werden. Diese Methode legt die subscriptionId aus der Authentifizierungsdatei auf die vom Benutzer bereitgestellte Umgebungsvariable im Optionsparameter oder die Standardeinstellung "AZURE_SUBSCRIPTION_ID" fest.
loginWithServicePrincipalCertificate(string, string, string)	Stellt ein ApplicationTokenCertificateCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind. Wenn Sie persönliche Konten verwenden, muss der parameter `domain` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
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)	Stellt ein ApplicationTokenCertificateCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind. Wenn Sie persönliche Konten verwenden, muss der parameter `domain` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
loginWithServicePrincipalSecret(string, string, string)	Stellt ein ApplicationTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind. Wenn Sie persönliche Konten verwenden, muss der parameter `domain` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
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)	Stellt ein ApplicationTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind. Wenn Sie persönliche Konten verwenden, muss der parameter `domain` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
loginWithUsernamePassword(string, string)	Stellt ein UserTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser UserId für alle anwendbaren Mandanten zugeordnet sind. Diese Methode gilt nur für Organisations-IDs, die nicht 2FA aktiviert sind, andernfalls verwenden Sie die interaktive Anmeldung. Bei Verwendung von persönlichen Konten muss die `domain`-Eigenschaft im parameter `options` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	Stellt ein UserTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser UserId für alle anwendbaren Mandanten zugeordnet sind. Diese Methode gilt nur für Organisations-IDs, die nicht 2FA aktiviert sind, andernfalls verwenden Sie die interaktive Anmeldung. Bei Verwendung von persönlichen Konten muss die `domain`-Eigenschaft im parameter `options` auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.
loginWithVmMSI()	Bevor Sie diese Methode verwenden, installieren Sie az cli von https://github.com/Azure/azure-cli/releases. Wenn Sie einen virtuellen Azure-Computer mit az cli bereitgestellt haben und MSI aktiviert ist, können Sie diese Methode verwenden, um Authentifizierungstoken von der VM abzurufen. Um einen neuen virtuellen Computer zu erstellen, aktivieren Sie MSI, führen Sie den folgenden Befehl aus: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Hinweis: Der obige Befehl aktiviert einen Dienstendpunkt auf dem Host mit einem Standardport 50342 Um MSI auf einer bereits bereitgestellten VM zu aktivieren, führen Sie den folgenden Befehl aus: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number> Um mehr über diesen Befehl zu erfahren, führen Sie folgendes aus: az vm --assign-identity -h Authentifiziert sich mithilfe des Identitätsdiensts, der auf einem virtuellen Azure-Computer ausgeführt wird. Diese Methode sendet eine Anforderung an den Authentifizierungsdienst, der auf der VM gehostet wird, und ruft ein Zugriffstoken zurück.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Variablen

AuthConstants

Details zur Funktion

buildTenantList(TokenCredentialsBase, string)

Erstellt ein Array von TenantIds.

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

Parameter

credentials: TokenCredentialsBase

Die Anmeldeinformationen.

apiVersion: string

Standardwert 2016-06-01

Gibt zurück

Promise<string[]>

Eine Zusage, die in ein Array von TenantIds aufgelöst und mit einem Fehler abgelehnt wird.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parameter

credentials: MSITokenCredentials

Gibt zurück

Authenticator

interactiveLogin()

Stellt eine URL und einen Code bereit, der in einen Browser kopiert und eingefügt und dort authentifiziert werden muss. Bei erfolgreicher Ausführung erhält der Benutzer ein DeviceTokenCredentials-Objekt und die Liste der Abonnements, die dieser UserId zugeordnet sind, über alle anwendbaren Mandanten hinweg.

Bei Verwendung von persönlichen Konten muss die domain-Eigenschaft im parameter options auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Gibt zurück

Promise<DeviceTokenCredentials>

Wenn ein Rückruf als letzter Parameter übergeben wurde, gibt er "void" zurück. Andernfalls wird eine Zusage zurückgegeben. Der Rückruf wird mit dem resultierenden DeviceTokenCredentials-Objekt und einer Liste der zugehörigen Abonnements für alle anwendbaren Mandanten aufgerufen.

interactiveLogin(InteractiveLoginOptions)

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

Parameter

options: InteractiveLoginOptions

Gibt zurück

Promise<DeviceTokenCredentials>

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

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

Parameter

options: InteractiveLoginOptions

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

interactiveLogin(any)

function interactiveLogin(callback: any)

Parameter

callback: any

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

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

Parameter

options: InteractiveLoginOptions

Objekt, das optionale Parameter darstellt.

Gibt zurück

Promise<AuthResponse<DeviceTokenCredentials>>

Eine Zusage, die in AuthResponse aufgelöst wird, die "Anmeldeinformationen" und optionales "Abonnements"-Array enthält und mit einem Fehler ablehnt.

loginWithAppServiceMSI()

Authentifizieren Sie sich mithilfe der App Service-MSI.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Gibt zurück

Promise<MSIAppServiceTokenCredentials>

Wenn ein Rückruf als letzter Parameter übergeben wurde, gibt er "void" zurück. Andernfalls wird eine Zusage zurückgegeben. Der Rückruf wird mit dem resultierenden MSIAppServiceTokenCredentials-Objekt aufgerufen.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parameter

options: MSIAppServiceOptions

Gibt zurück

Promise<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

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

Parameter

options: MSIAppServiceOptions

callback: Callback<MSIAppServiceTokenCredentials>

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parameter

callback: Callback<MSIAppServiceTokenCredentials>

loginWithAuthFile()

Bevor Sie diese Methode verwenden, installieren Sie az cli von https://github.com/Azure/azure-cli/releases. Führen Sie dann az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}aus. Wenn Sie den SP für eine andere Cloud/Umgebung erstellen möchten, führen Sie folgendes aus:

AZ Cloud List
az cloud set –n <Name der Umgebung>
az ad sp create-for-rbac --sdk-auth > auth.json // create sp mit geheimen ODER
az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // SP mit Zertifikat erstellen Wenn der Dienstprinzipal bereits erstellt wurde, melden Sie sich mit den Informationen zum Dienstprinzipal an:
az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
az account show --sdk-auth > auth.json

Authentifiziert sich mithilfe der Dienstprinzipalinformationen, die in der Authentifizierungsdatei bereitgestellt werden. Diese Methode legt die subscriptionId aus der Authentifizierungsdatei auf die vom Benutzer bereitgestellte Umgebungsvariable im Optionsparameter oder die Standardeinstellung "AZURE_SUBSCRIPTION_ID" fest.

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Gibt zurück

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Wenn ein Rückruf als letzter Parameter übergeben wurde, gibt er "void" zurück. Andernfalls wird eine Zusage zurückgegeben. Der Rückruf wird mit dem resultierenden ApplicationTokenCredentials- oder ApplicationTokenCertificateCredentials-Objekt und einer Liste der zugehörigen Abonnements für alle anwendbaren Mandanten aufgerufen.

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parameter

options: LoginWithAuthFileOptions

Gibt zurück

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)

Parameter

options: LoginWithAuthFileOptions

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

loginWithAuthFile(any)

function loginWithAuthFile(callback: any)

Parameter

callback: any

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

AZ Cloud List
az cloud set –n <Name der Umgebung>
az ad sp create-for-rbac --sdk-auth > auth.json // create sp mit geheimen ODER
az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // SP mit Zertifikat erstellen Wenn der Dienstprinzipal bereits erstellt wurde, melden Sie sich mit den Informationen zum Dienstprinzipal an:
az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
az account show --sdk-auth > auth.json

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

Parameter

options: LoginWithAuthFileOptions

Optionale Parameter

Gibt zurück

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

Eine Zusage, die in AuthResponse aufgelöst wird, die "Anmeldeinformationen" und optionales "Abonnements"-Array enthält und mit einem Fehler ablehnt.

loginWithServicePrincipalCertificate(string, string, string)

Stellt ein ApplicationTokenCertificateCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind.

Wenn Sie persönliche Konten verwenden, muss der parameter domain auf die ID eines Mandanten für dieses Konto festgelegt werden. Andernfalls können die resultierenden Anmeldeinformationen nicht auf die Ressourcen des Kontos zugreifen.

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

Parameter

clientId: string

Die Client-ID der Active Directory-Anwendung, die auch als SPN (ServicePrincipal Name) bezeichnet wird. Ein Beispiel finden Sie unter Active Directory-Schnellstart für .Net-.

certificateStringOrFilePath: string

Ein PEM-codiertes Zertifikat und ein privater Schlüssel ODER ein absoluter Dateipfad zur PEM-Datei, die diese Informationen enthält. Zum Beispiel:

CertificateString: "-----BEGIN PRIVATE KEY<-----\nxxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nyyyyy<\n-----END CERTIFICATE>-----\n"
CertificateFilePath: Absolute Dateipfad der PEM-Datei.

domain: string

Die Domänen- oder Mandanten-ID, die diese Anwendung enthält.

Gibt zurück

Promise<ApplicationTokenCertificateCredentials>

Wenn ein Rückruf als letzter Parameter übergeben wurde, gibt er "void" zurück. Andernfalls wird eine Zusage zurückgegeben. Der Rückruf wird mit dem resultierenden ApplicationTokenCertificateCredentials-Objekt und einer Liste der zugehörigen Abonnements für alle anwendbaren Mandanten aufgerufen.

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

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

Parameter

clientId: string

certificateStringOrFilePath: string

domain: string

options: AzureTokenCredentialsOptions

Gibt zurück

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)

Parameter

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)

Parameter

clientId: string

certificateStringOrFilePath: string

domain: string

callback: any

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Stellt ein ApplicationTokenCertificateCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind.

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

Parameter

clientId: string

Die Client-ID der Active Directory-Anwendung, die auch als SPN (ServicePrincipal Name) bezeichnet wird. Ein Beispiel finden Sie unter Active Directory-Schnellstart für .Net-.

certificateStringOrFilePath: string

Ein PEM-codiertes Zertifikat und ein privater Schlüssel ODER ein absoluter Dateipfad zur PEM-Datei, die diese Informationen enthält. Zum Beispiel:

CertificateString: "-----BEGIN PRIVATE KEY<-----\nxxxxx>\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\nyyyyy<\n-----END CERTIFICATE>-----\n"
CertificateFilePath: Absolute Dateipfad der PEM-Datei.

domain: string

Die Domänen- oder Mandanten-ID, die diese Anwendung enthält.

options: AzureTokenCredentialsOptions

Objekt, das optionale Parameter darstellt.

Gibt zurück

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

Eine Zusage, die in AuthResponse aufgelöst wird, die "Anmeldeinformationen" und optionales "Abonnements"-Array enthält und mit einem Fehler ablehnt.

loginWithServicePrincipalSecret(string, string, string)

Stellt ein ApplicationTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind.

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

Parameter

clientId: string

Die Client-ID der Active Directory-Anwendung, die auch als SPN (ServicePrincipal Name) bezeichnet wird. Ein Beispiel finden Sie unter Active Directory-Schnellstart für .Net-.

secret: string

Der Anwendungsschlüssel für den Dienstprinzipal.

domain: string

Die Domänen- oder Mandanten-ID, die diese Anwendung enthält.

Gibt zurück

Promise<ApplicationTokenCredentials>

Wenn ein Rückruf als letzter Parameter übergeben wurde, gibt er "void" zurück. Andernfalls wird eine Zusage zurückgegeben. Der Rückruf wird mit dem resultierenden ApplicationTokenCredentials-Objekt und einer Liste der zugehörigen Abonnements für alle anwendbaren Mandanten aufgerufen.

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

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

Parameter

clientId: string

secret: string

domain: string

options: AzureTokenCredentialsOptions

Gibt zurück

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)

Parameter

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)

Parameter

clientId: string

secret: string

domain: string

callback: any

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Stellt ein ApplicationTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser servicePrincipalId/clientId für alle anwendbaren Mandanten zugeordnet sind.

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

Parameter

clientId: string

Die Client-ID der Active Directory-Anwendung, die auch als SPN (ServicePrincipal Name) bezeichnet wird. Ein Beispiel finden Sie unter Active Directory-Schnellstart für .Net-.

secret: string

Der Anwendungsschlüssel für den Dienstprinzipal.

domain: string

Die Domänen- oder Mandanten-ID, die diese Anwendung enthält.

options: AzureTokenCredentialsOptions

Objekt, das optionale Parameter darstellt.

Gibt zurück

Promise<AuthResponse<ApplicationTokenCredentials>>

Eine Zusage, die in AuthResponse aufgelöst wird, die "Anmeldeinformationen" und optionales "Abonnements"-Array enthält und mit einem Fehler ablehnt.

loginWithUsernamePassword(string, string)

Stellt ein UserTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser UserId für alle anwendbaren Mandanten zugeordnet sind.

Diese Methode gilt nur für Organisations-IDs, die nicht 2FA aktiviert sind, andernfalls verwenden Sie die interaktive Anmeldung.

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

Parameter

username: string

Der Benutzername für das Organisations-ID-Konto.

password: string

Das Kennwort für das Organisations-ID-Konto.

Gibt zurück

Promise<UserTokenCredentials>

Wenn ein Rückruf als letzter Parameter übergeben wurde, gibt er "void" zurück. Andernfalls wird eine Zusage zurückgegeben. Der Rückruf wird mit dem resultierenden UserTokenCredentials-Objekt und einer Liste der zugehörigen Abonnements für alle anwendbaren Mandanten aufgerufen.

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parameter

username: string

password: string

options: LoginWithUsernamePasswordOptions

Gibt zurück

Promise<UserTokenCredentials>

loginWithUsernamePassword(string, string, any)

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

Parameter

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)

Parameter

username: string

password: string

options: LoginWithUsernamePasswordOptions

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

loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)

Stellt ein UserTokenCredentials -Objekt und die Liste der Abonnements bereit, die dieser UserId für alle anwendbaren Mandanten zugeordnet sind. Diese Methode gilt nur für Organisations-IDs, die nicht 2FA aktiviert sind, andernfalls verwenden Sie die interaktive Anmeldung.

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

Parameter

username: string

Der Benutzername für das Organisations-ID-Konto.

password: string

Das Kennwort für das Organisations-ID-Konto.

options: LoginWithUsernamePasswordOptions

Objekt, das optionale Parameter darstellt.

Gibt zurück

Promise<AuthResponse<UserTokenCredentials>>

Eine Zusage, die in AuthResponse aufgelöst wird, die credentials und ein optionales subscriptions Array enthält und mit einem Fehler ablehnt.

loginWithVmMSI()

Bevor Sie diese Methode verwenden, installieren Sie az cli von https://github.com/Azure/azure-cli/releases. Wenn Sie einen virtuellen Azure-Computer mit az cli bereitgestellt haben und MSI aktiviert ist, können Sie diese Methode verwenden, um Authentifizierungstoken von der VM abzurufen.

Um einen neuen virtuellen Computer zu erstellen, aktivieren Sie MSI, führen Sie den folgenden Befehl aus: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Hinweis: Der obige Befehl aktiviert einen Dienstendpunkt auf dem Host mit einem Standardport 50342

Um MSI auf einer bereits bereitgestellten VM zu aktivieren, führen Sie den folgenden Befehl aus: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Um mehr über diesen Befehl zu erfahren, führen Sie folgendes aus: az vm --assign-identity -h

Authentifiziert sich mithilfe des Identitätsdiensts, der auf einem virtuellen Azure-Computer ausgeführt wird. Diese Methode sendet eine Anforderung an den Authentifizierungsdienst, der auf der VM gehostet wird, und ruft ein Zugriffstoken zurück.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Gibt zurück

Promise<MSIVmTokenCredentials>

Wenn ein Rückruf als letzter Parameter übergeben wurde, gibt er "void" zurück. Andernfalls wird eine Zusage zurückgegeben. Der Rückruf wird mit dem resultierenden MSIVmTokenCredentials-Objekt aufgerufen.

loginWithVmMSI(MSIVmOptions)

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

Parameter

options: MSIVmOptions

Gibt zurück

Promise<MSIVmTokenCredentials>

loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)

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

Parameter

options: MSIVmOptions

callback: Callback<MSIVmTokenCredentials>

loginWithVmMSI(Callback<MSIVmTokenCredentials>)

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parameter

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 }

Freigeben über

@azure/ms-rest-nodeauth package

Klassen

Schnittstellen

Typaliase

Functions

Variablen

Details zur Funktion

buildTenantList(TokenCredentialsBase, string)

Parameter

Gibt zurück

createAuthenticator(MSITokenCredentials)

Parameter

Gibt zurück

interactiveLogin()

Gibt zurück

interactiveLogin(InteractiveLoginOptions)

Parameter

Gibt zurück

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

Parameter

interactiveLogin(any)

Parameter

interactiveLoginWithAuthResponse(InteractiveLoginOptions)

Parameter

Gibt zurück

loginWithAppServiceMSI()

Gibt zurück

loginWithAppServiceMSI(MSIAppServiceOptions)

Parameter

Gibt zurück

loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)

Parameter

loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)

Parameter

loginWithAuthFile()

Gibt zurück

loginWithAuthFile(LoginWithAuthFileOptions)

Parameter

Gibt zurück

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

Parameter

loginWithAuthFile(any)

Parameter

loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)

Parameter

Gibt zurück

loginWithServicePrincipalCertificate(string, string, string)

Parameter

Gibt zurück

loginWithServicePrincipalCertificate(string, string, string, AzureTokenCredentialsOptions)

Parameter

Gibt zurück

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

Parameter

loginWithServicePrincipalCertificate(string, string, string, any)

Parameter

loginWithServicePrincipalCertificateWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Parameter

Gibt zurück

loginWithServicePrincipalSecret(string, string, string)

Parameter

Gibt zurück

loginWithServicePrincipalSecret(string, string, string, AzureTokenCredentialsOptions)

Parameter

Gibt zurück

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

Parameter

loginWithServicePrincipalSecret(string, string, string, any)

Parameter

loginWithServicePrincipalSecretWithAuthResponse(string, string, string, AzureTokenCredentialsOptions)

Parameter

Gibt zurück

loginWithUsernamePassword(string, string)

Parameter

Gibt zurück

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

Parameter

Gibt zurück

loginWithUsernamePassword(string, string, any)