az staticwebapp backends

使用靜態 Web 應用程式連結或取消連結預先部署後端。 也稱為「攜帶您自己的 API」。

命令

名稱	Description	類型	狀態
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 backends link

將後端連結至靜態 Web 應用程式。 也稱為「攜帶您自己的 API」。

單一靜態 Web 應用程式只能使用一個後端。 如果後端先前已連結至另一個靜態 Web 應用程式，則必須先從後端移除驗證組態，再連結至不同的靜態 Web 應用程式。 靜態 Web 應用程式 SKU 必須是「標準」。 支援的後端類型包括 Azure Functions、Azure API 管理、Azure App 服務、Azure Container Apps。 必須針對 Azure Functions 類型的後端和Azure App 服務提供後端區域。 若要深入瞭解，請參閱 https://learn.microsoft.com/azure/static-web-apps/apis-overview 。

az staticwebapp backends link --backend-resource-id
                              --name
                              --resource-group
                              [--backend-region]
                              [--environment-name]

範例

將後端連結至靜態 Web 應用程式

az staticwebapp backends link -n MyStaticAppName -g MyResourceGroup --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion

將後端連結至靜態 Web 應用程式環境

az staticwebapp backends link -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion

必要參數

--backend-resource-id

要連結之後端的資源識別碼。

--name -n

靜態網站的名稱。

--resource-group -g

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

選擇性參數

--backend-region

後端資源的區域。

--environment-name

靜態網站環境的名稱。

預設值: default

全域參數

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

在連結至靜態 Web 應用程式的後端上顯示詳細資料。

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

範例

顯示靜態 Web 應用程式後端。

az staticwebapp backends show -n MyStaticAppName -g MyResourceGroup

顯示環境的靜態 Web 應用程式後端。

az staticwebapp backends show -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName

必要參數

--name -n

靜態網站的名稱。

--resource-group -g

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

選擇性參數

--environment-name

靜態網站環境的名稱。

預設值: default

全域參數

--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 backends unlink

從靜態 Web 應用程式取消連結後端。

az staticwebapp backends unlink --name
                                --resource-group
                                [--environment-name]
                                [--remove-backend-auth]

範例

取消連結靜態應用程式後端。

az staticwebapp backends unlink -n MyStaticAppName -g MyResourceGroup

從靜態 Web 應用程式環境取消連結後端，並從後端移除驗證設定。

az staticwebapp backends unlink -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName --remove-backend-auth

必要參數

--name -n

靜態網站的名稱。

--resource-group -g

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

選擇性參數

--environment-name

靜態網站環境的名稱。

預設值: default

--remove-backend-auth

如果設定為 true，則會在連結程式期間移除在後端設定的識別提供者。

預設值: 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 backends validate

驗證靜態 Web 應用程式的後端。

單一靜態 Web 應用程式只能使用一個後端。 如果後端先前已連結至另一個靜態 Web 應用程式，則必須先從後端移除驗證組態，再連結至不同的靜態 Web 應用程式。 靜態 Web 應用程式 SKU 必須是「標準」。 支援的後端類型包括 Azure Functions、Azure API 管理、Azure App 服務、Azure Container Apps。 必須針對 Azure Functions 類型的後端和Azure App 服務提供後端區域。 若要深入瞭解，請參閱 https://learn.microsoft.com/azure/static-web-apps/apis-overview 。

az staticwebapp backends validate --backend-resource-id
                                  --name
                                  --resource-group
                                  [--backend-region]
                                  [--environment-name]

範例

驗證靜態 Web 應用程式的後端

az staticwebapp backends validate -n MyStaticAppName -g MyResourceGroup --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion

驗證靜態 Web 應用程式環境的後端

az staticwebapp backends validate -n MyStaticAppName -g MyResourceGroup --environment-name MyEnvironmentName --backend-resource-id "/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/<resource-provider>/<resource-type>/<backend-name>" --backend-region MyBackendRegion

必要參數

--backend-resource-id

要連結之後端的資源識別碼。

--name -n

靜態網站的名稱。

--resource-group -g

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

選擇性參數

--backend-region

後端資源的區域。

--environment-name

靜態網站環境的名稱。

預設值: default

全域參數

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