Microsoft.ApiManagement 服務/產品
Bicep 資源定義
服務/產品資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/products 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
屬性值
服務/產品
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
需要字串 () 字元限制：1-80 合法字元： 英數字元和連字號。 以字母開頭，並以英數字元結尾。 |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： service |
| properties | 產品實體合約屬性。 | ProductContractProperties |
ProductContractProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| approvalRequired | 是否需要訂用帳戶核准。 如果為 false，新的訂用帳戶將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 | bool |
| description | 產品描述。 可包含 HTML 格式標籤。 | 字串 |
| displayName | 產品名稱。 | 需要字串 () |
| 狀態 | 產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員可以看到非已發佈的產品。 Product 的默認狀態為 notPublished。 | 'notPublished' 'published' |
| subscriptionRequired | 存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true，則產品稱為「受保護」，而且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，而且可以在沒有訂用帳戶密鑰的情況下對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性，則會假設其值為 true。 | bool |
| subscriptionsLimit | 使用者是否可以同時擁有此產品的訂閱數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 | int |
| terms | 產品使用規定。 嘗試訂閱產品的開發人員將會看到且必須接受這些使用規定，才能完成訂閱程序。 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
使用範本建立 API 管理執行個體和所有子資源 |
此範本示範如何建立 API 管理 服務及設定子實體 |
| 在 Azure API 管理 前面建立 Azure Front Door |
此範例示範如何使用 Azure Front Door 作為 Azure API 管理 前面的全域負載平衡器。 |
ARM 範本資源定義
服務/產品資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/products 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
屬性值
服務/產品
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.ApiManagement/service/products' |
| apiVersion | 資源 API 版本 | '2023-05-01-preview' |
| NAME | 資源名稱 瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。 |
需要字串 () 字元限制：1-80 合法字元： 英數字元和連字號。 以字母開頭，並以英數字元結尾。 |
| properties | 產品實體合約屬性。 | ProductContractProperties |
ProductContractProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| approvalRequired | 是否需要訂用帳戶核准。 如果為 false，新的訂用帳戶將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 | bool |
| description | 產品描述。 可包含 HTML 格式標籤。 | 字串 |
| displayName | 產品名稱。 | 需要字串 () |
| 狀態 | 產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員可以看到非已發佈的產品。 Product 的默認狀態為 notPublished。 | 'notPublished' 'published' |
| subscriptionRequired | 存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true，則產品稱為「受保護」，而且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，而且可以在沒有訂用帳戶密鑰的情況下對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性，則會假設其值為 true。 | bool |
| subscriptionsLimit | 使用者是否可以同時擁有此產品的訂閱數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 | int |
| terms | 產品使用規定。 嘗試訂閱產品的開發人員將會看到且必須接受這些使用規定，才能完成訂閱程序。 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 使用範本建立 API 管理執行個體和所有子資源 |
此範本示範如何建立 API 管理 服務及設定子實體 |
| 在 Azure API 管理 前面建立 Azure Front Door |
此範例示範如何使用 Azure Front Door 作為 Azure API 管理 前面的全域負載平衡器。 |
Terraform (AzAPI 提供者) 資源定義
服務/產品資源類型可以使用目標作業進行部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/products 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
屬性值
服務/產品
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/products@2023-05-01-preview” |
| NAME | 資源名稱 | 需要字串 () 字元限制：1-80 合法字元： 英數字元和連字號。 以字母開頭，並以英數字元結尾。 |
| parent_id | 此資源父系之資源的標識碼。 | 類型資源的標識碼： 服務 |
| properties | 產品實體合約屬性。 | ProductContractProperties |
ProductContractProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| approvalRequired | 是否需要訂用帳戶核准。 如果為 false，新的訂用帳戶將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 | bool |
| description | 產品描述。 可包含 HTML 格式標籤。 | 字串 |
| displayName | 產品名稱。 | 字串 (必要) |
| 狀態 | 是否發佈產品。 開發人員入口網站的使用者可探索已發佈的產品。 只有系統管理員可以看到未發行的產品。 Product 的默認狀態為 notPublished。 | “notPublished” “published” |
| subscriptionRequired | 是否需要產品訂用帳戶才能存取此產品中包含的API。 如果為 true，則產品稱為「受保護」，且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，而且可以在沒有訂用帳戶密鑰的情況下對產品中包含的 API 提出要求。 如果建立新產品時省略 屬性，則會假設其值為 true。 | bool |
| subscriptionsLimit | 使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許每個使用者訂用帳戶無限制。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 | int |
| terms | 產品使用規定。 嘗試訂閱產品的開發人員將會看到且必須接受這些使用規定，才能完成訂閱程序。 | 字串 |
意見反應
即將登場：在 2024 年，我們將逐步淘汰 GitHub 問題作為內容的意見反應機制，並將它取代為新的意見反應系統。 如需詳細資訊，請參閱：https://aka.ms/ContentUserFeedback。
提交並檢視相關的意見反應