SubscriptionUpdateParameters interface

套件:

@azure/arm-apimanagement

訂閱更新詳細數據。

屬性

allowTracing	判斷是否可以啟用追蹤
displayName	訂用帳戶名稱。
expirationDate	訂閱到期日。 此設定僅供稽核之用，且訂用帳戶不會自動過期。 您可以使用 state 屬性來管理訂用帳戶生命週期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
ownerId	用戶標識碼路徑：/users/{userId}
primaryKey	主要訂用帳戶金鑰。
scope	範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}
secondaryKey	次要訂用帳戶金鑰。
state	訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。
stateComment	描述當狀態變更為「已拒絕」狀態時，系統管理員所描述訂閱狀態變更的批注。

屬性詳細資料

allowTracing

判斷是否可以啟用追蹤

allowTracing?: boolean

屬性值

boolean

displayName

訂用帳戶名稱。

displayName?: string

屬性值

string

expirationDate

訂閱到期日。 此設定僅供稽核之用，且訂用帳戶不會自動過期。 您可以使用 state 屬性來管理訂用帳戶生命週期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。

expirationDate?: Date

屬性值

Date

ownerId

用戶標識碼路徑：/users/{userId}

ownerId?: string

屬性值

string

primaryKey

主要訂用帳戶金鑰。

primaryKey?: string

屬性值

string

scope

範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}

scope?: string

屬性值

string

secondaryKey

次要訂用帳戶金鑰。

secondaryKey?: string

屬性值

string

state

訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。

state?: SubscriptionState

屬性值

SubscriptionState

stateComment

描述當狀態變更為「已拒絕」狀態時，系統管理員所描述訂閱狀態變更的批注。

stateComment?: string

屬性值

string