az functionapp

注意

此命令群組具有 Azure CLI 和至少一個擴充功能中定義的命令。 安裝每個擴充功能以受益於其擴充功能。 深入了解擴充功能。

管理函式應用程式。 若要安裝 Azure Functions Core 工具,請參閱 https://github.com/Azure/azure-functions-core-tools

命令

名稱 Description 類型 狀態
az functionapp app

管理 Azure Functions 應用程式的命令。

副檔名 預覽
az functionapp app up

透過 GitHub 動作部署至 Azure Functions。

副檔名 預覽
az functionapp config

設定函式應用程式。

核心和擴充功能 GA
az functionapp config access-restriction

顯示、設定、新增和移除 functionapp 存取限制的方法。

核心 GA
az functionapp config access-restriction add

將存取限制新增至函式應用程式。

核心 GA
az functionapp config access-restriction remove

從 functionapp 移除存取限制。

核心 GA
az functionapp config access-restriction set

設定 SCM 網站是否使用與主要月臺相同的限制。

核心 GA
az functionapp config access-restriction show

顯示 functionapp 的存取限制設定。

核心 GA
az functionapp config appsettings

設定函式應用程式設定。

核心 GA
az functionapp config appsettings delete

刪除函式應用程式的設定。

核心 GA
az functionapp config appsettings list

顯示函式應用程式的設定。

核心 GA
az functionapp config appsettings set

更新函式應用程式的設定。

核心 GA
az functionapp config container

管理現有函式應用程式的容器設定。

核心和擴充功能 GA
az functionapp config container delete

刪除現有函式應用程式的容器設定。

核心 GA
az functionapp config container set

設定現有的函式應用程式的容器設定。

核心 GA
az functionapp config container set (appservice-kube 擴充功能)

設定現有的函式應用程式的容器設定。

副檔名 GA
az functionapp config container show

取得函式應用程式容器設定的詳細數據。

核心 GA
az functionapp config hostname

設定函式應用程式的主機名。

核心 GA
az functionapp config hostname add

將主機名系結至函式應用程式。

核心 GA
az functionapp config hostname delete

從函式應用程式解除系結主機名。

核心 GA
az functionapp config hostname get-external-ip

取得函式應用程式的對外IP位址。

核心 GA
az functionapp config hostname list

列出函式應用程式的所有主機名系結。

核心 GA
az functionapp config set

設定現有的函式應用程式的組態。

核心 GA
az functionapp config show

取得現有函式應用程式設定的詳細數據。

核心 GA
az functionapp config ssl

設定 SSL 憑證。

核心 GA
az functionapp config ssl bind

將 SSL 憑證系結至函式應用程式。

核心 GA
az functionapp config ssl create

在函式應用程式中建立主機名的受控憑證。

核心 預覽
az functionapp config ssl delete

從函式應用程式刪除 SSL 憑證。

核心 GA
az functionapp config ssl import

從 金鑰保存庫 將 SSL 憑證匯入函式應用程式。

核心 GA
az functionapp config ssl list

列出函式應用程式的SSL憑證。

核心 GA
az functionapp config ssl show

顯示函式應用程式的 SSL 憑證詳細數據。

核心 GA
az functionapp config ssl unbind

從函式應用程式解除系結 SSL 憑證。

核心 GA
az functionapp config ssl upload

將 SSL 憑證上傳至函式應用程式。

核心 GA
az functionapp connection

管理 functionapp 連線的命令。

核心和擴充功能 GA
az functionapp connection create

建立 functionapp 與目標資源之間的連線。

核心和擴充功能 GA
az functionapp connection create app-insights

建立與 app-insights 的 functionapp 連線。

核心 GA
az functionapp connection create appconfig

建立與 appconfig 的 functionapp 連線。

核心 GA
az functionapp connection create confluent-cloud

建立 confluent-cloud 的 functionapp 連線。

核心 GA
az functionapp connection create cosmos-cassandra

建立 cosmos-cassandra 的 functionapp 連線。

核心 GA
az functionapp connection create cosmos-gremlin

建立 cosmos-gremlin 的 functionapp 連線。

核心 GA
az functionapp connection create cosmos-mongo

建立 cosmos-mongo 的 functionapp 連線。

核心 GA
az functionapp connection create cosmos-sql

建立 cosmos-sql 的 functionapp 連線。

核心 GA
az functionapp connection create cosmos-table

建立 cosmos-table 的 functionapp 連線。

