SubscriptionContract interface

Paquete:

@azure/arm-apimanagement

Detalles de la suscripción.

Extends

ProxyResource

Propiedades

allowTracing	Determina si el seguimiento está habilitado
createdDate	Fecha de creación de la suscripción. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
displayName	Nombre de la suscripción o null si la suscripción no tiene ningún nombre.
endDate	Fecha en la que se canceló o expiró la suscripción. La configuración es solo para fines de auditoría y la suscripción no se cancela 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	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.
notificationDate	Próxima fecha de notificación de expiración de la suscripción. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.
ownerId	Identificador de recursos de usuario del propietario de la suscripción. El valor es una dirección URL relativa válida en el formato /users/{userId} donde {userId} es un identificador de usuario.
primaryKey	Clave principal de suscripción. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.
scope	Ámbito como /products/{productId} o /apis o /apis/{apiId}.
secondaryKey	Clave secundaria de suscripción. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.
startDate	Fecha de activación de la suscripción. La configuración es solo para fines de auditoría y la suscripción no se activa 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.
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	Comentario de suscripción opcional agregado por un administrador cuando se cambia el estado a "rechazado".

Propiedades heredadas

id	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
name	El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
type	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

allowTracing

Determina si el seguimiento está habilitado

allowTracing?: boolean

Valor de propiedad

boolean

createdDate

Fecha de creación de la suscripción. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

createdDate?: Date

Valor de propiedad

Date

displayName

Nombre de la suscripción o null si la suscripción no tiene ningún nombre.

displayName?: string

Valor de propiedad

string

endDate

Fecha en la que se canceló o expiró la suscripción. La configuración es solo para fines de auditoría y la suscripción no se cancela 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.

endDate?: Date

Valor de propiedad

Date

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

notificationDate

Próxima fecha de notificación de expiración de la suscripción. La fecha se ajusta al siguiente formato: yyyy-MM-ddTHH:mm:ssZ según lo especificado por el estándar ISO 8601.

notificationDate?: Date

Valor de propiedad

Date

ownerId

Identificador de recursos de usuario del propietario de la suscripción. El valor es una dirección URL relativa válida en el formato /users/{userId} donde {userId} es un identificador de usuario.

ownerId?: string

Valor de propiedad

string

primaryKey

Clave principal de suscripción. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.

primaryKey?: string

Valor de propiedad

string

scope

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

scope?: string

Valor de propiedad

string

secondaryKey

Clave secundaria de suscripción. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor.

secondaryKey?: string

Valor de propiedad

string

startDate

Fecha de activación de la suscripción. La configuración es solo para fines de auditoría y la suscripción no se activa 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.

startDate?: Date

Valor de propiedad

Date

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

SubscriptionState

stateComment

Comentario de suscripción opcional agregado por un administrador cuando se cambia el estado a "rechazado".

stateComment?: string

Valor de propiedad

string

Detalles de las propiedades heredadas

id

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

id?: string

Valor de propiedad

string

heredado deProxyResource.id

name

El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

name?: string

Valor de propiedad

string

heredado deProxyResource.name

type

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

type?: string

Valor de propiedad

string

Heredado deProxyResource.type