pulumi-azure-native-kotlin/com.pulumi.azurenative.apimanagement.kotlin.outputs/GetProductResult

GetProductResult

data class GetProductResult(val approvalRequired: Boolean? = null, val description: String? = null, val displayName: String, val id: String, val name: String, val state: String? = null, val subscriptionRequired: Boolean? = null, val subscriptionsLimit: Int? = null, val terms: String? = null, val type: String)

Product details.

Constructors

GetProductResult

constructor(approvalRequired: Boolean? = null, description: String? = null, displayName: String, id: String, name: String, state: String? = null, subscriptionRequired: Boolean? = null, subscriptionsLimit: Int? = null, terms: String? = null, type: String)

Types

Companion

object Companion

Properties

approvalRequired

val approvalRequired: Boolean? = null

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

val description: String? = null

Product description. May include HTML formatting tags.

displayName

val displayName: String

Product name.

val id: String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

val name: String

The name of the resource

state

val state: String? = null

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

val subscriptionRequired: Boolean? = null

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

val subscriptionsLimit: Int? = null

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

val terms: String? = null

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.

type

val type: String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"