ApiManagementProductData Class
Definition
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.
A class representing the ApiManagementProduct data model. Product details.
public class ApiManagementProductData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.ApiManagementProductData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.ApiManagementProductData>type ApiManagementProductData = class
inherit ResourceData
interface IJsonModel<ApiManagementProductData>
interface IPersistableModel<ApiManagementProductData>Public Class ApiManagementProductData
Inherits ResourceData
Implements IJsonModel(Of ApiManagementProductData), IPersistableModel(Of ApiManagementProductData)- Inheritance
- Implements
Constructors
| ApiManagementProductData() |
Initializes a new instance of ApiManagementProductData. |
Properties
| Description |
Product description. May include HTML formatting tags. |
| DisplayName |
Product name. |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
| 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. |
| Name |
The name of the resource. (Inherited from ResourceData) |
| ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
| 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. |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
| 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. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from ResourceData) |
Explicit Interface Implementations
| IJsonModel<ApiManagementProductData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ApiManagementProductData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ApiManagementProductData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ApiManagementProductData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ApiManagementProductData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
