Product

Manages an API Management Product.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleService = new Azure.ApiManagement.Service("exampleService", new Azure.ApiManagement.ServiceArgs
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@exmaple.com",
            SkuName = "Developer_1",
        });
        var exampleProduct = new Azure.ApiManagement.Product("exampleProduct", new Azure.ApiManagement.ProductArgs
        {
            ProductId = "test-product",
            ApiManagementName = exampleService.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            DisplayName = "Test Product",
            SubscriptionRequired = true,
            ApprovalRequired = true,
            Published = true,
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/apimanagement"
    "github.com/pulumi/pulumi-azure/sdk/v3/go/azure/core"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
            Location: pulumi.String("West Europe"),
        })
        if err != nil {
            return err
        }
        exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
            Location:          exampleResourceGroup.Location,
            ResourceGroupName: exampleResourceGroup.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, "exampleProduct", &apimanagement.ProductArgs{
            ProductId:            pulumi.String("test-product"),
            ApiManagementName:    exampleService.Name,
            ResourceGroupName:    exampleResourceGroup.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
    })
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_service = azure.apimanagement.Service("exampleService",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_product = azure.apimanagement.Product("exampleProduct",
    product_id="test-product",
    api_management_name=example_service.name,
    resource_group_name=example_resource_group.name,
    display_name="Test Product",
    subscription_required=True,
    approval_required=True,
    published=True)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleService = new azure.apimanagement.Service("exampleService", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleProduct = new azure.apimanagement.Product("exampleProduct", {
    productId: "test-product",
    apiManagementName: exampleService.name,
    resourceGroupName: exampleResourceGroup.name,
    displayName: "Test Product",
    subscriptionRequired: true,
    approvalRequired: true,
    published: true,
});

Create a Product Resource

new Product(name: string, args: ProductArgs, opts?: CustomResourceOptions);

def Product(resource_name, opts=None, api_management_name=None, approval_required=None, description=None, display_name=None, product_id=None, published=None, resource_group_name=None, subscription_required=None, subscriptions_limit=None, terms=None, __props__=None);

func NewProduct(ctx *Context, name string, args ProductArgs, opts ...ResourceOption) (*Product, error)

public Product(string name, ProductArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ProductArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ProductArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProductArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Product Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Product resource accepts the following input properties:

ApiManagementName string: The name of the API Management Service. Changing this forces a new resource to be created.
DisplayName string: The Display Name for this API Management Product.
ProductId string: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
Published bool: Is this Product Published?
ResourceGroupName string: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
SubscriptionRequired bool: Is a Subscription required to access API’s included in this Product?
ApprovalRequired bool: Do subscribers need to be approved prior to being able to use the Product?
Description string: A description of this Product, which may include HTML formatting tags.
SubscriptionsLimit int: The number of subscriptions a user can have to this Product at the same time.
Terms string: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

ApiManagementName string: The name of the API Management Service. Changing this forces a new resource to be created.
DisplayName string: The Display Name for this API Management Product.
ProductId string: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
Published bool: Is this Product Published?
ResourceGroupName string: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
SubscriptionRequired bool: Is a Subscription required to access API’s included in this Product?
ApprovalRequired bool: Do subscribers need to be approved prior to being able to use the Product?
Description string: A description of this Product, which may include HTML formatting tags.
SubscriptionsLimit int: The number of subscriptions a user can have to this Product at the same time.
Terms string: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

apiManagementName string: The name of the API Management Service. Changing this forces a new resource to be created.
displayName string: The Display Name for this API Management Product.
productId string: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
published boolean: Is this Product Published?
resourceGroupName string: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
subscriptionRequired boolean: Is a Subscription required to access API’s included in this Product?
approvalRequired boolean: Do subscribers need to be approved prior to being able to use the Product?
description string: A description of this Product, which may include HTML formatting tags.
subscriptionsLimit number: The number of subscriptions a user can have to this Product at the same time.
terms string: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

api_management_name str: The name of the API Management Service. Changing this forces a new resource to be created.
display_name str: The Display Name for this API Management Product.
product_id str: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
published bool: Is this Product Published?
resource_group_name str: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
subscription_required bool: Is a Subscription required to access API’s included in this Product?
approval_required bool: Do subscribers need to be approved prior to being able to use the Product?
description str: A description of this Product, which may include HTML formatting tags.
subscriptions_limit float: The number of subscriptions a user can have to this Product at the same time.
terms str: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

Outputs

All input properties are implicitly available as output properties. Additionally, the Product resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Product Resource

Get an existing Product resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ProductState, opts?: CustomResourceOptions): Product

static get(resource_name, id, opts=None, api_management_name=None, approval_required=None, description=None, display_name=None, product_id=None, published=None, resource_group_name=None, subscription_required=None, subscriptions_limit=None, terms=None, __props__=None);

func GetProduct(ctx *Context, name string, id IDInput, state *ProductState, opts ...ResourceOption) (*Product, error)

public static Product Get(string name, Input<string> id, ProductState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiManagementName string: The name of the API Management Service. Changing this forces a new resource to be created.
ApprovalRequired bool: Do subscribers need to be approved prior to being able to use the Product?
Description string: A description of this Product, which may include HTML formatting tags.
DisplayName string: The Display Name for this API Management Product.
ProductId string: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
Published bool: Is this Product Published?
ResourceGroupName string: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
SubscriptionRequired bool: Is a Subscription required to access API’s included in this Product?
SubscriptionsLimit int: The number of subscriptions a user can have to this Product at the same time.
Terms string: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

ApiManagementName string: The name of the API Management Service. Changing this forces a new resource to be created.
ApprovalRequired bool: Do subscribers need to be approved prior to being able to use the Product?
Description string: A description of this Product, which may include HTML formatting tags.
DisplayName string: The Display Name for this API Management Product.
ProductId string: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
Published bool: Is this Product Published?
ResourceGroupName string: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
SubscriptionRequired bool: Is a Subscription required to access API’s included in this Product?
SubscriptionsLimit int: The number of subscriptions a user can have to this Product at the same time.
Terms string: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

apiManagementName string: The name of the API Management Service. Changing this forces a new resource to be created.
approvalRequired boolean: Do subscribers need to be approved prior to being able to use the Product?
description string: A description of this Product, which may include HTML formatting tags.
displayName string: The Display Name for this API Management Product.
productId string: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
published boolean: Is this Product Published?
resourceGroupName string: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
subscriptionRequired boolean: Is a Subscription required to access API’s included in this Product?
subscriptionsLimit number: The number of subscriptions a user can have to this Product at the same time.
terms string: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

api_management_name str: The name of the API Management Service. Changing this forces a new resource to be created.
approval_required bool: Do subscribers need to be approved prior to being able to use the Product?
description str: A description of this Product, which may include HTML formatting tags.
display_name str: The Display Name for this API Management Product.
product_id str: The Identifier for this Product, which must be unique within the API Management Service. Changing this forces a new resource to be created.
published bool: Is this Product Published?
resource_group_name str: The name of the Resource Group in which the API Management Service should be exist. Changing this forces a new resource to be created.
subscription_required bool: Is a Subscription required to access API’s included in this Product?
subscriptions_limit float: The number of subscriptions a user can have to this Product at the same time.
terms str: The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.

Package Details

Repository: https://github.com/pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud