az spring api-portal

注意

此參考是 Azure CLI 的 Spring 延伸模組的一部分（2.56.0 版或更高版本）。 擴充功能會在您第一次執行 az spring api-portal 命令時自動安裝。 深入了解擴充功能。

（僅限企業層）在 Azure Spring Apps 中管理 API 入口網站的命令。

命令

名稱	Description	類型	狀態
az spring api-portal clear	清除 API 入口網站的所有設定。	副檔名	GA
az spring api-portal create	建立 API 入口網站。	副檔名	GA
az spring api-portal custom-domain	用來管理 API 入口網站的自定義網域的命令。	副檔名	GA
az spring api-portal custom-domain bind	使用 API 入口網站系結自定義網域。	副檔名	GA
az spring api-portal custom-domain list	列出 API 入口網站的所有自訂網域。	副檔名	GA
az spring api-portal custom-domain show	顯示自訂網域的詳細數據。	副檔名	GA
az spring api-portal custom-domain unbind	解除系結 API 入口網站的自定義網域。	副檔名	GA
az spring api-portal custom-domain update	更新 API 入口網站的自訂網域。	副檔名	GA
az spring api-portal delete	刪除 API 入口網站。	副檔名	GA
az spring api-portal show	顯示 API 入口網站的設定、布建狀態和運行時間狀態。	副檔名	GA
az spring api-portal update	更新現有的 API 入口網站屬性。	副檔名	GA

az spring api-portal clear

清除 API 入口網站的所有設定。

az spring api-portal clear --resource-group
                           --service

必要參數

--resource-group -g

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

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

全域參數

--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 spring api-portal create

建立 API 入口網站。

az spring api-portal create --resource-group
                            --service
                            [--instance-count]

範例

建立 API 入口網站。

az spring api-portal create -s MyService -g MyResourceGroup --instance-count 1

必要參數

--resource-group -g

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

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--instance-count

實例數目。

全域參數

--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 spring api-portal delete

刪除 API 入口網站。

az spring api-portal delete --resource-group
                            --service
                            [--yes]

必要參數

--resource-group -g

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

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--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 spring api-portal show

顯示 API 入口網站的設定、布建狀態和運行時間狀態。

az spring api-portal show --resource-group
                          --service

必要參數

--resource-group -g

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

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

全域參數

--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 spring api-portal update

更新現有的 API 入口網站屬性。

az spring api-portal update --resource-group
                            --service
                            [--assign-endpoint {false, true}]
                            [--client-id]
                            [--client-secret]
                            [--enable-api-try-out {false, true}]
                            [--https-only {false, true}]
                            [--instance-count]
                            [--issuer-uri]
                            [--scope]

範例

更新 API 入口網站屬性。

az spring api-portal update -s MyService -g MyResourceGroup --assign-endpoint true --https-only true

必要參數

--resource-group -g

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

--service -s

Azure Spring Apps 實例的名稱，您可以使用 az configure --defaults spring=來設定預設服務。

選擇性參數

--assign-endpoint

如果為 true，請指派端點 URL 以進行直接存取。

接受的值: false, true

--client-id

應用程式的公用標識碼。

--client-secret

只有應用程式和授權伺服器才知道的秘密。

--enable-api-try-out

在 API 入口網站中傳送要求和檢視回應，以試用 API。

接受的值: false, true

--https-only

如果為 true，請透過 HTTPs 存取端點。

接受的值: false, true

--instance-count

實例數目。

--issuer-uri

簽發者標識碼的 URI。

--scope

您可以代表使用者執行特定動作應用程式的逗號分隔清單。

全域參數

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