ProductContract interface

Paquet:

@azure/arm-apimanagement

Détails du produit.

Extends

ProxyResource

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 ne puisse utiliser l’une des API du produit. Ne peut être présent que 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 sont visibles uniquement par les administrateurs. L’état par défaut de Product est notPublié.
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 nouveau produit, sa valeur est supposée être true.
subscriptionsLimit	Indique 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. Ne peut être présent que 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.

Propriétés héritées

id	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
name	Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
type	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

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 ne puisse utiliser l’une des API du produit. Ne peut être présent que 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 sont visibles uniquement par les administrateurs. L’état par défaut de Product est notPublié.

state?: ProductState

Valeur de propriété

ProductState

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 nouveau produit, sa valeur est supposée être true.

subscriptionRequired?: boolean

Valeur de propriété

boolean

subscriptionsLimit

Indique 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. Ne peut être présent que 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

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

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

id?: string

Valeur de propriété

string

Hérité deProxyResource.id

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

name?: string

Valeur de propriété

string

Hérité deProxyResource.name

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

type?: string

Valeur de propriété

string

Hérité deProxyResource.type