ProductEntityBaseParameters interface

Pakiet:

@azure/arm-apimanagement

Parametry podstawowe jednostki produktu

Właściwości

approvalRequired	czy jest wymagane zatwierdzenie subskrypcji. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, co umożliwi 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	czy produkt jest publikowany, czy nie. Opublikowane produkty są wykrywalne przez użytkowników portalu dla deweloperów. Niepublikowane produkty są widoczne tylko dla administratorów. Domyślny stan produktu nie jestPublikowany.
subscriptionRequired	Określa, czy do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie jest wymagana subskrypcja produktu. 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 zakończyło się pomyślnie. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API zawartego w produkcie można wykonać bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że jest to 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 na użytkownika. 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 zostaną przedstawini i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji.

Szczegóły właściwości

approvalRequired

czy jest wymagane zatwierdzenie subskrypcji. Jeśli wartość false, nowe subskrypcje zostaną zatwierdzone automatycznie, co umożliwi 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

description

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

description?: string

Wartość właściwości

string

state

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

state?: ProductState

Wartość właściwości

ProductState

subscriptionRequired

Określa, czy do uzyskiwania dostępu do interfejsów API uwzględnionych w tym produkcie jest wymagana subskrypcja produktu. 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 zakończyło się pomyślnie. Jeśli wartość false, produkt jest określany jako "otwarty", a żądania do interfejsu API zawartego w produkcie można wykonać bez klucza subskrypcji. Jeśli właściwość zostanie pominięta podczas tworzenia nowego produktu, przyjmuje się, że jest to wartość true.

subscriptionRequired?: boolean

Wartość właściwości

boolean

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 na użytkownika. 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

terms

Warunki użytkowania produktu. Deweloperzy próbujący zasubskrybować produkt zostaną przedstawini i zobowiązani do zaakceptowania tych warunków, zanim będą mogli ukończyć proces subskrypcji.

terms?: string

Wartość właściwości

string