ProductEntityBaseParameters Class

Reference

Definition

Namespace:: Microsoft.Azure.Management.ApiManagement.Models

Assembly:: Microsoft.Azure.Management.ApiManagement.dll

Package:: Microsoft.Azure.Management.ApiManagement v8.0.0-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Product Entity Base Parameters

public class ProductEntityBaseParameters

type ProductEntityBaseParameters = class

Public Class ProductEntityBaseParameters

Inheritance: Object
ProductEntityBaseParameters

Derived: Microsoft.Azure.Management.ApiManagement.Models.ProductTagResourceContractProperties

Constructors

ProductEntityBaseParameters()	Initializes a new instance of the ProductEntityBaseParameters class.
ProductEntityBaseParameters(String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>, Nullable<ProductState>)	Initializes a new instance of the ProductEntityBaseParameters class.

Properties

ApprovalRequired	Gets or sets 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	Gets or sets product description. May include HTML formatting tags.
State	Gets or sets 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. Possible values include: 'notPublished', 'published'
SubscriptionRequired	Gets or sets 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	Gets or sets 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	Gets or sets 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.

Methods

Validate()

Validate the object.

Applies to