Mulai cepat: Membuat fungsi PowerShell di Azure dari baris perintah
Dalam artikel ini, Anda menggunakan alat baris perintah untuk membuat fungsi PowerShell yang merespons permintaan HTTP. Setelah menguji kode secara lokal, sebarkan kode ke lingkungan tanpa server Azure Functions.
Menyelesaikan panduan mulai cepat ini dikenakan biaya kecil berupa beberapa sen USD atau kurang di akun Azure Anda.
Ada juga versi berbasis Visual Studio Code dari artikel ini.
Mengonfigurasi lingkungan lokal Anda
Sebelum memulai, Anda harus memiliki:
Akun Azure dengan langganan aktif. Buat akun secara gratis.
Salah satu alat berikut untuk membuat sumber daya Azure:
Modul Azure Az PowerShell versi 9.4.0 atau yang lebih baru.
Azure CLI versi 2.4 atau yang lebih baru.
Instal Azure Functions Core Tools
Cara yang disarankan untuk menginstal Core Tools tergantung pada sistem operasi komputer pengembangan lokal Anda.
Langkah-langkah berikut menggunakan penginstal Windows (MSI) untuk menginstal Core Tools v4.x. Untuk informasi selengkapnya tentang penginstal berbasis paket lainnya, lihat Core Tools readme.
Unduh dan jalankan penginstal Core Tools, berdasarkan versi Windows Anda:
- v4.x - Windows 64-bit (Disarankan. penelusuran kesalahan Visual Studio Code memerlukan 64-bit.)
- v4.x - Windows 32-bit
Jika sebelumnya Anda menggunakan penginstal Windows (MSI) untuk menginstal Core Tools di Windows, Anda harus menghapus instalan versi lama dari Tambahkan Hapus Program sebelum menginstal versi terbaru.
Membuat proyek fungsi lokal
Di Azure Functions, proyek fungsi adalah kontainer untuk satu atau beberapa fungsi individual yang masing-masing merespons pemicu tertentu. Semua fungsi dalam proyek memiliki konfigurasi lokal dan hosting yang sama. Di bagian ini, Anda membuat proyek fungsi yang berisi satu fungsi.
Jalankan perintah
func init
, sebagai berikut, untuk membuat proyek fungsi dalam folder bernama LocalFunctionProj dengan runtime bahasa umum yang ditentukan:func init LocalFunctionProj --powershell
Navigasi ke folder proyek:
cd LocalFunctionProj
Folder ini berisi berbagai file untuk proyek, termasuk file konfigurasi bernama local.settings.json dan host.json. Karena local.settings.json dapat berisi rahasia yang diunduh dari Azure, file dikecualikan dari kontrol sumber secara default dalam file .gitignore.
Tambahkan fungsi ke proyek Anda dengan menggunakan perintah berikut, yang mana argumen
--name
adalah nama unik fungsi Anda (HttpExample) dan argumen--template
menentukan pemicu fungsi (HTTP).func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"
func new
membuat subfolder yang cocok dengan nama fungsi yang berisi file kode yang sesuai dengan bahasa yang dipilih proyek dan file konfigurasi bernama function.json.
(Opsional) Memeriksa isi file
Jika diinginkan, Anda dapat melompat ke Menjalankan fungsi secara lokal dan memeriksa isi file nanti.
run.ps1
run.ps1 menentukan skrip fungsi yang dipicu sesuai dengan konfigurasi dalam function.json.
using namespace System.Net
# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)
# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."
# Interact with query parameters or the body of the request.
$name = $Request.Query.Name
if (-not $name) {
$name = $Request.Body.Name
}
$body = "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response."
if ($name) {
$body = "Hello, $name. This HTTP triggered function executed successfully."
}
# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
StatusCode = [HttpStatusCode]::OK
Body = $body
})
Untuk pemicu HTTP, fungsi menerima data permintaan yang diteruskan ke param $Request
yang ditentukan dalam function.json. Objek yang dikembalikan, didefinisikan sebagai Response
dalam function.json, diteruskan ke cmdlet Push-OutputBinding
sebagai respons.
function.json
function.json adalah file konfigurasi yang menentukan input dan output bindings
untuk fungsi, termasuk jenis pemicu.
{
"bindings": [
{
"authLevel": "function",
"type": "httpTrigger",
"direction": "in",
"name": "Request",
"methods": [
"get",
"post"
]
},
{
"type": "http",
"direction": "out",
"name": "Response"
}
]
}
Setiap pengikatan memerlukan arah, jenis, dan nama yang unik. Pemicu HTTP memiliki pengikatan input jenis httpTrigger
dan pengikatan output jenis http
.
Jalankan fungsi secara lokal
Jalankan fungsi Anda dengan memulai host runtime Azure Functions lokal dari folder LocalFunctionProj.
func start
Menjelang akhir output, baris berikut harus muncul:
Catatan
Jika HttpExample tidak muncul seperti yang ditunjukkan di atas, Anda mungkin memulai hosting dari luar folder akar proyek. Dalam kasus tersebut, gunakan Ctrl+C untuk menghentikan hosting, buka folder akar proyek, dan jalankan kembali perintah sebelumnya.
Salin URL fungsi HTTP Anda dari output ini ke browser dan tambahkan string
?name=<YOUR_NAME>
kueri , membuat URL lengkap sepertihttp://localhost:7071/api/HttpExample?name=Functions
. Browser akan menampilkan pesan tanggapan yang mengulang nilai string kueri Anda. Terminal tempat Anda memulai proyek juga menunjukkan output log saat Anda membuat permintaan.Jika sudah selesai, tekan Ctrl + C dan ketik
y
untuk menghentikan hosting fungsi.
Membuat sumber daya Azure pendukung untuk fungsi Anda
Sebelum dapat menyebarkan kode fungsi ke Azure, Anda perlu membuat tiga sumber daya:
- Grup sumber daya, yang merupakan kontainer logis untuk sumber daya terkait.
- Akun penyimpanan, yang digunakan untuk mempertahankan status dan informasi lain tentang fungsi Anda.
- Aplikasi fungsi, menyediakan lingkungan untuk menjalankan kode fungsi Anda. Aplikasi fungsi memetakan proyek fungsi lokal Anda dan memungkinkan Anda mengelompokkan fungsi sebagai unit logis untuk pengelolaan, penyebaran, dan berbagi sumber daya yang lebih mudah.
Gunakan perintah berikut untuk membuat item ini. Azure CLI dan PowerShell didukung.
Jika Anda belum melakukannya, masuk ke Azure:
az login
Perintah az login memasukkan Anda ke akun Azure Anda.
Buat grup sumber daya bernama
AzureFunctionsQuickstart-rg
di wilayah yang Anda pilih:az group create --name AzureFunctionsQuickstart-rg --location <REGION>
Perintah az group create membuat grup sumber daya. Dalam perintah di atas, ganti
<REGION>
dengan wilayah yang dekat dengan wilayah Anda, dan menggunakan kode wilayah yang tersedia yang ditampilkan dari perintah lokasi daftar akun az.Buat akun penyimpanan tujuan umum di grup sumber daya dan wilayah Anda:
az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS --allow-blob-public-access false
Perintah az storage account create membuat akun penyimpanan.
Di contoh sebelumnya, ganti
<STORAGE_NAME>
dengan nama yang sesuai untuk Anda dan unik di Azure Storage. Nama harus berisi tiga hingga 24 karakter angka dan huruf kecil saja.Standard_LRS
menentukan akun tujuan umum, yang didukung oleh Functions.
Penting
Akun penyimpanan digunakan untuk menyimpan data aplikasi penting, terkadang termasuk kode aplikasi itu sendiri. Anda harus membatasi akses dari aplikasi dan pengguna lain ke akun penyimpanan.
Buat aplikasi fungsi di Azure:
az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location <REGION> --runtime powershell --functions-version 4 --name <APP_NAME> --storage-account <STORAGE_NAME>
Perintah az functionapp create membuat aplikasi fungsi di Azure.
Dalam contoh sebelumnya, ganti
<STORAGE_NAME>
dengan nama akun yang Anda gunakan di langkah sebelumnya, dan ganti<APP_NAME>
dengan nama unik global yang sesuai untuk Anda.<APP_NAME>
juga merupakan domain DNS default untuk aplikasi fungsi.Perintah ini membuat aplikasi fungsi yang berjalan dalam runtime bahasa tertentu berdasarkan Rencana Penggunaan Azure Functions, yang gratis untuk jumlah penggunaan yang Anda keluarkan di sini. Perintah ini juga menyediakan instans Azure Application Insights terkait dalam grup sumber daya yang sama. Dengan instans tersebut, Anda dapat memantau aplikasi fungsi Anda dan melihat log. Untuk mengetahui informasi selengkapnya, lihat Memantau Azure Functions. Instans tidak dikenakan biaya sampai Anda mengaktifkannya.
Menyebarkan proyek fungsi ke Azure
Setelah berhasil membuat aplikasi fungsi di Azure, Anda sekarang siap untuk menyebarkan proyek fungsi lokal dengan menggunakan func azure functionapp publish
perintah .
Di folder proyek akar Anda, jalankan perintah ini func azure functionapp publish
:
func azure functionapp publish <APP_NAME>
Dalam contoh ini, ganti <APP_NAME>
dengan nama aplikasi Anda. Penyebaran yang berhasil menunjukkan hasil yang mirip dengan output berikut (dipotong untuk kesederhanaan):
... Getting site publishing info... Creating archive for current directory... Performing remote build for functions project. ... Deployment successful. Remote build succeeded! Syncing triggers... Functions in msdocs-azurefunctions-qs: HttpExample - [httpTrigger] Invoke url: https://msdocs-azurefunctions-qs.azurewebsites.net/api/httpexample
Menggunakan fungsi pada Azure
Karena fungsi Anda menggunakan pemicu HTTP, Anda memanggilnya dengan membuat permintaan HTTP ke URL-nya di browser atau dengan alat seperti curl.
Salin Panggilan URL lengkap yang ditampilkan dalam output perintah terbitkan ke bilah alamat browser, menambahkan parameter kueri ?name=Functions
. Browser harus menampilkan output yang sama seperti saat Anda menjalankan fungsi secara lokal.
Jalankan perintah berikut untuk melihat mendekati real-time log streaming:
func azure functionapp logstream <APP_NAME>
Di jendela terminal terpisah atau di browser, panggil lagi fungsi jarak jauh. Log verbose dari eksekusi fungsi di Azure ditampilkan di terminal.
Membersihkan sumber daya
Jika Anda melanjutkan ke langkah berikutnya dan menambahkan pengikatan output antrean Azure Storage, buat semua sumber daya Anda tetap di tempat saat Anda akan membuat apa yang telah Anda lakukan.
Jika tidak, gunakan perintah berikut untuk menghapus grup sumber daya dan semua sumber daya yang terkandung untuk menghindari timbulnya biaya lebih lanjut.
az group delete --name AzureFunctionsQuickstart-rg