@azure/ms-rest-nodeauth package

Membangun array tenantIds.

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

Parameter

Mengembalikan

Janji yang diselesaikan ke array tenantIds dan menolak dengan kesalahan.

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parameter

Mengembalikan

Menyediakan url dan kode yang perlu disalin dan ditempelkan di browser dan diautentikasi di sana. Jika berhasil, pengguna akan mendapatkan objek DeviceTokenCredentials dan daftar langganan yang terkait dengan userId tersebut di semua penyewa yang berlaku.

Saat menggunakan akun pribadi, properti domain dalam parameter options diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Mengembalikan

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan void lainnya mengembalikan Promise. Panggilan balik dipanggil dengan objek DeviceTokenCredentials yang dihasilkan dan daftar langganan terkait di semua penyewa yang berlaku.

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

Parameter

Mengembalikan

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

Parameter

function interactiveLogin(callback: any)

Parameter

Menyediakan url dan kode yang perlu disalin dan ditempelkan di browser dan diautentikasi di sana. Jika berhasil, pengguna akan mendapatkan objek DeviceTokenCredentials dan daftar langganan yang terkait dengan userId tersebut di semua penyewa yang berlaku.

Saat menggunakan akun pribadi, properti domain dalam parameter options diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

Mengembalikan

Janji yang diselesaikan ke AuthResponse, yang berisi array "kredensial" dan "langganan" opsional dan menolak dengan Kesalahan.

Autentikasi menggunakan MSI App Service.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Mengembalikan

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan void lainnya mengembalikan Promise. Panggilan balik dipanggil dengan objek MSIAppServiceTokenCredentials yang dihasilkan.

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

Parameter

Mengembalikan

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

Parameter

function loginWithAppServiceMSI(callback: Callback<MSIAppServiceTokenCredentials>)

Parameter

Sebelum menggunakan metode ini, silakan instal az cli dari https://github.com/Azure/azure-cli/releases. Kemudian jalankan az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Jika Anda ingin membuat sp untuk cloud/lingkungan yang berbeda, silakan jalankan:

1. az daftar cloud
2. az cloud set –n <nama lingkungan>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp dengan rahasia ATAU
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp dengan sertifikat Jika perwakilan layanan sudah dibuat, masuk dengan info perwakilan layanan:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. az akun tampilkan --sdk-auth > auth.json

Mengautentikasi menggunakan informasi perwakilan layanan yang disediakan dalam file autentikasi. Metode ini akan mengatur subscriptionId dari file autentikasi ke variabel lingkungan yang disediakan pengguna dalam parameter opsi atau "AZURE_SUBSCRIPTION_ID" default.

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Mengembalikan

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan void lainnya mengembalikan Promise. Panggilan balik dipanggil dengan objek ApplicationTokenCredentials atau ApplicationTokenCertificateCredentials yang dihasilkan dan daftar langganan terkait di semua penyewa yang berlaku.

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

Parameter

Mengembalikan

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

Parameter

function loginWithAuthFile(callback: any)

Parameter

Sebelum menggunakan metode ini, silakan instal az cli dari https://github.com/Azure/azure-cli/releases. Kemudian jalankan az ad sp create-for-rbac --sdk-auth > ${yourFilename.json}. Jika Anda ingin membuat sp untuk cloud/lingkungan yang berbeda, silakan jalankan:

1. az daftar cloud
2. az cloud set –n <nama lingkungan>
3. az ad sp create-for-rbac --sdk-auth > auth.json // create sp dengan rahasia ATAU
4. az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp dengan sertifikat Jika perwakilan layanan sudah dibuat, masuk dengan info perwakilan layanan:
5. az login --service-principal -u <clientId> -p <clientSecret> -t <tenantId>
6. az akun tampilkan --sdk-auth > auth.json

Mengautentikasi menggunakan informasi perwakilan layanan yang disediakan dalam file autentikasi. Metode ini akan mengatur subscriptionId dari file autentikasi ke variabel lingkungan yang disediakan pengguna dalam parameter opsi atau "AZURE_SUBSCRIPTION_ID" default.

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

Parameter

Mengembalikan

Janji yang diselesaikan ke AuthResponse, yang berisi array "kredensial" dan "langganan" opsional dan menolak dengan Kesalahan.

Menyediakan objek ApplicationTokenCertificateCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId tersebut di semua penyewa yang berlaku.

Saat menggunakan akun pribadi, parameter domain diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

Mengembalikan

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan void lainnya mengembalikan Promise. Panggilan balik dipanggil dengan objek ApplicationTokenCertificateCredentials yang dihasilkan dan daftar langganan terkait di semua penyewa yang berlaku.

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

Parameter

Mengembalikan

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

Parameter

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

Parameter

Menyediakan objek ApplicationTokenCertificateCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId tersebut di semua penyewa yang berlaku.

Saat menggunakan akun pribadi, parameter domain diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

Mengembalikan

Janji yang diselesaikan ke AuthResponse, yang berisi array "kredensial" dan "langganan" opsional dan menolak dengan Kesalahan.

Menyediakan objek ApplicationTokenCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId tersebut di semua penyewa yang berlaku.

Saat menggunakan akun pribadi, parameter domain diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

Mengembalikan

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan void lainnya mengembalikan Promise. Panggilan balik dipanggil dengan objek ApplicationTokenCredentials yang dihasilkan dan daftar langganan terkait di semua penyewa yang berlaku.

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

Parameter

Mengembalikan

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

Parameter

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

Parameter

Menyediakan objek ApplicationTokenCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId tersebut di semua penyewa yang berlaku.

Saat menggunakan akun pribadi, parameter domain diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

Mengembalikan

Janji yang diselesaikan ke AuthResponse, yang berisi array "kredensial" dan "langganan" opsional dan menolak dengan Kesalahan.

Menyediakan objek UserTokenCredentials dan daftar langganan yang terkait dengan userId tersebut di semua penyewa yang berlaku.

Metode ini hanya berlaku untuk id organisasi yang tidak diaktifkan 2FA jika tidak, silakan gunakan login interaktif.

Saat menggunakan akun pribadi, properti domain dalam parameter options diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

Mengembalikan

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan void lainnya mengembalikan Promise. Panggilan balik dipanggil dengan objek UserTokenCredentials yang dihasilkan dan daftar langganan terkait di semua penyewa yang berlaku.

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

Parameter

Mengembalikan

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

Parameter

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

Parameter

Menyediakan objek UserTokenCredentials dan daftar langganan yang terkait dengan userId tersebut di semua penyewa yang berlaku. Metode ini hanya berlaku untuk id organisasi yang tidak diaktifkan 2FA jika tidak, silakan gunakan login interaktif.

Saat menggunakan akun pribadi, properti domain dalam parameter options diperlukan untuk diatur ke Id penyewa untuk akun tersebut. Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

Mengembalikan

Janji yang diselesaikan ke AuthResponse, yang berisi credentials dan array subscriptions opsional, dan menolak dengan Kesalahan.

Sebelum menggunakan metode ini, silakan instal az cli dari https://github.com/Azure/azure-cli/releases. Jika Anda memiliki komputer virtual Azure yang disediakan dengan az cli dan mengaktifkan MSI, Anda kemudian dapat menggunakan metode ini untuk mendapatkan token autentikasi dari VM.

Untuk membuat VM baru, aktifkan MSI, jalankan perintah ini: az vm create -g <resource_group_name> -n <vm_name> --assign-identity --image <os_image_name> Note: perintah di atas memungkinkan titik akhir layanan pada host, dengan port default 50342

Untuk mengaktifkan MSI pada VM yang sudah disediakan, jalankan perintah berikut: az vm --assign-identity -g <resource_group_name> -n <vm_name> --port <custom_port_number>

Untuk mengetahui lebih lanjut tentang perintah ini, silakan jalankan: az vm --assign-identity -h

Mengautentikasi menggunakan layanan identitas yang berjalan di komputer virtual Azure. Metode ini membuat permintaan ke layanan autentikasi yang dihosting di VM dan mendapatkan kembali token akses.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Mengembalikan

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan void lainnya mengembalikan Promise. Panggilan balik dipanggil dengan objek MSIVmTokenCredentials yang dihasilkan.

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

Parameter

Mengembalikan

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

Parameter

function loginWithVmMSI(callback: Callback<MSIVmTokenCredentials>)

Parameter

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 }

Jenis