共用方式為

Microsoft.ApiManagement 服務/產品 2024-06-01-preview

  • 發行項

Bicep 資源定義

服務/產品資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/products 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.ApiManagement/service/products@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

屬性值

Microsoft.ApiManagement/service/products

名字 描述 價值
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
父母 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型的資源符號名稱：服務
性能 產品實體合約屬性。 ProductContractProperties

ProductContractProperties

名字 描述 價值
approvalRequired 是否需要訂用帳戶核准。 如果為 false，新訂閱將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 bool
描述 產品描述。 可能包含 HTML 格式標記。 字串

約束：
最大長度 =
displayName 產品名稱。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
州 產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員才能看到非已發佈的產品。 Product 的默認狀態為 notPublished。 'notPublished'
'published'
subscriptionRequired 存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true，則產品稱為「受保護」，而且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，且不需要訂用帳戶密鑰即可對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性，則會假設其值為 true。 bool
subscriptionsLimit 使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 int
條款 產品使用規定。 嘗試訂閱產品的開發人員將會先呈現，且必須接受這些條款，才能完成訂閱程式。 字串

ARM 樣本資源定義

服務/產品資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/products 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2024-06-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 版本 '2024-06-01-preview'
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
性能 產品實體合約屬性。 ProductContractProperties
類型 資源類型 'Microsoft.ApiManagement/service/products'

ProductContractProperties

名字 描述 價值
approvalRequired 是否需要訂用帳戶核准。 如果為 false，新訂閱將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 bool
描述 產品描述。 可能包含 HTML 格式標記。 字串

約束：
最大長度 =
displayName 產品名稱。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
州 產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員才能看到非已發佈的產品。 Product 的默認狀態為 notPublished。 'notPublished'
'published'
subscriptionRequired 存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true，則產品稱為「受保護」，而且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，且不需要訂用帳戶密鑰即可對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性，則會假設其值為 true。 bool
subscriptionsLimit 使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 int
條款 產品使用規定。 嘗試訂閱產品的開發人員將會先呈現，且必須接受這些條款，才能完成訂閱程式。 字串

Terraform （AzAPI 提供者） 資源定義

服務/產品資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/products 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2024-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

屬性值

Microsoft.ApiManagement/service/products

名字 描述 價值
名字 資源名稱 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼：服務
性能 產品實體合約屬性。 ProductContractProperties
類型 資源類型 “Microsoft.ApiManagement/service/products@2024-06-01-preview”

ProductContractProperties

名字 描述 價值
approvalRequired 是否需要訂用帳戶核准。 如果為 false，新訂閱將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 bool
描述 產品描述。 可能包含 HTML 格式標記。 字串

約束：
最大長度 =
displayName 產品名稱。 字串

約束：
最小長度 = 1
最大長度 = 1 （必要）
州 產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員才能看到非已發佈的產品。 Product 的默認狀態為 notPublished。 'notPublished'
'published'
subscriptionRequired 存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true，則產品稱為「受保護」，而且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，且不需要訂用帳戶密鑰即可對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性，則會假設其值為 true。 bool
subscriptionsLimit 使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。 int
條款 產品使用規定。 嘗試訂閱產品的開發人員將會先呈現，且必須接受這些條款，才能完成訂閱程式。 字串