ProductContract interface

Pakiet:

@azure/arm-apimanagement

Szczegóły produktu.

Rozszerzenie

ProxyResource

Właściwości

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.
displayName	Nazwa produktu.
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.

Właściwości dziedziczone

id	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
name	Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
type	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

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

description

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

description?: string

Wartość właściwości

string

displayName

Nazwa produktu.

displayName?: string

Wartość właściwości

string

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

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

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

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

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

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

dziedziczone zProxyResource.id

name

Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name?: string

Wartość właściwości

string

dziedziczone zProxyResource.name

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

dziedziczone zProxyResource.type