@azure/ms-rest-nodeauth package

Bérlőazonosítók tömbjének létrehozása.

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

Paraméterek

Visszatér

Egy ígéret, amely a bérlőazonosítók tömbjére oldódik fel, és egy hibával elutasítja.

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Paraméterek

Visszatér

Olyan URL-címet és kódot biztosít, amelyet át kell másolni és beilleszteni egy böngészőbe, és ott hitelesíteni kell. Ha sikeres, a felhasználó egy DeviceTokenCredentials objektumot és az adott userId-hez társított előfizetések listáját fogja kapni az összes vonatkozó bérlőben.

Személyes fiókok használatakor a domain paraméter options tulajdonságát az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Visszatér

Ha egy visszahívást az utolsó paraméterként ad vissza, akkor érvénytelen lesz, máskülönben ígéretet ad vissza. A visszahívás az eredményül kapott DeviceTokenCredentials objektummal és az összes vonatkozó bérlőhöz tartozó előfizetések listájával lesz meghívva.

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

Paraméterek

Visszatér

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

Paraméterek

function interactiveLogin(callback: any)

Paraméterek

Olyan URL-címet és kódot biztosít, amelyet át kell másolni és beilleszteni egy böngészőbe, és ott hitelesíteni kell. Ha sikeres, a felhasználó egy DeviceTokenCredentials objektumot és az adott userId-hez társított előfizetések listáját fogja kapni az összes vonatkozó bérlőben.

Személyes fiókok használatakor a domain paraméter options tulajdonságát az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

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

Paraméterek

Visszatér

Az AuthResponse számára feloldott ígéret, amely tartalmazza a "hitelesítő adatokat" és az opcionális "előfizetések" tömböt, és hibaüzenettel elutasítja.

Hitelesítés az App Service MSI használatával.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Visszatér

Ha egy visszahívást az utolsó paraméterként ad vissza, akkor érvénytelen lesz, máskülönben ígéretet ad vissza. A visszahívást az eredményül kapott MSIAppServiceTokenCredentials objektum hívja meg.

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

Paraméterek

Visszatér

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

Paraméterek

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Paraméterek

A módszer használata előtt telepítse az az cli-t https://github.com/Azure/azure-cli/releases. Ezután hajtsa végre az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Ha egy másik felhőhöz/környezethez szeretné létrehozni az sp-t, hajtsa végre a következőt:

1. az cloud list
2. az cloud set –n <a környezet neve>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp titkos VAGY
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp tanúsítvánnyal Ha a szolgáltatásnév már létrejött, jelentkezzen be a szolgáltatásnév adataival:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. az account show --SDK-Auth > auth.json

Hitelesítés a hitelesítési fájlban megadott egyszerű szolgáltatásadatok használatával. Ez a módszer a hitelesítési fájlból a felhasználó által megadott környezeti változóra állítja be az előfizetés azonosítóját a beállításparaméterben vagy az alapértelmezett "AZURE_SUBSCRIPTION_ID".

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Visszatér

Ha egy visszahívást az utolsó paraméterként ad vissza, akkor érvénytelen lesz, máskülönben ígéretet ad vissza. A visszahívást az eredményül kapott ApplicationTokenCredentials vagy ApplicationTokenCertificateCredentials objektum, valamint a kapcsolódó előfizetések listája hívja meg az összes megfelelő bérlőben.

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

Paraméterek

Visszatér

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

Paraméterek

function loginWithAuthFile(callback: any)

Paraméterek

A módszer használata előtt telepítse az az cli-t https://github.com/Azure/azure-cli/releases. Ezután hajtsa végre az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Ha egy másik felhőhöz/környezethez szeretné létrehozni az sp-t, hajtsa végre a következőt:

1. az cloud list
2. az cloud set –n <a környezet neve>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp titkos VAGY
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp tanúsítvánnyal Ha a szolgáltatásnév már létrejött, jelentkezzen be a szolgáltatásnév adataival:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. az account show --SDK-Auth > auth.json

Hitelesítés a hitelesítési fájlban megadott egyszerű szolgáltatásadatok használatával. Ez a módszer a hitelesítési fájlból a felhasználó által megadott környezeti változóra állítja be az előfizetés azonosítóját a beállításparaméterben vagy az alapértelmezett "AZURE_SUBSCRIPTION_ID".

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

Paraméterek

Visszatér

Az AuthResponse számára feloldott ígéret, amely tartalmazza a "hitelesítő adatokat" és az opcionális "előfizetések" tömböt, és hibaüzenettel elutasítja.

Egy ApplicationTokenCertificateCredentials objektumot és az adott servicePrincipalId/clientId azonosítóhoz társított előfizetések listáját tartalmazza az összes vonatkozó bérlőn.

Személyes fiókok használatakor a domain paramétert az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

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

Paraméterek

Visszatér

