SubscriptionCreateParameters interface

Paquete:

@azure/arm-apimanagement

Detalles de creación de suscripciones.

Propiedades

allowTracing	Determina si se puede habilitar el seguimiento
displayName	Nombre de la suscripción.
ownerId	Usuario (ruta de acceso de identificador de usuario) para quien se crea la suscripción en forma /users/{userId}
primaryKey	Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente.
scope	Ámbito como /products/{productId} o /apis o /apis/{apiId}.
secondaryKey	Clave de suscripción secundaria. Si no se especifica durante la clave de solicitud, se generará automáticamente.
state	Estado inicial de la suscripción. Si no se especifica ningún valor, la suscripción se crea con el estado Enviado. 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ó.

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

ownerId

Usuario (ruta de acceso de identificador de usuario) para quien se crea la suscripción en forma /users/{userId}

ownerId?: string

Valor de propiedad

string

primaryKey

Clave de suscripción principal. Si no se especifica durante la clave de solicitud, se generará automáticamente.

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. Si no se especifica durante la clave de solicitud, se generará automáticamente.

secondaryKey?: string

Valor de propiedad

string

state

Estado inicial de la suscripción. Si no se especifica ningún valor, la suscripción se crea con el estado Enviado. 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

SubscriptionState