az staticwebapp

注意

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

管理靜態應用程式。

命令

名稱	Description	類型	狀態
az staticwebapp appsettings	管理靜態應用程式的應用程式設定。	核心	GA
az staticwebapp appsettings delete	刪除具有靜態應用程式之指定索引鍵的應用程式設定。	核心	GA
az staticwebapp appsettings list	列出靜態應用程式的應用程式設定。	核心	GA
az staticwebapp appsettings set	將 新增至或變更靜態應用程式的應用程式設定。	核心	GA
az staticwebapp backends	使用靜態 Web 應用程式連結或取消連結預先部署後端。 也稱為「攜帶您自己的 API」。	核心	GA
az staticwebapp backends link	將後端連結至靜態 Web 應用程式。 也稱為「攜帶您自己的 API」。	核心	GA
az staticwebapp backends show	在連結至靜態 Web 應用程式的後端上顯示詳細資料。	核心	GA
az staticwebapp backends unlink	從靜態 Web 應用程式取消連結後端。	核心	GA
az staticwebapp backends validate	驗證靜態 Web 應用程式的後端。	核心	GA
az staticwebapp create	建立靜態應用程式。 若要提供靜態 Web 應用程式的內容並與 Github 存放庫整合，請提供 Github 存放庫 URL （--source） 和分支 （--branch）。 如果存放庫位於 Github 組織底下，請確定 Azure CLI Github 應用程式可以存取組織。 使用 「--login-with-github」 引數時，可以在瀏覽器中要求存取權。 存取權必須由組織的系統管理員授與。	核心	GA
az staticwebapp dbconnection	管理靜態 Web 應用程式資料庫連線。	擴充	預覽版
az staticwebapp dbconnection create	建立靜態 Web 應用程式資料庫連線。	擴充	預覽版
az staticwebapp dbconnection delete	刪除靜態 Web 應用程式資料庫連線。	擴充	預覽版
az staticwebapp dbconnection show	取得靜態 Web 應用程式資料庫連線的詳細資料。	擴充	預覽版
az staticwebapp delete	刪除靜態應用程式。	核心	GA
az staticwebapp disconnect	中斷原始檔控制，以啟用連線到不同的存放庫。	核心	GA
az staticwebapp enterprise-edge	管理靜態 Webapp 的 Azure Front Door CDN。 如需最佳體驗和可用性，請查看我們的檔 https://aka.ms/swaedge 。	核心	GA
az staticwebapp enterprise-edge disable	停用靜態 Webapp 的 Azure Front Door CDN。 如需最佳體驗和可用性，請查看我們的檔 https://aka.ms/swaedge 。	核心	GA
az staticwebapp enterprise-edge enable	為靜態 Webapp 啟用 Azure Front Door CDN。 啟用企業級邊緣需要重新註冊 Azure Front Door Microsoft.CDN 資源提供者。 如需最佳體驗和可用性，請查看我們的檔 https://aka.ms/swaedge 。	核心	GA
az staticwebapp enterprise-edge show	顯示 Webapp 的 Azure Front Door CDN 狀態（已啟用、停用、啟用、停用）。 如需最佳體驗和可用性，請查看我們的檔 https://aka.ms/swaedge 。	核心	GA
az staticwebapp environment	管理靜態應用程式的環境。	核心	GA
az staticwebapp environment delete	刪除靜態應用程式生產環境或指定的環境。	核心	GA
az staticwebapp environment functions	顯示函式的相關資訊。	核心	GA
az staticwebapp environment list	列出靜態應用程式的所有環境，包括生產環境。	核心	GA
az staticwebapp environment show	顯示生產環境或指定環境的相關資訊。	核心	GA
az staticwebapp functions	使用靜態 Webapp 連結或取消連結預先xisting functionapp。 也稱為「攜帶您自己的函式」。	核心	GA
az staticwebapp functions link	將 Azure 函式連結至靜態 Webapp。 也稱為「攜帶您自己的函式」。單一靜態 Web 應用程式只能使用一個 Azure Functions 應用程式。 靜態 Webapp SKU 必須是「標準」。	核心	GA
az staticwebapp functions show	顯示連結至靜態 Webapp 的 Azure 函式詳細資料。	核心	GA
az staticwebapp functions unlink	從靜態 Webapp 取消連結 Azure 函式。	核心	GA
az staticwebapp hostname	管理靜態應用程式的 Functions 自訂主機名稱。	核心	GA
az staticwebapp hostname delete	刪除靜態應用程式的指定主機名稱。	核心	GA
az staticwebapp hostname list	列出靜態應用程式的自訂主機名稱。	核心	GA
az staticwebapp hostname set	將指定的子域主機名稱設定為靜態應用程式。 請使用您的 DNS 提供者設定 CNAME/TXT/ALIAS 記錄。 使用 --no-wait 來等候驗證。	核心	GA
az staticwebapp hostname show	取得 staticwebapp 自訂網域的詳細資料。 可用來擷取 TXT 網域驗證的驗證權杖（請參閱範例）。	核心	GA
az staticwebapp identity	管理靜態 Web 應用程式的受控識別。	核心	GA
az staticwebapp identity assign	將受控識別指派給靜態 Web 應用程式。	核心	GA
az staticwebapp identity remove	停用靜態 Web 應用程式的受控識別。	核心	GA
az staticwebapp identity show	顯示靜態 Web 應用程式的受控識別。	核心	GA
az staticwebapp list	列出訂用帳戶中的所有靜態應用程式資源，或在提供時在資源群組中列出。	核心	GA
az staticwebapp reconnect	在中斷連線命令之後，連線存放庫和分支。	核心	GA
az staticwebapp secrets	管理靜態應用程式的部署權杖。	核心	GA
az staticwebapp secrets list	列出靜態應用程式的部署權杖。	核心	GA
az staticwebapp secrets reset-api-key	重設靜態應用程式的部署權杖。	核心	GA
az staticwebapp show	顯示靜態應用程式的詳細資料。	核心	GA
az staticwebapp update	更新靜態應用程式。 傳回更新的應用程式。	核心	GA
az staticwebapp users	管理靜態應用程式的使用者。	核心	GA
az staticwebapp users invite	為指定的使用者建立靜態應用程式的邀請連結。	核心	GA
az staticwebapp users list	列出使用者和指派的角色，僅限於接受其邀請的使用者。	核心	GA
az staticwebapp users update	更新具有所列角色的使用者專案。 需要使用者詳細資料或使用者識別碼。	核心	GA

az staticwebapp create

建立靜態應用程式。 若要提供靜態 Web 應用程式的內容並與 Github 存放庫整合，請提供 Github 存放庫 URL （--source） 和分支 （--branch）。 如果存放庫位於 Github 組織底下，請確定 Azure CLI Github 應用程式可以存取組織。 使用 「--login-with-github」 引數時，可以在瀏覽器中要求存取權。 存取權必須由組織的系統管理員授與。

az staticwebapp create --name
                       --resource-group
                       [--api-location]
                       [--app-location]
                       [--branch]
                       [--location]
                       [--login-with-ado]
                       [--login-with-github]
                       [--no-wait]
                       [--output-location]
                       [--sku {Free, Standard}]
                       [--source]
                       [--tags]
                       [--token]

範例

在訂用帳戶中建立靜態應用程式。

az staticwebapp create -n MyStaticAppName -g MyExistingRg -s https://github.com/JohnDoe/my-first-static-web-app -l WestUs2 -b master -t MyAccessToken

在訂用帳戶中建立靜態應用程式，以互動方式擷取權杖

az staticwebapp create -n MyStaticAppName -g MyExistingRg -s https://github.com/JohnDoe/my-first-static-web-app -l WestUs2 -b master --login-with-github

建立不含任何內容的靜態 Web 應用程式，而不需要 github 整合

az staticwebapp create -n MyStaticAppName -g MyExistingRg

必要參數

--name -n

靜態網站的名稱。

--resource-group -g

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

選擇性參數

--api-location

Azure Functions 程式碼的位置。 例如，'/api' 代表名為 'api' 的資料夾。

--app-location

應用程式程式碼的位置。 例如，'/' 代表應用程式的根目錄，而 '/app' 則代表名為 'app' 的目錄。

預設值: /

--branch -b

