ProductContractProperties interface

Paket:

@azure/arm-apimanagement

Produktprofil.

Extends

ProductEntityBaseParameters

Eigenschaften

displayName

Produktname

Geerbte Eigenschaften

approvalRequired	gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn false, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts sofort nach dem Abonnement aufrufen können. Wenn true, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist.
description	Produktbeschreibung. Kann HTML-Formatierungstags umfassen.
state	ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals gefunden werden. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht.
subscriptionRequired	Gibt an, ob ein Produktabonnement für den Zugriff auf in diesem Produkt enthaltene APIs erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, damit eine Anforderung an eine im Produkt enthaltene API erfolgreich ist. Wenn false, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine im Produkt enthaltene API können ohne Abonnementschlüssel gestellt werden. Wenn die Eigenschaft beim Erstellen eines neuen Produkts ausgelassen wird, wird davon ausgegangen, dass der Wert true ist.
subscriptionsLimit	Gibt an, wie viele Abonnements ein Benutzer für dieses Produkt gleichzeitig haben kann. Legen Sie auf NULL fest oder lassen Sie aus, um unbegrenzte Anzahl pro Benutzerabonnement zuzulassen. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist.
terms	Nutzungsbedingungen für das Produkt. Diese Bedingungen werden Entwicklern angezeigt, die das Produkt abonnieren möchten. Sie müssen die Bedingungen akzeptieren, um den Abonnementvorgang abschließen zu können.

Details zur Eigenschaft

displayName

Produktname

displayName: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

approvalRequired

gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn false, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts sofort nach dem Abonnement aufrufen können. Wenn true, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist.

approvalRequired?: boolean

Eigenschaftswert

boolean

Geerbt vonProductEntityBaseParameters.approvalRequired

description

Produktbeschreibung. Kann HTML-Formatierungstags umfassen.

description?: string

Eigenschaftswert

string

Geerbt vonProductEntityBaseParameters.description

state

ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals gefunden werden. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht.

state?: ProductState

Eigenschaftswert

ProductState

Geerbt vonProductEntityBaseParameters.state

subscriptionRequired

Gibt an, ob ein Produktabonnement für den Zugriff auf in diesem Produkt enthaltene APIs erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, damit eine Anforderung an eine im Produkt enthaltene API erfolgreich ist. Wenn false, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine im Produkt enthaltene API können ohne Abonnementschlüssel gestellt werden. Wenn die Eigenschaft beim Erstellen eines neuen Produkts ausgelassen wird, wird davon ausgegangen, dass der Wert true ist.

subscriptionRequired?: boolean

Eigenschaftswert

boolean

Geerbt vonProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

Gibt an, wie viele Abonnements ein Benutzer für dieses Produkt gleichzeitig haben kann. Legen Sie auf NULL fest oder lassen Sie aus, um unbegrenzte Anzahl pro Benutzerabonnement zuzulassen. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist.

subscriptionsLimit?: number

Eigenschaftswert

number

Geerbt vonProductEntityBaseParameters.subscriptionsLimit

terms

Nutzungsbedingungen für das Produkt. Diese Bedingungen werden Entwicklern angezeigt, die das Produkt abonnieren möchten. Sie müssen die Bedingungen akzeptieren, um den Abonnementvorgang abschließen zu können.

terms?: string

Eigenschaftswert

string

Geerbt vonProductEntityBaseParameters.terms