ProductContract interface

Paket:

@azure/arm-apimanagement

Produktdetails.

Extends

ProxyResource

Eigenschaften

approvalRequired	gibt an, ob eine Abonnementgenehmigung erforderlich ist. Bei false werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren 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 Eigenschaft subscriptionRequired vorhanden ist und den Wert false aufweist.
description	Produktbeschreibung. Kann HTML-Formatierungstags umfassen.
displayName	Produktname
state	ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals auffindbar sein. 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 api, die im Produkt enthalten ist, können ohne einen Abonnementschlüssel erfolgen. 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 gleichzeitig für dieses Produkt haben kann. Legen Sie diesen Wert auf NULL fest oder lassen Sie es aus, um unbegrenzte Anzahl von Abonnements pro Benutzer zuzulassen. Kann nur vorhanden sein, wenn die Eigenschaft subscriptionRequired 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.

Geerbte Eigenschaften

id	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
name	Der Name der Ressource HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
type	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

approvalRequired

gibt an, ob eine Abonnementgenehmigung erforderlich ist. Bei false werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts unmittelbar nach dem Abonnieren 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 Eigenschaft subscriptionRequired vorhanden ist und den Wert false aufweist.

approvalRequired?: boolean

Eigenschaftswert

boolean

description

Produktbeschreibung. Kann HTML-Formatierungstags umfassen.

description?: string

Eigenschaftswert

string

displayName

Produktname

displayName?: string

Eigenschaftswert

string

state

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

state?: ProductState

Eigenschaftswert

ProductState

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 api, die im Produkt enthalten ist, können ohne einen Abonnementschlüssel erfolgen. Wenn die Eigenschaft beim Erstellen eines neuen Produkts ausgelassen wird, wird davon ausgegangen, dass der Wert true ist.

subscriptionRequired?: boolean

Eigenschaftswert

boolean

subscriptionsLimit

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

subscriptionsLimit?: number

Eigenschaftswert

number

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

Geerbte Eigenschaftsdetails

id

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

Geerbt vonProxyResource.id

name

Der Name der Ressource HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

Geerbt vonProxyResource.name

type

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

Geerbt vonProxyResource.type