ProductContractProperties interface

Pakiet:

@azure/arm-apimanagement

Profil produktu.

Rozszerzenie

ProductEntityBaseParameters

Właściwości

displayName

Nazwa produktu.

Właściwości dziedziczone

approvalRequired	czy jest wymagane zatwierdzenie subskrypcji. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, umożliwiając deweloperom wywoływanie interfejsów API produktu natychmiast po zasubskrybowaniu. Jeśli to prawda, administratorzy muszą ręcznie zatwierdzić subskrypcję, zanim deweloper będzie mógł dowolnego z interfejsów API produktu. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.
description	Opis produktu. Może zawierać tagi formatowania HTML.
state	niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished.
subscriptionRequired	Czy subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie. Jeśli to prawda, produkt jest określany jako "chroniony", a prawidłowy klucz subskrypcji jest wymagany, aby żądanie do interfejsu API zawartego w produkcie powiodło się. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API uwzględnionego w produkcie mogą zostać wykonane bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość ma wartość true.
subscriptionsLimit	Określa, czy liczba subskrypcji, które użytkownik może mieć w tym samym czasie. Ustaw wartość null lub pomiń, aby zezwolić na nieograniczoną liczbę subskrypcji użytkowników. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.
terms	Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji.

Szczegóły właściwości

displayName

Nazwa produktu.

displayName: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

approvalRequired

czy jest wymagane zatwierdzenie subskrypcji. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, umożliwiając deweloperom wywoływanie interfejsów API produktu natychmiast po zasubskrybowaniu. Jeśli to prawda, administratorzy muszą ręcznie zatwierdzić subskrypcję, zanim deweloper będzie mógł dowolnego z interfejsów API produktu. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.

approvalRequired?: boolean

Wartość właściwości

boolean

dziedziczone zProductEntityBaseParameters.approvalRequired

description

Opis produktu. Może zawierać tagi formatowania HTML.

description?: string

Wartość właściwości

string

dziedziczone zProductEntityBaseParameters.description

state

niezależnie od tego, czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublished.

state?: ProductState

Wartość właściwości

ProductState

dziedziczone zProductEntityBaseParameters.state

subscriptionRequired

Czy subskrypcja produktu jest wymagana do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie. Jeśli to prawda, produkt jest określany jako "chroniony", a prawidłowy klucz subskrypcji jest wymagany, aby żądanie do interfejsu API zawartego w produkcie powiodło się. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API uwzględnionego w produkcie mogą zostać wykonane bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że wartość ma wartość true.

subscriptionRequired?: boolean

Wartość właściwości

boolean

dziedziczone zProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

Określa, czy liczba subskrypcji, które użytkownik może mieć w tym samym czasie. Ustaw wartość null lub pomiń, aby zezwolić na nieograniczoną liczbę subskrypcji użytkowników. Może być obecny tylko wtedy, gdy właściwość subscriptionRequired jest obecna i ma wartość false.

subscriptionsLimit?: number

Wartość właściwości

number

dziedziczone zProductEntityBaseParameters.subscriptionsLimit

terms

Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt będą przedstawiani i zobowiązani do zaakceptowania tych warunków przed ukończeniem procesu subskrypcji.

terms?: string

Wartość właściwości

string

dziedziczone zProductEntityBaseParameters.terms