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

ProductUpdateParameters interface

包:

@azure/arm-apimanagement

产品更新参数。

属性

approvalRequired	是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，则管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
description	产品说明。 可以包含 HTML 格式标记。
displayName	产品名称。
state	是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。
subscriptionRequired	访问此产品中包含的 API 是否需要产品订阅。 如果为 true，则产品称为“受保护”，并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false，则产品称为“打开”，并且无需订阅密钥即可对产品中包含的 API 发出请求。 如果在创建新产品时省略属性，则假定其值为 true。
subscriptionsLimit	用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许无限制的每个用户订阅。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。
terms	产品使用条款。 当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。

属性详细信息

approvalRequired

是否需要订阅批准。 如果为 false，则新订阅将自动获得批准，使开发人员能够在订阅后立即调用产品的 API。 如果为 true，则管理员必须先手动批准订阅，然后开发人员才能使用产品的任何 API。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。

approvalRequired?: boolean

属性值

boolean

description

产品说明。 可以包含 HTML 格式标记。

description?: string

属性值

string

displayName

产品名称。

displayName?: string

属性值

string

state

是否发布产品。 开发人员门户的用户可发现已发布的产品。 未发布的产品仅对管理员可见。 产品的默认状态为 NotPublished。

state?: ProductState

属性值

ProductState

subscriptionRequired

访问此产品中包含的 API 是否需要产品订阅。 如果为 true，则产品称为“受保护”，并且需要有效的订阅密钥才能成功请求产品中包含的 API。 如果为 false，则产品称为“打开”，并且无需订阅密钥即可对产品中包含的 API 发出请求。 如果在创建新产品时省略属性，则假定其值为 true。

subscriptionRequired?: boolean

属性值

boolean

subscriptionsLimit

用户是否可以同时拥有此产品的订阅数。 设置为 null 或省略以允许无限制的每个用户订阅。 仅当 subscriptionRequired 属性存在且值为 false 时，才能存在。

subscriptionsLimit?: number

属性值

number

terms

产品使用条款。 当开发人员尝试订阅此产品时，系统会显示这些条款，开发人员需接受这些条款才能完成订阅过程。

terms?: string

属性值

string