ProductUpdateProperties interface

Paquet:

@azure/arm-apimanagement

Paramètres fournis à l’opération Mettre à jour le produit.

Extends

ProductEntityBaseParameters

Propriétés

displayName

Nom du produit.

Propriétés héritées

approvalRequired	si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement pour permettre 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 effectuer 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 inclure des balises de mise en forme HTML.
state	si le produit est publié ou non. Les produits publiés sont détectables 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 du produit n’est pas Publié.
subscriptionRequired	Indique si un abonnement 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 requise 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 la valeur 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 essaient de s’abonner au produit sont présentés et doivent accepter ces conditions avant de pouvoir terminer le processus d’abonnement.

Détails de la propriété

displayName

Nom du produit.

displayName?: string

Valeur de propriété

string

Détails de la propriété héritée

approvalRequired

si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement pour permettre 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 effectuer 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

héritée deProductEntityBaseParameters.approvalRequired

description

Description du produit. Peut inclure des balises de mise en forme HTML.

description?: string

Valeur de propriété

string

héritée deProductEntityBaseParameters.description

state

si le produit est publié ou non. Les produits publiés sont détectables 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 du produit n’est pas Publié.

state?: ProductState

Valeur de propriété

ProductState

héritée deProductEntityBaseParameters.state

subscriptionRequired

Indique si un abonnement 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 requise 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

héritée deProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

Indique si le nombre d’abonnements qu’un utilisateur peut avoir à ce produit en même temps. Définissez la valeur 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

héritée deProductEntityBaseParameters.subscriptionsLimit

terms

Conditions d’utilisation du produit. Les développeurs qui essaient de s’abonner au produit sont présentés et doivent accepter ces conditions avant de pouvoir terminer le processus d’abonnement.

terms?: string

Valeur de propriété

string

héritée deProductEntityBaseParameters.terms