ArmApiManagementModelFactory.ProductEntityBaseProperties Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement.Models

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ArmApiManagementModelFactory.cs

Initializes a new instance of ProductEntityBaseProperties.

public static Azure.ResourceManager.ApiManagement.Models.ProductEntityBaseProperties ProductEntityBaseProperties (string description = default, string terms = default, bool? isSubscriptionRequired = default, bool? isApprovalRequired = default, int? subscriptionsLimit = default, Azure.ResourceManager.ApiManagement.Models.ApiManagementProductState? state = default);

static member ProductEntityBaseProperties : string * string * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<Azure.ResourceManager.ApiManagement.Models.ApiManagementProductState> -> Azure.ResourceManager.ApiManagement.Models.ProductEntityBaseProperties

Public Shared Function ProductEntityBaseProperties (Optional description As String = Nothing, Optional terms As String = Nothing, Optional isSubscriptionRequired As Nullable(Of Boolean) = Nothing, Optional isApprovalRequired As Nullable(Of Boolean) = Nothing, Optional subscriptionsLimit As Nullable(Of Integer) = Nothing, Optional state As Nullable(Of ApiManagementProductState) = Nothing) As ProductEntityBaseProperties

Parameters

description

String

Product description. May include HTML formatting tags.

terms

String

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.

isSubscriptionRequired

Nullable<Boolean>

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.

isApprovalRequired

Nullable<Boolean>

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.

subscriptionsLimit

Nullable<Int32>

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.

state

Nullable<ApiManagementProductState>

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.

Returns

ProductEntityBaseProperties

A new ProductEntityBaseProperties instance for mocking.