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

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.apimanagement.Product

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    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)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi-azure/sdk/v5/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
    	})
    }
    
    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 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
    

    Create Product Resource

    new Product(name: string, args: ProductArgs, opts?: CustomResourceOptions);
    @overload
    def Product(resource_name: 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)
    @overload
    def Product(resource_name: str,
                args: ProductArgs,
                opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    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.
    ApprovalRequired bool

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

    NOTE: approval_required can only be set when subscription_required is set to true.

    Description string
    A description of this Product, which may include HTML formatting tags.
    SubscriptionRequired bool
    Is a Subscription required to access API's included in this Product? Defaults to true.
    SubscriptionsLimit int

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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.
    ApprovalRequired bool

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

    NOTE: approval_required can only be set when subscription_required is set to true.

    Description string
    A description of this Product, which may include HTML formatting tags.
    SubscriptionRequired bool
    Is a Subscription required to access API's included in this Product? Defaults to true.
    SubscriptionsLimit int

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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.
    approvalRequired Boolean

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

    NOTE: approval_required can only be set when subscription_required is set to true.

    description String
    A description of this Product, which may include HTML formatting tags.
    subscriptionRequired Boolean
    Is a Subscription required to access API's included in this Product? Defaults to true.
    subscriptionsLimit Integer

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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.
    approvalRequired boolean

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

    NOTE: approval_required can only be set when subscription_required is set to true.

    description string
    A description of this Product, which may include HTML formatting tags.
    subscriptionRequired boolean
    Is a Subscription required to access API's included in this Product? Defaults to true.
    subscriptionsLimit number

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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.
    approval_required bool

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

    NOTE: approval_required can only be set when subscription_required is set to true.

    description str
    A description of this Product, which may include HTML formatting tags.
    subscription_required bool
    Is a Subscription required to access API's included in this Product? Defaults to true.
    subscriptions_limit int

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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.
    approvalRequired Boolean

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

    NOTE: approval_required can only be set when subscription_required is set to true.

    description String
    A description of this Product, which may include HTML formatting tags.
    subscriptionRequired Boolean
    Is a Subscription required to access API's included in this Product? Defaults to true.
    subscriptionsLimit Number

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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)
    Resource lookup is not supported in YAML
    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?

    NOTE: approval_required can only be set when subscription_required is set to true.

    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? Defaults to true.
    SubscriptionsLimit int

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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?

    NOTE: approval_required can only be set when subscription_required is set to true.

    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? Defaults to true.
    SubscriptionsLimit int

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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?

    NOTE: approval_required can only be set when subscription_required is set to true.

    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? Defaults to true.
    subscriptionsLimit Integer

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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?

    NOTE: approval_required can only be set when subscription_required is set to true.

    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? Defaults to true.
    subscriptionsLimit number

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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?

    NOTE: approval_required can only be set when subscription_required is set to true.

    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? Defaults to true.
    subscriptions_limit int

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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?

    NOTE: approval_required can only be set when subscription_required is set to true.

    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? Defaults to true.
    subscriptionsLimit Number

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

    NOTE: subscriptions_limit can only be set when subscription_required is set to true.

    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
    

    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.

    Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi