az spring-cloud api-portal

注意

此參考是 Azure CLI 的 spring-cloud 擴充功能的一部分 (2.45.0 版或更高版本)。 擴充功能會在您第一次執行 az spring-cloud api-portal 命令時自動安裝。 深入了解擴充功能。

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

此命令群組已隱含取代,因為命令群組 'spring-cloud' 已被取代,且將在未來的版本中移除。 請改用 'spring'。

(僅限企業層)在 Azure Spring Cloud 中管理 API 入口網站的命令。

命令

名稱 Description 類型 狀態
az spring-cloud api-portal clear

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

擴充 預覽和已淘汰
az spring-cloud api-portal custom-domain

用來管理 API 入口網站的自訂網域的命令。

擴充 預覽和已淘汰
az spring-cloud api-portal custom-domain bind

使用 API 入口網站系結自訂網域。

擴充 預覽和已淘汰
az spring-cloud api-portal custom-domain list

列出 API 入口網站的所有自訂網域。

擴充 預覽和已淘汰
az spring-cloud api-portal custom-domain show

顯示自訂網域的詳細資料。

擴充 預覽和已淘汰
az spring-cloud api-portal custom-domain unbind

解除系結 API 入口網站的自訂網域。

擴充 預覽和已淘汰
az spring-cloud api-portal custom-domain update

更新 API 入口網站的自訂網域。

擴充 預覽和已淘汰
az spring-cloud api-portal show

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

擴充 預覽和已淘汰
az spring-cloud api-portal update

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

擴充 預覽和已淘汰

az spring-cloud api-portal clear

預覽 已被取代

命令群組 'spring-cloud api-portal' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

此命令已隱含取代,因為命令群組 'spring-cloud api-portal' 已被取代,且將在未來的版本中移除。 請改用 'spring api-portal'。

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

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

必要參數

--resource-group -g

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

--service -s

Azure Spring Cloud 的名稱,您可以使用 az configure --defaults spring-cloud=來設定預設服務。

全域參數
--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-cloud api-portal show

預覽 已被取代

命令群組 'spring-cloud api-portal' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

此命令已隱含取代,因為命令群組 'spring-cloud api-portal' 已被取代,且將在未來的版本中移除。 請改用 'spring api-portal'。

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

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

必要參數

--resource-group -g

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

--service -s

Azure Spring Cloud 的名稱,您可以使用 az configure --defaults spring-cloud=來設定預設服務。

全域參數
--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-cloud api-portal update

預覽 已被取代

命令群組 'spring-cloud api-portal' 處於預覽狀態,且正在開發中。 參考和支援層級: https://aka.ms/CLI_refstatus

此命令已隱含取代,因為命令群組 'spring-cloud api-portal' 已被取代,且將在未來的版本中移除。 請改用 'spring api-portal'。

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

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

範例

更新 API 入口網站屬性。

az spring-cloud 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 Cloud 的名稱,您可以使用 az configure --defaults spring-cloud=來設定預設服務。

選擇性參數

--assign-endpoint

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

接受的值: false, true
--client-id

應用程式的公用識別碼。

--client-secret

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

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