SubscriptionUpdateParameters interface

包:

@azure/arm-apimanagement

订阅更新详细信息。

属性

allowTracing	确定是否可以启用跟踪
displayName	订阅名称。
expirationDate	订阅到期日期。 此设置仅用于审核目的，订阅不会自动过期。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。
ownerId	用户标识符路径：/users/{userId}
primaryKey	主订阅密钥。
scope	范围，例如 /products/{productId} 或 /apis 或 /apis/{apiId}
secondaryKey	辅助订阅密钥。
state	订阅状态。 可能的状态为 * 活动 – 订阅处于活动状态， * 已暂停 – 订阅被阻止，订阅者无法调用产品的任何 API， * 已提交 – 订阅请求已由开发人员发出，但尚未批准或拒绝，* 已拒绝 – 订阅请求已被管理员拒绝，* 已取消 – 订阅已被开发人员或管理员取消， * 已过期 – 订阅已达到到期日期并已停用。
stateComment	描述管理员在状态更改为“已拒绝”时订阅状态更改的注释。

属性详细信息

allowTracing

确定是否可以启用跟踪

allowTracing?: boolean

属性值

boolean

displayName

订阅名称。

displayName?: string

属性值

string

expirationDate

订阅到期日期。 此设置仅用于审核目的，订阅不会自动过期。 可以使用 state 属性管理订阅生命周期。 日期符合以下格式：按 ISO 8601 标准指定的 yyyy-MM-ddTHH:mm:ssZ。

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