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

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleService = new azure.apimanagement.Service("example", {
name: "example-apim",
location: example.location,
resourceGroupName: example.name,
publisherName: "My Company",
publisherEmail: "company@exmaple.com",
skuName: "Developer_1",
});
const exampleProduct = new azure.apimanagement.Product("example", {
productId: "test-product",
apiManagementName: exampleService.name,
resourceGroupName: example.name,
displayName: "Test Product",
subscriptionRequired: true,
approvalRequired: true,
published: true,
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_service = azure.apimanagement.Service("example",
name="example-apim",
location=example.location,
resource_group_name=example.name,
publisher_name="My Company",
publisher_email="company@exmaple.com",
sku_name="Developer_1")
example_product = azure.apimanagement.Product("example",
product_id="test-product",
api_management_name=example_service.name,
resource_group_name=example.name,
display_name="Test Product",
subscription_required=True,
approval_required=True,
published=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("example", new()
{
Name = "example-apim",
Location = example.Location,
ResourceGroupName = example.Name,
PublisherName = "My Company",
PublisherEmail = "company@exmaple.com",
SkuName = "Developer_1",
});
var exampleProduct = new Azure.ApiManagement.Product("example", new()
{
ProductId = "test-product",
ApiManagementName = exampleService.Name,
ResourceGroupName = example.Name,
DisplayName = "Test Product",
SubscriptionRequired = true,
ApprovalRequired = true,
Published = true,
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
Name: pulumi.String("example-apim"),
Location: example.Location,
ResourceGroupName: example.Name,
PublisherName: pulumi.String("My Company"),
PublisherEmail: pulumi.String("company@exmaple.com"),
SkuName: pulumi.String("Developer_1"),
})
if err != nil {
return err
}
_, err = apimanagement.NewProduct(ctx, "example", &apimanagement.ProductArgs{
ProductId: pulumi.String("test-product"),
ApiManagementName: exampleService.Name,
ResourceGroupName: example.Name,
DisplayName: pulumi.String("Test Product"),
SubscriptionRequired: pulumi.Bool(true),
ApprovalRequired: pulumi.Bool(true),
Published: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.name("example-apim")
.location(example.location())
.resourceGroupName(example.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(example.name())
.displayName("Test Product")
.subscriptionRequired(true)
.approvalRequired(true)
.published(true)
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleService:
type: azure:apimanagement:Service
name: example
properties:
name: example-apim
location: ${example.location}
resourceGroupName: ${example.name}
publisherName: My Company
publisherEmail: company@exmaple.com
skuName: Developer_1
exampleProduct:
type: azure:apimanagement:Product
name: example
properties:
productId: test-product
apiManagementName: ${exampleService.name}
resourceGroupName: ${example.name}
displayName: Test Product
subscriptionRequired: true
approvalRequired: true
published: true

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
constructor(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)

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.

Functions

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