核心 GA
az functionapp connection create eventhub

建立 eventhub 的 functionapp 連線。

核心 GA
az functionapp connection create keyvault

建立keyvault的 functionapp 連線。

核心 GA
az functionapp connection create mysql

建立 mysql 的 functionapp 連線。

核心 已取代
az functionapp connection create mysql-flexible

建立與 mysql 彈性的 functionapp 連線。

核心 GA
az functionapp connection create mysql-flexible (serviceconnector-passwordless 擴充功能)

建立與 mysql 彈性的 functionapp 連線。

副檔名 GA
az functionapp connection create postgres

建立 postgres 的 functionapp 連線。

核心 已取代
az functionapp connection create postgres (serviceconnector-passwordless 擴充功能)

建立 postgres 的 functionapp 連線。

副檔名 GA
az functionapp connection create postgres-flexible

建立 postgres 彈性的 functionapp 連線。

核心 GA
az functionapp connection create postgres-flexible (serviceconnector-passwordless 擴充功能)

建立 postgres 彈性的 functionapp 連線。

副檔名 GA
az functionapp connection create redis

建立 redis 的 functionapp 連線。

核心 GA
az functionapp connection create redis-enterprise

建立 redis-enterprise 的 functionapp 連線。

核心 GA
az functionapp connection create servicebus

建立 servicebus 的 functionapp 連線。

核心 GA
az functionapp connection create signalr

建立與 signalr 的 functionapp 連線。

核心 GA
az functionapp connection create sql

建立 sql 的 functionapp 連線。

核心 GA
az functionapp connection create sql (serviceconnector-passwordless 擴充功能)

建立 sql 的 functionapp 連線。

副檔名 GA
az functionapp connection create storage-blob

建立與 storage-blob 的 functionapp 連線。

核心 GA
az functionapp connection create storage-file

建立與 storage-file 的 functionapp 連線。

核心 GA
az functionapp connection create storage-queue

建立記憶體佇列的 functionapp 連線。

核心 GA
az functionapp connection create storage-table

建立與 storage-table 的 functionapp 連線。

核心 GA
az functionapp connection create webpubsub

建立與 webpubsub 的 functionapp 連線。

核心 GA
az functionapp connection delete

刪除 functionapp 連線。

核心 GA
az functionapp connection list

列出 functionapp 的連線。

核心 GA
az functionapp connection list-configuration

列出 functionapp 連線的來源組態。

核心 GA
az functionapp connection list-support-types

列出 functionapp 連線支援的用戶端類型和驗證類型。

核心 GA
az functionapp connection show

取得 functionapp 連線的詳細數據。

核心 GA
az functionapp connection update

更新 functionapp 連線。

核心 GA
az functionapp connection update app-insights

將 functionapp 更新為 app-insights 連線。

核心 GA
az functionapp connection update appconfig

將 functionapp 更新為 appconfig 連線。

核心 GA
az functionapp connection update confluent-cloud

將 functionapp 更新為 confluent-cloud 連線。

核心 GA
az functionapp connection update cosmos-cassandra

將 functionapp 更新為 cosmos-cassandra 連線。

核心 GA
az functionapp connection update cosmos-gremlin

將 functionapp 更新為 cosmos-gremlin 連線。

核心 GA
az functionapp connection update cosmos-mongo

將 functionapp 更新為 cosmos-mongo 連線。

核心 GA
az functionapp connection update cosmos-sql

將 functionapp 更新為 cosmos-sql 連線。

核心 GA
az functionapp connection update cosmos-table

將 functionapp 更新為 cosmos-table 連線。

核心 GA
az functionapp connection update eventhub

將 functionapp 更新為 eventhub 連線。

核心 GA
az functionapp connection update keyvault

將 functionapp 更新為 keyvault 連線。

核心 GA
az functionapp connection update mysql

將 functionapp 更新為 mysql 連線。

核心 已取代
az functionapp connection update mysql-flexible

將 functionapp 更新為 mysql 彈性連線。

核心 GA
az functionapp connection update postgres

將 functionapp 更新為 postgres 連線。

核心 已取代
az functionapp connection update postgres-flexible

將 functionapp 更新為 postgres 彈性連線。

核心 GA
az functionapp connection update redis

將 functionapp 更新為 redis 連線。

核心 GA
az functionapp connection update redis-enterprise

將 functionapp 更新為 redis-enterprise 連線。

核心 GA
az functionapp connection update servicebus

