az apim product api

  • 參考

管理 Azure API 管理產品的 API。

命令

名稱 Description 類型 狀態
az apim product api add

將 API 新增至指定的產品。

 核心 GA
az apim product api check

檢查識別碼所指定的 API 實體是否與 Product 實體相關聯。

 核心 GA
az apim product api delete

從指定的產品中刪除指定的 API。

 核心 GA
az apim product api list

列出與產品相關聯的 API 集合。

 核心 GA

az apim product api add

編輯

將 API 新增至指定的產品。

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name

範例

將 API 新增至指定的產品。

az apim product api add --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必要參數

--api-id

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

--product-id

產品識別碼。 在目前API 管理服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

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 product api check

編輯

檢查識別碼所指定的 API 實體是否與 Product 實體相關聯。

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name

範例

檢查 API 是否與產品相關聯。

az apim product api check --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必要參數

--api-id

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

--product-id

產品識別碼。 在目前API 管理服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

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

編輯

從指定的產品中刪除指定的 API。

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name

範例

從指定的產品中刪除指定的 API。

az apim product api delete --resource-group MyResourceGroup --service-name MyServiceName  --product-id MyProductID --api-id MyAPIID

必要參數

--api-id

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

--product-id

產品識別碼。 在目前API 管理服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

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

編輯

列出與產品相關聯的 API 集合。

az apim product api list --product-id
                         --resource-group
                         --service-name

範例

列出與產品相關聯的所有 API。

az apim product api list --resource-group MyResourceGroup  --service-name MyServiceName  --product-id MyProductID

必要參數

--product-id

產品識別碼。 在目前API 管理服務實例中必須是唯一的。

--resource-group -g

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

--service-name -n

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