Azure Functions Core Tools 參考
本文提供 Azure Functions Core Tools 的參考檔,可讓您從本機電腦開發、管理及部署 Azure Functions 專案。 若要深入瞭解如何使用 Core Tools,請參閱 使用 Azure Functions Core Tools。
核心工具命令會組織成下列內容,每個命令都會提供一組唯一的動作。
命令內容 | 描述 |
---|---|
func |
用來在本機電腦上建立和執行函式的命令。 |
func azure |
使用 Azure 資源的命令,包括發佈。 |
func azurecontainerapps |
將容器化函式應用程式部署至 Azure Container Apps。 |
func durable |
使用 Durable Functions 的命令。 |
func extensions |
安裝和管理延伸模組的命令。 |
func kubernetes |
使用 Kubernetes 和 Azure Functions 的命令。 |
func settings |
用於管理本機 Functions 主機環境設定的命令。 |
func templates |
列出可用函式範本的命令。 |
使用本文中的命令之前,您必須先 安裝 Core Tools。
func init
以特定語言建立新的 Functions 專案。
func init <PROJECT_FOLDER>
當您提供 <PROJECT_FOLDER>
時,專案會在具有此名稱的新資料夾中建立。 否則會使用目前的資料夾。
func init
支援下列選項,除非另有說明,否則不支援 1.x 版:
選項 | 描述 |
---|---|
--csx |
建立 .NET 函式作為 C# 腳本,這是 1.x 版的行為。 只對 --worker-runtime dotnet 有效。 |
--docker |
使用以所選 --worker-runtime 為基礎的基底映射,為容器建立 Dockerfile。 當您打算部署容器化函式應用程式時,請使用此選項。 |
--docker-only |
將 Dockerfile 新增至現有的專案。 如果未在 local.settings.json中指定或設定,則會提示背景工作運行時間。 當您打算部署容器化函式應用程式和專案已經存在時,請使用此選項。 |
--force |
即使專案中有現有的檔案,也初始化專案。 此設定會覆寫具有相同名稱的現有檔案。 項目資料夾中的其他檔案不會受到影響。 |
--language |
初始化語言特定的專案。 目前支援設定為 node 時--worker-runtime 。 選項為 typescript 和 javascript 。 您也可以使用 --worker-runtime javascript 或 --worker-runtime typescript 。 |
--managed-dependencies |
安裝受控相依性。 目前只有PowerShell背景工作角色運行時間支援這項功能。 |
--model |
當有多個模型可用時,設定目標語言所需的程序設計模型。 支援的選項為 V1 Python V2 和 , V3 以及 V4 適用於 Node.js。 如需詳細資訊,請參閱 Python 開發人員指南 和 Node.js開發人員指南。 |
--source-control |
控制是否已建立 Git 存放庫。 根據預設,不會建立存放庫。 在 時 true ,會建立存放庫。 |
--worker-runtime |
設定項目的語言運行時間。 支援的值為:csharp 、、dotnet 、javascript dotnet-isolated 、 powershell node python 、 和 。typescript 針對 Java,請使用 Maven。 若要只使用項目檔來產生語言無關的專案,請使用 custom 。 未設定時,系統會提示您在初始化期間選擇您的運行時間。 |
--target-framework |
設定函式應用程式項目的目標架構。 只對 --worker-runtime dotnet-isolated 有效。 支援的值為: net6.0 (預設值)、 net7.0 、 net8.0 、 和 net48 (.NET Framework 4.8)。 |
注意
當您使用 --docker
或 --docker-only
選項時,Core Tools 會自動建立適用於 C#、JavaScript、Python 和 PowerShell 函式的 Dockerfile。 針對 Java 函式,您必須手動建立 Dockerfile。 如需詳細資訊,請參閱建立容器化函式應用程式。
func 記錄
取得 Kubernetes 叢集中執行的函式記錄。
func logs --platform kubernetes --name <APP_NAME>
動作 func logs
支援下列選項:
選項 | 描述 |
---|---|
--platform |
函式應用程式的裝載平臺。 支援的選項: kubernetes 。 |
--name |
Azure 中的函式應用程式名稱。 |
若要深入瞭解,請參閱 Kubernetes 上的 Azure Functions 與 KEDA。
func new
根據範本,在目前專案中建立新的函式。
func new
當您在沒有使用 --template
選項的情況下執行 func new
時,系統會提示您選擇範本。 在 1.x 版中,您也必須選擇語言。
動作 func new
支援下列選項:
選項 | 描述 |
---|---|
--authlevel |
可讓您設定 HTTP 觸發程式的授權層級。 支援的值包括:function 、、anonymous admin 。 在本機執行時,不會強制執行授權。 如需詳細資訊,請參閱授權層級。 |
--csx |
(版本 2.x 和更新版本。)產生 1.x 版和入口網站中使用的相同 C# 文稿 (.csx) 範本。 |
--language , -l |
範本程式設計語言,例如 C#、F#或 JavaScript。 1.x 版中需要此選項。 在 2.x 版和更新版本中,您不會使用此選項,因為背景工作運行時間定義了語言。 |
--name , -n |
函式名稱。 |
--template , -t |
func templates list 使用 命令來查看每個支援語言可用範本的完整清單。 |
若要深入瞭解,請參閱 建立函式。
func run
僅限 1.x 版。
可讓您直接叫用函式,這類似於使用 Azure 入口網站 中的 [測試] 索引標籤來執行函式。 只有 1.x 版才支援此動作。 針對更新版本,請直接使用 func start
和呼叫函式端點。
func run
動作 func run
支援下列選項:
選項 | 描述 |
---|---|
--content |
傳遞至函式的內嵌內容。 |
--debug |
在執行函式之前,先將調試程式附加至主機進程。 |
--file |
要當做內容的檔名。 |
--no-interactive |
不會提示輸入,這適用於自動化案例。 |
--timeout |
等候時間(以秒為單位),直到本機 Functions 主機就緒為止。 |
例如,若要呼叫 HTTP 觸發函式並傳遞內容本文,請執行下列命令:
func run MyHttpTrigger --content '{\"name\": \"Azure\"}'
func start
啟動本機運行時間主機,並在目前資料夾中載入函式專案。
特定命令取決於 運行時間版本。
func start
func start
支援下列選項:
選項 | 描述 |
---|---|
--cert |
包含私鑰的 .pfx 檔案路徑。 只支援 --useHttps 。 |
--cors |
CORS 來源的逗號分隔清單,不含空格。 |
--cors-credentials |
允許使用 Cookie 和驗證標頭的跨原始來源驗證要求。 |
--dotnet-isolated-debug |
設定為 true 時,會暫停 .NET 背景工作進程,直到調試程式從偵錯的 .NET 隔離專案附加為止。 |
--enable-json-output |
盡可能發出主控台記錄作為 JSON。 |
--enableAuth |
啟用具有授權需求的完整驗證處理管線。 |
--functions |
要載入的函式以空格分隔的清單。 |
--language-worker |
設定語言背景工作角色的自變數。 例如,您可以藉由提供 偵錯埠和其他必要自變數,來啟用語言背景工作角色的偵錯。 |
--no-build |
在執行之前,請勿建置目前的專案。 僅適用於 .NET 類別專案。 預設值為 false 。 |
--password |
密碼或包含 .pfx 檔案密碼的檔案。 僅搭配 --cert 使用。 |
--port |
要接聽的本機埠。 預設值:7071。 |
--timeout |
Functions 主機啟動的逾時,以秒為單位。 預設值:20 秒。 |
--useHttps |
繫結至 https://localhost:{port} ,而不是系結至 http://localhost:{port} 。 根據預設,此選項會在您的計算機上建立受信任的憑證。 |
執行專案后,您可以 驗證個別函式端點。
func azure functionapp fetch-app-settings
從特定函式應用程式取得設定。
func azure functionapp fetch-app-settings <APP_NAME>
func azure functionapp fetch-app-settings
支援這些選擇性自變數:
選項 | 描述 |
---|---|
--access-token |
可讓您在執行已驗證 azure 的動作時使用特定的存取令牌。 |
--access-token-stdin |
從標準輸入讀取特定存取令牌。 直接從上一個命令 az account get-access-token 讀取令牌時,請使用此選項。 |
--management-url |
設定雲端的管理 URL。 在主權雲端中執行時,請使用此選項。 |
--slot |
要發佈之特定位置的選擇性名稱。 |
--subscription |
設定要使用的預設訂用帳戶。 |
如需詳細資訊,請參閱下載應用程式設定。
設定會下載至專案的local.settings.json檔案。 螢幕值會針對安全性遮罩。 您可以啟用 本機加密來保護local.settings.json檔案中的設定。
func azure functionapp list-functions
傳回指定函式應用程式中的函式清單。
func azure functionapp list-functions <APP_NAME>
func azure functionapp list-functions
支援這些選擇性自變數:
選項 | 描述 |
---|---|
--access-token |
可讓您在執行已驗證 azure 的動作時使用特定的存取令牌。 |
--access-token-stdin |
從標準輸入讀取特定存取令牌。 直接從上一個命令 az account get-access-token 讀取令牌時,請使用此選項。 |
--management-url |
設定雲端的管理 URL。 在主權雲端中執行時,請使用此選項。 |
--show-keys |
顯示包含其預設存取金鑰的 HTTP 函式端點 URL。 這些 URL 可用來存取具有 function 層級 HTTP 驗證的函式端點。 |
--slot |
要發佈之特定位置的選擇性名稱。 |
--subscription |
設定要使用的預設訂用帳戶。 |
func azure functionapp logstream
將本機命令提示字元連線至 Azure 中函式應用程式的串流記錄。
func azure functionapp logstream <APP_NAME>
線上的預設逾時為2小時。 您可以新增名為 SCM_LOGSTREAM_TIMEOUT 的應用程式設定,並以秒為單位的逾時值來變更逾時。 尚未支援取用方案中的Linux應用程式。 針對這些應用程式,請使用 --browser
選項來檢視入口網站中的記錄。
這個指令 func azure functionapp logstream
支援這些選擇性自變數:
選項 | 描述 |
---|---|
--access-token |
可讓您在執行已驗證 azure 的動作時使用特定的存取令牌。 |
--access-token-stdin |
從標準輸入讀取特定存取令牌。 直接從上一個命令 az account get-access-token 讀取令牌時,請使用此選項。 |
--browser |
在預設瀏覽器中開啟函式應用程式的 Azure 應用程式 Insights 實時數據流。 |
--management-url |
設定雲端的管理 URL。 在主權雲端中執行時,請使用此選項。 |
--slot |
要發佈之特定位置的選擇性名稱。 |
--subscription |
設定要使用的預設訂用帳戶。 |
如需詳細資訊,請參閱在 Azure Functions 中啟用串流執行記錄。
func azure functionapp publish
將 Functions 專案部署至 Azure 中的現有函式應用程式資源。
func azure functionapp publish <APP_NAME>
如需詳細資訊,請參閱部署專案檔。
下列發佈選項會根據版本套用:
選項 | 描述 |
---|---|
--access-token |
可讓您在執行已驗證 azure 的動作時使用特定的存取令牌。 |
--access-token-stdin |
從標準輸入讀取特定存取令牌。 直接從上一個命令 az account get-access-token 讀取令牌時,請使用此選項。 |
--additional-packages |
建置原生相依性時要安裝的套件清單。 例如: python3-dev libevent-dev 。 |
--build , -b |
部署至Linux函式應用程式時,執行建置動作。 接受: remote 與 local 。 |
--build-native-deps |
發佈 Python 函式應用程式時, .wheels 會略過產生資料夾。 |
--csx |
發佈 C# 文稿 (.csx) 專案。 |
--dotnet-cli-params |
發行編譯的 C# (.csproj) 函式時,核心工具會呼叫 dotnet build --output bin/publish 。 傳遞至此的任何參數會附加至命令行。 |
--force |
在特定案例中忽略預先發佈驗證。 |
--list-ignored-files |
顯示發佈期間忽略的檔案清單,此列表是以檔案為基礎 .funcignore 。 |
--list-included-files |
顯示以檔案為基礎的 .funcignore 已發佈檔案清單。 |
--management-url |
設定雲端的管理 URL。 在主權雲端中執行時,請使用此選項。 |
--no-build |
專案不會在發佈期間建置。 若為 Python, pip install 則不會執行。 |
--nozip |
關閉預設 Run-From-Package 模式。 |
--overwrite-settings -y |
使用時 --publish-local-settings -i 隱藏覆寫應用程式設定的提示。 |
--publish-local-settings -i |
將 local.settings.json 中的設定發佈至 Azure,如果設定已經存在,則會提示覆寫。 如果您使用 本機記憶體模擬器,請先將應用程式設定變更為 實際的記憶體連線。 |
--publish-settings-only , -o |
只發佈設定並略過內容。 預設值為提示。 |
--show-keys |
顯示包含其預設存取金鑰的 HTTP 函式端點 URL。 這些 URL 可用來存取具有 function 層級 HTTP 驗證的函式端點。 |
--slot |
要發佈之特定位置的選擇性名稱。 |
--subscription |
設定要使用的預設訂用帳戶。 |
func azure 記憶體 fetch-connection-string
取得指定之 Azure 儲存體 帳戶的 連接字串。
func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
如需詳細資訊,請參閱下載記憶體 連接字串。
func azurecontainerapps deploy
將容器化函式應用程式部署至 Azure Container Apps 環境。 函式應用程式和環境所使用的記憶體帳戶都必須已經存在。 如需詳細資訊,請參閱 Azure Functions 的 Azure 容器應用程式裝載。
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>
下列部署選項適用:
選項 | 描述 |
---|---|
--access-token |
可讓您在執行已驗證 azure 的動作時使用特定的存取令牌。 |
--access-token-stdin |
從標準輸入讀取特定存取令牌。 直接從上一個命令 az account get-access-token 讀取令牌時,請使用此選項。 |
--environment |
現有 Container Apps 環境的名稱。 |
--image-build |
當設定為 true 時,會略過本機 Docker 組建。 |
--image-name |
容器登錄中現有容器的映像名稱。 映射名稱包含標籤名稱。 |
--location |
部署的區域。 在理想情況下,這與環境和記憶體帳戶資源相同。 |
--management-url |
設定雲端的管理 URL。 在主權雲端中執行時,請使用此專案。 |
--name |
用於 Container Apps 環境中函式應用程式部署的名稱。 在入口網站中管理函式應用程式時,也會使用這個相同名稱。 名稱在環境中應該是唯一的。 |
--registry |
設定時,會執行 Docker 組建,並將映像推送至 中的 --registry 登錄集。 您無法將 --registry 與 --image-name 搭配使用。 針對 Docker Hub,也使用 --registry-username 。 |
--registry-password |
用來從私人登錄擷取映像的密碼或令牌。 |
--registry-username |
用來從私人登錄擷取映像的用戶名稱。 |
--resource-group |
要在其中建立函式相關資源的資源群組。 |
--storage-account |
函式應用程式要使用的記憶體帳戶 連接字串。 |
--subscription |
設定要使用的預設訂用帳戶。 |
--worker-runtime |
設定函式應用程式的運行時間語言。 此參數只會與 和--image-build 搭配--image-name 使用,否則會在本機組建期間決定語言。 支援的值包括:dotnet 、、、dotnetIsolated 、node python 、 powershell 和 custom (適用於客戶處理程式)。 |
重要
儲存體連接字串和其他服務認證是重要的秘密。 請務必使用 func azurecontainerapps deploy
安全地儲存任何腳本檔案,而且不會將它們儲存在任何可公開存取的原始檔控制中。
func deploy
func deploy
命令已被取代。 請改用 func kubernetes deploy
。
func durable delete-task-hub
刪除 Durable Functions 工作中樞中的所有記憶體成品。
func durable delete-task-hub
動作 delete-task-hub
支援下列選項:
選項 | 描述 |
---|---|
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--task-hub-name |
要使用的長期工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func durable get-history
傳回指定協調流程實例的歷程記錄。
func durable get-history --id <INSTANCE_ID>
動作 get-history
支援下列選項:
選項 | 描述 |
---|---|
--id |
指定協調流程實例的標識碼(必要)。 |
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--task-hub-name |
要使用的長期工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func durable get-instances
傳回所有協調流程實例的狀態。 支援使用 參數進行 top
分頁。
func durable get-instances
動作 get-instances
支援下列選項:
選項 | 描述 |
---|---|
--continuation-token |
選擇性令牌,表示要傳回之要求的特定頁面/區段。 |
--connection-string-setting |
包含要使用的記憶體 連接字串 之應用程式設定的選擇性名稱。 |
--created-after |
或者,取得在此日期/時間 (UTC) 之後建立的實例。 接受所有 ISO 8601 格式化的日期時間。 |
--created-before |
或者,取得在特定日期/時間 (UTC) 之前建立的實例。 接受所有 ISO 8601 格式化的日期時間。 |
--runtime-status |
或者,取得狀態符合特定狀態的實例,包括 running 、 completed 和 failed 。 您可以提供一或多個空間分隔的雕像。 |
--top |
選擇性地限制指定要求中傳回的記錄數目。 |
--task-hub-name |
要使用的 Durable Functions 工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func durable get-runtime-status
傳回指定協調流程實例的狀態。
func durable get-runtime-status --id <INSTANCE_ID>
動作 get-runtime-status
支援下列選項:
選項 | 描述 |
---|---|
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--id |
指定協調流程實例的標識碼(必要)。 |
--show-input |
設定時,回應會包含函式的輸入。 |
--show-output |
設定時,回應會包含執行歷程記錄。 |
--task-hub-name |
要使用的 Durable Functions 工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func durable purge-history
清除超過指定閾值之協調流程的協調流程實例狀態、歷程記錄和 Blob 記憶體。
func durable purge-history
動作 purge-history
支援下列選項:
選項 | 描述 |
---|---|
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--created-after |
選擇性地刪除在此日期/時間 (UTC) 之後建立的實例歷程記錄。 所有 ISO 8601 格式化的日期時間值都會接受。 |
--created-before |
選擇性地刪除在此日期/時間 (UTC) 之前建立的實例歷程記錄。 所有 ISO 8601 格式化的日期時間值都會接受。 |
--runtime-status |
選擇性地移除狀態符合特定狀態的實體歷程記錄,包括 completd 、 terminated 、 canceled 和 failed 。 您可以提供一或多個空間分隔的雕像。 如果您沒有包含 --runtime-status ,則不論狀態為何,都會刪除實例歷程記錄。 |
--task-hub-name |
要使用的 Durable Functions 工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func durable raise-event
將事件引發至指定的協調流程實例。
func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>
動作 raise-event
支援下列選項:
選項 | 描述 |
---|---|
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--event-data |
要傳遞至事件的數據,無論是內嵌還是來自 JSON 檔案(必要)。 對於檔案,請在檔案的路徑前面加上 ampersand (@ ),例如 @path/to/file.json 。 |
--event-name |
要引發的事件名稱(必要)。 |
--id |
指定協調流程實例的標識碼(必要)。 |
--task-hub-name |
要使用的 Durable Functions 工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func 耐久倒轉
倒轉指定的協調流程實例。
func durable rewind --id <INSTANCE_ID> --reason <REASON>
動作 rewind
支援下列選項:
選項 | 描述 |
---|---|
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--id |
指定協調流程實例的標識碼(必要)。 |
--reason |
倒轉協調流程的原因(必要)。 |
--task-hub-name |
要使用的 Durable Functions 工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func durable start-new
啟動指定協調器函式的新實例。
func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>
動作 start-new
支援下列選項:
選項 | 描述 |
---|---|
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--function-name |
要啟動的協調器函式名稱(必要)。 |
--id |
指定協調流程實例的標識碼(必要)。 |
--input |
內嵌或來自 JSON 檔案的協調器函式輸入(必要)。 對於檔案,請在檔案的路徑前面加上 ampersand (@ ),例如 @path/to/file.json 。 |
--task-hub-name |
要使用的 Durable Functions 工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func 耐久終止
停止指定的協調流程實例。
func durable terminate --id <INSTANCE_ID> --reason <REASON>
動作 terminate
支援下列選項:
選項 | 描述 |
---|---|
--connection-string-setting |
包含要使用的記憶體 連接字串 之設定的選擇性名稱。 |
--id |
指定協調流程實例的標識碼(必要)。 |
--reason |
停止協調流程的原因(必要)。 |
--task-hub-name |
要使用的 Durable Functions 工作中樞選擇性名稱。 |
若要深入瞭解,請參閱 Durable Functions 檔。
func 擴充功能安裝
在 non-.NET 專案或 C# 腳本專案中手動安裝 Functions 擴充功能。
func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>
動作 install
支援下列選項:
選項 | 描述 |
---|---|
--configPath |
包含 extensions.csproj 檔案之目錄的路徑。 |
--csx |
支援 C# 文稿 (.csx) 專案。 |
--force |
更新現有延伸模組的版本。 |
--output |
延伸模組的輸出路徑。 |
--package |
特定擴充套件的標識碼。 若未指定,則會安裝所有參考的延伸模組,如同 。func extensions sync |
--source |
不使用 NuGet.org 時,NuGet 摘要來源。 |
--version |
延伸模組套件版本。 |
下列範例會在本機專案中安裝事件中樞擴充功能 5.0.1 版:
func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1
使用 func extensions install
時適用下列考慮:
針對編譯的 C# 專案(同進程和隔離的背景工作進程),請改用標準 NuGet 套件安裝方法,例如
dotnet add package
。若要使用 Core Tools 手動安裝擴充功能,您必須 安裝 .NET 6.0 SDK 。
可能的話,您應該改用 延伸模組套件組合。 以下是您可能需要手動安裝延伸模組的一些原因:
- 您必須存取套件組合中無法使用的特定延伸模組版本。
- 您必須存取套件組合中無法使用的自訂延伸模組。
- 您必須存取單一套件組合中無法使用的特定延伸模組組合。
您必須先從定義套件組合的host.json檔案中移除
extensionBundle
物件,才能手動安裝延伸模組。 當您的 host.json 檔案中已設定擴充套件組合時,不會採取任何動作。第一次明確安裝擴展名時,名為 extensions.csproj 的 .NET 專案檔會新增至應用程式專案的根目錄。 此檔案會定義函式所需的一組 NuGet 套件。 雖然您可以使用 此檔案中的 NuGet 套件參考 ,但 Core Tools 可讓您安裝延伸模組,而不需要手動編輯此 C# 項目檔。
func 擴充功能同步處理
安裝新增至函式應用程式的所有延伸模組。
動作 sync
支援下列選項:
選項 | 描述 |
---|---|
--configPath |
包含 extensions.csproj 檔案之目錄的路徑。 |
--csx |
支援 C# 文稿 (.csx) 專案。 |
--output |
延伸模組的輸出路徑。 |
重新產生遺漏的 extensions.csproj 檔案。 當您的host.json檔案中定義擴充功能套件組合時,不會採取任何動作。
func kubernetes 部署
將 Functions 專案部署為自訂 Docker 容器至 Kubernetes 叢集。
func kubernetes deploy
此命令會將專案建置為自定義容器,並將其發佈至 Kubernetes 叢集。 自定義容器必須具有 Dockerfile。 若要使用 Dockerfile 建立應用程式,請使用 --dockerfile
選項搭配 func init
命令。
以下是可用的 Kubernetes 部署選項:
選項 | 描述 |
---|---|
--dry-run |
選擇性地顯示部署範本,而不需執行。 |
--config-map-name |
現有組態對應的選擇性名稱,以及 要用於部署的函式應用程式設定 。 需要 --use-config-map 。 默認行為是根據 local.settings.json 檔案中的 物件來建立設定Values 。 |
--cooldown-period |
在部署縮減為零之前,所有觸發程式都不再作用中的冷卻期間(以秒為單位),預設值為300秒。 |
--ignore-errors |
在資源傳回錯誤之後繼續部署。 預設行為是在發生錯誤時停止。 |
--image-name |
要用於 Pod 部署的映像名稱,以及要從中讀取函式的映像名稱。 |
--keda-version |
設定要安裝的 KEDA 版本。 有效的選項為: v1 和 v2 (預設值)。 |
--keys-secret-name |
用來儲存 存取金鑰的 Kubernetes 秘密集合名稱。 |
--max-replicas |
設定水準 Pod 自動調整程式 (HPA) 調整至的複本計數上限。 |
--min-replicas |
設定 HPA 不會調整的最小復本計數。 |
--mount-funckeys-as-containervolume |
將 存取金鑰 掛接為容器磁碟區。 |
--name |
用於 Kubernetes 中部署和其他成品的名稱。 |
--namespace |
設定要部署的 Kubernetes 命名空間,其預設為預設命名空間。 |
--no-docker |
函式會從目前目錄讀取,而不是從映像讀取。 需要掛接映像檔系統。 |
--registry |
設定時,會執行 Docker 組建,並將映像推送至該名稱的登錄。 您無法將 --registry 與 --image-name 搭配使用。 針對 Docker,請使用您的使用者名稱。 |
--polling-interval |
檢查非 HTTP 觸發程式的輪詢間隔(以秒為單位),預設值為 30 秒。 |
--pull-secret |
用來存取私人登錄認證的秘密。 |
--secret-name |
現有 Kubernetes 秘密集合的名稱,其中包含 要用於部署的函式應用程式設定 。 默認行為是根據 local.settings.json 檔案中的 物件來建立設定Values 。 |
--show-service-fqdn |
使用 Kubernetes FQDN 來顯示 HTTP 觸發程式的 URL,而不是使用 IP 位址的預設行為。 |
--service-type |
設定 Kubernetes Service 的類型。 支援的值為: ClusterIP 、 NodePort 和 LoadBalancer (預設值)。 |
--use-config-map |
ConfigMap 使用物件 (v1) 而不是 Secret 物件 (v1) 來設定函式應用程式設定。 對應名稱是使用 --config-map-name 來設定。 |
核心工具會使用本機 Docker CLI 來建置和發佈映射。 請確定您的 Docker 已在本機安裝。 docker login
執行 命令以連線到您的帳戶。
若要深入了解,請參閱將函數應用程式部署至 Kubernetes。
func kubernetes 安裝
在 Kubernetes 叢集中安裝 KEDA。
func kubernetes install
將 KEDA 安裝至 kubectl 組態檔中定義的叢集。
動作 install
支援下列選項:
選項 | 描述 |
---|---|
--dry-run |
顯示部署範本,而不執行。 |
--keda-version |
設定要安裝的 KEDA 版本。 有效的選項為: v1 和 v2 (預設值)。 |
--namespace |
支援安裝至特定的 Kubernetes 命名空間。 如果未設定,則會使用預設命名空間。 |
若要深入瞭解,請參閱 在 Kubernetes 中管理 KEDA 和函式。
func kubernetes remove
從 kubectl 組態檔中定義的 Kubernetes 叢集移除 KEDA。
func kubernetes remove
從 kubectl 組態檔中定義的叢集移除 KEDA。
動作 remove
支援下列選項:
選項 | 描述 |
---|---|
--namespace |
支援從特定的 Kubernetes 命名空間卸載。 如果未設定,則會使用預設命名空間。 |
若要深入瞭解,請參閱 從 Kubernetes 卸載 KEDA。
func 設定新增
將新的設定新增至Values
local.settings.json檔案中的集合。
func settings add <SETTING_NAME> <VALUE>
將 取代為應用程式設定的名稱,並將 <VALUE>
取代<SETTING_NAME>
為設定的值。
動作 add
支援下列選項:
選項 | 描述 |
---|---|
--connectionString |
將名稱/值組新增至集合,ConnectionStrings Values 而不是集合。 只有在特定架構需要時才使用 ConnectionStrings 集合。 若要深入瞭解,請參閱 local.settings.json檔案。 |
func 設定解密
解密先前在local.settings.json檔案中集合中Values
加密的值。
func settings decrypt
集合中的 ConnectionStrings
連接字串值也會解密。 在 local.settings.json 中, IsEncrypted
也會設定為 false
。 加密本機設定,以減少從local.settings.json洩漏重要信息的風險。 Azure 中的應用程式設定一律會以加密方式儲存。
func 設定刪除
從Values
local.settings.json檔案中的集合中移除現有的設定。
func settings delete <SETTING_NAME>
將 取代為應用程式設定的名稱,並將 <VALUE>
取代<SETTING_NAME>
為設定的值。
動作 delete
支援下列選項:
選項 | 描述 |
---|---|
--connectionString |
從 ConnectionStrings 集合中移除名稱/值組,而不是從集合中移除 Values 。 |
func 設定加密
加密local.settings.json檔案中集合中Values
個別專案的值。
func settings encrypt
集合中的 ConnectionStrings
連接字串值也會加密。 在 local.settings.json 中, IsEncrypted
也會設定為 true
,這會指定本機運行時間先解密設定,再使用這些設定。 加密本機設定,以減少從local.settings.json洩漏重要信息的風險。 Azure 中的應用程式設定一律會以加密方式儲存。
func 設定清單
輸出local.settings.json檔案中Values
集合中的設定清單。
func settings list
集合中的 ConnectionStrings
連接字串也會輸出。 根據預設,會針對安全性遮罩值。 您可以使用 --showValue
選項來顯示實際值。
動作 list
支援下列選項:
選項 | 描述 |
---|---|
--showValue |
顯示輸出中實際未遮罩的值。 |
func 範本清單
列出可用的函式(觸發程式)範本。
動作 list
支援下列選項:
選項 | 描述 |
---|---|
--language |
要篩選傳回範本的語言。 預設值為傳回所有語言。 |