將 functionapp 更新為 servicebus 連線。

核心 GA
az functionapp connection update signalr

將 functionapp 更新為 signalr 連線。

核心 GA
az functionapp connection update sql

將 functionapp 更新為 sql 連線。

核心 GA
az functionapp connection update storage-blob

將 functionapp 更新為 storage-blob 連線。

核心 GA
az functionapp connection update storage-file

將 functionapp 更新為記憶體檔案連線。

核心 GA
az functionapp connection update storage-queue

將 functionapp 更新為記憶體佇列連線。

核心 GA
az functionapp connection update storage-table

將 functionapp 更新為記憶體數據表連線。

核心 GA
az functionapp connection update webpubsub

將 functionapp 更新為 webpubsub 連線。

核心 GA
az functionapp connection validate

驗證 functionapp 連線。

核心 GA
az functionapp connection wait

將 CLI 置於等候狀態,直到符合連線的條件為止。

核心 GA
az functionapp cors

管理跨原始來源資源分享 (CORS)。

核心 GA
az functionapp cors add

新增允許的來源。

核心 GA
az functionapp cors credentials

啟用或停用 access-control-allow-credentials。

核心 GA
az functionapp cors remove

拿掉允許的來源。

核心 GA
az functionapp cors show

顯示允許的來源。

核心 GA
az functionapp create

建立函數應用程式。

核心 GA
az functionapp create (appservice-kube 擴充功能)

建立函數應用程式。

副檔名 GA
az functionapp delete

刪除函式應用程式。

核心 GA
az functionapp deploy

將提供的成品部署至 Azure functionapp。

核心 預覽
az functionapp deployment

管理函式應用程式部署。

核心和擴充功能 GA
az functionapp deployment container

管理容器式持續部署。

核心 GA
az functionapp deployment container config

透過容器設定持續部署。

核心 GA
az functionapp deployment container show-cd-url

取得可用來設定 Webhook 以進行持續部署的 URL。

核心 GA
az functionapp deployment github-actions

設定 functionapp 的 GitHub Actions。

核心 GA
az functionapp deployment github-actions add

將 GitHub Actions 工作流程檔案新增至指定的存放庫。 工作流程會建置應用程式,並將其部署至指定的 functionapp。

核心 GA
az functionapp deployment github-actions remove

從指定的存放庫移除 GitHub Actions 工作流程檔案並中斷連線。

核心 GA
az functionapp deployment list-publishing-credentials

取得可用函式應用程式發佈認證的詳細數據。

核心 GA
az functionapp deployment list-publishing-profiles

取得可用函式應用程式部署配置檔的詳細數據。

核心 GA
az functionapp deployment slot

管理函式應用程式部署位置。

核心 GA
az functionapp deployment slot auto-swap

設定部署位置自動交換。

核心 GA
az functionapp deployment slot create

建立部署位置。

核心 GA
az functionapp deployment slot delete

刪除部署位置。

核心 GA
az functionapp deployment slot list

列出所有部署位置。

核心 GA
az functionapp deployment slot swap

交換函式應用程式的部署位置。

核心 GA
az functionapp deployment source

透過原始檔控制管理函式應用程式部署。

核心和擴充功能 GA
az functionapp deployment source config

從 git 或 Mercurial 存放庫管理部署。

核心 GA
az functionapp deployment source config-local-git

取得 Git 存放庫端點的 URL,以複製和推送至函式應用程式部署。

核心 GA
az functionapp deployment source config-zip

使用函式應用程式的 kudu zip 推送部署來執行部署。

核心 GA
az functionapp deployment source config-zip (appservice-kube 擴充功能)

使用函式應用程式的 kudu zip 推送部署來執行部署。

副檔名 GA
az functionapp deployment source delete

刪除原始檔控制部署組態。

核心 GA
az functionapp deployment source show

取得原始檔控制部署設定的詳細數據。

核心 GA
az functionapp deployment source sync

從存放庫同步處理。 只有在手動整合模式下才需要。

核心 GA
az functionapp deployment source update-token

更新 Azure App Service 中快取的原始檔控制令牌。

核心 GA
az functionapp deployment user

管理部署的用戶認證。

核心 GA
az functionapp deployment user set

更新部署認證。

核心 GA
az functionapp deployment user show

取得發佈使用者。

核心 GA
az functionapp devops-pipeline

