ProductArgs

data class ProductArgs(val apiManagementName: Output<String>? = null, val approvalRequired: Output<Boolean>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val productId: Output<String>? = null, val published: Output<Boolean>? = null, val resourceGroupName: Output<String>? = null, val subscriptionRequired: Output<Boolean>? = null, val subscriptionsLimit: Output<Int>? = null, val terms: Output<String>? = null) : ConvertibleToJava<ProductArgs>

Manages an API Management Product.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Product;
import com.pulumi.azure.apimanagement.ProductArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.publisherName("My Company")
.publisherEmail("company@exmaple.com")
.skuName("Developer_1")
.build());
var exampleProduct = new Product("exampleProduct", ProductArgs.builder()
.productId("test-product")
.apiManagementName(exampleService.name())
.resourceGroupName(exampleResourceGroup.name())
.displayName("Test Product")
.subscriptionRequired(true)
.approvalRequired(true)
.published(true)
.build());
}
}

Import

API Management Products can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/product:Product example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/products/myproduct

Constructors

Link copied to clipboard
fun ProductArgs(apiManagementName: Output<String>? = null, approvalRequired: Output<Boolean>? = null, description: Output<String>? = null, displayName: Output<String>? = null, productId: Output<String>? = null, published: Output<Boolean>? = null, resourceGroupName: Output<String>? = null, subscriptionRequired: Output<Boolean>? = null, subscriptionsLimit: Output<Int>? = null, terms: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ProductArgs

Properties

Link copied to clipboard
val apiManagementName: Output<String>? = null

The name of the API Management Service. Changing this forces a new resource to be created.

Link copied to clipboard
val approvalRequired: Output<Boolean>? = null

Do subscribers need to be approved prior to being able to use the Product?

Link copied to clipboard
val description: Output<String>? = null

A description of this Product, which may include HTML formatting tags.

Link copied to clipboard
val displayName: Output<String>? = null

The Display Name for this API Management Product.

Link copied to clipboard
val productId: Output<String>? = null

The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.

Link copied to clipboard
val published: Output<Boolean>? = null

Is this Product Published?

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.

Link copied to clipboard
val subscriptionRequired: Output<Boolean>? = null

Is a Subscription required to access API's included in this Product? Defaults to true.

Link copied to clipboard
val subscriptionsLimit: Output<Int>? = null

The number of subscriptions a user can have to this Product at the same time.

Link copied to clipboard
val terms: Output<String>? = null

The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.