Compartir a través de


SubscriptionUpdateParameters interface

Detalles de actualización de la suscripción.

Propiedades

allowTracing

Determina si se puede habilitar el seguimiento

displayName

Nombre de la suscripción.

expirationDate

Fecha de expiración de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no expira automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la propiedad state. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

ownerId

Ruta de acceso del identificador de usuario: /users/{userId}

primaryKey

Clave de suscripción principal.

scope

Ámbito como /products/{productId} o /apis o /apis/{apiId}

secondaryKey

Clave de suscripción secundaria.

state

Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida : la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.

stateComment

Comentarios que describen el cambio de estado de suscripción por el administrador cuando el estado se cambia a "rechazado".

Detalles de las propiedades

allowTracing

Determina si se puede habilitar el seguimiento

allowTracing?: boolean

Valor de propiedad

boolean

displayName

Nombre de la suscripción.

displayName?: string

Valor de propiedad

string

expirationDate

Fecha de expiración de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no expira automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la propiedad state. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

expirationDate?: Date

Valor de propiedad

Date

ownerId

Ruta de acceso del identificador de usuario: /users/{userId}

ownerId?: string

Valor de propiedad

string

primaryKey

Clave de suscripción principal.

primaryKey?: string

Valor de propiedad

string

scope

Ámbito como /products/{productId} o /apis o /apis/{apiId}

scope?: string

Valor de propiedad

string

secondaryKey

Clave de suscripción secundaria.

secondaryKey?: string

Valor de propiedad

string

state

Estado de la suscripción. Los estados posibles son * activos : la suscripción está activa, * suspendida : la suscripción está bloqueada y el suscriptor no puede llamar a ninguna API del producto, * enviada : el desarrollador ha realizado la solicitud de suscripción, pero aún no se ha aprobado o rechazado, * rechazado , la solicitud de suscripción se ha denegado por un administrador, * cancelado : la suscripción la ha cancelado el desarrollador o el administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.

state?: SubscriptionState

Valor de propiedad

stateComment

Comentarios que describen el cambio de estado de suscripción por el administrador cuando el estado se cambia a "rechazado".

stateComment?: string

Valor de propiedad

string