Catatan
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba masuk atau mengubah direktori.
Akses ke halaman ini memerlukan otorisasi. Anda dapat mencoba mengubah direktori.
Artikel ini menyediakan dokumentasi referensi untuk runtime lokal dan alat yang mendukung Azure Functions. Gunakan alat ini untuk mengembangkan, mengelola, dan menjalankan proyek Azure Functions dari komputer lokal Anda. Nama binernya adalah func (atau func.exe pada Windows).
Dua pengalaman pengembangan lokal dikirimkan sebagai: func.exeAzure Functions Core Tools (GA) dan Azure Functions CLI (pratinjau). Gunakan pemilih untuk memilih pengalaman mana yang akan dilihat.
Penting
Azure Functions CLI (v5) saat ini dalam pratinjau. Versi pratinjau ini belum mendukung Java dan PowerShell. Untuk bekerja dengan bahasa yang saat ini tidak didukung, terus gunakan Azure Functions Core Tools v4.
Ada dua alat baris perintah yang dikirimkan untuk func.exe Azure Functions:
| Alat Inti Azure Functions | Azure Functions CLI | |
|---|---|---|
| func.exe versi | v4 | v5 |
| Tingkat dukungan | Ketersediaan umum (GA) | Tinjauan |
| Menginstal jejak | Biner lengkap yang mencakup semua perintah dan kemampuan untuk semua bahasa asli. | Penginstalan dasar kecil, ditambah beban kerja per bahasa dan fitur lain yang Anda tambahkan sesuai kebutuhan. Host dikirim sebagai beban kerjanya sendiri, sehingga Anda mendapatkan versi host terbaru tanpa mengunduh ulang CLI. |
| Gunakan saat... | Anda memerlukan dukungan GA penuh untuk semua alur kerja pengembangan. | Anda menginginkan pengalaman berbasis beban kerja yang ringan dengan fitur baru seperti templat mulai cepat dan profil yang menjaga lingkungan lokal Anda tetap sinkron dengan konfigurasi paket hosting Azure Anda. |
Untuk mempelajari selengkapnya tentang menggunakan Core Tools, lihat Work dengan Azure Functions Core Tools.
Perintah Core Tools diatur ke dalam konteks berikut, masing-masing memberikan serangkaian tindakan yang unik.
| Konteks perintah | Deskripsi |
|---|---|
func |
Perintah untuk membuat dan menjalankan fungsi di komputer lokal Anda. |
func azure |
Perintah untuk bekerja dengan sumber daya Azure, termasuk penerbitan. |
func azurecontainerapps |
Perintah untuk menyebarkan aplikasi fungsi dalam kontainer ke Azure Container Apps. |
func bundles |
Perintah untuk mengelola bundel ekstensi. |
func durable |
Perintah untuk bekerja dengan Durable Functions. |
func extensions |
Perintah untuk menginstal dan mengelola ekstensi. |
func kubernetes |
Perintah untuk bekerja dengan Kubernetes dan Azure Functions. |
func settings |
Perintah untuk mengelola pengaturan lingkungan untuk host Functions lokal. |
func templates |
Perintah untuk mencantumkan templat fungsi yang tersedia. |
Sebelum menggunakan perintah dalam artikel ini, instal Core Tools.
Penting
Azure Functions CLI (v5) saat ini dalam pratinjau. Versi pratinjau ini belum mendukung Java dan PowerShell. Untuk bekerja dengan bahasa yang saat ini tidak didukung, terus gunakan Azure Functions Core Tools v4.
Untuk mempelajari selengkapnya tentang menggunakan CLI, termasuk penginstalan dan beban kerja, lihat Kembangkan Azure Functions secara lokal menggunakan Azure Functions CLI.
Perintah bawaan berikut dikirimkan dengan penginstalan CLI dasar:
| Perintah | Deskripsi |
|---|---|
func init |
Menginisialisasi proyek Azure Functions baru. |
func new |
Buat fungsi baru dari templat. |
func run |
Luncurkan runtime host Azure Functions secara lokal.
func start adalah alias yang kompatibel dengan versi sebelumnya. |
func quickstart |
Telusuri dan perancah aplikasi fungsi lengkap dari katalog templat mulai cepat. |
func profile |
Periksa dan kelola profil CLI Azure Functions. |
func setup |
Siapkan dependensi CLI Azure Functions lokal (runtime host, pekerja bahasa, bundel ekstensi). |
func workload |
Kelola beban kerja CLI yang diinstal. |
Beban kerja mungkin berkontribusi pada perintah tingkat atas tambahan. Perintah tersebut hanya muncul setelah Anda menginstal beban kerja yang berkontribusi.
func init
Membuat proyek Fungsi baru dalam bahasa tertentu.
func init [<PROJECT_FOLDER>]
Saat Anda menyediakan <PROJECT_FOLDER>, perintah membuat proyek di folder baru dengan nama ini. Jika tidak, ia menggunakan folder saat ini.
Perintah mendukung func init opsi ini, yang tergantung pada versi:
| Opsi | Deskripsi |
|---|---|
--bundles-channel, -c |
Saluran rilis bundel ekstensi. Nilai yang didukung adalah: GA (default), Preview, dan Experimental. Hanya berlaku untuk proyek non-.NET. |
--configuration-profile |
Menginisialisasi proyek dengan profil konfigurasi host. Opsi --configuration-profile saat ini dalam pratinjau. Untuk informasi selengkapnya, lihat Profil konfigurasi. |
--csx |
Membuat fungsi .NET sebagai skrip C#. Hanya berlaku dengan --worker-runtime dotnet. |
--docker |
Membuat Dockerfile untuk kontainer dengan menggunakan gambar dasar berdasarkan .--worker-runtime Gunakan opsi ini saat Anda berencana untuk menyebarkan aplikasi fungsi dalam kontainer. |
--docker-only |
Menambahkan Dockerfile ke proyek yang sudah ada. Meminta runtime pekerja jika tidak ditentukan atau diatur dalam local.settings.json. Gunakan opsi ini saat Anda berencana untuk menyebarkan aplikasi fungsi dalam kontainer dan proyek sudah ada. |
--force |
Menginisialisasi proyek bahkan ketika ada file yang ada dalam proyek. Pengaturan ini menimpa berkas yang ada dengan nama yang sama. File lain dalam folder proyek tidak terpengaruh. |
--language, -l |
Menginisialisasi proyek bahasa tertentu. Saat ini didukung ketika --worker-runtime diatur ke node. Opsinya adalah: typescript dan javascript. Anda juga dapat menggunakan --worker-runtime javascript atau --worker-runtime typescript. |
--managed-dependencies |
Menginstal dependensi terkelola. Saat ini, hanya runtime pekerja PowerShell yang mendukung fitur ini. |
--model, -m |
Mengatur model pemrograman untuk bahasa target saat lebih dari satu model tersedia. Opsi yang didukung adalah V1 dan V2 untuk Python, dan V3 dan V4 untuk Node.js. Untuk informasi selengkapnya, lihat panduan pengembang Python dan panduan pengembang Node.js. |
--no-bundle |
Jangan konfigurasikan bundel ekstensi di host.json. Hanya berlaku untuk proyek non-.NET. |
--no-docs |
Melompati pembuatan file dokumentasi "Memulai". Berlaku untuk proyek Python. |
--skip-npm-install |
Lewati berjalan npm install setelah pembuatan proyek. Berlaku untuk proyek Node.js. |
--source-control |
Mengontrol apakah repositori Git dibuat. Secara default, repositori tidak dibuat. Ketika true, repositori dibuat. |
--worker-runtime |
Menyetel runtime bahasa untuk proyek. Nilai yang didukung adalah: csharp, , dotnetdotnet-isolated, javascript, node (JavaScript), powershell, python, dan typescript. Untuk Java, gunakan Maven. Untuk menghasilkan proyek bahasa-agnostik hanya dengan file proyek, gunakan custom. Saat tidak diatur, Anda akan diminta untuk memilih runtime selama inisialisasi. |
--target-framework |
Mengatur kerangka kerja target untuk proyek aplikasi fungsi. Hanya berlaku dengan --worker-runtime dotnet-isolated. Nilai yang didukung adalah: net10.0 (pratinjau), net9.0, net8.0 (default), net6.0, dan net48 (.NET Framework 4.8). |
Catatan
Saat Anda menggunakan opsi --docker atau --docker-only, Core Tools secara otomatis membuat fungsi Dockerfile untuk C#, JavaScript, Python, dan PowerShell. Untuk fungsi Java, Anda harus membuat Dockerfile secara manual. Untuk informasi selengkapnya, lihat Membuat aplikasi fungsi dalam kontainer.
Profil konfigurasi
Penting
Dukungan untuk profil konfigurasi saat ini dalam pratinjau.
Saat Anda menggunakan opsi ini --configuration-profile , Anda membuat serangkaian konfigurasi dan pengaturan proyek yang telah ditentukan sebelumnya. Saat Anda menentukan profil konfigurasi, inisialisasi mungkin melewati semua langkah inisialisasi lainnya.
| Nilai profil | Deskripsi | Tindakan tertentu |
|---|---|---|
mcp-custom-handler |
Membuat proyek yang menggunakan handler kustom untuk menghosting server MCP (Model Context Protocol) yang dapat disambungkan oleh agen AI dan klien MCP lainnya. | • Mengonfigurasi "configurationProfile": "mcp-custom-handler" elemen dalam file host.json dengan pengaturan handler kustom tertentu.• Diatur MCP_EXTENSION_ENABLED ke true dalam local.settings.json. |
func init [<PATH>] [options]
Saat Anda menyediakan <PATH>, proyek dibuat di folder itu. Jika tidak, folder saat ini yang digunakan.
Perintah ini func init mendukung opsi bawaan ini:
| Opsi | Deskripsi |
|---|---|
--stack, -s |
Tumpukan yang akan digunakan untuk proyek (misalnya, python, , nodedotnet, go). Jalankan func workload list untuk melihat tumpukan yang dikontribusikan oleh beban kerja yang Anda instal. |
--name, -n |
Nama proyek aplikasi fungsi. |
--language, -l |
Bahasa pemrograman (misalnya, C#, F#, JavaScript, TypeScript, Python). Digunakan saat tumpukan mendukung lebih dari satu bahasa. Nilai yang didukung dihitung dari beban kerja tumpukan yang diinstal. |
--force |
Inisialisasi ulang bahkan ketika folder target tidak kosong. Menghapus folder (kecuali .git) sebelum perancah. |
Beban kerja menyumbangkan opsi tambahan yang dikelompokkan di bawah nama beban kerja di func init --help. Lihat opsi khusus beban kerja untuk opsi per tumpukan.
Jika tidak ada beban kerja yang menyediakan tumpukan yang diminta, CLI mencetak petunjuk yang menunjuk ke dan func workload install keluar dengan kode keluar bukan nol.
Opsi khusus beban kerja
Perintah diperluas init saat Anda menginstal satu atau beberapa beban kerja ini:
| Opsi | Deskripsi |
|---|---|
--target-framework, -tfm |
Kerangka kerja .NET target untuk proyek (misalnya, net10.0). Standar: net10.0. |
Penginisialisasi .NET tidak menulis blok bundel ekstensi, sehingga --no-bundles dan --bundles-channel tidak berlaku.
Ketika lebih dari satu beban kerja yang diinstal menyumbangkan opsi yang sama, opsi muncul sekali di func init --help.
Opsi bersama
Saat ini, opsi bersama adalah --no-bundles dan --bundles-channel. ID bundel ekstensi default yang Anda tulis ke host.json bergantung pada saluran yang dipilih:
| Saluran | ID Bundel |
|---|---|
GA (standar) |
Microsoft.Azure.Functions.ExtensionBundle |
Preview |
Microsoft.Azure.Functions.ExtensionBundle.Preview |
Experimental |
Microsoft.Azure.Functions.ExtensionBundle.Experimental |
Rentang versi default adalah [4.*, 5.0.0).
func new
Membuat fungsi baru dalam proyek saat ini berdasarkan templat.
func new
Perintah mendukung func new opsi ini, yang tergantung pada versi:
| Opsi | Deskripsi |
|---|---|
--authlevel, -a |
Mengatur tingkat otorisasi untuk pemicu HTTP. Nilai yang didukung adalah: function, anonymous, admin. Otorisasi tidak diberlakukan saat berjalan secara lokal. Untuk informasi selengkapnya, lihat Tingkat otorisasi. |
--csx |
Menghasilkan templat skrip C# (.csx) yang sama yang digunakan dalam versi 1 dan di portal. |
--file, -f |
File target untuk fungsi baru. Untuk proyek Python v2, menentukan file untuk menambahkan fungsi ke (default ke function_app.py). Untuk proyek Node.js v4, menentukan nama file output di src/functions folder . Tidak berlaku untuk proyek .NET yang dikompilasi. |
--name, -n |
Nama fungsi. |
--template, -t |
Gunakan perintah func templates list untuk melihat daftar lengkap templat yang tersedia untuk setiap bahasa yang didukung. |
Untuk informasi lebih lanjut, lihat Membuat fungsi.
func new [<PATH>] [options]
Penting
func new saat ini merupakan rintisan pratinjau. Ini mencetak petunjuk penginstalan beban kerja dan keluar dengan kode keluar bukan nol hingga beban kerja templat diinstal dan disambungkan. Opsi khusus templat terhidrasi secara dinamis dari metadata templat, jadi menambahkan opsi templat baru tidak memerlukan rilis CLI.
Perintah ini func new mendukung opsi bawaan ini:
| Opsi | Deskripsi |
|---|---|
--name, -n |
Nama fungsi. |
--template, -t |
Nama templat fungsi. Templat yang tersedia berasal dari beban kerja yang diinstal <stack>-templates untuk tumpukan proyek. |
--force |
Timpa file yang sudah ada. |
Opsi tambahan dikontribusikan secara dinamis oleh templat yang dipilih. Jalankan func new --template <name> --help untuk melihat opsi untuk templat tertentu.
Jika tidak ada beban kerja templat yang diinstal untuk proyek saat ini, CLI mencetak petunjuk yang menunjuk ke func workload install.
func logs
Mendapatkan log untuk fungsi yang berjalan di cluster Kubernetes.
func logs --platform kubernetes --name <APP_NAME>
func logs Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--platform |
Platform hosting untuk aplikasi fungsi. Opsi yang valid: kubernetes. |
--name |
Nama aplikasi fungsi di Azure. |
Untuk informasi selengkapnya, lihat Azure Functions di Kubernetes dengan KEDA.
func pack
Membuat paket penyebaran yang berisi kode proyek Anda dalam status dapat dijalankan. Gunakan metode ini saat Anda perlu membuat paket penyebaran secara manual untuk aplikasi Anda di komputer lokal Anda di luar func azure functionapp publish perintah. Secara default, func pack membangun proyek Anda saat diperlukan.
Untuk aplikasi fungsi Go, func pack membangun paket penyebaran Linux x64 yang dapat Anda sebarkan dengan menggunakan perintah Azure CLI az functionapp deployment source config-zip.
func pack [<FOLDER_PATH>]
Secara default, func pack mengemas direktori saat ini, dan file .zip output memiliki nama yang sama dengan folder akar proyek Anda. Jalankan func pack di direktori yang berisi file proyek host.json Anda. Jika Anda perlu menjalankan func pack di direktori lain, atur <FOLDER_PATH> sebagai jalur ke akar proyek, seperti func pack ./myprojectroot. Jika file .zip tertentu sudah ada, file tersebut pertama kali dihapus lalu diganti dengan versi yang diperbarui.
func pack Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--output, -o |
Mengatur jalur ke lokasi tempat penyebaran .zip file paket dibuat. |
--no-build |
Project tidak dibangun sebelum pengemasan. Untuk aplikasi C#, gunakan hanya saat Anda sudah membuat biner Anda. Untuk aplikasi Node.js, baik npm install dan npm run build dilewati. Untuk aplikasi Go, gunakan hanya jika bin/app sudah berisi biner Linux x64. |
--skip-install |
Melompati berjalan npm install saat mengemas aplikasi fungsi berbasis Node.js. Digunakan untuk menghindari penimpaan modul npm kustom. |
--build-native-deps |
Menginstal dependensi Python secara lokal dengan menggunakan gambar yang cocok dengan lingkungan yang digunakan dalam Azure. Saat diaktifkan, Core Tools memulai kontainer Docker, membangun aplikasi di dalam kontainer tersebut, dan membuat file .zip dengan semua dependensi yang dipulihkan di .python_packages. Gunakan opsi ini saat berjalan di Windows untuk menghindari potensi masalah pustaka saat Anda menyebarkan ke Linux di Azure. |
func run (hanya v1)
Catatan
Perintah ini hanya berlaku untuk Alat Inti versi 1 dan tidak digunakan lagi. Untuk versi 4, gunakan func start dan panggil titik akhir fungsi secara langsung.
Memanggil fungsi secara langsung, mirip dengan menjalankan fungsi dengan menggunakan tab Test di portal Azure.
func run
func run Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--content |
Konten sebaris diteruskan ke fungsi. |
--debug |
Lampirkan debugger ke proses host sebelum menjalankan fungsi. |
--file |
Nama berkas yang akan digunakan sebagai konten. |
--no-interactive |
Tidak meminta input, yang mana berguna untuk skenario otomatisasi. |
--timeout |
Waktu untuk menunggu (dalam detik) sampai host Functions lokal siap. |
Misalnya, untuk memanggil fungsi yang dipicu HTTP dan meneruskan isi konten, jalankan perintah ini:
func run MyHttpTrigger --content '{\"name\": \"Azure\"}'
func start
Memulai host runtime lokal dan memuat proyek fungsi di folder saat ini.
Perintah tertentu bergantung pada versi runtime.
func start
func start Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--cert |
Jalur ke file .pfx yang berisi kunci privat. Hanya didukung dengan --useHttps. |
--cors |
Daftar asal CORS yang dipisahkan koma, tanpa spasi. |
--cors-credentials |
Memungkinkan permintaan terautentikasi lintas asal yang menggunakan cookie dan header Autentikasi. |
--dotnet-isolated-debug |
Saat diatur ke true, jeda proses pekerja .NET hingga debugger dilampirkan dari proyek terisolasi .NET sedang di-debug. |
--enable-json-output |
Memancarkan log konsol sebagai JSON jika memungkinkan. |
--enableAuth |
Mengaktifkan alur penanganan autentikasi penuh dengan persyaratan otorisasi. |
--functions |
Daftar fungsi yang dipisahkan spasi untuk dimuat. |
--json-output-file |
Jika disediakan, jalur ke file yang digunakan untuk menulis output saat menggunakan --enable-json-output. |
--language-worker |
Argumen untuk mengonfigurasi pekerja bahasa. Misalnya, Anda dapat mengaktifkan penelusuran kesalahan untuk pekerja bahasa dengan menyediakan port debug dan argumen lain yang diperlukan. |
--no-build |
Jangan membangun proyek saat ini sebelum berjalan. Hanya untuk proyek kelas .NET. Defaultnya adalah false. |
--password |
Baik kata sandi maupun file yang berisi kata sandi untuk file .pfx. Hanya digunakan dengan --cert. |
--port, -p |
Port lokal untuk mendengarkan. Nilai default: 7071. |
--runtime |
Mengatur versi host mana yang akan dimulai. Nilai yang diizinkan adalah: inproc6, inproc8, dan default (yang menjalankan host di luar proses). |
--timeout, -t |
Batas waktu untuk memulai host Functions, dalam hitungan detik. Default: 20 detik. |
--useHttps |
Mengikat ke https://localhost:{port} bukan ke http://localhost:{port}. Secara default, opsi ini membuat sertifikat tepercaya pada komputer Anda. |
--user-log-level |
Mengatur tingkat log minimum untuk log pengguna. Nilai yang valid adalah: Trace, , DebugInformation, Warning, Error, Critical, dan None. Pengaturan ini tidak memengaruhi log sistem. Untuk proyek terisolasi .NET, atur juga tingkat minimum di Program.cs dengan menggunakan builder.Logging.SetMinimumLevel(LogLevel.Debug) agar opsi ini berlaku. |
Dengan proyek berjalan, verifikasi titik akhir fungsi individual.
func run
Memulai runtime host Functions dan memuat proyek di folder saat ini.
func run [<PATH>] [options]
func start dipertahankan sebagai alias yang kompatibel dengan versi sebelumnya dan menerima argumen dan opsi yang sama.
func run Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--port, -p |
Port lokal untuk mendengarkan. Standar: 7071. |
--cors |
Daftar asal CORS yang dipisahkan koma, tanpa spasi. |
--cors-credentials |
Izinkan permintaan terautentikasi lintas asal yang menggunakan cookie dan Authentication header. |
--functions |
Daftar fungsi yang dipisahkan spasi untuk dimuat. |
--no-build |
Jangan membangun proyek sebelum menjalankan. |
--enable-auth |
Aktifkan alur penanganan autentikasi penuh, termasuk persyaratan otorisasi. |
--host-version, -v |
Versi runtime host yang akan digunakan (misalnya, 4.1049.0). |
--profile |
Profil Azure Functions untuk diterapkan saat menyelesaikan versi host, pekerja, dan bundel. Lihat func profile. |
--offline |
Gunakan hanya beban kerja yang diinstal secara lokal dan lewati penginstalan jaringan. |
--output |
Mode keluaran: compact (TUI interaktif), plain (CI / non-TTY), atau json (NDJSON untuk konsumen terprogram dan agen AI). Default untuk mendeteksi otomatis berdasarkan terminal. |
--no-tui |
Alias untuk --output=plain. Menonaktifkan TUI interaktif. |
--log-file |
Cerminkan semua peristiwa host ke file log yang ditentukan. |
--no-azurite |
Nonaktifkan Azurite terkelola. Host dimulai tanpa menyelidiki atau memulai emulator lokal. |
Saat proyek sedang berjalan, panggil titik akhir fungsi secara langsung untuk memverifikasi perilaku.
Azurite yang Dikelola
Saat project Anda menggunakan penyimpanan lokal (misalnya, AzureWebJobsStorage=UseDevelopmentStorage=true), func run secara otomatis memeriksa emulator Azurite yang sedang berjalan dan memulainya jika tidak menemukannya. Emulator berhenti saat func run keluar. Lulus --no-azurite untuk memilih keluar dan mengelola Azurite sendiri.
Mode keluaran
func run Memilih mode keluaran secara otomatis berdasarkan terminal:
| Keadaan | Modus |
|---|---|
| Terminal interaktif (TTY) | compact |
Stdout non-interaktif, output yang dialihkan, atau CI kumpulan variabel lingkungan |
plain |
Eksplisit --output=json |
json |
CLI tidak pernah memilih jsonsecara otomatis . Jika compact diminta tetapi stdout bukan TTY, CLI menurunkan peringkat ke plain dan menulis pemberitahuan satu baris ke stderr. Mode ini json memancarkan JSON yang dibatasi baris baru (NDJSON), satu objek per baris, dengan .schema_version1
func quickstart
Menelusuri dan merancah aplikasi fungsi lengkap dari katalog templat mulai cepat Azure Functions. Templat mulai cepat adalah aplikasi sampel lengkap, seperti HTTP API, pekerja yang dipicu antrean, atau orkestrasi Durable Functions. Beban kerja tumpukan berkontribusi pada penyelesai khusus bahasa. Katalog diambil pada waktu pemanggilan perintah.
func quickstart [<PATH>] [options]
Saat Anda menyediakan <PATH>, proyek dibuat di folder itu. Jika tidak, folder saat ini yang digunakan.
func quickstart Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--stack, -s |
Tumpukan yang akan digunakan, seperti python, node, atau dotnet. |
--language, -l |
Bahasa pemrograman. Nilai yang didukung berasal dari penyedia mulai cepat yang diinstal. |
--template, -t |
ID templat dari katalog, seperti http-trigger-python-azd. Melewati semua perintah interaktif. |
--resource, -r |
Filter berdasarkan pemicu atau sumber daya pengikatan, seperti http, timer, blobeventhubservicebuscosmossqlmcpatau .durable |
--iac |
Memfilter berdasarkan jenis infrastruktur-sebagai-kode, seperti bicep, terraform, atau none. |
--search |
Filter substring yang tidak peka huruf besar/kecil diterapkan ke nama dan deskripsi templat. |
--fetch |
Strategi pengambilan katalog: auto (default), git, atau http.
auto menyelidiki dan git kembali ke HTTP. |
--force |
Perancah bahkan ketika folder target tidak kosong. Menghapus folder (kecuali .git) sebelum perancah. |
Subperintah:
| Subcommand | Deskripsi |
|---|---|
func quickstart list |
Cantumkan templat yang tersedia di katalog. |
func quickstart info |
Tampilkan detail tentang templat tertentu. |
func quickstart list
Mencantumkan templat yang tersedia dari katalog, difilter secara opsional.
func quickstart list [options]
| Opsi | Deskripsi |
|---|---|
--stack, -s |
Tumpukan yang akan digunakan, seperti python, node, atau dotnet. |
--language, -l |
Bahasa pemrograman. Nilai yang didukung berasal dari penyedia mulai cepat yang diinstal. |
--resource, -r |
Filter berdasarkan pemicu atau sumber daya pengikatan. |
--iac |
Filter berdasarkan jenis infrastruktur-sebagai-kode. |
--search |
Pencocokan substring yang tidak peka huruf besar/kecil terhadap ID, nama templat, jenis sumber daya, Infrastruktur sebagai jenis Kode, dan deskripsi. |
--json |
Keluarkan JSON yang dapat dibaca mesin, bukan tabel. |
func quickstart info
Menampilkan informasi terperinci tentang templat tertentu.
func quickstart info <ID> [options]
<ID> adalah ID templat dari katalog. Gunakan func quickstart list untuk menemukan ID yang tersedia.
| Opsi | Deskripsi |
|---|---|
--json |
Keluarkan JSON yang dapat dibaca mesin, bukan output yang diformat. |
func profile
Memeriksa dan mengelola profil CLI Azure Functions. Profil mengkodekan batasan versi, seperti rentang versi host, rentang versi bundel ekstensi, dan rentang versi pekerja. Mereka juga mendefinisikan warisan dari profil lain. Sumber profil termasuk profil lokal proyek (.func/profiles/), global pengguna (~/.azure-functions/profiles/), dan profil bawaan. Gunakan func run --profile <name> opsi untuk memilih batasan profil mana yang berlaku saat meluncurkan host.
func profile <subcommand>
Subperintah:
| Subcommand | Deskripsi |
|---|---|
func profile list |
Daftar profil yang tersedia dari proyek, pengguna, dan sumber bawaan. |
func profile show |
Tampilkan detail untuk profil. |
func profile set |
Atur profil default untuk proyek. |
func profile list
Mencantumkan profil yang tersedia dari proyek, pengguna, dan sumber bawaan. Merender tabel nama, sumber, versi host, bundel ekstensi, dan status.
func profile list [<PATH>] [options]
| Opsi | Deskripsi |
|---|---|
--source |
Daftar sumber yang dipisahkan koma untuk mencakup: project, user, built-in. Default ke semua sumber. |
--json |
Keluarkan JSON yang dapat dibaca mesin, bukan tabel. |
func profile show
Menampilkan detail untuk satu profil, baik diselesaikan (dengan nilai yang diwariskan diterapkan) atau mentah (definisi seperti yang tertulis, tanpa perluasan pewarisan).
func profile show <NAME> [<PATH>] [options]
| Opsi | Deskripsi |
|---|---|
--raw |
Tampilkan definisi profil mentah tanpa nilai yang diwariskan. |
func profile set
Mengatur profil default untuk proyek Functions dengan menulis nama profil ke dalam ..func/config.json Jika profil belum ada dalam daftar profil proyek, tambahkan.
func profile set <NAME> [<PATH>]
func setup
Mempersiapkan komputer lokal untuk menjalankan proyek Azure Functions. Menginstal atau memverifikasi runtime host, pekerja bahasa, bundel ekstensi, dan templat untuk tumpukan yang Anda tentukan. Mendukung batasan versi berbasis profil, pemilihan prarilis, mode CI noninteraktif, dan mode pemeriksa-saja.
func setup [<PATH>] [options]
--features memilih apa yang akan diinstal atau diverifikasi. Fitur dan beban kerja yang diselesaikan masing-masing adalah:
| Feature | Beban kerja diinstal |
|---|---|
node |
host, , bundlesnode, , node-worker,node-templates |
python |
host, , bundlespython, , python-worker,python-templates |
go |
host,bundles,go,go-worker |
dotnet |
host, , dotnetdotnet-templates |
runtime |
host, bundles |
host |
host hanya |
--features dapat diulang dan menerima nilai yang dipisahkan koma, sehingga Anda dapat menggabungkan fitur dalam satu panggilan (misalnya, func setup --features node,python).
dotnet-isolated diterima sebagai alias untuk dotnet.
| Opsi | Deskripsi |
|---|---|
--features |
Komponen yang akan diinstal atau diverifikasi. Dapat diulang atau dipisahkan koma. Lihat tabel di atas untuk beban kerja yang diinstal setiap fitur. |
--profile |
Profil Azure Functions untuk digunakan untuk batasan versi. Berulang. Digabungkan dengan --profiles. |
--profiles |
Daftar profil Azure Functions yang dipisahkan koma untuk digunakan untuk batasan versi. |
--install-policy |
Kebijakan latest-compatible instal: (default) atau if-needed. |
--source |
Sumber paket NuGet untuk digunakan untuk resolusi dan penginstalan beban kerja. |
--prerelease |
Izinkan versi beban kerja prarilis saat menyelesaikan dari katalog. Default: diaktifkan saat beban kerja dalam pratinjau. |
--non-interactive |
Jangan meminta masukan. |
--yes, -y |
Jawab ya untuk perintah penyiapan. |
--check |
Verifikasi apakah dependensi yang dipilih diinstal, tanpa membuat perubahan. |
--output |
Mode keluaran: plain (default) atau json (NDJSON). |
func workload
Mengelola beban kerja yang diinstal untuk Azure Functions CLI.
func workload <subcommand>
Subperintah:
| Subcommand | Deskripsi |
|---|---|
func workload list |
Cantumkan beban kerja yang diinstal. |
func workload search |
Cari katalog beban kerja. |
func workload install |
Instal beban kerja. |
func workload update |
Perbarui beban kerja yang diinstal di tempat. |
func workload uninstall |
Copot pemasangan beban kerja. |
func workload prune |
Hapus penginstalan beban kerja berdampingan yang tidak aktif. |
func workload list
Mencantumkan beban kerja yang terinstal. Secara default, perintah hanya menampilkan versi yang dimuat (tertinggi-instal-semver) dari setiap beban kerja. Gunakan --all-versions untuk melihat setiap instalasi berdampingan.
func workload list [options]
| Opsi | Deskripsi |
|---|---|
--all-versions, -a |
Cantumkan setiap versi yang diinstal dari setiap beban kerja. Default: hanya versi yang dimuat. |
--json |
Keluarkan JSON yang dapat dibaca mesin, bukan tabel. |
func workload search
Mencari katalog beban kerja yang dikonfigurasi untuk paket beban kerja yang tersedia.
func workload search [<QUERY>] [options]
Saat Anda menghilangkan <QUERY>, perintah mencantumkan semua beban kerja dalam katalog.
| Opsi | Deskripsi |
|---|---|
--source |
URL sumber katalog untuk dicari. Default ke katalog yang dikonfigurasi. |
--prerelease |
Sertakan versi prarilis dalam hasil. Default: diaktifkan saat beban kerja dalam pratinjau. |
--json |
Keluarkan JSON yang dapat dibaca mesin, bukan tabel. |
func workload install
Menyelesaikan ID paket beban kerja (atau alias) melalui katalog yang dikonfigurasi dan menginstalnya.
func workload install <ID> [options]
<ID> dapat berupa ID paket beban kerja, alias (misalnya, python), atau jalur ke file paket beban kerja lokal.
| Opsi | Deskripsi |
|---|---|
--version, -v |
Versi khusus untuk diinstal. Default: versi stabil terbaru dalam katalog. |
--source |
URL sumber katalog atau direktori lokal untuk menyelesaikannya. Default: katalog yang dikonfigurasi. |
--prerelease |
Izinkan versi prarilis saat menyelesaikan dari katalog. Default: diaktifkan saat beban kerja dalam pratinjau. |
--force, -f |
Menimpa penginstalan yang ada dari ID dan versi yang sama. Juga melewati perintah "gunakan pembaruan sebagai gantinya". |
--exact, -e |
Nonaktifkan pencocokan alias.
<ID> harus berupa ID paket literal. |
Jika versi beban kerja sudah diinstal, CLI meminta Anda untuk menggunakannya func workload update sebagai gantinya. Konteks non-interaktif memperlakukan prompt sebagai penurunan.
func workload update
Melakukan pertukaran versi atom di tempat untuk beban kerja yang diinstal. Pembaruan tidak berdampingan; Untuk pemasangan berdampingan, gunakan func workload install --force.
func workload update [<ID>] [options]
Teruskan untuk <ID> memperbarui satu beban kerja, atau --all untuk memperbarui setiap beban kerja yang diinstal. Tentukan dengan tepat salah satu dari dua opsi ini.
| Opsi | Deskripsi |
|---|---|
--version, -v |
Versi terinstal untuk diganti. Default: versi terinstal tertinggi. |
--all |
Perbarui setiap beban kerja yang diinstal. Bersifat saling eksklusif dengan <ID>. |
--major |
Izinkan melintasi batas versi utama. Default: hanya jurusan yang sama. |
--source |
URL sumber katalog atau direktori lokal untuk menyelesaikannya. Default: katalog yang dikonfigurasi. |
--prerelease |
Izinkan versi prarilis saat menyelesaikan dari katalog. Default: diaktifkan saat beban kerja dalam pratinjau. |
--exact, -e |
Nonaktifkan pencocokan alias.
<ID> harus berupa ID paket literal. |
func workload uninstall
Menghapus satu atau semua versi beban kerja yang diinstal.
func workload uninstall <ID> [options]
| Opsi | Deskripsi |
|---|---|
--version, -v |
Versi khusus untuk dihapus. Default: satu-satunya versi yang diinstal. |
--all-versions, -a |
Copot pemasangan setiap versi beban kerja yang diinstal. Bersifat saling eksklusif dengan --version. |
--exact, -e |
Nonaktifkan pencocokan alias.
<ID> harus berupa ID paket literal. |
func workload prune
Menghapus penginstalan beban kerja berdampingan yang tidak aktif. Untuk setiap ID paket dalam cakupan, perintah menyimpan versi terinstal tertinggi dan menghapus versi yang lebih lama. Perintah ini hanya lokal dan tidak pernah menyentuh katalog.
func workload prune [<ID>] [options]
Saat Anda menghilangkan <ID>, perintah memangkas setiap beban kerja yang diinstal.
| Opsi | Deskripsi |
|---|---|
--exact, -e |
Nonaktifkan pencocokan alias.
<ID> harus berupa ID paket literal. |
func azure functionapp
Konteks func azure functionapp berisi perintah berikut:
func azure functionapp fetch-app-settingsfunc azure functionapp list-functionsfunc azure functionapp logstreamfunc azure functionapp publish
Semua func azure functionapp perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--slot |
Menargetkan slot penyebaran bernama tertentu, jika dikonfigurasi. |
--access-token |
Menyediakan token akses, selain token default, untuk digunakan untuk melakukan tindakan terautentikasi di Azure. |
--access-token-stdin |
Membaca token akses tertentu dari input standar. Gunakan opsi ini saat membaca token langsung dari perintah sebelumnya seperti az account get-access-token. |
--management-url |
Mengatur URL manajemen untuk cloud Azure, yang defaultnya https://management.azure.com. Gunakan opsi ini saat aplikasi fungsi Anda berjalan di sovereign cloud. |
--subscription |
Mengatur langganan Azure default. |
func azure functionapp fetch-app-settings
Mendapatkan pengaturan dari aplikasi fungsi tertentu.
func azure functionapp fetch-app-settings <APP_NAME>
Untuk informasi selengkapnya, lihat Mengunduh pengaturan aplikasi.
Perintah mengunduh pengaturan ke dalam file local.settings.json untuk proyek. Nilai di layar ditutupi untuk keamanan. Anda dapat melindungi pengaturan dalam file local.settings.json dengan mengaktifkan enkripsi lokal.
func azure functionapp list-functions
Mencantumkan fungsi dalam aplikasi fungsi yang ditentukan.
func azure functionapp list-functions <APP_NAME>
Perintah func azure functionapp list-functions mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--show-keys |
Sertakan nilai kunci akses tingkat fungsi dalam URL titik akhir fungsi yang dikembalikan. |
func azure functionapp logstream
Menyambungkan prompt perintah lokal ke log streaming untuk aplikasi fungsi di Azure.
func azure functionapp logstream <APP_NAME>
Batas waktu default untuk koneksi adalah 2 jam. Ubah batas waktu dengan menambahkan pengaturan aplikasi bernama SCM_LOGSTREAM_TIMEOUT, dengan nilai batas waktu dalam detik. Belum didukung untuk Linux dalam paket Konsumsi atau KonsumsiFlex. Untuk aplikasi ini, gunakan opsi --browser untuk menampilkan log di portal.
Perintah func azure functionapp logstream mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--browser |
Buka Azure Application Insights Live Stream untuk aplikasi fungsi di browser default. |
Untuk informasi selengkapnya, lihat log eksekusi streaming Enable di Azure Functions.
func azure functionapp publish
Menyebarkan proyek Functions ke sumber daya aplikasi fungsi yang ada di Azure.
func azure functionapp publish <APP_NAME>
Untuk informasi selengkapnya, lihat Menyebarkan file proyek.
Opsi penerbitan berikut berlaku, berdasarkan versi:
| Opsi | Deskripsi |
|---|---|
--additional-packages |
Daftar paket yang akan diinstal saat membangun dependensi asli. Misalnya: python3-dev libevent-dev. |
--build, -b |
Melakukan tindakan build saat menyebarkan ke aplikasi fungsi Linux. Menerima: remote dan local. |
--build-native-deps |
Melompati pembuatan folder .wheels saat Anda menerbitkan aplikasi fungsi Python. |
--csx |
Menerbitkan proyek skrip C# (.csx). |
--dotnet-cli-params |
Saat Anda menerbitkan fungsi C# (.csproj) yang dikompilasi, alat inti memanggil dotnet build --output bin/publish. Parameter apa pun yang diteruskan ke opsi ini ditambahkan ke baris perintah. |
--dotnet-version |
Untuk aplikasi dotnet-isolated, menentukan versi .NET target (misalnya, 8.0). |
--force |
Mengabaikan verifikasi prapublikasi dalam skenario tertentu. |
--list-ignored-files |
Menampilkan daftar file yang diabaikan selama penerbitan, berdasarkan file .funcignore . |
--list-included-files |
Menampilkan daftar file yang diterbitkan, yang didasarkan pada file .funcignore . |
--no-build |
Project tidak dibangun selama penerbitan. Untuk Python, pip install tidak berjalan. |
--nozip |
Menonaktifkan mode default Run-From-Package. Mengekstrak file ke wwwroot folder di server alih-alih menjalankannya langsung dari paket penyebaran. |
--overwrite-settings, -y |
Menekan perintah untuk menimpa pengaturan aplikasi saat Anda menggunakan --publish-local-settings -i. |
--publish-local-settings, -i |
Menerbitkan pengaturan di local.settings.json ke Azure, meminta untuk menimpa jika pengaturan sudah ada. Jika Anda menggunakan emulator penyimpanan lokal, pertama-tama ubah pengaturan aplikasi ke koneksi penyimpanan aktual. |
--publish-settings-only, -o |
Menerbitkan hanya pengaturan dan melewati isi. Defaultnya adalah minta. |
--show-keys |
Menambahkan kunci fungsi ke URL yang ditampilkan dalam log. |
func azure storage fetch-connection-string
Mendapatkan string koneksi untuk akun Azure Storage yang ditentukan.
func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
Untuk informasi selengkapnya, lihat unduh penyimpanan string koneksi.
func azurecontainerapps deploy
Menyebarkan aplikasi fungsi dalam kontainer ke lingkungan Azure Container Apps. Akun penyimpanan host default, aplikasi fungsi, dan lingkungan harus sudah ada. Untuk informasi selengkapnya, lihat hosting Azure Container Apps Azure Functions.
func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> --registry-server <REGISTRY_SERVER> --registry-username <USERNAME> --registry-password <PASSWORD>
Opsi penyebaran berikut berlaku:
| Opsi | Deskripsi |
|---|---|
--environment |
Nama lingkungan Container Apps yang ada. |
--image-build |
Atur ke true untuk melewati build Docker lokal. |
--image-name |
Nama gambar kontainer yang ada dalam registri kontainer, termasuk nama tag. |
--location |
Wilayah untuk penyebaran. Idealnya, wilayah ini sama dengan lingkungan dan sumber daya akun penyimpanan. |
--name |
Nama yang digunakan untuk penyebaran aplikasi fungsi di lingkungan Aplikasi Kontainer. Nama ini juga muncul saat mengelola aplikasi fungsi di portal. Nama harus unik di lingkungan. |
--registry |
Saat diatur, build Docker berjalan dan gambar didorong ke registri yang diatur dalam --registry. Anda tidak dapat menggunakan --registry dengan --image-name. Untuk Docker Hub, gunakan juga --registry-username. |
--registry-password |
Kata sandi atau token yang digunakan untuk mengambil gambar dari registri privat. |
--registry-username |
Nama pengguna yang digunakan untuk mengambil gambar dari registri privat. |
--resource-group |
Grup sumber daya untuk membuat sumber daya terkait fungsi. |
--storage-account |
string koneksi untuk akun penyimpanan yang akan digunakan oleh aplikasi fungsi. |
--worker-runtime |
Mengatur bahasa runtime aplikasi fungsi. Parameter ini hanya digunakan dengan --image-name dan --image-build; jika tidak, bahasa ditentukan selama build lokal. Nilai yang didukung adalah: dotnet, , dotnetIsolatednode, python, powershell, dan custom (untuk handler kustom). |
Penting
String koneksi penyimpanan dan kredensial layanan lainnya adalah rahasia penting. Simpan file skrip apa pun yang digunakan func azurecontainerapps deploy dengan aman dan jangan simpan di kontrol sumber yang dapat diakses publik.
func deploy
Perintah func deploy tidak digunakan lagi. Sebagai gantinya, gunakan func kubernetes deploy.
func bundles add
Menambahkan konfigurasi bundel ekstensi ke file host.json .
func bundles add
func bundles add Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--force, -f |
Menimpa konfigurasi bundel ekstensi yang ada jika ada. |
--channel, -c |
Saluran rilis bundel ekstensi. Nilai yang didukung adalah: GA (default), Preview, dan Experimental. |
func bundles download
Mengunduh bundel ekstensi yang dikonfigurasi di host.json.
func bundles download
func bundles download Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--force, -f |
Memaksa pengunduhan ulang bundel ekstensi meskipun sudah ada. |
func bundles list
Mencantumkan bundel ekstensi yang diunduh.
func bundles list
func bundles path
Mendapatkan jalur ke bundel ekstensi yang diunduh.
func bundles path
func durable delete-task-hub
Menghapus semua artefak penyimpanan di hub tugas Durable Functions.
func durable delete-task-hub
func durable delete-task-hub Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connection-string-setting |
Nama pengaturan yang berisi string koneksi penyimpanan yang akan digunakan. |
--task-hub-name |
Nama hub tugas Tahan Lama untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable get-history
Mengembalikan riwayat instans orkestrasi tertentu.
func durable get-history --id <INSTANCE_ID>
func durable get-history Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--id |
ID instans orkestrasi. (Diperlukan) |
--connection-string-setting |
Nama pengaturan yang memiliki string koneksi penyimpanan untuk digunakan. |
--task-hub-name |
Nama hub tugas Tahan Lama untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable get-instances
Menampilkan status semua instans orkestrasi. Perintah ini mendukung paging dengan menggunakan top parameter.
func durable get-instances
func durable get-instances Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--continuation-token |
Token yang menunjukkan halaman atau bagian tertentu dari permintaan yang akan dikembalikan. |
--connection-string-setting |
Nama pengaturan aplikasi yang berisi string koneksi penyimpanan untuk digunakan. |
--created-after |
Dapatkan instans yang dibuat setelah tanggal dan waktu (UTC) ini. Semua tanggalwaktu dengan format ISO 8601 diterima. |
--created-before |
Dapatkan instans yang dibuat sebelum tanggal dan waktu tertentu (UTC). Semua tanggalwaktu dengan format ISO 8601 diterima. |
--runtime-status |
Dapatkan instans yang statusnya cocok dengan status tertentu, termasuk running, completed, dan failed. Anda dapat memberikan satu atau beberapa status yang dipisahkan ruang. |
--top |
Batasi jumlah rekaman yang dikembalikan dalam permintaan tertentu. |
--task-hub-name |
Nama hub tugas Durable Functions untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable get-runtime-status
Mengembalikan status instans orkestrasi tertentu.
func durable get-runtime-status --id <INSTANCE_ID>
func durable get-runtime-status Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connection-string-setting |
Nama pengaturan yang berisi string koneksi penyimpanan yang akan digunakan. |
--id |
ID instans orkestrasi. (Diperlukan) |
--show-input |
Saat diatur, respons menyertakan input fungsi. |
--show-output |
Saat diatur, respons menyertakan riwayat eksekusi. |
--task-hub-name |
Nama hub tugas Durable Functions untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable purge-history
Hapus menyeluruh status instans orkestrasi, riwayat, dan penyimpanan blob untuk orkestrasi yang lebih lama dari ambang yang ditentukan.
func durable purge-history
func durable purge-history Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connection-string-setting |
Nama pengaturan yang berisi string koneksi penyimpanan yang akan digunakan. |
--created-after |
Hapus riwayat instans yang dibuat setelah tanggal/waktu (UTC) ini. Semua nilai tanggalwaktu dalam format ISO 8601 diterima. |
--created-before |
Hapus riwayat instans yang dibuat sebelum tanggal/waktu (UTC) ini. Semua nilai tanggalwaktu dalam format ISO 8601 diterima. |
--runtime-status |
Hapus riwayat instans yang statusnya cocok dengan status tertentu, termasuk completed, , terminatedcanceled, dan failed. Berikan satu atau beberapa status yang dipisahkan spasi. Jika Anda tidak menyertakan --runtime-status, riwayat instans dihapus terlepas dari statusnya. |
--task-hub-name |
Nama hub tugas Durable Functions untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable raise-event
Mengangkat peristiwa ke instans orkestrasi yang ditentukan.
func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>
func durable raise-event Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connection-string-setting |
Nama pengaturan yang berisi string koneksi penyimpanan yang akan digunakan. |
--event-data |
Data yang akan diteruskan ke peristiwa, baik sebaris atau dari file JSON. Untuk file, awali jalur ke file dengan tanda (@), seperti @path/to/file.json. (Diperlukan) |
--event-name |
Nama acara yang akan dinaikkan. (Diperlukan) |
--id |
ID instans orkestrasi. (Diperlukan) |
--task-hub-name |
Nama hub tugas Durable Functions untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable rewind
Menggulung balik instans orkestrasi yang ditentukan.
func durable rewind --id <INSTANCE_ID> --reason <REASON>
func durable rewind Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connection-string-setting |
Nama pengaturan yang berisi string koneksi penyimpanan yang akan digunakan. |
--id |
ID instans orkestrasi. (Diperlukan) |
--reason |
Alasan untuk memundurkan orkestrasi. (Diperlukan) |
--task-hub-name |
Nama hub tugas Durable Functions untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable start-new
Memulai instans baru dari fungsi orkestrator yang ditentukan.
func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>
func durable start-new Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connection-string-setting |
Nama pengaturan yang berisi string koneksi penyimpanan yang akan digunakan. |
--function-name |
Nama fungsi orkestrator untuk memulai. (Diperlukan) |
--id |
Menentukan ID instans orkestrasi. (Diperlukan) |
--input |
Input ke fungsi orkestrator, baik sebaris atau dari file JSON. Untuk file, awali jalur ke file dengan ampersand (@), seperti @path/to/file.json. (Diperlukan) |
--task-hub-name |
Nama hub tugas Durable Functions untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func durable terminate
Mengakhiri instans orkestrasi yang ditentukan.
func durable terminate --id <INSTANCE_ID> --reason <REASON>
func durable terminate Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connection-string-setting |
Nama pengaturan yang berisi string koneksi penyimpanan yang akan digunakan. |
--id |
Menentukan ID instans orkestrasi. (Diperlukan) |
--reason |
Alasan untuk mengakhiri orkestrasi. (Diperlukan) |
--task-hub-name |
Nama hub tugas Durable Functions untuk digunakan. |
Untuk informasi selengkapnya, lihat dokumentasi Durable Functions.
func extensions install
Menginstal ekstensi Functions secara manual dalam proyek non-.NET atau proyek skrip C#.
func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>
func extensions install Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--configPath, -c |
Jalur direktori yang berisi file extensions.csproj. |
--csx |
Mendukung proyek skrip C# (.csx). |
--force, -f |
Memperbarui versi ekstensi yang ada. |
--output, -o |
Jalur output untuk ekstensi. |
--package, -p |
Pengidentifikasi untuk paket ekstensi tertentu. Jika tidak ditentukan, semua ekstensi yang dirujuk diinstal, seperti halnya func extensions sync. |
--source, -s |
Sumber umpan NuGet saat tidak menggunakan NuGet.org. |
--version, -v |
Versi paket ekstensi. |
Contoh berikut menginstal ekstensi Azure Event Hubs versi 5.0.1 di proyek lokal:
func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1
Pertimbangan ini berlaku saat menggunakan func extensions install:
Untuk proyek C# yang dikompilasi (baik dalam proses maupun proses pekerja terisolasi), gunakan metode penginstalan paket NuGet standar sebagai gantinya, seperti
dotnet add package.Untuk menginstal ekstensi secara manual dengan menggunakan Core Tools, Anda harus menginstal .NET SDK terinstal.
Jika memungkinkan, Anda harus menggunakan bundel ekstensi. Berikut adalah beberapa alasan mengapa Anda mungkin perlu menginstal ekstensi secara manual:
- Anda perlu mengakses versi ekstensi tertentu yang tidak tersedia dalam bundel.
- Anda perlu mengakses ekstensi kustom yang tidak tersedia dalam bundel.
- Anda perlu mengakses kombinasi ekstensi tertentu yang tidak tersedia dalam satu bundel.
Sebelum dapat menginstal ekstensi secara manual, Anda harus terlebih dahulu menghapus
extensionBundleobjek dari file host.json yang menentukan bundel. Tidak ada tindakan yang diambil ketika bundel ekstensi sudah diatur dalam file host.json Anda.Pertama kali Anda menginstal ekstensi secara eksplisit, file proyek .NET bernama extensions.csproj ditambahkan ke akar proyek aplikasi Anda. File ini mendefinisikan kumpulan paket NuGet yang diperlukan oleh fungsi Anda. Meskipun Anda dapat bekerja dengan referensi paket NuGet dalam file ini, Core Tools memungkinkan Anda menginstal ekstensi tanpa harus mengedit file proyek C# secara manual.
func extensions sync
Menginstal semua ekstensi yang diperlukan oleh aplikasi fungsi Anda.
func extensions sync Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--configPath, -c |
Jalur direktori yang berisi extensions.csproj file. |
--csx |
Mendukung proyek C# scripting (.csx). |
--output, -o |
Jalur output untuk ekstensi. |
Meregenerasi file yang hilang extensions.csproj . Tidak mengambil tindakan saat bundel ekstensi ditentukan dalam file Anda host.json .
func kubernetes deploy
Menyebarkan proyek Functions sebagai kontainer Docker kustom ke kluster Kubernetes.
func kubernetes deploy
Perintah ini membangun proyek Anda sebagai kontainer kustom dan menerbitkannya ke kluster Kubernetes. Kontainer kustom harus memiliki Dockerfile. Untuk membuat aplikasi dengan Dockerfile, gunakan --docker opsi dengan func init perintah .
func kubernetes deploy Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--dry-run |
Menampilkan templat penyebaran, tanpa eksekusi. |
--config-map-name |
Nama peta konfigurasi yang ada dengan pengaturan aplikasi fungsi untuk digunakan dalam penyebaran. Membutuhkan --use-config-map. Perilaku defaultnya adalah membuat pengaturan berdasarkan Values objek dalam file local.settings.json . |
--cooldown-period |
Periode cooldown (dalam detik) setelah semua pemicu tidak lagi aktif sebelum penyebaran menskalakan kembali ke nol, dengan default 300 dtk. |
--ignore-errors |
Lanjutkan penyebaran setelah sumber daya mengembalikan kesalahan. Perilaku default adalah berhenti saat kesalahan. |
--image-name |
Nama citra yang digunakan untuk penyebaran pod dan dari mana untuk membaca fungsi. |
--keda-version |
Atur versi KEDA untuk diinstal. Opsi yang valid adalah: v1 dan v2 (default). |
--keys-secret-name |
Nama koleksi Rahasia Kubernetes yang akan digunakan untuk menyimpan kunci akses. |
--max-replicas |
Atur jumlah replika maksimum yang diskalakan Horizontal Pod Autoscaler (HPA). |
--min-replicas |
Atur jumlah replika minimum di bawah HPA yang tidak akan diskalakan. |
--mount-funckeys-as-containervolume |
Pasang kunci akses sebagai volume kontainer. |
--name |
Nama yang digunakan untuk penyebaran dan artefak lainnya di Kubernetes. |
--namespace |
Atur namespace Layanan Kubernetes untuk disebarkan. Default ke namespace default. |
--no-docker |
Membaca fungsi dari direktori saat ini alih-alih dari gambar. Membutuhkan pemasangan filesystem citra. |
--registry |
Saat diatur, build Docker berjalan dan gambar didorong ke registri nama tersebut. Anda tidak dapat menggunakan --registry dengan --image-name. Untuk Docker, gunakan nama pengguna Anda. |
--polling-interval |
Interval polling (dalam hitungan detik) untuk memeriksa pemicu non-HTTP, dengan default 30dtk. |
--pull-secret |
Rahasia yang digunakan untuk mengakses info masuk registri privat. |
--secret-name |
Nama koleksi Rahasia Kubernetes yang ada yang memiliki pengaturan aplikasi fungsi untuk digunakan dalam penyebaran. Perilaku defaultnya adalah membuat pengaturan berdasarkan Values objek dalam file local.settings.json . |
--show-service-fqdn |
Tampilkan URL pemicu HTTP dengan Kubernetes FQDN alih-alih perilaku default menggunakan alamat IP. |
--service-type |
Atur jenis Layanan Kubernetes. Nilai yang didukung adalah ClusterIP, NodePort, dan LoadBalancer (default). |
--use-config-map |
Gunakan objek ConfigMap (v1) alih-alih objek Secret (v1) untuk mengonfigurasi pengaturan aplikasi fungsi. Nama pemetaan diatur menggunakan --config-map-name. |
--use-git-hash-version |
Gunakan hash Git sebagai versi untuk gambar kontainer. |
--write-configs |
Keluarkan konfigurasi Kubernetes sebagai file YAML alih-alih menyebarkan. |
--config-file |
Jalur file output saat menggunakan --write-configs. Default: functions.yaml. |
--hash-files |
File ke hash untuk menentukan versi gambar. |
--image-build |
Saat diatur ke false, lewati build Docker. |
--key-secret-annotations |
Anotasi untuk ditambahkan ke rahasia kunci, dalam key1=val1,key2=val2 format. |
Core Tools akan memanfaatkan CLI Docker lokal untuk membangun dan menerbitkan citra. Pastikan Docker sudah diinstal secara lokal. Jalankan perintah docker login untuk menyambungkan ke akun Anda.
Azure Functions mendukung hosting fungsi kontainer Anda baik di Azure Container Apps atau di Azure Functions. Azure Functions tidak secara resmi mendukung menjalankan kontainer Anda langsung di kluster Kubernetes atau di Azure Kubernetes Service (AKS). Untuk informasi selengkapnya, lihat dukungan kontainer Linux di Azure Functions.
func kubernetes delete
Menghapus penyebaran Functions dari kluster Kubernetes.
func kubernetes delete --name <APP_NAME>
func kubernetes delete Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--name |
Nama untuk penyebaran dan artefak lainnya di Kubernetes. (Diperlukan) |
--namespace |
Atur namespace Layanan Kubernetes. Default ke default namespace layanan. |
--registry |
Nama registri kontainer. |
--image-name |
Gambar yang digunakan untuk penyebaran pod. |
--keda-version |
Atur versi KEDA. Opsi yang valid adalah v1 dan v2 (default). |
func kubernetes install
Menginstal KEDA dalam kluster Kubernetes
func kubernetes install
Menginstal KEDA ke cluster yang didefinisikan dalam file konfigurasi kubectl.
func kubernetes install Perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--dry-run |
Menampilkan templat penyebaran tanpa eksekusi. |
--keda-version |
Mengatur versi KEDA untuk diinstal. Opsi yang valid adalah: v1 dan v2 (default). |
--namespace |
Menginstal ke namespace Layanan Kubernetes tertentu. Jika tidak ditentukan, namespace default digunakan. |
Untuk informasi selengkapnya, lihat Mengelola KEDA dan fungsi di Kubernetes.
func kubernetes remove
Menghapus KEDA dari kluster Kubernetes yang ditentukan dalam kubectl file konfigurasi.
func kubernetes remove
Menghapus KEDA dari kluster yang ditentukan dalam kubectl file konfigurasi.
Perintah func kubernetes remove mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--namespace |
Menghapus instalan dari namespace Layanan Kubernetes tertentu. Jika tidak ditentukan, namespace default digunakan. |
Untuk informasi selengkapnya, lihat Menghapus instalan KEDA dari Kubernetes.
func settings add
Menambahkan pengaturan baru ke kumpulan Values di file local.settings.json.
func settings add <SETTING_NAME> <VALUE>
Ganti <SETTING_NAME> dengan nama pengaturan aplikasi.
Perintah func settings add mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connectionString |
Menambahkan pasangan nama-nilai ke kumpulan ConnectionStrings alih-alih kumpulan Values.
ConnectionStrings Gunakan koleksi hanya ketika kerangka kerja tertentu memerlukannya. Untuk informasi selengkapnya, lihat filelocal.settings.json. |
func settings decrypt
Mendekripsi nilai terenkripsi dalam Values koleksi dalam file local.settings.json .
func settings decrypt
Perintah ini juga mendekripsi nilai string koneksi dalam koleksi ConnectionStrings. Dalam local.settings.json, perintah diatur IsEncrypted ke false. Enkripsi pengaturan lokal untuk mengurangi risiko mengekspos informasi sensitif dari local.settings.json. Dalam Azure, pengaturan aplikasi selalu disimpan dienkripsi.
func settings delete
Menghapus pengaturan yang sudah ada dari kumpulan Values di file local.settings.json.
func settings delete <SETTING_NAME>
Mengganti <SETTING_NAME> dengan nama pengaturan aplikasi dan <VALUE> dengan nilai pengaturan.
Perintah func settings delete mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--connectionString |
Menghapus pasangan nama-nilai dari ConnectionStrings koleksi alih-alih Values koleksi. |
func settings encrypt
Mengekripsi nilai item individu dalam kumpulan Values di file local.settings.json.
func settings encrypt
Perintah ini juga mengenkripsi nilai string koneksi dalam ConnectionStrings koleksi. Dalam local.settings.json, perintah diatur IsEncrypted ke true, yang menentukan bahwa runtime lokal mendekripsi pengaturan sebelum menggunakannya. Enkripsi pengaturan lokal untuk mengurangi risiko mengekspos informasi sensitif dari local.settings.json. Dalam Azure, pengaturan aplikasi selalu disimpan sebagai terenkripsi.
func settings list
Output daftar pengaturan dalam kumpulan Values di file local.settings.json.
func settings list
Output juga mencakup string koneksi dari ConnectionStrings koleksi. Secara default, perintah menutupi nilai untuk keamanan.
--showValue Gunakan opsi untuk menampilkan nilai aktual.
Perintah func settings list mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--showValue, -a |
Perlihatkan nilai yang tidak dimasak aktual dalam output. |
func templates list
Daftar templat fungsi (pemicu) yang tersedia.
Perintah func templates list mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--language, -l |
Bahasa untuk memfilter templat yang ditampilkan. Mengembalikan semua bahasa secara default. |
Opsi global
Sebagian besar perintah Alat Inti mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--script-root |
Mengatur direktori akar aplikasi fungsi dan mengubah direktori kerja untuk perintah . |
--verbose |
Mengaktifkan output verbose untuk pengelogan terperinci. Tidak semua perintah mendukung opsi ini. |
--offline |
Berjalan dalam mode offline, tanpa melakukan panggilan jaringan eksternal. Perintah func start, func init, dan func new mendukung opsi ini. Anda juga dapat mengaturnya melalui FUNCTIONS_CORE_TOOLS_OFFLINE variabel lingkungan. |
--version, -v |
Menampilkan versi Azure Functions Core Tools. |
--help, -h |
Menampilkan informasi bantuan. |
--pause-on-error |
Jeda untuk input tambahan sebelum keluar dari proses. Opsi ini berguna saat Anda meluncurkan Alat Inti dari lingkungan pengembangan terintegrasi (IDE). |
Sebagian besar perintah mendukung opsi ini:
| Opsi | Deskripsi |
|---|---|
--help, -h |
Tampilkan bantuan untuk perintah. |
--version |
Tampilkan versi CLI Azure Functions. Gunakan --verbose bersama untuk --version informasi build terperinci. |
--verbose |
Aktifkan keluaran yang lebih rinci. Menyebar ke semua subperintah. Saat diteruskan di root tanpa subperintah, mencetak informasi build, runtime, OS, dan arsitektur terperinci. |
Beban kerja yang tersedia
Jalankan func workload search untuk melihat katalog saat ini. Beban kerja berikut saat ini tersedia:
| Name | Deskripsi |
|---|---|
host |
Runtime host Azure Functions yang digunakan oleh func run. |
bundles |
Instal bundel ekstensi, yang mengaktifkan semua ekstensi pengikatan. Gunakan beban kerja ini untuk tumpukan non-.NET apa pun. Proyek .NET tidak menggunakan beban kerja ini. Sebagai gantinya, mereka mereferensikan ekstensi secara langsung dalam proyek mereka. |
dotnet |
Alat CLI Azure Functions untuk proyek .NET (C#, F#). Juga menyumbangkan templat untuk func quickstart. .NET tidak memerlukan beban kerja pekerja terpisah, karena pekerja adalah bagian dari proyek yang dikompilasi itu sendiri. |
dotnet-templates |
Templat perancah fungsi untuk proyek pekerja terisolasi .NET. |
python |
Alat Azure Functions CLI untuk proyek Python. Juga menyumbangkan templat untuk func quickstart. |
python-worker |
Pekerja bahasa Python yang digunakan oleh host Functions. |
python-templates |
Templat perancah fungsi untuk Python (model pemrograman v1 dan v2). |
node |
Azure Functions Alat CLI untuk proyek Node.js (JavaScript, TypeScript). Juga menyumbangkan templat untuk func quickstart. |
node-worker |
Pekerja bahasa Node.js yang digunakan oleh host Functions. |
node-templates |
Templat perancah fungsi untuk Node.js (JavaScript, TypeScript). |
go |
Alat Azure Functions CLI untuk proyek Go. Juga menyumbangkan templat untuk func quickstart. |
go-worker |
Pekerja bahasa Go yang digunakan oleh host Functions. |
Catatan
Tidak semua tumpukan bahasa Functions saat ini tersedia sebagai beban kerja. Tumpukan Java dan PowerShell saat ini tidak didukung di CLI Azure Functions.