SubscriptionCreateParameters interface

套件:

@azure/arm-apimanagement

訂用帳戶建立詳細數據。

屬性

allowTracing	判斷是否可以啟用追蹤
displayName	訂用帳戶名稱。
ownerId	以 /users/{userId} 形式建立訂用帳戶的使用者（使用者標識符路徑）
primaryKey	主要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。
scope	範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}。
secondaryKey	次要訂用帳戶金鑰。 如果在要求金鑰期間未指定，則會自動產生。
state	初始訂閱狀態。 如果未指定任何值，則會使用 [送出] 狀態來建立訂用帳戶。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。

屬性詳細資料

allowTracing

判斷是否可以啟用追蹤

allowTracing?: boolean

屬性值

boolean

displayName

訂用帳戶名稱。

displayName?: string

屬性值

string

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