存放庫中的目標分支。

--location -l

位置。​​ 來自的值： az account list-locations 。 您可以使用 來設定預設位置 az configure --defaults location=<location> 。

預設值: centralus

--login-with-ado

使用 Azure 認證來建立 Azure Dev Ops 個人存取權杖。

預設值: False

--login-with-github

以互動方式使用 Github 登入以擷取個人存取權杖。

預設值: False

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--output-location

相對於應用程式位置的組建輸出路徑。 例如，當您的應用程式位置設定為 '/app' 時，將值設定為 '/app' 會導致提供 '/app/build' 的內容。

--sku

靜態 Web 應用程式的定價層。

接受的值: Free, Standard

預設值: Free

--source -s

靜態網站存放庫的 URL。

--tags

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

--token -t

使用者的 GitHub 或 Azure Dev Ops 存放庫權杖。 這是用來建立 Github Action 或 Dev Ops 管線。

全域參數

--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 staticwebapp delete

刪除靜態應用程式。

az staticwebapp delete --name
                       [--no-wait]
                       [--resource-group]
                       [--yes]

範例

刪除靜態應用程式。

az staticwebapp delete -n MyStaticAppName -g MyRg

必要參數

--name -n

靜態網站的名稱。

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

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

--yes -y

不提示確認。

預設值: False

全域參數

--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 staticwebapp disconnect

中斷原始檔控制，以啟用連線到不同的存放庫。

az staticwebapp disconnect --name
                           [--no-wait]
                           [--resource-group]

範例

中斷靜態應用程式的連線。

az staticwebapp disconnect -n MyStaticAppName

必要參數

--name -n

靜態網站的名稱。

選擇性參數

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--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 staticwebapp list

列出訂用帳戶中的所有靜態應用程式資源，或在提供時在資源群組中列出。

az staticwebapp list [--resource-group]

範例

列出訂用帳戶中的靜態應用程式。

az staticwebapp list

選擇性參數

--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 staticwebapp reconnect

在中斷連線命令之後，連線存放庫和分支。

az staticwebapp reconnect --branch
                          --name
                          --source
                          [--login-with-github]
                          [--no-wait]
                          [--resource-group]
                          [--token]

範例

連線存放庫和分支至靜態應用程式。

az staticwebapp reconnect -n MyStaticAppName --source MyGitHubRepo -b master --token MyAccessToken

連線存放庫和分支至靜態應用程式，以互動方式擷取權杖

az staticwebapp reconnect -n MyStaticAppName --source MyGitHubRepo -b master --login-with-github

必要參數

--branch -b

存放庫中的目標分支。

--name -n

靜態網站的名稱。

--source -s

靜態網站存放庫的 URL。

選擇性參數

--login-with-github

以互動方式使用 Github 登入以擷取個人存取權杖。

預設值: False

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

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

--token -t

使用者的 GitHub 或 Azure Dev Ops 存放庫權杖。 這是用來建立 Github Action 或 Dev Ops 管線。

全域參數

--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 staticwebapp show

顯示靜態應用程式的詳細資料。

az staticwebapp show --name
                     [--resource-group]

範例

在訂用帳戶中顯示靜態應用程式。

az staticwebapp show -n MyStaticAppName

必要參數

--name -n

靜態網站的名稱。

選擇性參數

--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 staticwebapp update

更新靜態應用程式。 傳回更新的應用程式。

az staticwebapp update --name
                       [--branch]
                       [--no-wait]
                       [--resource-group]
                       [--sku {Free, Standard}]
                       [--source]
                       [--tags]
                       [--token]

範例

將靜態應用程式更新為標準 SKU。

az staticwebapp update -n MyStaticAppName --sku Standard

必要參數

--name -n

靜態網站的名稱。

選擇性參數

--branch -b

存放庫中的目標分支。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False

--resource-group -g

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

--sku

靜態 Web 應用程式的定價層。

接受的值: Free, Standard

--source -s

靜態網站存放庫的 URL。

--tags

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

--token -t

使用者的 GitHub 或 Azure Dev Ops 存放庫權杖。 這是用來建立 Github Action 或 Dev Ops 管線。

全域參數

--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 來取得完整偵錯記錄。