ProductContractProperties interface

Package:

@azure/arm-apimanagement

Product profile.

Extends

ProductEntityBaseParameters

Properties

displayName

Product name.

Inherited Properties

approvalRequired	whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
description	Product description. May include HTML formatting tags.
state	whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
subscriptionRequired	Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
subscriptionsLimit	Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
terms	Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

Property Details

displayName

Product name.

displayName: string

Property Value

string

Inherited Property Details

approvalRequired

whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.

approvalRequired?: boolean

Property Value

boolean

Inherited From ProductEntityBaseParameters.approvalRequired

description

Product description. May include HTML formatting tags.

description?: string

Property Value

string

Inherited From ProductEntityBaseParameters.description

state

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.

state?: ProductState

Property Value

ProductState

Inherited From ProductEntityBaseParameters.state

subscriptionRequired

Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.

subscriptionRequired?: boolean

Property Value

boolean

Inherited From ProductEntityBaseParameters.subscriptionRequired

subscriptionsLimit

Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.

subscriptionsLimit?: number

Property Value

number

Inherited From ProductEntityBaseParameters.subscriptionsLimit

terms

Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

terms?: string

Property Value

string

Inherited From ProductEntityBaseParameters.terms