Azure Function 與 Azure DevOps 的特定整合。 如需詳細資訊,請造訪 https://aka.ms/functions-azure-devops

副檔名 GA
az functionapp devops-pipeline create

建立函式應用程式的 Azure DevOps 管線。

副檔名 GA
az functionapp function

管理函式應用程式函式。

核心 GA
az functionapp function delete

刪除函式。

核心 GA
az functionapp function keys

管理函式金鑰。

核心 GA
az functionapp function keys delete

刪除函式金鑰。

核心 GA
az functionapp function keys list

列出所有函式索引鍵。

核心 GA
az functionapp function keys set

建立或更新函式金鑰。

核心 GA
az functionapp function list

列出函式應用程式中的函式。

核心 GA
az functionapp function show

取得函式的詳細數據。

核心 GA
az functionapp hybrid-connection

列出、新增和移除 functionapp 中的混合式連線的方法。

核心 GA
az functionapp hybrid-connection add

將現有的混合式連線新增至 functionapp。

核心 GA
az functionapp hybrid-connection list

列出 functionapp 上的混合式連線。

核心 GA
az functionapp hybrid-connection remove

從 functionapp 移除混合式連線。

核心 GA
az functionapp identity

管理 Web 應用程式的受控識別。

核心 GA
az functionapp identity assign

將受控識別指派給 Web 應用程式。

核心 GA
az functionapp identity remove

停用 Web 應用程式的受控識別。

核心 GA
az functionapp identity show

顯示 Web 應用程式的受控識別。

核心 GA
az functionapp keys

管理函式應用程式金鑰。

核心 GA
az functionapp keys delete

刪除函式應用程式金鑰。

核心 GA
az functionapp keys list

列出所有函式應用程式金鑰。

核心 GA
az functionapp keys set

建立或更新函式應用程式金鑰。

核心 GA
az functionapp list

列出函式應用程式。

核心 GA
az functionapp list-consumption-locations

列出執行函式應用程式的可用位置。

核心 GA
az functionapp list-runtimes

列出可用於函式應用程式的可用內建堆疊。

核心 GA
az functionapp log

管理函式應用程式記錄。

核心 GA
az functionapp log deployment

管理函式應用程式部署記錄。

核心 GA
az functionapp log deployment list

列出與函式應用程式相關聯之部署的部署記錄。

核心 GA
az functionapp log deployment show

顯示最新部署的部署記錄,或指定 deployment-id 時的特定部署記錄。

核心 GA
az functionapp plan

管理 Azure 函式的 App Service 方案。

核心 GA
az functionapp plan create

建立 Azure 函式的 App Service 方案。

核心 GA
az functionapp plan delete

刪除 App Service 方案。

核心 GA
az functionapp plan list

列出 App Service 方案。

核心 GA
az functionapp plan show

取得資源群組或一組資源群組的App Service 方案。

核心 GA
az functionapp plan update

更新 Azure 函式的 App Service 方案。

核心 GA
az functionapp restart

重新啟動函式應用程式。

核心 GA
az functionapp restart (appservice-kube 擴充功能)

重新啟動函式應用程式。

副檔名 GA
az functionapp show

取得函式應用程式的詳細數據。

核心 GA
az functionapp show (appservice-kube 擴充功能)

取得函式應用程式的詳細數據。

副檔名 GA
az functionapp start

啟動函式應用程式。

核心 GA
az functionapp stop

停止函式應用程式。

核心 GA
az functionapp update

更新函式應用程式。

核心 GA
az functionapp vnet-integration

列出、新增和移除 functionapp 中虛擬網路整合的方法。

核心 GA
az functionapp vnet-integration add

將區域虛擬網路整合新增至 functionapp。

核心 GA
az functionapp vnet-integration list

列出 functionapp 上的虛擬網路整合。

核心 GA
az functionapp vnet-integration remove

從 functionapp 移除區域虛擬網路整合。

核心 GA

az functionapp create

建立函數應用程式。

函式應用程式的名稱必須能夠產生唯一的 FQDN 作為 AppName.azurewebsites.net。

az functionapp create --name
                      --resource-group
                      --storage-account
                      [--app-insights]
                      [--app-insights-key]
                      [--assign-identity]
                      [--consumption-plan-location]
                      [--cpu]
                      [--dal {false, true}]
                      [--dapr-app-id]
                      [--dapr-app-port]
                      [--dapr-http-max-request-size]
                      [--dapr-http-read-buffer-size]
                      [--dapr-log-level {debug, error, info, warn}]
                      [--deployment-container-image-name]
                      [--deployment-local-git]
                      [--deployment-source-branch]
                      [--deployment-source-url]
                      [--disable-app-insights {false, true}]
                      [--docker-registry-server-password]
                      [--docker-registry-server-user]
                      [--enable-dapr {false, true}]
                      [--environment]
                      [--functions-version {4}]
                      [--https-only {false, true}]
                      [--image]
                      [--max-replicas]
                      [--memory]
                      [--min-replicas]
                      [--os-type {Linux, Windows}]
                      [--plan]
                      [--registry-password]
                      [--registry-server]
                      [--registry-username]
                      [--role]
                      [--runtime]
                      [--runtime-version]
                      [--scope]
                      [--subnet]
                      [--tags]
                      [--vnet]
                      [--workload-profile-name]
                      [--workspace]

範例

建立基本函式應用程式。

az functionapp create -g MyResourceGroup  -p MyPlan -n MyUniqueAppName -s MyStorageAccount

建立函數應用程式。 ( 自動產生 )

az functionapp create --consumption-plan-location westus --name MyUniqueAppName --os-type Windows --resource-group MyResourceGroup --runtime dotnet --storage-account MyStorageAccount

使用私人 ACR 映像建立函式應用程式。

az functionapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --runtime node --storage-account MyStorageAccount --deployment-container-image-name myacr.azurecr.io/myimage:tag --docker-registry-server-password passw0rd --docker-registry-server-user MyUser

必要參數

--name -n

新函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--storage-account -s

提供所提供資源群組中 儲存體 帳戶的字串值。 或不同資源群組中 儲存體 帳戶的資源標識符。

選擇性參數

--app-insights

要新增至函式應用程式的現有 App Insights 項目名稱。 必須位於相同的資源群組中。

--app-insights-key

要新增的 App Insights 檢測金鑰。

--assign-identity

接受以空格分隔的系統或使用者指派身分識別。 使用 '[system]' 來參考系統指派的身分識別,或參考使用者指派的身分識別的資源標識符。 如需更多範例,請參閱說明。

--consumption-plan-location -c

將裝載函式應用程式的地理位置。 使用 az functionapp list-consumption-locations 來檢視可用的位置。

--cpu
預覽

容器應用程式核心中的CPU。 例如 0.75。

--dal --dapr-enable-api-logging

啟用/停用Dapr Sidecar 的 API 記錄。

接受的值: false, true
預設值: False
--dapr-app-id

Dapr 應用程式識別碼。

--dapr-app-port

Dapr 埠會使用 來與應用程式通訊。

--dapr-http-max-request-size --dhmrs

以 MB 為單位的要求本文 HTTP 和 grpc 伺服器大小上限,以處理大型檔案的上傳。

--dapr-http-read-buffer-size --dhrbs

傳送多 KB 標頭標頭時,要處理之 HTTP 標頭讀取緩衝區的大小上限。

--dapr-log-level

Dapr 側車的記錄層級。

接受的值: debug, error, info, warn
--deployment-container-image-name
已被取代

選項 '--deployment-container-image-name' 已被取代,未來版本將會移除。 請改用 『--image』。

容器映射,例如 publisher/image-name:tag。

--deployment-local-git -l

啟用本機 Git。

--deployment-source-branch -b

要部署的分支。

預設值: master
--deployment-source-url -u

要與手動整合連結的 Git 存放庫 URL。

--disable-app-insights

停用在 functionapp create 期間建立 Application Insights 資源。 將無法使用任何記錄。

接受的值: false, true
--docker-registry-server-password
已被取代

選項 '--docker-registry-server-password' 已被取代,將在未來的版本中移除。 請改用 『--registry-password』。

容器登錄伺服器密碼。 私人登錄的必要專案。

--docker-registry-server-user
已被取代

選項 '--docker-registry-server-user' 已被取代,並將在未來版本中移除。 請改用 『--registry-username』。

容器登錄伺服器用戶名稱。

--enable-dapr

在 Azure Container App 環境中啟用/停用函式應用程式的 Dapr。

接受的值: false, true
預設值: False
--environment
預覽

容器應用程式環境的名稱。

--functions-version

函式應用程式版本。 注意:這會從下一個發行周期開始進行。

接受的值: 4
--https-only

使用 HTTP 重新導向至應用程式的所有流量至 HTTPS。

接受的值: false, true
預設值: False
--image -i

