共用方式為

az spring api-portal custom-domain

  • 參考

注意

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

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

命令

名稱 Description 類型 狀態
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 custom-domain bind

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

az spring api-portal custom-domain bind --domain-name
                                        --resource-group
                                        --service
                                        [--certificate]

範例

將自定義網域系結至 API 入口網站。

az spring api-portal custom-domain bind --domain-name MyDomainName --certificate MyCertName --service MyCluster --resource-group MyResourceGroup

必要參數

--domain-name

自訂網域的名稱。

--resource-group -g

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

--service -s

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

選擇性參數

--certificate

Azure Spring Apps 中的憑證名稱。

全域參數
--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 custom-domain list

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

az spring api-portal custom-domain list --resource-group
                                        --service

範例

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

az spring api-portal custom-domain list --service MyCluster --resource-group MyResourceGroup

必要參數

--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 custom-domain show

顯示自訂網域的詳細數據。

az spring api-portal custom-domain show --domain-name
                                        --resource-group
                                        --service

必要參數

--domain-name

自訂網域的名稱。

--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 custom-domain unbind

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

az spring api-portal custom-domain unbind --domain-name
                                          --resource-group
                                          --service

必要參數

--domain-name

自訂網域的名稱。

--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 custom-domain update

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

az spring api-portal custom-domain update --domain-name
                                          --resource-group
                                          --service
                                          [--certificate]

範例

使用指定的憑證系結自定義網域。

az spring api-portal custom-domain update --domain-name MyDomainName --certificate MCertName --service MyCluster --resource-group MyResourceGroup

必要參數

--domain-name

自訂網域的名稱。

--resource-group -g

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

--service -s

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

選擇性參數

--certificate

Azure Spring Apps 中的憑證名稱。

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