1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. Product

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.apimanagement.Product

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    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/v4/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

    Example coming soon!

    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,
});

    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)

    Example coming soon!

    Create Product Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Product(name: string, args: ProductArgs, opts?: CustomResourceOptions);
    @overload
def Product(resource_name: str,
            args: ProductArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Product(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_management_name: Optional[str] = None,
            display_name: Optional[str] = None,
            product_id: Optional[str] = None,
            published: Optional[bool] = None,
            resource_group_name: Optional[str] = None,
            subscription_required: Optional[bool] = None,
            approval_required: Optional[bool] = None,
            description: Optional[str] = None,
            subscriptions_limit: Optional[int] = None,
            terms: Optional[str] = None)
    func NewProduct(ctx *Context, name string, args ProductArgs, opts ...ResourceOption) (*Product, error)
    public Product(string name, ProductArgs args, CustomResourceOptions? opts = null)
    public Product(String name, ProductArgs args)
public Product(String name, ProductArgs args, CustomResourceOptions options)

    type: azure:apimanagement:Product
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args ProductArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args ProductArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var productResource = new Azure.ApiManagement.Product("productResource", new()
{
    ApiManagementName = "string",
    DisplayName = "string",
    ProductId = "string",
    Published = false,
    ResourceGroupName = "string",
    SubscriptionRequired = false,
    ApprovalRequired = false,
    Description = "string",
    SubscriptionsLimit = 0,
    Terms = "string",
});

    example, err := apimanagement.NewProduct(ctx, "productResource", &apimanagement.ProductArgs{
	ApiManagementName:    pulumi.String("string"),
	DisplayName:          pulumi.String("string"),
	ProductId:            pulumi.String("string"),
	Published:            pulumi.Bool(false),
	ResourceGroupName:    pulumi.String("string"),
	SubscriptionRequired: pulumi.Bool(false),
	ApprovalRequired:     pulumi.Bool(false),
	Description:          pulumi.String("string"),
	SubscriptionsLimit:   pulumi.Int(0),
	Terms:                pulumi.String("string"),
})

    var productResource = new Product("productResource", ProductArgs.builder()
    .apiManagementName("string")
    .displayName("string")
    .productId("string")
    .published(false)
    .resourceGroupName("string")
    .subscriptionRequired(false)
    .approvalRequired(false)
    .description("string")
    .subscriptionsLimit(0)
    .terms("string")
    .build());

    product_resource = azure.apimanagement.Product("productResource",
    api_management_name="string",
    display_name="string",
    product_id="string",
    published=False,
    resource_group_name="string",
    subscription_required=False,
    approval_required=False,
    description="string",
    subscriptions_limit=0,
    terms="string")

    const productResource = new azure.apimanagement.Product("productResource", {
    apiManagementName: "string",
    displayName: "string",
    productId: "string",
    published: false,
    resourceGroupName: "string",
    subscriptionRequired: false,
    approvalRequired: false,
    description: "string",
    subscriptionsLimit: 0,
    terms: "string",
});

    type: azure:apimanagement:Product
properties:
    apiManagementName: string
    approvalRequired: false
    description: string
    displayName: string
    productId: string
    published: false
    resourceGroupName: string
    subscriptionRequired: false
    subscriptionsLimit: 0
    terms: string

    Product Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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 Integer
    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 int
    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.
    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.

    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_name: Optional[str] = None,
        approval_required: Optional[bool] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        product_id: Optional[str] = None,
        published: Optional[bool] = None,
        resource_group_name: Optional[str] = None,
        subscription_required: Optional[bool] = None,
        subscriptions_limit: Optional[int] = None,
        terms: Optional[str] = None) -> Product
    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)
    public static Product get(String name, Output<String> id, ProductState state, CustomResourceOptions options)
    resources:  _:    type: azure:apimanagement:Product    get:      id: ${id}
    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.
    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 Integer
    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 int
    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.
    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.

    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.