az apic api deployment

Note

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

在 API 中心管理 API 部署的命令。

命令

名稱	Description	類型	狀態
az apic api deployment create	建立新的 API 部署或更新現有的 API 部署。	Extension	GA
az apic api deployment delete	刪除 API 部署。	Extension	GA
az apic api deployment list	列出 API 部署的集合。	Extension	GA
az apic api deployment show	取得 API 部署的詳細數據。	Extension	GA
az apic api deployment update	更新現有的 API 部署。	Extension	GA

az apic api deployment create

建立新的 API 部署或更新現有的 API 部署。

az apic api deployment create --api-id
                              --definition-id
                              --deployment-id
                              --environment-id
                              --resource-group
                              --server
                              --service-name
                              --title
                              [--custom-properties]
                              [--description]

範例

建立部署

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{"runtimeUri":["https://example.com"]}'

使用伺服器 json 檔案建立部署

az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'

必要參數

--api-id

API 的識別碼。

--definition-id

API 中心範圍的定義資源識別碼。

屬性	值
參數群組:	Properties Arguments

--deployment-id

API 部署的識別碼。

--environment-id

API 中心範圍的環境資源標識碼。

屬性	值
參數群組:	Properties Arguments

--resource-group -g

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

--server

伺服器支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--service-name -n

Azure API 中心服務的名稱。

--title

部署標題。

屬性	值
參數群組:	Properties Arguments

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--custom-properties

針對 API 目錄實體定義的自訂元數據。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--description

部署的描述。

屬性	值
參數群組:	Properties Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az apic api deployment delete

刪除 API 部署。

az apic api deployment delete [--api-id]
                              [--deployment-id]
                              [--ids]
                              [--resource-group]
                              [--service-name]
                              [--subscription]
                              [--yes]

範例

刪除 API 部署

az apic api deployment delete -g api-center-test -n contoso --deployment-id production --api-id echo-api

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--api-id

API 的識別碼。

屬性	值
參數群組:	Resource Id Arguments

--deployment-id

API 部署的識別碼。

屬性	值
參數群組:	Resource Id Arguments

--ids

一或多個資源識別碼（以空格分隔）。它應該是包含「資源標識碼」自變數所有資訊的完整資源識別碼。您應該提供 --ids 或其他「資源識別碼」自變數。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--service-name -n

Azure API 中心服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--yes -y

請勿提示確認。

屬性	值
預設值:	False

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az apic api deployment list

列出 API 部署的集合。

az apic api deployment list --api-id
                            --resource-group
                            --service-name
                            [--filter]
                            [--max-items]
                            [--next-token]

範例

列出 API 部署

az apic api deployment list -g api-center-test -n contoso --api-id echo-api

必要參數

--api-id

API 的識別碼。

--resource-group -g

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

--service-name -n

Azure API 中心服務的名稱。

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--filter

OData 篩選參數。

--max-items

命令輸出中要傳回的項目總數。如果可用的專案總數超過指定的值，則會在命令的輸出中提供令牌。若要繼續分頁，請在後續命令的 --next-token 自變數中提供令牌值。

屬性	值
參數群組:	Pagination Arguments

--next-token

標記，指定要開始分頁的位置。這是先前截斷回應中的令牌值。

屬性	值
參數群組:	Pagination Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az apic api deployment show

取得 API 部署的詳細數據。

az apic api deployment show [--api-id]
                            [--deployment-id]
                            [--ids]
                            [--resource-group]
                            [--service-name]
                            [--subscription]

範例

顯示 API 部署詳細數據

az apic api deployment show -g api-center-test -n contoso --deployment-id production --api-id echo-api

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--api-id

API 的識別碼。

屬性	值
參數群組:	Resource Id Arguments

--deployment-id

API 部署的識別碼。

屬性	值
參數群組:	Resource Id Arguments

--ids

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--service-name -n

Azure API 中心服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

az apic api deployment update

更新現有的 API 部署。

az apic api deployment update [--add]
                              [--api-id]
                              [--custom-properties]
                              [--definition-id]
                              [--deployment-id]
                              [--description]
                              [--environment-id]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--ids]
                              [--remove]
                              [--resource-group]
                              [--server]
                              [--service-name]
                              [--set]
                              [--subscription]
                              [--title]

範例

更新 API 部署

az apic api deployment update -g api-center-test -n contoso --deployment-id production --title "Production deployment" --api-id echo-api

選擇性參數

下列參數是選擇性參數，但視內容而定，命令可能需要一或多個參數才能成功執行。

--add

藉由指定路徑和索引鍵值組，將物件加入物件清單。範例： --add property.listProperty <key=value, string or JSON string>.

屬性	值
參數群組:	Generic Update Arguments

--api-id

API 的識別碼。

屬性	值
參數群組:	Resource Id Arguments

--custom-properties

針對 API 目錄實體定義的自訂元數據。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--definition-id

服務範圍定義資源標識碼。

屬性	值
參數群組:	Properties Arguments

--deployment-id

API 部署的識別碼。

屬性	值
參數群組:	Resource Id Arguments

--description

部署的描述。

屬性	值
參數群組:	Properties Arguments

--environment-id

服務範圍的環境資源標識碼。

屬性	值
參數群組:	Properties Arguments

--force-string

使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。

屬性	值
參數群組:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--ids

屬性	值
參數群組:	Resource Id Arguments

--remove

從清單中移除屬性或專案。範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。

屬性	值
參數群組:	Generic Update Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--server

伺服器支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

屬性	值
參數群組:	Properties Arguments

--service-name -n

Azure API 中心服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--set

指定要設定的屬性路徑和值，以更新物件。範例： --set property1.property2=<value>.

屬性	值
參數群組:	Generic Update Arguments

--subscription

訂用帳戶的名稱或標識碼。您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

屬性	值
參數群組:	Resource Id Arguments

--title

Title.

屬性	值
參數群組:	Properties Arguments

全域參數

--debug

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	False

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

屬性	值
預設值:	False

--output -o

輸出格式。

屬性	值
預設值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查詢字串。如需詳細資訊和範例，請參閱 http://jmespath.org/。

--verbose

增加記錄的詳細程度。針對完整偵錯記錄使用 --debug。

屬性	值
預設值:	False

意見反應

此頁面對您有幫助嗎？

共用方式為

az apic api deployment

命令

az apic api deployment create

範例

必要參數

選擇性參數

az apic api deployment delete

範例

選擇性參數

az apic api deployment list

範例

必要參數

選擇性參數

az apic api deployment show

範例

選擇性參數

az apic api deployment update

範例

選擇性參數

意見反應