@azure/ms-rest-nodeauth package

Kelas

ApplicationTokenCertificateCredentials
ApplicationTokenCredentials
AzureCliCredentials	Menjelaskan kredensial dengan mengambil token melalui Azure CLI.
DeviceTokenCredentials
MSIAppServiceTokenCredentials	Menyediakan informasi tentang kredensial token identitas layanan terkelola di lingkungan App Service.
MSITokenCredentials	Menyediakan informasi tentang kredensial token identitas layanan terkelola. Objek ini hanya dapat digunakan untuk memperoleh token pada komputer virtual yang disediakan di Azure dengan identitas layanan terkelola.
MSIVmTokenCredentials	Menyediakan informasi tentang kredensial token identitas layanan terkelola pada komputer virtual yang disediakan di Azure.
TokenCredentialsBase
UserTokenCredentials

Antarmuka

AuthResponse	Menjelaskan respons autentikasi.
AzureTokenCredentialsOptions	Menjelaskan parameter opsional untuk autentikasi servicePrincipal/secret.
CliAccessToken	Menjelaskan token akses yang diambil dari Azure CLI.
InteractiveLoginOptions	Menjelaskan parameter opsional untuk autentikasi interaktif.
LinkedSubscription	Menyediakan informasi tentang langganan yang ditemukan selama proses autentikasi. Struktur jenis ini berbeda dari objek langganan yang didapatkan seseorang dengan membuat permintaan ke RESOURCEManager API.
LinkedUser	Menyediakan informasi tentang pengguna dari perspektif autentikasi.
ListAllSubscriptionOptions	Menjelaskan opsi yang dapat disediakan saat mencantumkan semua langganan/akun melalui Azure CLI.
LoginWithAuthFileOptions	Menjelaskan parameter opsional untuk masuk denganAuthFile.
LoginWithUsernamePasswordOptions	Menjelaskan parameter opsional untuk autentikasi nama pengguna/kata sandi.
MSIAppServiceOptions	Menentukan parameter opsional untuk autentikasi dengan MSI untuk AppService.
MSIOptions	Menentukan parameter opsional untuk autentikasi dengan MSI.
MSITokenResponse	Menjelaskan MSITokenResponse.
MSIVmOptions	Menentukan parameter opsional untuk autentikasi dengan MSI untuk Komputer Virtual.

Alias Jenis

TokenAudience
UserType	Menyediakan informasi tentang jenis pengguna. Saat ini dapat berupa "pengguna" atau "servicePrincipal".

Fungsi

