az apim product

  • 參考

管理 Azure API 管理 產品。

命令

名稱 Description 類型 狀態
az apim product api

管理 Azure API 管理 產品的 API。

 核心 GA
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 create

建立產品。

 核心 GA
az apim product delete

刪除產品。

 核心 GA
az apim product list

列出指定服務實例中的產品集合。

 核心 GA
az apim product show

取得其識別碼所指定產品的詳細數據。

 核心 GA
az apim product update

更新現有的產品詳細數據。

 核心 GA
az apim product wait

將 CLI 置於等候狀態，直到符合 apim 產品的條件為止。

 核心 GA

az apim product create

編輯

建立產品。

az apim product create --product-name
                       --resource-group
                       --service-name
                       [--approval-required {false, true}]
                       [--description]
                       [--legal-terms]
                       [--no-wait]
                       [--product-id]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

範例

建立產品。

az apim product create --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyProductName --description MyDescription --legal-terms MyTerms --subscription-required true --approval-required true --subscriptions-limit 8 --state "published"

必要參數

--product-name

產品名稱。

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--approval-required

是否需要訂用帳戶核准。 如果為 false，新訂閱將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能使用任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。

接受的值: false, true
--description

產品描述。 可能包含 HTML 格式標記。

--legal-terms

產品使用規定。 嘗試訂閱產品的開發人員將會先呈現，且必須接受這些條款，才能完成訂閱程式。

--no-wait

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

預設值: False
--product-id

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

--state

產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員才能看到非已發佈的產品。 Product 的默認狀態為 notPublished。 可能的值包括：『notPublished』、『published』。

接受的值: notPublished, published
--subscription-required -s

存取此產品中包含的 API 是否需要產品訂用帳戶。

接受的值: false, true
--subscriptions-limit

使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 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 product delete

編輯

刪除產品。

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

範例

刪除具有此產品所有訂用帳戶的產品。

az apim product delete --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --delete-subscriptions true

必要參數

--product-id

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

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--delete-subscriptions

刪除與產品相關聯的現有訂閱。

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

編輯

列出指定服務實例中的產品集合。

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

範例

列出此APIM實例的所有產品。

az apim product list --resource-group MyResourceGroup --service-name MyServiceName

必要參數

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

編輯

取得其識別碼所指定產品的詳細數據。

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

範例

取得其識別碼所指定產品的詳細數據。

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

az apim product update

編輯

更新現有的產品詳細數據。

az apim product update --product-id
                       --resource-group
                       --service-name
                       [--add]
                       [--approval-required {false, true}]
                       [--description]
                       [--force-string]
                       [--if-match]
                       [--legal-terms]
                       [--no-wait]
                       [--product-name]
                       [--remove]
                       [--set]
                       [--state {notPublished, published}]
                       [--subscription-required {false, true}]
                       [--subscriptions-limit]

範例

更新現有的產品詳細數據。

az apim product update --resource-group MyResourceGroup  --service-name MyServiceName --product-id MyProductID --product-name MyNewProductName --description MyNewDescription --legal-terms MyNewTerms --subscription-required false --state "notPublished"

必要參數

--product-id

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

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

--add

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

預設值: []
--approval-required

是否需要訂用帳戶核准。 如果為 false，新訂閱將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能使用任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。

接受的值: false, true
--description

產品描述。 可能包含 HTML 格式標記。

--force-string

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

預設值: False
--if-match

實體的 ETag。

--legal-terms

產品使用規定。 嘗試訂閱產品的開發人員將會先呈現，且必須接受這些條款，才能完成訂閱程式。

--no-wait

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

預設值: False
--product-name

產品名稱。

--remove

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

預設值: []
--set

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

預設值: []
--state

產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員才能看到非已發佈的產品。 Product 的默認狀態為 notPublished。 可能的值包括：『notPublished』、『published』。

接受的值: notPublished, published
--subscription-required -s

存取此產品中包含的 API 是否需要產品訂用帳戶。

接受的值: false, true
--subscriptions-limit

使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 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 product wait

編輯

將 CLI 置於等候狀態，直到符合 apim 產品的條件為止。

az apim product wait --product-id
                     --resource-group
                     --service-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

範例

將 CLI 置於等候狀態，直到符合 apim 的條件為止。 （ 自動產生 ）

az apim product wait --created --resource-group MyResourceGroup --service-name MyServiceName --product-id MyProductID

必要參數

--product-id

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

--resource-group -g

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

--service-name -n

API 管理服務實例的名稱。

選擇性參數

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