We recommend using Azure Native.
azure.apimanagement.Product
Explore with Pulumi AI
Manages an API Management Product.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleService = new Azure.ApiManagement.Service("exampleService", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
PublisherName = "My Company",
PublisherEmail = "company@exmaple.com",
SkuName = "Developer_1",
});
var exampleProduct = new Azure.ApiManagement.Product("exampleProduct", new()
{
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/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 {
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
})
}
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 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,
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleService:
type: azure:apimanagement:Service
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
publisherName: My Company
publisherEmail: company@exmaple.com
skuName: Developer_1
exampleProduct:
type: azure:apimanagement:Product
properties:
productId: test-product
apiManagementName: ${exampleService.name}
resourceGroupName: ${exampleResourceGroup.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:
- Api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- Display
Name string The Display Name for this API Management Product.
- Product
Id 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?
- Resource
Group stringName 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 whensubscription_required
is set totrue
.- Description string
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 whensubscription_required
is set totrue
.- Terms string
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- Api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- Display
Name string The Display Name for this API Management Product.
- Product
Id 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?
- Resource
Group stringName 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 whensubscription_required
is set totrue
.- Description string
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 whensubscription_required
is set totrue
.- Terms string
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- display
Name String The Display Name for this API Management Product.
- product
Id 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?
- resource
Group StringName 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 Boolean Do subscribers need to be approved prior to being able to use the Product?
NOTE:
approval_required
can only be set whensubscription_required
is set totrue
.- description String
A description of this Product, which may include HTML formatting tags.
- subscription
Required Boolean Is a Subscription required to access API's included in this Product? Defaults to
true
.- subscriptions
Limit Integer The number of subscriptions a user can have to this Product at the same time.
NOTE:
subscriptions_limit
can only be set whensubscription_required
is set totrue
.- terms String
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- display
Name string The Display Name for this API Management Product.
- product
Id 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?
- resource
Group stringName 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 boolean Do subscribers need to be approved prior to being able to use the Product?
NOTE:
approval_required
can only be set whensubscription_required
is set totrue
.- description string
A description of this Product, which may include HTML formatting tags.
- subscription
Required boolean Is a Subscription required to access API's included in this Product? Defaults to
true
.- subscriptions
Limit number The number of subscriptions a user can have to this Product at the same time.
NOTE:
subscriptions_limit
can only be set whensubscription_required
is set totrue
.- terms string
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api_
management_ strname 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_ strname 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 whensubscription_required
is set totrue
.- 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 whensubscription_required
is set totrue
.- terms str
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- display
Name String The Display Name for this API Management Product.
- product
Id 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?
- resource
Group StringName 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 Boolean Do subscribers need to be approved prior to being able to use the Product?
NOTE:
approval_required
can only be set whensubscription_required
is set totrue
.- description String
A description of this Product, which may include HTML formatting tags.
- subscription
Required Boolean Is a Subscription required to access API's included in this Product? Defaults to
true
.- subscriptions
Limit Number The number of subscriptions a user can have to this Product at the same time.
NOTE:
subscriptions_limit
can only be set whensubscription_required
is set totrue
.- 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.
- Api
Management stringName 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 whensubscription_required
is set totrue
.- Description string
A description of this Product, which may include HTML formatting tags.
- Display
Name string The Display Name for this API Management Product.
- Product
Id 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?
- Resource
Group stringName 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 whensubscription_required
is set totrue
.- Terms string
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- Api
Management stringName 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 whensubscription_required
is set totrue
.- Description string
A description of this Product, which may include HTML formatting tags.
- Display
Name string The Display Name for this API Management Product.
- Product
Id 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?
- Resource
Group stringName 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 whensubscription_required
is set totrue
.- Terms string
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- approval
Required Boolean Do subscribers need to be approved prior to being able to use the Product?
NOTE:
approval_required
can only be set whensubscription_required
is set totrue
.- description String
A description of this Product, which may include HTML formatting tags.
- display
Name String The Display Name for this API Management Product.
- product
Id 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?
- resource
Group StringName 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 Boolean Is a Subscription required to access API's included in this Product? Defaults to
true
.- subscriptions
Limit Integer The number of subscriptions a user can have to this Product at the same time.
NOTE:
subscriptions_limit
can only be set whensubscription_required
is set totrue
.- terms String
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- approval
Required boolean Do subscribers need to be approved prior to being able to use the Product?
NOTE:
approval_required
can only be set whensubscription_required
is set totrue
.- description string
A description of this Product, which may include HTML formatting tags.
- display
Name string The Display Name for this API Management Product.
- product
Id 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?
- resource
Group stringName 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 boolean Is a Subscription required to access API's included in this Product? Defaults to
true
.- subscriptions
Limit number The number of subscriptions a user can have to this Product at the same time.
NOTE:
subscriptions_limit
can only be set whensubscription_required
is set totrue
.- terms string
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api_
management_ strname 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 whensubscription_required
is set totrue
.- 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_ strname 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 whensubscription_required
is set totrue
.- terms str
The Terms and Conditions for this Product, which must be accepted by Developers before they can begin the Subscription process.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- approval
Required Boolean Do subscribers need to be approved prior to being able to use the Product?
NOTE:
approval_required
can only be set whensubscription_required
is set totrue
.- description String
A description of this Product, which may include HTML formatting tags.
- display
Name String The Display Name for this API Management Product.
- product
Id 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?
- resource
Group StringName 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 Boolean Is a Subscription required to access API's included in this Product? Defaults to
true
.- subscriptions
Limit Number The number of subscriptions a user can have to this Product at the same time.
NOTE:
subscriptions_limit
can only be set whensubscription_required
is set totrue
.- 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.