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

要建立之 API 的唯一名稱。

API 修訂標識碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

--display-name

要建立之 API 的顯示名稱。

--path

API 的路徑。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--api-type

API 的類型。

接受的值: graphql, http, soap, websocket

--authorization-scope

指定 OAuth 作業範圍。

--authorization-server-id

指定 OAuth 授權伺服器識別碼。

--bearer-token-sending-methods

指定持有人令牌的傳送方法。

--description

API 的描述。可能包含 HTML 格式標記。

--no-wait

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

預設值: False

--open-id-provider-id

指定驗證設定中的 openid。

--protocols

描述可以叫用此 API 中作業的通訊協定。

接受的值: http, https, ws, wss

--service-url

實作此 API 之後端服務的絕對 URL。長度不能超過 2000 個字元。

--subscription-key-header-name

指定訂用帳戶金鑰標頭名稱。

--subscription-key-query-param-name

指定訂用帳戶金鑰查詢字串參數名稱。

--subscription-key-required

指定在呼叫此 API 期間是否需要訂用帳戶密鑰，true - API 只會包含在已關閉的產品中，false - API 會單獨包含在開放式產品中，null - 產品混合在一起。

--subscription-required

如果為 true，則 API 要求時需要訂用帳戶密鑰。

接受的值: false, true

預設值: 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 apim api delete

編輯

刪除 API 管理 API。

az apim api delete --api-id
                   --resource-group
                   --service-name
                   [--delete-revisions]
                   [--if-match]
                   [--no-wait]
                   [--yes]

必要參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--delete-revisions

刪除 Api 的所有修訂。

--if-match

實體的 ETag。

--no-wait

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

預設值: False

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

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。 Regex 模式： ^[^*#&+：<>？]+$.

--ef --export-format

指定匯出 API 的格式。

接受的值: OpenApiJsonFile, OpenApiJsonUrl, OpenApiYamlFile, OpenApiYamlUrl, SwaggerFile, SwaggerUrl, WadlFile, WadlUrl, WsdlFile, WsdlUrl

--resource-group -g

資源群組的名稱。名稱不區分大小寫。

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--file-path -f

指定匯出 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 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

必要參數

--path

必要。相對 URL 會唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

--specification-format

指定匯入的 API 格式。

接受的值: GraphQL, OpenApi, OpenApiJson, Swagger, Wadl, Wsdl

選擇性參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

--api-revision

描述 Api 的修訂。如果未提供任何值，則會建立預設修訂 1。

--api-type

API 的類型。

接受的值: graphql, http, soap, websocket

--api-version

描述 Api 的版本。如果您將版本新增至非版本設定的 API，系統會自動建立原始版本，並在預設 URL 上回應。

--api-version-set-id

描述要與 API 搭配使用的版本集。

--description

API 的描述。可能包含 HTML 格式標記。

--display-name

此 API 的顯示名稱。

--no-wait

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

預設值: False

--protocols

描述可以叫用此 API 中作業的通訊協定（一或多個通訊協定）。

接受的值: http, https, ws, wss

--service-url

實作此 API 之後端服務的絕對 URL。長度不能超過 2000 個字元。

--soap-api-type

檔案格式為 WSDL 時，API 的類型。

--specification-path

指定匯入 API 的檔案路徑。

--specification-url

指定匯入 API 的 URL。

--subscription-key-header-name

指定訂用帳戶金鑰標頭名稱。

--subscription-key-query-param-name

指定訂用帳戶金鑰查詢字串參數名稱。

--subscription-required

如果為 true，則 API 要求時需要訂用帳戶密鑰。

接受的值: false, true

--wsdl-endpoint-name

要匯入的 WSDL 連接點（連接埠）本機名稱。

--wsdl-service-name

要匯入之 WSDL 服務的本機名稱。

全域參數

--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 apim api list

編輯

列出 API 管理 API。

az apim api list --resource-group
                 --service-name
                 [--filter-display-name]
                 [--skip]
                 [--top]

必要參數

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--filter-display-name

依 displayName 篩選 API。

--skip

要略過的記錄數目。

--top

要傳回的記錄筆數。

全域參數

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

編輯

顯示 API 管理 API 的詳細數據。

az apim api show --api-id
                 --resource-group
                 --service-name

必要參數

--api-id

API 識別碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

--resource-group -g

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

--service-name

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

要建立之 API 的唯一名稱。

API 修訂標識碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--add

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

預設值: []

--api-type

API 的類型。

接受的值: graphql, http, soap, websocket

--description

API 的描述。可能包含 HTML 格式標記。

--display-name

API 名稱。長度必須為 1 到 300 個字元。

--force-string

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

預設值: False

--if-match

實體的 ETag。建立實體時不需要，但在更新實體時則為必要專案。預設值為 None。

--no-wait

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

預設值: False

--path

必要。相對 URL 可唯一識別此 API 及其 API 管理服務實例內的所有資源路徑。

--protocols

描述可以叫用此 API 中作業的通訊協定。

接受的值: http, https, ws, wss

--remove

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

預設值: []

--service-url

實作此 API 之後端服務的絕對 URL。長度不能超過 2000 個字元。

--set

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

預設值: []

--subscription-key-header-name

指定訂用帳戶金鑰標頭名稱。

--subscription-key-query-param-name

指定訂用帳戶金鑰查詢字串參數名稱。

--subscription-required

如果為 true，則 API 要求時需要訂用帳戶密鑰。

接受的值: false, true

--tags

以空格分隔的標記：key[=value] [key[=value] ...]。使用「清除現有的標記」。

全域參數

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

API 修訂標識碼。目前 API 管理服務實例中必須是唯一的。非目前的修訂具有 ;rev=n 作為後綴，其中 n 是修訂編號。必要。

--name -n

API 管理服務實例的名稱。

--resource-group -g

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

選擇性參數

--created

請等候在 'Succeeded' 使用 'provisioningState' 建立。

預設值: False

--custom

等到條件符合自定義 JMESPath 查詢為止。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到刪除為止。

預設值: False

--exists

等候資源存在。

預設值: False

--interval

輪詢間隔以秒為單位。

預設值: 30

--timeout

以秒為單位的等候上限。

預設值: 3600

--updated

等到 provisioningState 更新為 'Succeeded'。

預設值: 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 apim api

命令

az apim api create

範例

必要參數

選擇性參數

az apim api delete

必要參數

選擇性參數

az apim api export

範例

必要參數

選擇性參數

az apim api import

範例

必要參數

選擇性參數

az apim api list

必要參數

選擇性參數

az apim api show

必要參數

az apim api update

範例

必要參數

選擇性參數

az apim api wait

範例

必要參數

選擇性參數

其他資源