SubscriptionUpdateParameters interface
Detalles de actualización de la suscripción.
Propiedades
allow |
Determina si se puede habilitar el seguimiento |
display |
el nombre de la suscripción. |
expiration |
Fecha de expiración de la suscripción. La configuración solo tiene fines de auditoría y la suscripción no ha expirado automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la |
owner |
Ruta de acceso del identificador de usuario: /users/{userId} |
primary |
Clave de suscripción principal. |
scope | Ámbito como /products/{productId} o /apis o /apis/{apiId} |
secondary |
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 ha sido denegada por un administrador, * cancelado– la suscripción ha sido cancelada por el desarrollador o administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó. |
state |
Los comentarios que describen el estado de la suscripción cambian 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
el 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 ha expirado automáticamente. El ciclo de vida de la suscripción se puede administrar mediante la state
propiedad . 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 ha sido denegada por un administrador, * cancelado– la suscripción ha sido cancelada por el desarrollador o administrador, * expirado: la suscripción alcanzó su fecha de expiración y se desactivó.
state?: SubscriptionState
Valor de propiedad
stateComment
Los comentarios que describen el estado de la suscripción cambian por el administrador cuando el estado se cambia a "rechazado".
stateComment?: string
Valor de propiedad
string