SubscriptionUpdateParameters interface

Paquet:

@azure/arm-apimanagement

Détails de la mise à jour de l’abonnement.

Propriétés

allowTracing	Détermine si le suivi peut être activé
displayName	Nom de l’abonnement.
expirationDate	Date d’expiration de l’abonnement. Le paramètre est à des fins d’audit uniquement et l’abonnement n’a pas expiré automatiquement. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
ownerId	Chemin d’accès de l’identificateur de l’utilisateur : /users/{userId}
primaryKey	Clé d’abonnement principale.
scope	Étendue telle que /products/{productId} ou /apis ou /apis/{apiId}
secondaryKey	Clé d’abonnement secondaire.
state	État de l’abonnement. Les états possibles sont * actifs – l’abonnement est actif, * suspendu – l’abonnement est bloqué et l’abonné ne peut pas appeler d’API du produit, * envoyé – la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée, * rejeté – la demande d’abonnement a été refusée par un administrateur, * annulée – l’abonnement a été annulé par le développeur ou l’administrateur, * expiré : l’abonnement a atteint sa date d’expiration et a été désactivé.
stateComment	Commentaires décrivant le changement d’état de l’abonnement par l’administrateur lorsque l’état est remplacé par « rejeté ».

Détails de la propriété

allowTracing

Détermine si le suivi peut être activé

allowTracing?: boolean

Valeur de propriété

boolean

displayName

Nom de l’abonnement.

displayName?: string

Valeur de propriété

string

expirationDate

Date d’expiration de l’abonnement. Le paramètre est à des fins d’audit uniquement et l’abonnement n’a pas expiré automatiquement. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.

expirationDate?: Date

Valeur de propriété

Date

ownerId

Chemin d’accès de l’identificateur de l’utilisateur : /users/{userId}

ownerId?: string

Valeur de propriété

string

primaryKey

Clé d’abonnement principale.

primaryKey?: string

Valeur de propriété

string

scope

Étendue telle que /products/{productId} ou /apis ou /apis/{apiId}

scope?: string

Valeur de propriété

string

secondaryKey

Clé d’abonnement secondaire.

secondaryKey?: string

Valeur de propriété

string

state

État de l’abonnement. Les états possibles sont * actifs – l’abonnement est actif, * suspendu – l’abonnement est bloqué et l’abonné ne peut pas appeler d’API du produit, * envoyé – la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée, * rejeté – la demande d’abonnement a été refusée par un administrateur, * annulée – l’abonnement a été annulé par le développeur ou l’administrateur, * expiré : l’abonnement a atteint sa date d’expiration et a été désactivé.

state?: SubscriptionState

Valeur de propriété

SubscriptionState

stateComment

Commentaires décrivant le changement d’état de l’abonnement par l’administrateur lorsque l’état est remplacé par « rejeté ».

stateComment?: string

Valeur de propriété

string