Mengautentikasi aplikasi yang dihosting Azure ke sumber daya Azure dengan Azure SDK for JavaScript

Artikel
03/30/2023

Saat aplikasi dihosting di Azure (menggunakan layanan seperti Azure App Service, Azure Virtual Machines, atau Azure Container Instances), pendekatan yang direkomendasikan untuk mengautentikasi aplikasi ke sumber daya Azure adalah dengan menggunakan identitas terkelola.

Identitas terkelola menyediakan identitas untuk aplikasi Anda sehingga aplikasi Anda terhubung ke sumber daya Azure lainnya tanpa perlu menggunakan rahasia (seperti string koneksi kunci). Secara internal, Azure mengetahui identitas aplikasi Anda dan sumber daya apa yang diizinkan untuk disambungkan. Azure menggunakan informasi ini untuk mendapatkan token Microsoft Entra secara otomatis untuk aplikasi agar dapat terhubung ke sumber daya Azure lainnya, semuanya tanpa harus mengelola (membuat atau memutar) rahasia autentikasi.

Tipe identitas terkelola

Ada dua jenis identitas terkelola:

Identitas terkelola yang ditetapkan sistem - sumber daya Azure tunggal
Identitas terkelola yang ditetapkan pengguna - beberapa sumber daya Azure

Artikel ini membahas langkah-langkah untuk mengaktifkan dan menggunakan identitas terkelola yang ditetapkan sistem untuk aplikasi. Jika Anda perlu menggunakan identitas terkelola yang ditetapkan pengguna, lihat artikel Mengelola identitas terkelola yang ditetapkan pengguna untuk melihat cara membuat identitas terkelola yang ditetapkan pengguna.

Identitas terkelola yang ditetapkan sistem untuk sumber daya tunggal

Identitas terkelola yang ditetapkan sistem disediakan oleh dan diikat langsung ke sumber daya Azure. Saat Mengaktifkan identitas terkelola pada sumber daya Azure, Anda mendapatkan identitas terkelola yang ditetapkan sistem untuk sumber daya tersebut. Ini terkait dengan siklus hidup sumber daya Azure. Jadi, ketika sumber daya dihapus, Azure akan secara otomatis menghapus identitas untuk Anda. Karena yang harus Anda lakukan adalah mengaktifkan identitas terkelola untuk sumber daya Azure yang menghosting kode Anda, ini adalah jenis identitas terkelola term mudah untuk digunakan.

Identitas terkelola yang ditetapkan pengguna untuk beberapa sumber daya

Secara konseptual identitas ini adalah sumber daya Azure mandiri. Ini paling sering digunakan ketika solusi Anda memiliki beberapa beban kerja yang berjalan pada beberapa sumber daya Azure yang semuanya perlu berbagi identitas yang sama dan izin yang sama. Misalnya, jika solusi Anda memiliki komponen yang berjalan pada beberapa App Service dan instans komputer virtual dan semuanya memerlukan akses ke set sumber daya Azure yang sama, membuat dan menggunakan identitas terkelola yang ditetapkan pengguna di seluruh sumber daya tersebut akan masuk akal.

1 - Ditetapkan sistem: Aktifkan di aplikasi yang dihosting

Langkah pertama adalah mengaktifkan identitas terkelola pada sumber daya Azure yang menghosting aplikasi Anda. Misalnya, jika Anda menghosting aplikasi Django menggunakan Azure App Service, Anda perlu mengaktifkan identitas terkelola untuk aplikasi web App Service tersebut. Jika Anda menggunakan komputer virtual untuk menghosting aplikasi, Anda akan mengaktifkan VM untuk menggunakan identitas terkelola.

Anda dapat mengaktifkan identitas terkelola yang akan digunakan untuk sumber daya Azure menggunakan portal Microsoft Azure atau Azure CLI.

Portal Azure
Azure CLI

