az apic

Note

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

管理 Azure API 中心服務。

命令

名稱	Description	類型	狀態
az apic api	在 API 中心管理 API 的命令。	Extension	GA
az apic api-analysis	管理 Azure API 中心服務 API 分析功能。	Extension	Preview
az apic api-analysis create	建立新的或更新現有的 API 分析器組態。	Extension	Preview
az apic api-analysis delete	刪除會刪除 API 分析器組態。	Extension	Preview
az apic api-analysis export-ruleset	匯出 API 分析器規則集。	Extension	Preview
az apic api-analysis import-ruleset	匯入 API 分析器規則集。	Extension	Preview
az apic api-analysis list	列出 API 分析器組態。	Extension	Preview
az apic api-analysis show	取得 API 分析器設定的詳細數據。	Extension	Preview
az apic api-analysis update	更新新的或更新現有的 API 分析器組態。	Extension	Preview
az apic api create	註冊新的 API 或更新現有的 API。	Extension	GA
az apic api definition	在 API 中心管理 API 定義的命令。	Extension	GA
az apic api definition create	建立新的 API 定義或更新現有的 API 定義。	Extension	GA
az apic api definition delete	刪除指定的 API 定義。	Extension	GA
az apic api definition export-specification	匯出 API 規格。	Extension	GA
az apic api definition import-specification	匯入 API 規格。	Extension	GA
az apic api definition list	列出 API 定義的集合。	Extension	GA
az apic api definition show	取得 API 定義的詳細數據。	Extension	GA
az apic api definition update	更新現有的 API 定義。	Extension	GA
az apic api delete	刪除指定的 API。	Extension	GA
az apic api deployment	在 API 中心管理 API 部署的命令。	Extension	GA
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 list	列出 API 的集合。	Extension	GA
az apic api register	使用規格檔案作為事實來源，向版本、定義和相關聯的部署註冊新的 API。 目前我們只支援 OpenAPI JSON/YAML 格式。	Extension	Preview
az apic api show	取得 API 的詳細數據。	Extension	GA
az apic api update	更新現有的 API。	Extension	GA
az apic api version	在 API 中心管理 API 版本的命令。	Extension	GA
az apic api version create	建立新的 API 版本或更新現有的 API 版本。	Extension	GA
az apic api version delete	刪除指定的 API 版本。	Extension	GA
az apic api version list	列出 API 版本的集合。	Extension	GA
az apic api version show	取得 API 版本的詳細數據。	Extension	GA
az apic api version update	更新現有的 API 版本。	Extension	GA
az apic create	建立實例或更新 Azure API 中心服務的現有實例。	Extension	GA
az apic delete	刪除 Azure API 中心服務的實例。	Extension	GA
az apic environment	在 API 中心管理環境的命令。	Extension	GA
az apic environment create	建立新的環境或更新現有的環境。	Extension	GA
az apic environment delete	刪除環境。	Extension	GA
az apic environment list	列出環境的集合。	Extension	GA
az apic environment show	取得環境的詳細數據。	Extension	GA
az apic environment update	更新現有的環境。	Extension	GA
az apic integration	管理 Azure API 中心中的整合。	Extension	GA
az apic integration create	管理 Azure API 中心服務。	Extension	GA
az apic integration create apim	將 Azure APIM 新增為 API 來源。	Extension	GA
az apic integration create aws	將 Amazon API 閘道新增為 API 來源。	Extension	GA
az apic integration delete	刪除指定的 API 來源。	Extension	GA
az apic integration list	列出 API 來源的集合。	Extension	GA
az apic integration show	取得 API 來源的詳細數據。	Extension	GA
az apic list	列出 Azure 訂用帳戶內的 Azure API 中心服務。	Extension	GA
az apic metadata	在 API 中心管理元數據架構的命令。	Extension	GA
az apic metadata create	建立新的元數據架構或更新現有的元數據架構。	Extension	GA
az apic metadata delete	刪除指定的元數據架構。	Extension	GA
az apic metadata export	匯出元數據架構。	Extension	GA
az apic metadata list	列出元數據架構的集合。	Extension	GA
az apic metadata show	取得元數據架構的詳細數據。	Extension	GA
az apic metadata update	更新現有的元數據架構。	Extension	GA
az apic show	顯示 Azure API 中心服務實例的詳細數據。	Extension	GA
az apic update	更新 Azure API 中心服務的實例。	Extension	GA

az apic create

建立實例或更新 Azure API 中心服務的現有實例。

az apic create --name
               --resource-group
               [--identity]
               [--location]
               [--tags]

範例

建立服務範例

az apic create -g contoso-resources -n contoso -l eastus

使用系統指派的身分識別範例建立服務

az apic create -g contoso-resources -n contoso -l eastus --identity '{type:systemassigned}'

必要參數

--name -n

API 中心服務的名稱。

--resource-group -g

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

選擇性參數

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

--identity

指派給此資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--location -l

未指定資源所在的地理位置，將會使用資源群組的位置。

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

全域參數

--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 delete

刪除 Azure API 中心服務的實例。

az apic delete [--ids]
               [--name]
               [--resource-group]
               [--subscription]
               [--yes]

範例

刪除服務

az apic delete -n contoso -g contoso-resources

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name -n

API 中心服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	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 list

列出 Azure 訂用帳戶內的 Azure API 中心服務。

有一個已知問題，列出訂用帳戶下的所有資源無法運作。 請依資源群組列出資源。

az apic list [--max-items]
             [--next-token]
             [--resource-group]

範例

列出資源群組中的服務

az apic list -g contoso-resources

選擇性參數

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

--max-items

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

屬性	值
參數群組:	Pagination Arguments

--next-token

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

屬性	值
參數群組:	Pagination Arguments

--resource-group -g

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

全域參數

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

顯示 Azure API 中心服務實例的詳細數據。

az apic show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

範例

顯示服務詳細數據

az apic show -g contoso-resources -n contoso

選擇性參數

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

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name -n

API 中心服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--resource-group -g

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

屬性	值
參數群組:	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 update

更新 Azure API 中心服務的實例。

az apic update [--add]
               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
               [--identity]
               [--ids]
               [--name]
               [--remove]
               [--resource-group]
               [--set]
               [--subscription]
               [--tags]

範例

更新服務詳細數據

az apic update -g contoso-resources -n contoso

使用系統指派的身分識別範例更新服務

az apic update -g contoso-resources -n contoso --identity '{type:systemassigned}'

選擇性參數

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

--add

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

屬性	值
參數群組:	Generic Update Arguments

--force-string

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

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

--identity

指派給此資源的受控服務識別。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

--ids

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

屬性	值
參數群組:	Resource Id Arguments

--name -n

API 中心服務的名稱。

屬性	值
參數群組:	Resource Id Arguments

--remove

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

屬性	值
參數群組:	Generic Update Arguments

--resource-group -g

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

屬性	值
參數群組:	Resource Id Arguments

--set

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

屬性	值
參數群組:	Generic Update Arguments

--subscription

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

屬性	值
參數群組:	Resource Id Arguments

--tags

資源標籤。 支援速記語法、json-file 和 yaml-file。 請嘗試 “？？” 以顯示更多。

全域參數

--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