ProductContract interface

Pakket:

@azure/arm-apimanagement

Productdetails.

Uitbreiding

ProxyResource

Eigenschappen

approvalRequired	of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Als dit waar is, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
description	Productbeschrijving. Kan HTML-opmaaktags bevatten.
displayName	Productnaam.
state	of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.
subscriptionRequired	Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Als dit waar is, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist om een aanvraag naar een API in het product te laten slagen. Als het onwaar is, wordt het product 'open' genoemd en kunnen aanvragen voor een API in het product worden ingediend zonder een abonnementssleutel. Als eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat de waarde waar is.
subscriptionsLimit	Of het aantal abonnementen dat een gebruiker op hetzelfde moment op dit product kan hebben. Stel in op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
terms	Gebruiksvoorwaarden van het product. Ontwikkelaars die zich willen abonneren op het product, worden gepresenteerd en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

Overgenomen eigenschappen

id	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name	De naam van de resource OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
type	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

approvalRequired

of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Als dit waar is, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar een van de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

approvalRequired?: boolean

Waarde van eigenschap

boolean

description

Productbeschrijving. Kan HTML-opmaaktags bevatten.

description?: string

Waarde van eigenschap

string

displayName

Productnaam.

displayName?: string

Waarde van eigenschap

string

state

of het product wel of niet wordt gepubliceerd. Gepubliceerde producten kunnen worden gevonden door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is notPublished.

state?: ProductState

Waarde van eigenschap

ProductState

subscriptionRequired

Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Als dit waar is, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist om een aanvraag naar een API in het product te laten slagen. Als het onwaar is, wordt het product 'open' genoemd en kunnen aanvragen voor een API in het product worden ingediend zonder een abonnementssleutel. Als eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat de waarde waar is.

subscriptionRequired?: boolean

Waarde van eigenschap

boolean

subscriptionsLimit

Of het aantal abonnementen dat een gebruiker op hetzelfde moment op dit product kan hebben. Stel in op null of weglaten om onbeperkte abonnementen per gebruiker toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.

subscriptionsLimit?: number

Waarde van eigenschap

number

terms

Gebruiksvoorwaarden van het product. Ontwikkelaars die zich willen abonneren op het product, worden gepresenteerd en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

terms?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

id

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

id?: string

Waarde van eigenschap

string

Overgenomen vanProxyResource.id

name

De naam van de resource OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name?: string

Waarde van eigenschap

string

Overgenomen vanProxyResource.name

type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type?: string

Waarde van eigenschap

string

Overgenomen vanProxyResource.type