你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement service/products 2021-08-01
Bicep 资源定义
可以使用面向以下操作部署服务/产品资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/products 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/products@2021-08-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
属性值
service/products
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为：service 的资源的符号名称 |
| properties | 产品实体协定属性。 | ProductContractProperties |
ProductContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| approvalRequired | 是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。 | bool |
| description | 产品说明。 可以包含 HTML 格式标记。 | 字符串 |
| displayName | 产品名称。 | 字符串 (必需) |
| state | 是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 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 API 管理前面使用 Azure Front Door 作为全局负载均衡器。 |
ARM 模板资源定义
可以使用面向以下操作部署服务/产品资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/products 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/products",
"apiVersion": "2021-08-01",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
属性值
service/products
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/products” |
| apiVersion | 资源 API 版本 | '2021-08-01' |
| name | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| properties | 产品实体协定属性。 | ProductContractProperties |
ProductContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| approvalRequired | 是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。 | bool |
| description | 产品说明。 可以包含 HTML 格式标记。 | 字符串 |
| displayName | 产品名称。 | 字符串 (必需) |
| state | 是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 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 API 管理前面使用 Azure Front Door 作为全局负载均衡器。 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署服务/产品资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/products 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/products@2021-08-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
属性值
service/products
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/products@2021-08-01” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| parent_id | 此资源的父资源的 ID。 | 类型为：service 的资源的 ID |
| properties | 产品实体协定属性。 | ProductContractProperties |
ProductContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| approvalRequired | 是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，则管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。 | bool |
| description | 产品说明。 可以包含 HTML 格式标记。 | 字符串 |
| displayName | 产品名称。 | 字符串 (必需) |
| state | 产品是否已发布。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态未发布。 | “notPublished” “已发布” |
| subscriptionRequired | 访问此产品中包含的 API 是否需要产品订阅。 如果为 true，则产品称为“protected”，并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false，则产品称为“打开”，并且无需订阅密钥即可对产品中包含的 API 发出请求。 如果在创建新产品时省略属性，则假定其值为 true。 | bool |
| subscriptionsLimit | 用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许每个用户订阅不受限制。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。 | int |
| terms | 产品使用条款。 当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。 | 字符串 |