ProductEntityBaseProperties Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.ApiManagement.Models
Assembly:
Azure.ResourceManager.ApiManagement.dll
Package:
Azure.ResourceManager.ApiManagement v1.2.0
Package:
Azure.ResourceManager.ApiManagement v1.3.0-beta.1
Source:
ProductEntityBaseProperties.cs
Source:
ProductEntityBaseProperties.cs

Product Entity Base Parameters.

public class ProductEntityBaseProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.Models.ProductEntityBaseProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.Models.ProductEntityBaseProperties>
type ProductEntityBaseProperties = class
    interface IJsonModel<ProductEntityBaseProperties>
    interface IPersistableModel<ProductEntityBaseProperties>
Public Class ProductEntityBaseProperties
Implements IJsonModel(Of ProductEntityBaseProperties), IPersistableModel(Of ProductEntityBaseProperties)
Inheritance
Object
ProductEntityBaseProperties
Derived
Implements
IJsonModel<ProductEntityBaseProperties> IPersistableModel<ProductEntityBaseProperties> IPersistableModel<T>

Properties

Description

Product description. May include HTML formatting tags.
IsApprovalRequired

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.
IsSubscriptionRequired

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.
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.
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.

Explicit Interface Implementations

IJsonModel<ProductEntityBaseProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ProductEntityBaseProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ProductEntityBaseProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ProductEntityBaseProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ProductEntityBaseProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to