az functionapp

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

命令

az functionapp app

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

az functionapp app up

透過 GitHub 動作部署至Azure Functions。

az functionapp config

設定函式應用程式。

az functionapp config access-restriction

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

az functionapp config access-restriction add

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

az functionapp config access-restriction remove

從 functionapp 移除存取限制。

az functionapp config access-restriction set

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

az functionapp config access-restriction show

顯示 functionapp 的存取限制設定。

az functionapp config appsettings

設定函式應用程式設定。

az functionapp config appsettings delete

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

az functionapp config appsettings list

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

az functionapp config appsettings set

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

az functionapp config container

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

az functionapp config container delete

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

az functionapp config container set

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

az functionapp config container show

取得函式應用程式容器設定的詳細資料。

az functionapp config hostname

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

az functionapp config hostname add

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

az functionapp config hostname delete

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

az functionapp config hostname get-external-ip

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

az functionapp config hostname list

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

az functionapp config set

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

az functionapp config show

取得現有函式應用程式組態的詳細資料。

az functionapp config ssl

設定 SSL 憑證。

az functionapp config ssl bind

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

az functionapp config ssl create

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

az functionapp config ssl delete

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

az functionapp config ssl import

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

az functionapp config ssl list

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

az functionapp config ssl show

顯示函式應用程式的 SSL 憑證詳細資料。

az functionapp config ssl unbind

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

az functionapp config ssl upload

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

az functionapp cors

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

az functionapp cors add

新增允許的來源。

az functionapp cors remove

移除允許的來源。

az functionapp cors show

顯示允許的來源。

az functionapp create

建立函數應用程式。

az functionapp delete

刪除函式應用程式。

az functionapp deploy

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

az functionapp deployment

管理函式應用程式部署。

az functionapp deployment container

管理容器型持續部署。

az functionapp deployment container config

透過容器設定持續部署。

az functionapp deployment container show-cd-url

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

az functionapp deployment github-actions

設定 functionapp 的GitHub Actions。

az functionapp deployment github-actions add

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

az functionapp deployment github-actions remove

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

az functionapp deployment list-publishing-credentials

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

az functionapp deployment list-publishing-profiles

取得可用函式應用程式部署設定檔的詳細資料。

az functionapp deployment slot

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

az functionapp deployment slot auto-swap

設定部署位置自動交換。

az functionapp deployment slot create

建立部署位置。

az functionapp deployment slot delete

刪除部署位置。

az functionapp deployment slot list

列出所有部署位置。

az functionapp deployment slot swap

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

az functionapp deployment source

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

az functionapp deployment source config

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

az functionapp deployment source config-local-git

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

az functionapp deployment source config-zip

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

az functionapp deployment source delete

刪除原始檔控制部署設定。

az functionapp deployment source show

取得原始檔控制部署設定的詳細資料。

az functionapp deployment source sync

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

az functionapp deployment source update-token

更新 Azure App Service 中快取的原始檔控制權杖。

az functionapp deployment user

管理用於部署的使用者認證。

az functionapp deployment user set

更新部署認證。

az functionapp deployment user show

取得發佈使用者。

az functionapp devops-pipeline

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

az functionapp devops-pipeline create

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

az functionapp function

管理函式應用程式函式。

az functionapp function delete

刪除函式。

az functionapp function keys

管理函式金鑰。

az functionapp function keys delete

刪除函式金鑰。

az functionapp function keys list

列出所有函式索引鍵。

az functionapp function keys set

建立或更新函式金鑰。

az functionapp function show

取得函式的詳細資料。

az functionapp hybrid-connection

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

az functionapp hybrid-connection add

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

az functionapp hybrid-connection list

列出 functionapp 上的混合式連線。

az functionapp hybrid-connection remove

從 functionapp 移除混合式連線。

az functionapp identity

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

az functionapp identity assign

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

az functionapp identity remove

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

az functionapp identity show

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

az functionapp keys

管理函式應用程式金鑰。

az functionapp keys delete

刪除函式應用程式金鑰。

az functionapp keys list

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

az functionapp keys set

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

az functionapp list

列出函式應用程式。

az functionapp list-consumption-locations

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

