Docs
PackagesWe recommend using Azure Native.
azure.apimanagement.ProductTag
Explore with Pulumi AI
Manages an API Management Product tag
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@terraform.io",
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,
});
var exampleTag = new Azure.ApiManagement.Tag("exampleTag", new()
{
ApiManagementId = exampleService.Id,
});
var exampleProductTag = new Azure.ApiManagement.ProductTag("exampleProductTag", new()
{
ApiManagementProductId = exampleProduct.ProductId,
ApiManagementName = exampleService.Name,
ResourceGroupName = exampleResourceGroup.Name,
});
});
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@terraform.io"),
SkuName: pulumi.String("Developer_1"),
})
if err != nil {
return err
}
exampleProduct, 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
}
_, err = apimanagement.NewTag(ctx, "exampleTag", &apimanagement.TagArgs{
ApiManagementId: exampleService.ID(),
})
if err != nil {
return err
}
_, err = apimanagement.NewProductTag(ctx, "exampleProductTag", &apimanagement.ProductTagArgs{
ApiManagementProductId: exampleProduct.ProductId,
ApiManagementName: exampleService.Name,
ResourceGroupName: exampleResourceGroup.Name,
})
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 com.pulumi.azure.apimanagement.Tag;
import com.pulumi.azure.apimanagement.TagArgs;
import com.pulumi.azure.apimanagement.ProductTag;
import com.pulumi.azure.apimanagement.ProductTagArgs;
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@terraform.io")
.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());
var exampleTag = new Tag("exampleTag", TagArgs.builder()
.apiManagementId(exampleService.id())
.build());
var exampleProductTag = new ProductTag("exampleProductTag", ProductTagArgs.builder()
.apiManagementProductId(exampleProduct.productId())
.apiManagementName(exampleService.name())
.resourceGroupName(exampleResourceGroup.name())
.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@terraform.io",
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_tag = azure.apimanagement.Tag("exampleTag", api_management_id=example_service.id)
example_product_tag = azure.apimanagement.ProductTag("exampleProductTag",
api_management_product_id=example_product.product_id,
api_management_name=example_service.name,
resource_group_name=example_resource_group.name)
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@terraform.io",
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,
});
const exampleTag = new azure.apimanagement.Tag("exampleTag", {apiManagementId: exampleService.id});
const exampleProductTag = new azure.apimanagement.ProductTag("exampleProductTag", {
apiManagementProductId: exampleProduct.productId,
apiManagementName: exampleService.name,
resourceGroupName: exampleResourceGroup.name,
});
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@terraform.io
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
exampleTag:
type: azure:apimanagement:Tag
properties:
apiManagementId: ${exampleService.id}
exampleProductTag:
type: azure:apimanagement:ProductTag
properties:
apiManagementProductId: ${exampleProduct.productId}
apiManagementName: ${exampleService.name}
resourceGroupName: ${exampleResourceGroup.name}
Create ProductTag Resource
new ProductTag(name: string, args: ProductTagArgs, opts?: CustomResourceOptions);@overload
def ProductTag(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_management_name: Optional[str] = None,
api_management_product_id: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None)
@overload
def ProductTag(resource_name: str,
args: ProductTagArgs,
opts: Optional[ResourceOptions] = None)func NewProductTag(ctx *Context, name string, args ProductTagArgs, opts ...ResourceOption) (*ProductTag, error)public ProductTag(string name, ProductTagArgs args, CustomResourceOptions? opts = null)
public ProductTag(String name, ProductTagArgs args)
public ProductTag(String name, ProductTagArgs args, CustomResourceOptions options)
type: azure:apimanagement:ProductTag
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProductTagArgs
- 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 ProductTagArgs
- 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 ProductTagArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProductTagArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProductTagArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ProductTag 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 ProductTag 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.
- Api
Management stringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- 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.
- Name string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- Api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- Api
Management stringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- 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.
- Name string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- api
Management StringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- 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.
- name String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- api
Management stringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- 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.
- name string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- api_
management_ strname The name of the API Management Service. Changing this forces a new resource to be created.
- api_
management_ strproduct_ id The name of the API Management product. Changing this forces a new resource to be created.
- 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.
- name str
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- api
Management StringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- 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.
- name String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProductTag 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 ProductTag Resource
Get an existing ProductTag 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?: ProductTagState, opts?: CustomResourceOptions): ProductTag@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_management_name: Optional[str] = None,
api_management_product_id: Optional[str] = None,
name: Optional[str] = None,
resource_group_name: Optional[str] = None) -> ProductTagfunc GetProductTag(ctx *Context, name string, id IDInput, state *ProductTagState, opts ...ResourceOption) (*ProductTag, error)public static ProductTag Get(string name, Input<string> id, ProductTagState? state, CustomResourceOptions? opts = null)public static ProductTag get(String name, Output<String> id, ProductTagState 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.
- Api
Management stringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- Name string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- 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.
- Api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- Api
Management stringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- Name string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- 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.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- api
Management StringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- name String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- 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.
- api
Management stringName The name of the API Management Service. Changing this forces a new resource to be created.
- api
Management stringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- name string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- 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.
- api_
management_ strname The name of the API Management Service. Changing this forces a new resource to be created.
- api_
management_ strproduct_ id The name of the API Management product. Changing this forces a new resource to be created.
- name str
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- 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.
- api
Management StringName The name of the API Management Service. Changing this forces a new resource to be created.
- api
Management StringProduct Id The name of the API Management product. Changing this forces a new resource to be created.
- name String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
- 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.
Import
API Management Products can be imported using the resource id, e.g.
$ pulumi import azure:apimanagement/productTag:ProductTag example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/products/myproduct/tags/mytag
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
azurermTerraform Provider.