容器映射,例如 publisher/image-name:tag。

--max-replicas
預覽

在容器應用程式上建立函式應用程式時,複本數目上限。

--memory
預覽

容器應用程式的記憶體大小。 例如 1.0Gi,。

--min-replicas
預覽

在容器應用程式上建立函式應用程式時,複本數目下限。

--os-type

設定要建立之應用程式的OS類型。

接受的值: Linux, Windows
--plan -p

functionapp app Service 方案的名稱或資源標識碼。 使用 'appservice plan create' 來取得一個。 如果使用來自不同資源群組的App Service方案,則必須使用完整的資源標識碼,而不是方案名稱。

--registry-password -w

容器登錄伺服器密碼。 私人登錄的必要專案。

--registry-server
預覽

容器登錄伺服器主機名,例如 myregistry.azurecr.io。

--registry-username -d

容器登錄伺服器用戶名稱。

--role

系統指派身分識別的角色名稱或標識碼。

預設值: Contributor
--runtime

函式運行時間堆疊。 使用 「az functionapp list-runtimes」 來檢查支援的運行時間和版本。

--runtime-version

函式運行時間堆疊的版本。 函式運行時間堆疊。 使用 「az functionapp list-runtimes」 來檢查支援的運行時間和版本。

--scope

系統指派的身分識別可以存取的範圍。

--subnet

要加入 Webapp 之預先存在的子網的名稱或資源識別碼。 如果依名稱指定子網,則也需要 --vnet 自變數。

--tags

以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。

--vnet

區域虛擬網路的名稱或資源識別碼。 如果不同資源群組中有多個相同名稱的 vnet,請使用 vnet 資源識別符來指定要使用的 vnet。 如果使用 vnet 名稱,預設會使用與 webapp 相同的資源群組中的 vnet。 必須與 --subnet 自變數搭配使用。

--workload-profile-name
預覽

要執行容器應用程式的工作負載配置檔名稱。

--workspace

要用於 application insights 元件的現有記錄分析工作區名稱。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp create (appservice-kube 擴充功能)

建立函數應用程式。

函式應用程式的名稱必須能夠產生唯一的 FQDN 作為 AppName.azurewebsites.net。

az functionapp create --name
                      --resource-group
                      [--app-insights]
                      [--app-insights-key]
                      [--assign-identity]
                      [--consumption-plan-location]
                      [--custom-location]
                      [--deployment-container-image-name]
                      [--deployment-local-git]
                      [--deployment-source-branch]
                      [--deployment-source-url]
                      [--disable-app-insights {false, true}]
                      [--docker-registry-server-password]
                      [--docker-registry-server-user]
                      [--functions-version {4}]
                      [--max-worker-count]
                      [--min-worker-count]
                      [--os-type {Linux, Windows}]
                      [--plan]
                      [--role]
                      [--runtime]
                      [--runtime-version]
                      [--scope]
                      [--storage-account]
                      [--tags]

範例

建立基本函式應用程式。

az functionapp create -g MyResourceGroup  -p MyPlan -n MyUniqueAppName -s MyStorageAccount

建立函數應用程式。 ( 自動產生 )

az functionapp create --consumption-plan-location westus --name MyUniqueAppName --os-type Windows --resource-group MyResourceGroup --runtime dotnet --storage-account MyStorageAccount

使用私人 ACR 映像建立函式應用程式。

az functionapp create -g MyResourceGroup -p MyPlan -n MyUniqueAppName --runtime node --storage-account MyStorageAccount --deployment-container-image-name myacr.azurecr.io/myimage:tag --docker-registry-server-password passw0rd --docker-registry-server-user MyUser

在 App Service kubernetes 環境中建立函式應用程式

az functionapp create -g MyResourceGroup  -p MyPlan -n MyUniqueAppName -s MyStorageAccount --custom-location /subscriptions/sub_id/resourcegroups/group_name/providers/microsoft.extendedlocation/customlocations/custom_location_name

在 App Service kubernetes 環境中和與自定義位置相同的資源群組中建立函式應用程式

az functionapp create -g MyResourceGroup  -p MyPlan -n MyUniqueAppName -s MyStorageAccount --custom-location custom_location_name

必要參數

--name -n

函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

選擇性參數

--app-insights

要新增至函式應用程式的現有 App Insights 項目名稱。 必須位於相同的資源群組中。

--app-insights-key

要新增的 App Insights 檢測金鑰。