az functionapp list-runtimes

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

az functionapp log

管理函式應用程式記錄。

az functionapp log deployment

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

az functionapp log deployment list

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

az functionapp log deployment show

顯示最新部署的部署記錄,如果指定 deployment-id,則為特定部署。

az functionapp plan

管理 Azure 函式的App Service方案。

az functionapp plan create

建立 Azure 函式的App Service方案。

az functionapp plan delete

刪除App Service方案。

az functionapp plan list

列出App Service方案。

az functionapp plan show

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

az functionapp plan update

更新 Azure 函式的App Service方案。

az functionapp restart

重新開機函式應用程式。

az functionapp show

取得函式應用程式的詳細資料。

az functionapp start

啟動函式應用程式。

az functionapp stop

停止函式應用程式。

az functionapp update

更新函式應用程式。

az functionapp vnet-integration

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

az functionapp vnet-integration add

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

az functionapp vnet-integration list

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

az functionapp vnet-integration remove

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

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]
                      [--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 {2, 3, 4}]
                      [--https-only {false, true}]
                      [--os-type {Linux, Windows}]
                      [--plan]
                      [--role]
                      [--runtime]
                      [--runtime-version]
                      [--scope]
                      [--subnet]
                      [--tags]
                      [--vnet]

範例

建立基本函式應用程式。

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 來檢視可用的位置。

--deployment-container-image-name -i

來自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 -w

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

--docker-registry-server-user -d

容器登錄伺服器使用者名稱。

--functions-version

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

接受的值: 2, 3, 4
--https-only

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

接受的值: false, true
--os-type

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

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

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

--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 引數使用。

az functionapp delete

刪除函式應用程式。

az functionapp delete [--ids]
                      [--name]
                      [--resource-group]
                      [--slot]

範例

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

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

選擇性參數

--ids

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

--name -n

函式應用程式的名稱。

--resource-group -g

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

--slot -s

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

az functionapp deploy

將提供的成品部署至 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]
                      [--target-path]
                      [--timeout]
                      [--type {ear, jar, lib, startup, static, war, zip}]

範例

以非同步方式部署 war 檔案。

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

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

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

選擇性參數

--async

非同步部署。

接受的值: false, true
--clean

如果為 true,請先清除目標目錄,再部署檔案 (s) 。 預設值是根據成品類型來決定。

接受的值: false, true
--ids

一或多個資源識別碼 (以空格分隔)。 它應該是包含 'Resource Id' 引數所有資訊的完整資源識別碼。 您應該提供 --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" ;。

--target-path

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

--timeout

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

--type

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

接受的值: ear, jar, lib, startup, static, war, zip

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> 來設定預設群組。

az functionapp list-consumption-locations

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

az functionapp list-consumption-locations

az functionapp list-runtimes

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

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

選擇性參數

--os --os-type

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

接受的值: linux, windows

az functionapp restart

重新開機函式應用程式。

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

範例

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

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

選擇性參數

--ids

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

--name -n

函式應用程式的名稱。

--resource-group -g

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

--slot -s

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

az functionapp show

取得函式應用程式的詳細資料。

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

範例

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

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

選擇性參數

--ids

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

--name -n

函式應用程式的名稱。

--resource-group -g

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

--slot -s

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

az functionapp start

啟動函式應用程式。

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

範例

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

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

選擇性參數

--ids

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

--name -n

函式應用程式的名稱。

--resource-group -g

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

--slot -s

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

az functionapp stop

停止函式應用程式。

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

範例

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

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

選擇性參數

--ids

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

--name -n

函式應用程式的名稱。

--resource-group -g

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

--slot -s

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

az functionapp update

更新函式應用程式。

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

範例

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

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

選擇性參數

--add

藉由指定路徑和索引鍵值組,將物件新增至物件清單。 範例:--add property.listProperty < key=value、string 或 JSON 字串 > 。

--force

如果嘗試將 functionapp 從 Premium 遷移至使用量 --plan,則為必要專案。

--force-string

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

--ids

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

--name -n

函式應用程式的名稱。

--plan

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

--remove

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

--resource-group -g

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

--set

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

--slot -s

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