az apic api definition

參考

注意

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

在 API 中心管理 API 定義的命令。

命令

名稱	Description	類型	狀態
az apic api definition create	建立新的 API 定義或更新現有的 API 定義。	副檔名	GA
az apic api definition delete	刪除指定的 API 定義。	副檔名	GA
az apic api definition export-specification	匯出 API 規格。	副檔名	GA
az apic api definition import-specification	匯入 API 規格。	副檔名	GA
az apic api definition list	列出 API 定義的集合。	副檔名	GA
az apic api definition show	取得 API 定義的詳細數據。	副檔名	GA
az apic api definition update	更新現有的 API 定義。	副檔名	GA

az apic api definition create

建立新的 API 定義或更新現有的 API 定義。

az apic api definition create --api-id
                              --definition-id
                              --resource-group
                              --service
                              --title
                              --version-id
                              [--description]

範例

建立 API 定義

az apic api definition create -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

必要參數

--api-id

API 的識別碼。

--definition-id

API 定義的識別碼。

--resource-group -g

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

--service --service-name -s

API 中心服務的名稱。

--title

API 版本。

--version-id

API 版本的識別碼。

選擇性參數

--description

API 定義描述。

全域參數

--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 apic api definition delete

刪除指定的 API 定義。

az apic api definition delete [--api-id]
                              [--definition-id]
                              [--ids]
                              [--resource-group]
                              [--service]
                              [--subscription]
                              [--version-id]
                              [--yes]

範例

刪除 API 定義

az apic api definition delete -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

選擇性參數

--api-id

API 的識別碼。

--definition-id

API 定義的識別碼。

--ids

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

--resource-group -g

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

--service --service-name -s

API 中心服務的名稱。

--subscription

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

--version-id

API 版本的識別碼。

--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 apic api definition export-specification

匯出 API 規格。

az apic api definition export-specification --file-name
                                            [--api-id]
                                            [--definition-id]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service]
                                            [--subscription]
                                            [--version-id]

範例

匯出規格

az apic api version definition export-specification -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id default

必要參數

--file-name

要匯出規格之檔案的名稱。

選擇性參數

--api-id

API 的識別碼。

--definition-id

API 定義的識別碼。

--ids

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--service --service-name -s

API 中心服務的名稱。

--subscription

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

--version-id

API 版本的識別碼。

全域參數

--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 apic api definition import-specification

匯入 API 規格。

az apic api definition import-specification [--api-id]
                                            [--definition-id]
                                            [--file-name]
                                            [--format {inline, link}]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--service]
                                            [--specification]
                                            [--subscription]
                                            [--value]
                                            [--version-id]

範例

匯入規格範例 1

az apic api definition import-specification -g api-center-test -s contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}'

匯入規格範例 2

az apic api definition import-specification -g api-center-test -s contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}'

選擇性參數

--api-id

API 的識別碼。

--definition-id

API 定義的識別碼。

--file-name

要從何處匯入規格的檔名。

--format

API 規格來源的格式。

接受的值: inline, link

--ids

--no-wait

請勿等候長時間執行的作業完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--service --service-name -s

API 中心服務的名稱。

--specification

API 規格詳細數據。支援速記語法、json-file 和 yaml-file。請嘗試 “？？” 以顯示更多。

--subscription

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

--value

API 規格來源的值。

--version-id

API 版本的識別碼。

全域參數

--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 apic api definition list

列出 API 定義的集合。

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

範例

列出 API 定義

az apic api definition list -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01

必要參數

--api-id

API 的識別碼。

--resource-group -g

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

--service --service-name -s

API 中心服務的名稱。

--version-id

API 版本的識別碼。

選擇性參數

--filter

OData 篩選參數。

--max-items

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

--next-token

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

全域參數

--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 apic api definition show

取得 API 定義的詳細數據。

az apic api definition show [--api-id]
                            [--definition-id]
                            [--ids]
                            [--resource-group]
                            [--service]
                            [--subscription]
                            [--version-id]

範例

顯示 API 定義詳細數據

az apic api definition show -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi"

選擇性參數

--api-id

API 的識別碼。

--definition-id

API 定義的識別碼。

--ids

--resource-group -g

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

--service --service-name -s

API 中心服務的名稱。

--subscription

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

--version-id

API 版本的識別碼。

全域參數

--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 apic api definition update

更新現有的 API 定義。

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

範例

更新 API 定義

az apic api definition update -g api-center-test -s contosoeuap --api-id echo-api --version-id 2023-01-01 --definition-id "openapi" --title "OpenAPI"

選擇性參數

--add

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

--api-id

API 的識別碼。

--definition-id

API 定義的識別碼。

--description

API 定義描述。

--force-string

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

--remove

從清單中移除屬性或專案。範例：--remove property.list OR --remove 屬性ToRemove。

--resource-group -g

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

--service --service-name -s

API 中心服務的名稱。

--set

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

--subscription

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

--title

API 版本標題。

--version-id

API 版本的識別碼。

全域參數

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

Share via

az apic api definition

命令

az apic api definition create

範例

必要參數

選擇性參數

az apic api definition delete

範例

選擇性參數

az apic api definition export-specification

範例

必要參數

選擇性參數

az apic api definition import-specification

範例

選擇性參數

az apic api definition list

範例

必要參數

選擇性參數

az apic api definition show

範例

選擇性參數

az apic api definition update

範例

選擇性參數

意見反應

其他資源