SubscriptionCreateParameters interface

Paquet:

@azure/arm-apimanagement

Détails de la création d’abonnement.

Propriétés

allowTracing	Détermine si le suivi peut être activé
displayName	Nom de l’abonnement.
ownerId	Utilisateur (chemin d’accès de l’ID utilisateur) pour lequel l’abonnement est créé sous la forme /users/{userId}
primaryKey	Clé d’abonnement principale. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement.
scope	Étendue comme /products/{productId} ou /apis ou /apis/{apiId}.
secondaryKey	Clé d’abonnement secondaire. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement.
state	État initial de l’abonnement. Si aucune valeur n’est spécifiée, l’abonnement est créé avec l’état Soumis. 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é.

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

ownerId

Utilisateur (chemin d’accès de l’ID utilisateur) pour lequel l’abonnement est créé sous la forme /users/{userId}

ownerId?: string

Valeur de propriété

string

primaryKey

Clé d’abonnement principale. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement.

primaryKey?: string

Valeur de propriété

string

scope

Étendue comme /products/{productId} ou /apis ou /apis/{apiId}.

scope?: string

Valeur de propriété

string

secondaryKey

Clé d’abonnement secondaire. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement.

secondaryKey?: string

Valeur de propriété

string

state

État initial de l’abonnement. Si aucune valeur n’est spécifiée, l’abonnement est créé avec l’état Soumis. 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