Petunjuk	Cuplikan layar
Navigasikan ke sumber daya yang menghosting kode aplikasi Anda di portal Microsoft Azure. Misalnya, Anda dapat mengetikkan nama sumber daya Anda di kotak pencarian di bagian atas halaman dan menavigasinya dengan memilihnya dalam kotak dialog.
Pada halaman untuk sumber daya Anda, pilih item menu Identitas dari menu sebelah kiri. Semua sumber daya Azure yang mampu mendukung identitas terkelola akan memiliki item menu Identitas meskipun tata letak menu mungkin sedikit berbeda.
Pada halaman Identitas : Ubah penggeser Status menjadi Aktif. Pilih Simpan. Dialog konfirmasi memverifikasi bahwa Anda ingin mengaktifkan identitas terkelola untuk layanan Anda. Jawab Ya untuk mengaktifkan identitas terkelola untuk sumber daya Azure.

Perintah Azure CLI dapat dijalankan di Azure Cloud Shell atau pada stasiun kerja dengan Azure CLI terpasang.

Perintah Azure CLI yang digunakan untuk mengaktifkan identitas terkelola untuk sumber daya Azure adalah formulir az <command-group> identity --resource-group <resource-group-name> --name <resource-name>. Perintah khusus untuk layanan Azure populer ditunjukkan di bawah ini.

Azure App Service
Azure Virtual Machines

az webapp identity assign --resource-group <resource-group-name> -name <web-app-name>

az vm identity assign --resource-group <resource-group-name> -name <virtual-machine-name>

Outputnya terlihat seperti berikut ini.

{
  "principalId": "<REPLACE_WITH_YOUR_PRINCIPAL_ID>",
  "tenantId": "<REPLACE_WITH_YOUR_TENANT_ID>",
  "type": "SystemAssigned",
  "userAssignedIdentities": null
}

Nilai principalId adalah ID unik dari identitas terkelola. Simpan salinan output ini karena Anda akan membutuhkan nilai-nilai ini di langkah berikutnya.

2 - Menetapkan peran ke identitas terkelola

Selanjutnya, Anda perlu menentukan peran (izin) apa yang dibutuhkan aplikasi Anda dan menetapkan identitas terkelola ke peran tersebut di Azure. Identitas terkelola dapat ditetapkan peran di sumber daya, grup sumber daya, atau cakupan langganan. Contoh ini menunjukkan cara menetapkan peran di cakupan grup sumber daya karena sebagian besar aplikasi mengelompokkan semua sumber daya Azure mereka ke dalam satu grup sumber daya.

Portal Azure
Azure CLI

Petunjuk	Cuplikan layar
Temukan grup sumber daya untuk aplikasi Anda dengan mencari nama grup sumber daya menggunakan kotak pencarian di bagian atas portal Microsoft Azure. Navigasi ke grup sumber daya Anda dengan memilih nama grup sumber daya di bawah judul Grup Sumber Daya dalam kotak dialog.
Pada halaman untuk grup sumber daya, pilih Kontrol akses (IAM) dari menu sebelah kiri.
Pada halaman Kontrol akses (IAM): Pilih tab Penetapan peran. Pilih + Tambahkan dari menu atas lalu Tambahkan penetapan peran dari menu drop-down yang dihasilkan.
Halaman Tambahkan penetapan peran mencantumkan semua peran yang dapat ditetapkan untuk grup sumber daya. Gunakan kotak pencarian untuk memfilter daftar ke ukuran yang lebih mudah dikelola. Contoh ini menunjukkan cara memfilter peran Blob Penyimpanan. Pilih peran yang ingin ditetapkan. Pilih Berikutnya untuk masuk ke layar berikutnya.
Halaman Tambahkan penetapan peran berikutnya memungkinkan Anda menentukan pengguna yang akan ditetapkan perannya. Pilih Identitas terkelola di bagian Tetapkan akses ke. Pilih + Pilih anggota di bawah Anggota Kotak dialog terbuka di sisi kanan portal Azure.
Dalam dialog Pilih identitas terkelola: Dropdown Identitas terkelola dan kotak teks Pilih dapat digunakan untuk memfilter daftar identitas terkelola dalam langganan Anda. Dalam contoh ini dengan memilih App Service, hanya identitas terkelola yang terkait dengan App Service yang ditampilkan. Pilih identitas terkelola untuk sumber daya Azure yang menghosting aplikasi Anda. Pilih Pilih di bagian bawah dialog untuk melanjutkan.
Identitas terkelola ditampilkan seperti yang dipilih pada layar Tambahkan penetapan peran. Pilih Tinjau + tetapkan untuk masuk ke halaman akhir lalu Tinjau + tetapkan lagi untuk menyelesaikan proses.

Identitas terkelola diberi peran di Azure menggunakan perintah [az role assignment create].

az role assignment create --assignee "{managedIdentityId}" \
    --role "{roleName}" \
    --resource-group "{resourceGroupName}"

Untuk mendapatkan nama peran yang dapat ditetapkan oleh perwakilan layanan, gunakan perintah az role definition list.

az role definition list \
    --query "sort_by([].{roleName:roleName, description:description}, &roleName)" \
    --output table

Misalnya, untuk mengizinkan identitas terkelola dengan ID 99999999-9999-9999-9999-999999999999 baca, tulis, dan hapus akses ke kontainer dan data blob Azure Storage ke semua akun penyimpanan di grup sumber daya msdocs-sdk-auth-example , Anda akan menetapkan perwakilan layanan aplikasi ke peran Kontributor Data Blob Penyimpanan menggunakan perintah berikut.

az role assignment create --assignee 99999999-9999-9999-9999-999999999999 \
    --role "Storage Blob Data Contributor" \
    --resource-group "msdocs-sdk-auth-example"

Untuk informasi tentang menetapkan izin di tingkat sumber daya atau langganan menggunakan Azure CLI, lihat artikel Menetapkan peran Azure menggunakan Azure CLI.

3 - Menerapkan DefaultAzureCredential di aplikasi Anda

Kelas DefaultAzureCredential akan secara otomatis mendeteksi bahwa identitas terkelola sedang digunakan dan menggunakan identitas terkelola untuk mengautentikasi ke sumber daya Azure lainnya. Seperti yang dibahas dalam artikel gambaran umum autentikasi Azure SDK for JavaScript, DefaultAzureCredential mendukung beberapa metode autentikasi dan menentukan metode autentikasi yang digunakan saat runtime. Dengan cara ini, aplikasi Anda dapat menggunakan metode autentikasi yang berbeda di lingkungan yang berbeda tanpa menerapkan kode khusus lingkungan.

Pertama, tambahkan paket @azure/identitas ke aplikasi Anda.

npm install @azure/identity

Selanjutnya, untuk kode JavaScript apa pun yang membuat objek klien Azure SDK di aplikasi, Anda ingin:

DefaultAzureCredential Impor kelas dari @azure/identity modul.
Buat objek DefaultAzureCredential.
Teruskan DefaultAzureCredential objek ke konstruktor objek klien Azure SDK.

Contoh ini ditampilkan di segmen kode berikut.

// connect-with-default-azure-credential.js
import { BlobServiceClient } from '@azure/storage-blob';
import { DefaultAzureCredential } from '@azure/identity';
import 'dotenv/config'

const accountName = process.env.AZURE_STORAGE_ACCOUNT_NAME;
if (!accountName) throw Error('Azure Storage accountName not found');

const blobServiceClient = new BlobServiceClient(
  `https://${accountName}.blob.core.windows.net`,
  new DefaultAzureCredential()
);

Ketika kode di atas dijalankan di stasiun kerja lokal Anda selama pengembangan lokal, metode SDK, DefaultAzureCredential(), lihat variabel lingkungan untuk perwakilan layanan aplikasi atau di VISUAL Code, Azure CLI, atau Azure PowerShell untuk serangkaian kredensial pengembang, yang salah satunya dapat digunakan untuk mengautentikasi aplikasi ke sumber daya Azure selama pengembangan lokal. Dengan cara ini, kode yang sama ini dapat digunakan untuk mengautentikasi aplikasi Anda ke sumber daya Azure selama pengembangan lokal dan saat disebarkan ke Azure.