ProductUpdateProperties interface

套件:

@azure/arm-apimanagement

提供給更新產品作業的參數。

Extends

ProductEntityBaseParameters

屬性

displayName

產品名稱。

繼承的屬性

approvalRequired	是否需要訂用帳戶核准。 如果為 false，新訂閱將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。
description	產品描述。 可能包含 HTML 格式標記。
state	產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員才能看到非已發佈的產品。 Product 的默認狀態為 notPublished。
subscriptionRequired	存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true，則產品稱為「受保護」，而且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，且不需要訂用帳戶密鑰即可對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性，則會假設其值為 true。
subscriptionsLimit	使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。
terms	產品使用規定。 嘗試訂閱產品的開發人員將會先呈現，且必須接受這些條款，才能完成訂閱程式。

屬性詳細資料

displayName

產品名稱。

displayName?: string

屬性值

string

繼承的屬性詳細資料

approvalRequired

是否需要訂用帳戶核准。 如果為 false，新訂閱將會自動核准，讓開發人員在訂閱之後立即呼叫產品的 API。 如果為 true，系統管理員必須先手動核准訂用帳戶，開發人員才能取得任何產品的 API。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。

approvalRequired?: boolean

屬性值

boolean

繼承自ProductEntityBaseParameters.approvalRequired

description

產品描述。 可能包含 HTML 格式標記。

description?: string

屬性值

string

繼承自ProductEntityBaseParameters.description

state

產品是否發佈。 開發人員入口網站的使用者可以探索已發佈的產品。 只有系統管理員才能看到非已發佈的產品。 Product 的默認狀態為 notPublished。

state?: ProductState

屬性值

ProductState

繼承自ProductEntityBaseParameters.state

subscriptionRequired

存取此產品中包含的 API 是否需要產品訂用帳戶。 如果為 true，則產品稱為「受保護」，而且需要有效的訂用帳戶密鑰，才能成功要求產品中包含的 API。 如果為 false，則產品稱為「開啟」，且不需要訂用帳戶密鑰即可對產品中包含的 API 提出要求。 如果在建立新產品時省略 屬性，則會假設其值為 true。

subscriptionRequired?: boolean

屬性值

boolean

繼承自ProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

使用者是否可以同時擁有此產品的訂用帳戶數目。 設定為 null 或省略 ，以允許無限制的每個使用者訂用帳戶。 只有在 subscriptionRequired 屬性存在且值為 false 時，才能存在。

subscriptionsLimit?: number

屬性值

number

繼承自ProductEntityBaseParameters.subscriptionsLimit

terms

產品使用規定。 嘗試訂閱產品的開發人員將會先呈現，且必須接受這些條款，才能完成訂閱程式。

terms?: string

屬性值

string

繼承自ProductEntityBaseParameters.terms