ProductContractProperties interface

Пакет:

@azure/arm-apimanagement

Профиль продукта.

Extends

ProductEntityBaseParameters

Свойства

displayName

Название продукта.

Унаследованные свойства

approvalRequired	требуется ли утверждение подписки. Если задано значение false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если значение равно true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false.
description	Описание продукта. Может содержать теги форматирования HTML.
state	независимо от того, опубликован ли продукт. Пользователи портала разработчика могут обнаруживать опубликованные продукты. Неопубликоные продукты видны только администраторам. Состояние продукта по умолчанию — notPublished.
subscriptionRequired	Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, и для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если задано значение false, продукт называется "открытым", и запросы к API, включенного в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что оно имеет значение true.
subscriptionsLimit	Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустите, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false.
terms	Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления.

Сведения о свойстве

displayName

Название продукта.

displayName: string

Значение свойства

string

Сведения об унаследованном свойстве

approvalRequired

требуется ли утверждение подписки. Если задано значение false, новые подписки будут автоматически утверждены, что позволит разработчикам вызывать API продукта сразу после подписки. Если значение равно true, администраторы должны вручную утвердить подписку, прежде чем разработчик сможет использовать любой из API продукта. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false.

approvalRequired?: boolean

Значение свойства

boolean

Наследуется отProductEntityBaseParameters.approvalRequired

description

Описание продукта. Может содержать теги форматирования HTML.

description?: string

Значение свойства

string

Наследуется отProductEntityBaseParameters.description

state

независимо от того, опубликован ли продукт. Пользователи портала разработчика могут обнаруживать опубликованные продукты. Неопубликоные продукты видны только администраторам. Состояние продукта по умолчанию — notPublished.

state?: ProductState

Значение свойства

ProductState

Наследуется отProductEntityBaseParameters.state

subscriptionRequired

Требуется ли подписка на продукт для доступа к API, включенным в этот продукт. Если значение равно true, продукт называется защищенным, и для успешного выполнения запроса к API, включенного в продукт, требуется действительный ключ подписки. Если задано значение false, продукт называется "открытым", и запросы к API, включенного в продукт, могут выполняться без ключа подписки. Если свойство опущено при создании нового продукта, предполагается, что оно имеет значение true.

subscriptionRequired?: boolean

Значение свойства

boolean

Наследуется отProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

Указывает, может ли пользователь одновременно иметь количество подписок на этот продукт. Задайте значение NULL или опустите, чтобы разрешить неограниченное количество подписок на пользователя. Может присутствовать только в том случае, если свойство subscriptionRequired присутствует и имеет значение false.

subscriptionsLimit?: number

Значение свойства

number

Наследуется отProductEntityBaseParameters.subscriptionsLimit

terms

Условия использования продукта. Они будут представлены разработчикам во время оформления подписки на продукт. Им понадобится принять эти условия, чтобы завершить процедуру оформления.

terms?: string

Значение свойства

string

Наследуется отProductEntityBaseParameters.terms