--assign-identity

接受以空格分隔的系統或使用者指派身分識別。 使用 '[system]' 來參考系統指派的身分識別,或參考使用者指派的身分識別的資源標識符。 如需更多範例,請參閱說明。

--consumption-plan-location -c

將裝載函式應用程式的地理位置。 使用 az functionapp list-consumption-locations 來檢視可用的位置。

--custom-location

自訂位置的名稱或識別碼。 針對應用程式的不同資源群組中的自定義位置使用標識碼。

--deployment-container-image-name -i

僅限 Linux。 Docker Hub 中的容器映射名稱,例如 publisher/image-name:tag。

--deployment-local-git -l

啟用本機 Git。

--deployment-source-branch -b

要部署的分支。

預設值: master
--deployment-source-url -u

要與手動整合連結的 Git 存放庫 URL。

--disable-app-insights

停用在 functionapp create 期間建立 Application Insights 資源。 將無法使用任何記錄。

接受的值: false, true
--docker-registry-server-password

容器登錄伺服器密碼。 私人登錄的必要專案。

--docker-registry-server-user

容器登錄伺服器用戶名稱。

--functions-version

函式應用程式版本。 使用 「az functionapp list-runtimes」 來檢查與運行時間和運行時間版本的相容性。

接受的值: 4
--max-worker-count
預覽

要配置的背景工作角色數目上限。

--min-worker-count
預覽

要配置的背景工作角色數目下限。

--os-type

設定要建立之應用程式的OS類型。

接受的值: Linux, Windows
--plan -p

函式 App Service 方案的名稱或資源識別碼。 使用 'appservice plan create' 來取得一個。

--role

系統指派身分識別的角色名稱或標識碼。

預設值: Contributor
--runtime

函式運行時間堆疊。 使用 「az functionapp list-runtimes」 來檢查支援的運行時間和版本。

--runtime-version

函式運行時間堆疊的版本。 使用 「az functionapp list-runtimes」 來檢查支援的運行時間和版本。

--scope

系統指派的身分識別可以存取的範圍。

--storage-account -s

提供所提供資源群組中 儲存體 帳戶的字串值。 或不同資源群組中 儲存體 帳戶的資源標識符。 非 kubernetes 函式應用程式的必要專案。

--tags

以空格分隔的標記:key[=value] [key[=value] ...]。使用 「清除現有的標記」。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp delete

刪除函式應用程式。

az functionapp delete [--ids]
                      [--keep-empty-plan]
                      [--name]
                      [--resource-group]
                      [--slot]
                      [--subscription]

範例

刪除函式應用程式。 ( 自動產生 )

az functionapp delete --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--keep-empty-plan

保留空白的 App Service 方案。

--name -n

functionapp 的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp deploy

預覽

此命令處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

將提供的成品部署至 Azure functionapp。

az functionapp deploy [--async {false, true}]
                      [--clean {false, true}]
                      [--ids]
                      [--ignore-stack {false, true}]
                      [--name]
                      [--resource-group]
                      [--restart {false, true}]
                      [--slot]
                      [--src-path]
                      [--src-url]
                      [--subscription]
                      [--target-path]
                      [--timeout]
                      [--type {ear, jar, lib, startup, static, war, zip}]

範例

以異步方式部署戰爭檔案。

az functionapp deploy --resource-group ResourceGroup --name AppName --src-path SourcePath --type war --async true

將靜態文本檔部署至 wwwroot/staticfiles/test.txt

az functionapp deploy --resource-group ResourceGroup --name AppName --src-path SourcePath --type static --target-path staticfiles/test.txt

選擇性參數

--async

異步部署。

接受的值: false, true
--clean

如果為 true,請在部署檔案之前清除目標目錄。 預設值是根據成品類型來決定。

接受的值: false, true
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--ignore-stack

如果為 true,則會忽略任何堆疊特定的預設值。

接受的值: false, true
--name -n

要部署的函式應用程式名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--restart

如果為 true,則會在部署之後重新啟動 Web 應用程式,預設值為 true。 如果您要部署多個成品,而且不想在先前的部署上重新啟動月臺,請將此設定為 false。

接受的值: false, true
--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--src-path

要部署之成品的路徑。 例如:「myapp.zip」 或 「myworkspace/apps/myapp.war」。

--src-url

成品的 URL。 Webapp 會從此 URL 提取成品。 例如:“http://mysite.com/files/myapp.war?key=123"。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--target-path

