通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.ApiManagement 服务/产品 2022-08-01

  • 项目

Bicep 资源定义

可以使用目标操作部署服务/产品资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/products 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ApiManagement/service/products@2022-08-01' = {
  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 （必需）
州 产品是否发布。 已发布的产品可由开发人员门户的用户发现。 非已发布产品仅对管理员可见。 产品的默认状态未发布。 “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": "2022-08-01",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

属性值

Microsoft.ApiManagement/service/products

名字 描述 价值
apiVersion API 版本 '2022-08-01'
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
性能 产品实体协定属性。 ProductContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/products”

ProductContractProperties

名字 描述 价值
approvalRequired 是否需要订阅审批。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，则管理员必须先手动批准订阅，然后开发人员才能使用任何产品的 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。 bool
描述 产品说明。 可能包括 HTML 格式标记。 字符串

约束：
最大长度 =
displayName 产品名称。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
州 产品是否发布。 已发布的产品可由开发人员门户的用户发现。 非已发布产品仅对管理员可见。 产品的默认状态未发布。 “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@2022-08-01"
  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 此资源的父资源的 ID。 类型资源的 ID：服务
性能 产品实体协定属性。 ProductContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/products@2022-08-01”

ProductContractProperties

名字 描述 价值
approvalRequired 是否需要订阅审批。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，则管理员必须先手动批准订阅，然后开发人员才能使用任何产品的 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。 bool
描述 产品说明。 可能包括 HTML 格式标记。 字符串

约束：
最大长度 =
displayName 产品名称。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
州 产品是否发布。 已发布的产品可由开发人员门户的用户发现。 非已发布产品仅对管理员可见。 产品的默认状态未发布。 “notPublished”
“published”
subscriptionRequired 访问此产品中包含的 API 是否需要产品订阅。 如果为 true，则产品称为“受保护”，并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false，则产品称为“打开”，并且可以在没有订阅密钥的情况下向产品中包含的 API 发出请求。 如果在创建新产品时省略属性，则假定其值为 true。 bool
subscriptionsLimit 用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许每个用户订阅不受限制。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。 int
条款 产品使用条款。 尝试订阅产品的开发人员将呈现并要求他们接受这些条款，然后才能完成订阅过程。 字符串