az apim product api

Manage Azure API 管理 Product's APIS.

命令

名稱	Description	類型	狀態
az apim product api add	將 API 新增至指定的產品。	Core	GA
az apim product api check	檢查標識子所指定的 API 實體是否與 Product 實體相關聯。	Core	GA
az apim product api delete	從指定的產品中刪除指定的 API。	Core	GA
az apim product api list	列出與產品相關聯的 API 集合。	Core	GA

az apim product api add

將 API 新增至指定的產品。

az apim product api add --api-id
                        --product-id
                        --resource-group
                        --service-name
                        [--acquire-policy-token]
                        [--change-reference]

範例

將 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 是修訂編號。

屬性	值
參數群組:	API Arguments

--product-id

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

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

全域參數

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

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

az apim product api check --api-id
                          --product-id
                          --resource-group
                          --service-name
                          [--acquire-policy-token]
                          [--change-reference]

範例

檢查 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 是修訂編號。

屬性	值
參數群組:	API Arguments

--product-id

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

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

全域參數

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

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

az apim product api delete --api-id
                           --product-id
                           --resource-group
                           --service-name
                           [--acquire-policy-token]
                           [--change-reference]

範例

從指定的產品中刪除指定的 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 是修訂編號。

屬性	值
參數群組:	API Arguments

--product-id

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

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

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

--acquire-policy-token

自動取得 Azure 原則 令牌以進行此資源操作。

屬性	值
參數群組:	Global Policy Arguments

--change-reference

相關變更的 ID 是為此資源操作所參考的。

屬性	值
參數群組:	Global Policy Arguments

全域參數

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

提高日誌詳細程度以顯示所有調試日誌。

屬性	值
預設值:	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