應部署成品的絕對路徑。 預設為 「home/site/wwwroot/」。。 例如:“/home/site/deployments/tools/”、“/home/site/scripts/startup-script.sh”。

--timeout

部署作業的逾時,以毫秒為單位。

--type

用來覆寫要部署的成品類型。

接受的值: ear, jar, lib, startup, static, war, zip
全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp list

列出函式應用程式。

az functionapp list [--resource-group]

範例

列出 MyResourceGroup 中的所有函式應用程式。

az functionapp list --resource-group MyResourceGroup

列出所有函式應用程式的預設主機名和狀態。

az functionapp list --query "[].{hostName: defaultHostName, state: state}"

列出所有執行中的函式應用程式。

az functionapp list --query "[?state=='Running']"

選擇性參數

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp list-consumption-locations

列出執行函式應用程式的可用位置。

az functionapp list-consumption-locations
全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp list-runtimes

列出可用於函式應用程式的可用內建堆疊。

az functionapp list-runtimes [--os {linux, windows}]

選擇性參數

--os --os-type

將輸出限制為只有 Windows 或 Linux 執行時間。

接受的值: linux, windows
全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp restart

重新啟動函式應用程式。

az functionapp restart [--ids]
                       [--name]
                       [--resource-group]
                       [--slot]
                       [--subscription]

範例

重新啟動函式應用程式。 ( 自動產生 )

az functionapp restart --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp restart (appservice-kube 擴充功能)

重新啟動函式應用程式。

az functionapp restart [--ids]
                       [--name]
                       [--resource-group]
                       [--slot]
                       [--subscription]

範例

重新啟動函式應用程式。 ( 自動產生 )

az functionapp restart --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp show

取得函式應用程式的詳細數據。

az functionapp show [--ids]
                    [--name]
                    [--resource-group]
                    [--slot]
                    [--subscription]

範例

取得函式應用程式的詳細數據。 ( 自動產生 )

az functionapp show --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp show (appservice-kube 擴充功能)

取得函式應用程式的詳細數據。

az functionapp show [--ids]
                    [--name]
                    [--resource-group]
                    [--slot]
                    [--subscription]

範例

取得函式應用程式的詳細數據。 ( 自動產生 )

az functionapp show --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp start

啟動函式應用程式。

az functionapp start [--ids]
                     [--name]
                     [--resource-group]
                     [--slot]
                     [--subscription]

範例

啟動函式應用程式。 ( 自動產生 )

az functionapp start --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp stop

停止函式應用程式。

az functionapp stop [--ids]
                    [--name]
                    [--resource-group]
                    [--slot]
                    [--subscription]

範例

停止函式應用程式。 ( 自動產生 )

az functionapp stop --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

函式應用程式的名稱。

--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。

az functionapp update

更新函式應用程式。

az functionapp update [--add]
                      [--force]
                      [--force-string]
                      [--ids]
                      [--name]
                      [--plan]
                      [--remove]
                      [--resource-group]
                      [--set]
                      [--slot]
                      [--subscription]

範例

更新函式應用程式。 ( 自動產生 )

az functionapp update --name MyFunctionApp --resource-group MyResourceGroup

選擇性參數

--add

藉由指定路徑和索引鍵值組,將物件加入物件清單。 範例:--add property.listProperty <key=value, string or JSON string>

預設值: []
--force

如果嘗試將 functionapp 從 進階版 移轉至取用 --plan,則為必要專案。

預設值: False
--force-string

使用 'set' 或 'add' 時,請保留字串常值,而不是嘗試轉換成 JSON。

預設值: False
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 「資源標識碼」自變數所有資訊的完整資源識別碼。 您應該提供 --ids 或其他「資源識別碼」自變數。

--name -n

函式應用程式的名稱。

--plan

要更新 functionapp 的計劃名稱或資源識別碼。

--remove

從清單中移除屬性或專案。 範例: --remove property.list <indexToRemove>--remove propertyToRemove

預設值: []
--resource-group -g

資源群組的名稱。 您可以使用 來設定預設群組 az configure --defaults group=<name>

--set

指定要設定的屬性路徑和值,以更新物件。 範例:--set property1.property2=<value>

預設值: []
--slot -s

位置的名稱。 如果未指定,則預設為生產位置。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

全域參數
--debug

增加記錄詳細資訊,以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤,隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例,請參閱 http://jmespath.org/

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。

--verbose

增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。