buildTenantList(TokenCredentialsBase, string)	Membangun array tenantIds.
createAuthenticator(MSITokenCredentials)
interactiveLogin()	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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
interactiveLogin(InteractiveLoginOptions)
interactiveLogin(InteractiveLoginOptions, (err: Error, credentials: DeviceTokenCredentials, subscriptions: LinkedSubscription[]) => void)
interactiveLogin(any)
interactiveLoginWithAuthResponse(InteractiveLoginOptions)	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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
loginWithAppServiceMSI()	Autentikasi menggunakan MSI App Service.
loginWithAppServiceMSI(MSIAppServiceOptions)
loginWithAppServiceMSI(MSIAppServiceOptions, Callback<MSIAppServiceTokenCredentials>)
loginWithAppServiceMSI(Callback<MSIAppServiceTokenCredentials>)
loginWithAuthFile()	Sebelum menggunakan metode ini, harap 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: az cloud list az cloud set –n az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Jika perwakilan layanan sudah dibuat maka masuk dengan info perwakilan layanan: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Mengautentikasi menggunakan informasi perwakilan layanan yang disediakan dalam file auth. Metode ini akan mengatur subscriptionId dari file auth ke variabel lingkungan yang disediakan pengguna dalam parameter opsi atau "AZURE_SUBSCRIPTION_ID" default.
loginWithAuthFile(LoginWithAuthFileOptions)
loginWithAuthFile(LoginWithAuthFileOptions, (err: Error, credentials: ApplicationTokenCredentials | ApplicationTokenCertificateCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithAuthFile(any)
loginWithAuthFileWithAuthResponse(LoginWithAuthFileOptions)	Sebelum menggunakan metode ini, harap 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: az cloud list az cloud set –n az ad sp create-for-rbac --sdk-auth > auth.json // create sp with secret OR az ad sp create-for-rbac --create-cert --sdk-auth > auth.json // create sp with certificate Jika perwakilan layanan sudah dibuat maka masuk dengan info perwakilan layanan: az login --service-principal -u -p -t az account show --sdk-auth > auth.json Mengautentikasi menggunakan informasi perwakilan layanan yang disediakan dalam file auth. Metode ini akan mengatur subscriptionId dari file auth ke variabel lingkungan yang disediakan pengguna dalam parameter opsi atau "AZURE_SUBSCRIPTION_ID" default.
loginWithServicePrincipalCertificate(string, string, string)	Menyediakan objek ApplicationTokenCertificateCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId di semua penyewa yang berlaku. Saat menggunakan akun pribadi, parameter harus diatur ke Id penyewa untuk akun tersebut domain . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
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)	Menyediakan objek ApplicationTokenCertificateCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId di semua penyewa yang berlaku. Saat menggunakan akun pribadi, parameter harus diatur ke Id penyewa untuk akun tersebut domain . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
loginWithServicePrincipalSecret(string, string, string)	Menyediakan objek ApplicationTokenCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId tersebut di semua penyewa yang berlaku. Saat menggunakan akun pribadi, parameter harus diatur ke Id penyewa untuk akun tersebut domain . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
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)	Menyediakan objek ApplicationTokenCredentials dan daftar langganan yang terkait dengan servicePrincipalId/clientId tersebut di semua penyewa yang berlaku. Saat menggunakan akun pribadi, parameter harus diatur ke Id penyewa untuk akun tersebut domain . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
loginWithUsernamePassword(string, string)	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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)
loginWithUsernamePassword(string, string, any)
loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions, (err: Error, credentials: UserTokenCredentials, subscriptions: LinkedSubscription[]) => void)
loginWithUsernamePasswordWithAuthResponse(string, string, LoginWithUsernamePasswordOptions)	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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.
loginWithVmMSI()	Sebelum menggunakan metode ini, harap 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 pada komputer virtual Azure. Metode ini membuat permintaan ke layanan autentikasi yang dihosting di VM dan mendapatkan kembali token akses.
loginWithVmMSI(MSIVmOptions)
loginWithVmMSI(MSIVmOptions, Callback<MSIVmTokenCredentials>)
loginWithVmMSI(Callback<MSIVmTokenCredentials>)

Detail Fungsi

buildTenantList(TokenCredentialsBase, string)

Membangun array tenantIds.

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

Parameter

credentials

TokenCredentialsBase

Kredensial.

apiVersion

string

nilai default 2016-06-01

Mengembalikan

Promise<string[]>

Janji yang menyelesaikan array tenantIds dan menolak dengan kesalahan.

createAuthenticator(MSITokenCredentials)

function createAuthenticator(credentials: MSITokenCredentials): Authenticator

Parameter

credentials

MSITokenCredentials

Mengembalikan

Authenticator

interactiveLogin()

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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

function interactiveLogin(): Promise<DeviceTokenCredentials>

Mengembalikan

Promise<DeviceTokenCredentials>

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

interactiveLogin(InteractiveLoginOptions)

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

Parameter

options

InteractiveLoginOptions

Mengembalikan

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)

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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

options

InteractiveLoginOptions

Objek yang mewakili parameter opsional.

Mengembalikan

Promise<AuthResponse<DeviceTokenCredentials>>

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

loginWithAppServiceMSI()

Autentikasi menggunakan MSI App Service.

function loginWithAppServiceMSI(): Promise<MSIAppServiceTokenCredentials>

Mengembalikan

Promise<MSIAppServiceTokenCredentials>

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan kekosongan jika tidak mengembalikan Promise. Panggilan balik dipanggil dengan objek MSIAppServiceTokenCredentials yang dihasilkan.

loginWithAppServiceMSI(MSIAppServiceOptions)

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

Parameter

options

MSIAppServiceOptions

Mengembalikan

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()

Sebelum menggunakan metode ini, harap 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 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 with certificate Jika perwakilan layanan sudah dibuat maka masuk dengan info perwakilan layanan:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

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

function loginWithAuthFile(): Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

Mengembalikan

Promise<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>

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

loginWithAuthFile(LoginWithAuthFileOptions)

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

Parameter

options

LoginWithAuthFileOptions

Mengembalikan

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)

Sebelum menggunakan metode ini, harap 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 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 with certificate Jika perwakilan layanan sudah dibuat maka masuk dengan info perwakilan layanan:
5. az login --service-principal -u -p -t
6. az account show --sdk-auth > auth.json

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

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

Parameter

options

LoginWithAuthFileOptions

Parameter opsional

Mengembalikan

Promise<AuthResponse<ApplicationTokenCredentials | ApplicationTokenCertificateCredentials>>

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

