Partager via

ProductUpdateParameters interface

  • Référence
Paquet:
@azure/arm-apimanagement

Paramètres de mise à jour du produit.

Propriétés

approvalRequired

si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement, ce qui permet aux développeurs d’appeler les API du produit immédiatement après l’abonnement. Si la valeur est true, les administrateurs doivent approuver manuellement l’abonnement avant que le développeur puisse utiliser l’une des API du produit. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false.
description

Description du produit. Peut comporter des balises de mise en forme.
displayName

Nom du produit.
state

si le produit est publié ou non. Les produits publiés peuvent être découverts par les utilisateurs du portail des développeurs. Les produits non publiés ne sont visibles que par les administrateurs. L’état par défaut de Product est notPublished.
subscriptionRequired

Indique si un abonnement au produit est requis pour accéder aux API incluses dans ce produit. Si la valeur est true, le produit est appelé « protégé » et une clé d’abonnement valide est nécessaire pour qu’une demande adressée à une API incluse dans le produit réussisse. Si la valeur est false, le produit est appelé « ouvert » et les demandes adressées à une API incluse dans le produit peuvent être effectuées sans clé d’abonnement. Si la propriété est omise lors de la création d’un produit, sa valeur est supposée être true.
subscriptionsLimit

Indique si le nombre d’abonnements qu’un utilisateur peut avoir à ce produit en même temps. Définissez sur null ou omettez pour autoriser un nombre illimité d’abonnements par utilisateur. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false.
terms

Conditions d’utilisation du produit. Les développeurs qui veulent s’abonner au produit devront consulter et accepter ces conditions pour pouvoir terminer le processus d’abonnement.

Détails de la propriété

approvalRequired

si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement, ce qui permet aux développeurs d’appeler les API du produit immédiatement après l’abonnement. Si la valeur est true, les administrateurs doivent approuver manuellement l’abonnement avant que le développeur puisse utiliser l’une des API du produit. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false.

approvalRequired?: boolean

Valeur de propriété

boolean

description

Description du produit. Peut comporter des balises de mise en forme.

description?: string

Valeur de propriété

string

displayName

Nom du produit.

displayName?: string

Valeur de propriété

string

state

si le produit est publié ou non. Les produits publiés peuvent être découverts par les utilisateurs du portail des développeurs. Les produits non publiés ne sont visibles que par les administrateurs. L’état par défaut de Product est notPublished.

state?: ProductState

Valeur de propriété

ProductState

subscriptionRequired

Indique si un abonnement au produit est requis pour accéder aux API incluses dans ce produit. Si la valeur est true, le produit est appelé « protégé » et une clé d’abonnement valide est nécessaire pour qu’une demande adressée à une API incluse dans le produit réussisse. Si la valeur est false, le produit est appelé « ouvert » et les demandes adressées à une API incluse dans le produit peuvent être effectuées sans clé d’abonnement. Si la propriété est omise lors de la création d’un produit, sa valeur est supposée être true.

subscriptionRequired?: boolean

Valeur de propriété

boolean

subscriptionsLimit

Indique si le nombre d’abonnements qu’un utilisateur peut avoir à ce produit en même temps. Définissez sur null ou omettez pour autoriser un nombre illimité d’abonnements par utilisateur. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false.

subscriptionsLimit?: number

Valeur de propriété

number

terms

Conditions d’utilisation du produit. Les développeurs qui veulent s’abonner au produit devront consulter et accepter ces conditions pour pouvoir terminer le processus d’abonnement.

terms?: string

Valeur de propriété

string