az apim api
管理 Azure API 管理 API。
命令
| 名稱 | Description | 類型 | 狀態 |
|---|---|---|---|
| az apim api create |
建立 API 管理 API。 |
核心 | GA |
| az apim api delete |
刪除 API 管理 API。 |
核心 | GA |
| az apim api export |
匯出 API 管理 API。 |
核心 | GA |
| az apim api import |
匯入 API 管理 API。 |
核心 | GA |
| az apim api list |
列出 API 管理 API。 |
核心 | GA |
| az apim api operation |
管理 Azure API 管理 API 作業。 |
核心 | GA |
| az apim api operation create |
在 API 中建立新的作業。 |
核心 | GA |
| az apim api operation delete |
刪除 API 中指定的作業。 |
核心 | GA |
| az apim api operation list |
列出指定 API 之作業的集合。 |
核心 | GA |
| az apim api operation show |
取得其識別碼所指定的 API 作業詳細數據。 |
核心 | GA |
| az apim api operation update |
更新 其識別碼所指定 API 中作業的詳細數據。 |
核心 | GA |
| az apim api release |
管理 Azure API 管理 API 版本。 |
核心 | GA |
| az apim api release create |
建立 API 的新版本。 |
核心 | GA |
| az apim api release delete |
刪除 API 中指定的版本。 |
核心 | GA |
| az apim api release list |
列出 API 的所有版本。 |
核心 | GA |
| az apim api release show |
傳回 API 版本的詳細數據。 |
核心 | GA |
| az apim api release update |
更新 其識別碼所指定 API 版本的詳細數據。 |
核心 | GA |
| az apim api revision |
管理 Azure API 管理 API 修訂。 |
核心 | GA |
| az apim api revision create |
建立 API 修訂。 |
核心 | GA |
| az apim api revision list |
列出 API 的所有修訂。 |
核心 | GA |
| az apim api schema |
管理 Azure API 管理 API 架構。 |
核心 | GA |
| az apim api schema create |
建立 API 管理 API 架構。 |
核心 | GA |
| az apim api schema delete |
刪除 API 管理 API 架構。 |
核心 | GA |
| az apim api schema get-etag |
取得 API 管理 API 架構的 etag。 |
核心 | GA |
| az apim api schema list |
列出 API 架構 API 管理。 |
核心 | GA |
| az apim api schema show |
顯示 API 管理 API 架構的詳細數據。 |
核心 | GA |
| az apim api schema wait |
將 CLI 置於等候狀態，直到符合 apim API 架構的條件為止。 |
核心 | GA |
| az apim api show |
顯示 API 管理 API 的詳細數據。 |
核心 | GA |
| az apim api update |
更新 API 管理 API。 |
核心 | GA |
| az apim api versionset |
管理 Azure API 管理 API 版本集。 |
核心 | GA |
| az apim api versionset create |
建立 Api 版本集。 |
核心 | GA |
| az apim api versionset delete |
刪除特定的 Api 版本集。 |
核心 | GA |
| az apim api versionset list |
列出指定服務實例中的 API 版本集合。 |
核心 | GA |
| az apim api versionset show |
取得其標識碼所指定的 Api 版本集合詳細數據。 |
核心 | GA |
| az apim api versionset update |
更新 其識別碼所指定的 Api VersionSet 詳細數據。 |
核心 | GA |
| az apim api wait |
將 CLI 置於等候狀態，直到符合 apim API 的條件為止。 |
核心 | GA |
az apim api create
建立 API 管理 API。
az apim api create --api-id
--display-name
--path
--resource-group
--service-name
[--api-type {graphql, http, soap, websocket}]
[--authorization-scope]
[--authorization-server-id]
[--bearer-token-sending-methods]
[--description]
[--no-wait]
[--open-id-provider-id]
[--protocols {http, https, ws, wss}]
[--service-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-key-required]
[--subscription-required {false, true}]範例
建立基本 API。
az apim api create --service-name MyApim -g MyResourceGroup --api-id MyApi --path '/myapi' --display-name 'My API'必要參數
要建立之 API 的唯一名稱。
API 修訂標識碼。 目前 API 管理 服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
要建立之 API 的顯示名稱。
API 的路徑。
資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。
API 管理 服務實例的名稱。
選擇性參數
API 的類型。
指定 OAuth 作業範圍。
指定 OAuth 授權伺服器識別碼。
指定持有人令牌的傳送方法。
API 的描述。 可能包含 HTML 格式標記。
請勿等候長時間執行的作業完成。
指定驗證設定中的 openid。
描述可以叫用此 API 中作業的通訊協定。
實作此 API 之後端服務的絕對 URL。 長度不能超過 2000 個字元。
指定訂用帳戶金鑰標頭名稱。
指定訂用帳戶金鑰查詢字串參數名稱。
指定在呼叫此 API 期間是否需要訂用帳戶密鑰，true - API 只會包含在已關閉的產品中，false - API 會單獨包含在開放式產品中，null - 產品混合在一起。
如果為 true，則 API 要求時需要訂用帳戶密鑰。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az apim api delete
刪除 API 管理 API。
az apim api delete --api-id
--resource-group
--service-name
[--delete-revisions]
[--if-match]
[--no-wait]
[--yes]必要參數
API 識別碼。 目前 API 管理 服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。
API 管理 服務實例的名稱。
選擇性參數
刪除 Api 的所有修訂。
實體的 ETag。
請勿等候長時間執行的作業完成。
不提示確認。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az apim api export
匯出 API 管理 API。
az apim api export --api-id
--ef {OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl}
--resource-group
--service-name
[--file-path]範例
將 API 管理 API 匯出至檔案，或傳回包含匯出連結的回應。
az apim api export -g MyResourceGroup --service-name MyApim --api-id MyApi --export-format OpenApiJson --file-path path必要參數
API 識別碼。 目前 API 管理 服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。 Regex 模式： ^[^*#&+：<>？]+$.
指定匯出 API 的格式。
資源群組的名稱。 名稱不區分大小寫。
API 管理服務實例的名稱。
選擇性參數
指定匯出 API 的檔案路徑。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az apim api import
匯入 API 管理 API。
az apim api import --path
--resource-group
--service-name
--specification-format {GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl}
[--api-id]
[--api-revision]
[--api-type {graphql, http, soap, websocket}]
[--api-version]
[--api-version-set-id]
[--description]
[--display-name]
[--no-wait]
[--protocols {http, https, ws, wss}]
[--service-url]
[--soap-api-type]
[--specification-path]
[--specification-url]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--wsdl-endpoint-name]
[--wsdl-service-name]範例
從檔案或 URL 匯入 API 管理 API
az apim api import -g MyResourceGroup --service-name MyApim --path MyApi --specification-url https://MySpecificationURL --specification-format OpenApiJson必要參數
必要。 相對 URL 會唯一識別此 API 及其 API 管理 服務實例內的所有資源路徑。
資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。
API 管理服務實例的名稱。
指定匯入的 API 格式。
選擇性參數
API 識別碼。 目前 API 管理 服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
描述 Api 的修訂。 如果未提供任何值，則會建立預設修訂 1。
API 的類型。
描述 Api 的版本。 如果您將版本新增至非版本設定的 API，系統會自動建立原始版本，並在預設 URL 上回應。
描述要與 API 搭配使用的版本集。
API 的描述。 可能包含 HTML 格式標記。
此 API 的顯示名稱。
請勿等候長時間執行的作業完成。
描述可以叫用此 API 中作業的通訊協定（一或多個通訊協定）。
實作此 API 之後端服務的絕對 URL。 長度不能超過 2000 個字元。
檔案格式為 WSDL 時，API 的類型。
指定匯入 API 的檔案路徑。
指定匯入 API 的 URL。
指定訂用帳戶金鑰標頭名稱。
指定訂用帳戶金鑰查詢字串參數名稱。
如果為 true，則 API 要求時需要訂用帳戶密鑰。
要匯入的 WSDL 連接點 （連接埠） 本機名稱。
要匯入之 WSDL 服務的本機名稱。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az apim api list
列出 API 管理 API。
az apim api list --resource-group
--service-name
[--filter-display-name]
[--skip]
[--top]必要參數
資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。
API 管理 服務實例的名稱。
選擇性參數
依 displayName 篩選 API。
要略過的記錄數目。
要傳回的記錄筆數。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az apim api show
顯示 API 管理 API 的詳細數據。
az apim api show --api-id
--resource-group
--service-name必要參數
API 識別碼。 目前 API 管理 服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。
API 管理 服務實例的名稱。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az apim api update
更新 API 管理 API。
az apim api update --api-id
--resource-group
--service-name
[--add]
[--api-type {graphql, http, soap, websocket}]
[--description]
[--display-name]
[--force-string]
[--if-match]
[--no-wait]
[--path]
[--protocols {http, https, ws, wss}]
[--remove]
[--service-url]
[--set]
[--subscription-key-header-name]
[--subscription-key-query-param-name]
[--subscription-required {false, true}]
[--tags]範例
建立基本 API。
az apim api update --service-name MyApim -g MyResourceGroup --api-id MyApi --description foo必要參數
要建立之 API 的唯一名稱。
API 修訂標識碼。 目前 API 管理 服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。
資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。
API 管理 服務實例的名稱。
選擇性參數
藉由指定路徑和索引鍵值組，將物件加入物件清單。 範例：--add property.listProperty <key=value, string or JSON string>。
API 的類型。
API 的描述。 可能包含 HTML 格式標記。
API 名稱。 長度必須為 1 到 300 個字元。
使用 'set' 或 'add' 時，請保留字串常值，而不是嘗試轉換成 JSON。
實體的 ETag。 建立實體時不需要，但在更新實體時則為必要專案。 預設值為 None。
請勿等候長時間執行的作業完成。
必要。 相對 URL 可唯一識別此 API 及其 API 管理 服務實例內的所有資源路徑。
描述可以叫用此 API 中作業的通訊協定。
從清單中移除屬性或專案。 範例： --remove property.list <indexToRemove> 或 --remove propertyToRemove。
實作此 API 之後端服務的絕對 URL。 長度不能超過 2000 個字元。
指定要設定的屬性路徑和值，以更新物件。 範例：--set property1.property2=<value>。
指定訂用帳戶金鑰標頭名稱。
指定訂用帳戶金鑰查詢字串參數名稱。
如果為 true，則 API 要求時需要訂用帳戶密鑰。
以空格分隔的標記：key[=value] [key[=value] ...]。使用 「清除現有的標記」。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
az apim api wait
將 CLI 置於等候狀態，直到符合 apim API 的條件為止。
az apim api wait --api-id
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]範例
將 CLI 置於等候狀態，直到符合 apim API 的條件為止。 （ 自動產生 ）
az apim api wait --created --api-id MyApi --name MyApim --resource-group MyResourceGroup必要參數
API 修訂標識碼。 目前 API 管理 服務實例中必須是唯一的。 非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。 必要。
API 管理服務實例的名稱。
資源群組的名稱。 您可以使用 az configure --defaults group=<name> 來設定預設群組。
選擇性參數
請等候在 'Succeeded' 使用 'provisioningState' 建立。
等到條件符合自定義 JMESPath 查詢為止。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。
等到刪除為止。
等候資源存在。
輪詢間隔以秒為單位。
以秒為單位的等候上限。
等到 provisioningState 更新為 'Succeeded'。
全域參數
增加記錄詳細資訊，以顯示所有偵錯記錄。
顯示此說明訊息並結束。
只顯示錯誤，隱藏警告。
輸出格式。
JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。
訂用帳戶的名稱或識別碼。 您可以使用 來設定預設訂用 az account set -s NAME_OR_ID帳戶。
增加記錄詳細資訊。 使用 --debug 來取得完整偵錯記錄。
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應