loginWithServicePrincipalCertificate(string, string, string)

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

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

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

Parameter

clientId

string

Id klien aplikasi direktori aktif juga dikenal sebagai SPN (ServicePrincipal Name). Lihat Mulai Cepat Direktori Aktif untuk .Net misalnya.

certificateStringOrFilePath

string

Sertifikat yang dikodekan PEM dan kunci privat ATAU jalur file absolut ke file .pem yang berisi informasi tersebut. Contohnya:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: Jalur file absolut dari file .pem.

domain

string

Id domain atau penyewa yang berisi aplikasi ini.

Mengembalikan

Promise<ApplicationTokenCertificateCredentials>

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

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

Mengembalikan

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)

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

Saat menggunakan akun pribadi, parameter harus diatur ke Id penyewa untuk akun tersebut domain . 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

clientId

string

Id klien aplikasi direktori aktif juga dikenal sebagai SPN (ServicePrincipal Name). Lihat Mulai Cepat Direktori Aktif untuk .Net misalnya.

certificateStringOrFilePath

string

Sertifikat yang dikodekan PEM dan kunci privat ATAU jalur file absolut ke file .pem yang berisi informasi tersebut. Contohnya:

• CertificateString: "-----BEGIN PRIVATE KEY-----\n\n-----END PRIVATE KEY-----\n-----BEGIN CERTIFICATE-----\n\n-----END CERTIFICATE-----\n"
• CertificateFilePath: Jalur file absolut dari file .pem.

domain

string

Id domain atau penyewa yang berisi aplikasi ini.

options

AzureTokenCredentialsOptions

Objek yang mewakili parameter opsional.

Mengembalikan

Promise<AuthResponse<ApplicationTokenCertificateCredentials>>

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

loginWithServicePrincipalSecret(string, string, string)

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

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

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

Parameter

clientId

string

Id klien aplikasi direktori aktif juga dikenal sebagai SPN (ServicePrincipal Name). Lihat Mulai Cepat Direktori Aktif untuk .Net misalnya.

secret

string

Rahasia aplikasi untuk perwakilan layanan.

domain

string

Id domain atau penyewa yang berisi aplikasi ini.

Mengembalikan

Promise<ApplicationTokenCredentials>

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

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

Mengembalikan

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)

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

Saat menggunakan akun pribadi, parameter harus diatur ke Id penyewa untuk akun tersebut domain . 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

clientId

string

Id klien aplikasi direktori aktif juga dikenal sebagai SPN (ServicePrincipal Name). Lihat Mulai Cepat Direktori Aktif untuk .Net misalnya.

secret

string

Rahasia aplikasi untuk perwakilan layanan.

domain

string

Id domain atau penyewa yang berisi aplikasi ini.

options

AzureTokenCredentialsOptions

Objek yang mewakili parameter opsional.

Mengembalikan

Promise<AuthResponse<ApplicationTokenCredentials>>

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

loginWithUsernamePassword(string, string)

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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

username

string

Nama pengguna untuk akun Id Organisasi.

password

string

Kata sandi untuk akun Id Organisasi.

Mengembalikan

Promise<UserTokenCredentials>

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

loginWithUsernamePassword(string, string, LoginWithUsernamePasswordOptions)

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

Parameter

username

string

password

string

options

LoginWithUsernamePasswordOptions

Mengembalikan

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)

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, domain properti dalam parameter harus diatur ke Id penyewa untuk akun tersebut options . Jika tidak, kredensial yang dihasilkan tidak akan dapat mengakses sumber daya akun.

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

Parameter

username

string

Nama pengguna untuk akun Id Organisasi.

password

string

Kata sandi untuk akun Id Organisasi.

options

LoginWithUsernamePasswordOptions

Objek yang mewakili parameter opsional.

Mengembalikan

Promise<AuthResponse<UserTokenCredentials>>

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

loginWithVmMSI()

Sebelum menggunakan metode ini, harap 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 pada komputer virtual Azure. Metode ini membuat permintaan ke layanan autentikasi yang dihosting di VM dan mendapatkan kembali token akses.

function loginWithVmMSI(): Promise<MSIVmTokenCredentials>

Mengembalikan

Promise<MSIVmTokenCredentials>

Jika panggilan balik diteruskan sebagai parameter terakhir, maka mengembalikan kekosongan jika tidak mengembalikan Promise. Panggilan balik dipanggil dengan objek MSIVmTokenCredentials yang dihasilkan.

loginWithVmMSI(MSIVmOptions)

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

Parameter

options

MSIVmOptions

Mengembalikan

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>