Ha egy visszahívást az utolsó paraméterként ad vissza, akkor érvénytelen lesz, máskülönben ígéretet ad vissza. A visszahívás az eredményül kapott ApplicationTokenCertificateCredentials objektummal és az összes érintett bérlőhöz tartozó előfizetések listájával hívódik meg.

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

Paraméterek

Visszatér

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

Paraméterek

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

Paraméterek

Egy ApplicationTokenCertificateCredentials objektumot és az adott servicePrincipalId/clientId azonosítóhoz társított előfizetések listáját tartalmazza az összes vonatkozó bérlőn.

Személyes fiókok használatakor a domain paramétert az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

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

Paraméterek

Visszatér

Az AuthResponse számára feloldott ígéret, amely tartalmazza a "hitelesítő adatokat" és az opcionális "előfizetések" tömböt, és hibaüzenettel elutasítja.

Egy ApplicationTokenCredentials objektumot és az adott servicePrincipalId/clientId azonosítóhoz társított előfizetések listáját tartalmazza az összes vonatkozó bérlőben.

Személyes fiókok használatakor a domain paramétert az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

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

Paraméterek

Visszatér

Ha egy visszahívást az utolsó paraméterként ad vissza, akkor érvénytelen lesz, máskülönben ígéretet ad vissza. A visszahívás az eredményül kapott ApplicationTokenCredentials objektummal és az összes érintett bérlőhöz tartozó előfizetések listájával lesz meghívva.

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

Paraméterek

Visszatér

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

Paraméterek

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

Paraméterek

Egy ApplicationTokenCredentials objektumot és az adott servicePrincipalId/clientId azonosítóhoz társított előfizetések listáját tartalmazza az összes vonatkozó bérlőben.

Személyes fiókok használatakor a domain paramétert az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

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

Paraméterek

Visszatér

Az AuthResponse számára feloldott ígéret, amely tartalmazza a "hitelesítő adatokat" és az opcionális "előfizetések" tömböt, és hibaüzenettel elutasítja.

Egy UserTokenCredentials objektumot és az adott userId-hez társított előfizetések listáját tartalmazza az összes vonatkozó bérlőben.

Ez a módszer csak olyan szervezeti azonosítókra alkalmazható, amelyek nem engedélyezettek 2FA-ra, ellenkező esetben használjon interaktív bejelentkezést.

Személyes fiókok használatakor a domain paraméter options tulajdonságát az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

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

Paraméterek

Visszatér

Ha egy visszahívást az utolsó paraméterként ad vissza, akkor érvénytelen lesz, máskülönben ígéretet ad vissza. A visszahívás az eredményül kapott UserTokenCredentials objektummal és az összes érintett bérlőhöz tartozó előfizetések listájával hívódik meg.

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

Paraméterek

Visszatér

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

Paraméterek

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

Paraméterek

Egy UserTokenCredentials objektumot és az adott userId-hez társított előfizetések listáját tartalmazza az összes vonatkozó bérlőben. Ez a módszer csak olyan szervezeti azonosítókra alkalmazható, amelyek nem engedélyezettek 2FA-ra, ellenkező esetben használjon interaktív bejelentkezést.

Személyes fiókok használatakor a domain paraméter options tulajdonságát az adott fiókhoz tartozó bérlő azonosítójára kell beállítani. Ellenkező esetben az eredményül kapott hitelesítő adatok nem fognak tudni hozzáférni a fiók erőforrásaihoz.

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

Paraméterek

Visszatér

Az AuthResponse-nek feloldó ígéret, amely credentials és opcionális subscriptions tömböt tartalmaz, és hibaüzenettel elutasítja.

A módszer használata előtt telepítse az az cli-t https://github.com/Azure/azure-cli/releases. Ha egy Azure-beli virtuális gép ki van építve az az cli-vel, és az MSI engedélyezve van, akkor ezzel a módszerrel lekérheti a hitelesítési jogkivonatokat a virtuális gépről.

Új virtuális gép létrehozásához engedélyezze az MSI-t, hajtsa végre a következő parancsot: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Megjegyzés: a fenti parancs engedélyezi a szolgáltatásvégpontot a gazdagépen az alapértelmezett 50342-s porttal

Ha engedélyezni szeretné az MSI-t egy már kiépített virtuális gépen, hajtsa végre a következő parancsot: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Ha többet szeretne megtudni erről a parancsról, hajtsa végre a következőt: az vm --assign-identity -h

Hitelesítés egy Azure-beli virtuális gépen futó identitásszolgáltatással. Ez a metódus kérést küld a virtuális gépen üzemeltetett hitelesítési szolgáltatásnak, és visszakéri a hozzáférési jogkivonatot.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Visszatér

Ha egy visszahívást az utolsó paraméterként ad vissza, akkor érvénytelen lesz, máskülönben ígéretet ad vissza. A visszahívást az eredményül kapott MSIVmTokenCredentials objektum hívja meg.

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

Paraméterek

Visszatér

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

Paraméterek

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Paraméterek

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 }

Típus