ProductContract interface

包:

@azure/arm-apimanagement

产品详细信息。

扩展

ProxyResource

属性

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

继承属性

id	资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。
name	资源说明的名称：此属性不会序列化。 它只能由服务器填充。
type	资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

approvalRequired

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

approvalRequired?: boolean

属性值

boolean

description

产品说明。 可能包括 HTML 格式标记。

description?: string

属性值

string

displayName

产品名称。

displayName?: string

属性值

string

state

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

state?: ProductState

属性值

ProductState

subscriptionRequired

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

subscriptionRequired?: boolean

属性值

boolean

subscriptionsLimit

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

subscriptionsLimit?: number

属性值

number

terms

产品使用条款。 尝试订阅产品的开发人员将呈现并要求他们接受这些条款，然后才能完成订阅过程。

terms?: string

属性值

string

继承属性详细信息

id

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自 ProxyResource.id 的

name

资源说明的名称：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自 ProxyResource.name 的

type

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ProxyResource.type