SubscriptionContract interface

套件:

@azure/arm-apimanagement

訂用帳戶詳細數據。

Extends

ProxyResource

屬性

allowTracing	判斷是否啟用追蹤
createdDate	訂用帳戶建立日期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。 注意：這個屬性不會串行化。 它只能由伺服器填入。
displayName	訂閱的名稱，如果訂用帳戶沒有名稱，則為 null。
endDate	取消或過期訂閱的日期。 此設定僅供稽核之用，且不會自動取消訂用帳戶。 您可以使用 state 屬性來管理訂用帳戶生命週期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
expirationDate	訂閱到期日。 此設定僅供稽核之用，且訂用帳戶不會自動過期。 您可以使用 state 屬性來管理訂用帳戶生命週期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
notificationDate	即將推出的訂用帳戶到期通知日期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
ownerId	訂用帳戶擁有者的用戶資源標識碼。 值是 /users/{userId} 格式的有效相對 URL，其中 {userId} 是使用者標識符。
primaryKey	訂用帳戶主鍵。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。
scope	範圍，例如 /products/{productId} 或 /apis 或 /apis/{apiId}。
secondaryKey	訂用帳戶次要金鑰。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。
startDate	訂用帳戶啟用日期。 此設定僅供稽核之用，而且不會自動啟用訂用帳戶。 您可以使用 state 屬性來管理訂用帳戶生命週期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。
state	訂用帳戶狀態。 可能的狀態為 * 作用中 – 訂用帳戶為作用中、 * 已暫停 – 已封鎖訂用帳戶，且訂閱者無法呼叫產品的任何 API* 已提交 – 已由開發人員提出訂閱要求，但尚未核准或拒絕，* 已拒絕 – 系統管理員已拒絕訂閱要求，* 已取消 – 開發人員或系統管理員已取消訂用帳戶要求， * 已過期 – 訂用帳戶已達到到期日且已停用。
stateComment	當狀態變更為「已拒絕」時，系統管理員新增的選擇性訂用帳戶批注。

繼承的屬性

id	資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此屬性將不會串行化。 它只能由伺服器填入。
name	資源名稱注意：此屬性將不會串行化。 它只能由伺服器填入。
type	資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts” 附注：此屬性將不會串行化。 它只能由伺服器填入。

屬性詳細資料

allowTracing

判斷是否啟用追蹤

allowTracing?: boolean

屬性值

boolean

createdDate

訂用帳戶建立日期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。

注意：這個屬性不會串行化。 它只能由伺服器填入。

createdDate?: Date

屬性值

Date

displayName

訂閱的名稱，如果訂用帳戶沒有名稱，則為 null。

displayName?: string

屬性值

string

endDate

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

endDate?: Date

屬性值

Date

expirationDate

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

expirationDate?: Date

屬性值

Date

notificationDate

即將推出的訂用帳戶到期通知日期。 日期符合下列格式：yyyy-MM-ddTHH:mm:ssZ ISO 8601 標準所指定。

notificationDate?: Date

屬性值

Date

ownerId

訂用帳戶擁有者的用戶資源標識碼。 值是 /users/{userId} 格式的有效相對 URL，其中 {userId} 是使用者標識符。

ownerId?: string

屬性值

string

primaryKey

訂用帳戶主鍵。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。

primaryKey?: string

屬性值

string

scope

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

scope?: string

屬性值

string

secondaryKey

訂用帳戶次要金鑰。 此屬性不會填入 『GET』 作業！ 使用 '/listSecrets' POST 要求來取得值。

secondaryKey?: string

屬性值

string

startDate

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

startDate?: Date

屬性值

Date

state

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

state?: SubscriptionState

屬性值

SubscriptionState

stateComment

當狀態變更為「已拒絕」時，系統管理員新增的選擇性訂用帳戶批注。

stateComment?: string

屬性值

string

繼承的屬性詳細資料

id

資源的完整資源標識碼。 例如 - /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