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

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.ProductTag

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an API Management Product tag

    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@terraform.io",
    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,
});
const exampleTag = new azure.apimanagement.Tag("example", {
    apiManagementId: exampleService.id,
    name: "example-tag",
});
const exampleProductTag = new azure.apimanagement.ProductTag("example", {
    apiManagementProductId: exampleProduct.productId,
    apiManagementName: exampleService.name,
    resourceGroupName: example.name,
    name: exampleTag.name,
});

    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@terraform.io",
    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)
example_tag = azure.apimanagement.Tag("example",
    api_management_id=example_service.id,
    name="example-tag")
example_product_tag = azure.apimanagement.ProductTag("example",
    api_management_product_id=example_product.product_id,
    api_management_name=example_service.name,
    resource_group_name=example.name,
    name=example_tag.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 {
		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@terraform.io"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		exampleProduct, 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
		}
		exampleTag, err := apimanagement.NewTag(ctx, "example", &apimanagement.TagArgs{
			ApiManagementId: exampleService.ID(),
			Name:            pulumi.String("example-tag"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewProductTag(ctx, "example", &apimanagement.ProductTagArgs{
			ApiManagementProductId: exampleProduct.ProductId,
			ApiManagementName:      exampleService.Name,
			ResourceGroupName:      example.Name,
			Name:                   exampleTag.Name,
		})
		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@terraform.io",
        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,
    });

    var exampleTag = new Azure.ApiManagement.Tag("example", new()
    {
        ApiManagementId = exampleService.Id,
        Name = "example-tag",
    });

    var exampleProductTag = new Azure.ApiManagement.ProductTag("example", new()
    {
        ApiManagementProductId = exampleProduct.ProductId,
        ApiManagementName = exampleService.Name,
        ResourceGroupName = example.Name,
        Name = exampleTag.Name,
    });

});

    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 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@terraform.io")
            .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());

        var exampleTag = new Tag("exampleTag", TagArgs.builder()
            .apiManagementId(exampleService.id())
            .name("example-tag")
            .build());

        var exampleProductTag = new ProductTag("exampleProductTag", ProductTagArgs.builder()
            .apiManagementProductId(exampleProduct.productId())
            .apiManagementName(exampleService.name())
            .resourceGroupName(example.name())
            .name(exampleTag.name())
            .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@terraform.io
      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
  exampleTag:
    type: azure:apimanagement:Tag
    name: example
    properties:
      apiManagementId: ${exampleService.id}
      name: example-tag
  exampleProductTag:
    type: azure:apimanagement:ProductTag
    name: example
    properties:
      apiManagementProductId: ${exampleProduct.productId}
      apiManagementName: ${exampleService.name}
      resourceGroupName: ${example.name}
      name: ${exampleTag.name}

    Create ProductTag Resource

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

    Constructor syntax

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

@overload
def ProductTag(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               api_management_name: Optional[str] = None,
               api_management_product_id: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               name: Optional[str] = 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.

    Parameters

    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.

    Constructor example

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

    var productTagResource = new Azure.ApiManagement.ProductTag("productTagResource", new()
{
    ApiManagementName = "string",
    ApiManagementProductId = "string",
    ResourceGroupName = "string",
    Name = "string",
});

    example, err := apimanagement.NewProductTag(ctx, "productTagResource", &apimanagement.ProductTagArgs{
	ApiManagementName:      pulumi.String("string"),
	ApiManagementProductId: pulumi.String("string"),
	ResourceGroupName:      pulumi.String("string"),
	Name:                   pulumi.String("string"),
})

    var productTagResource = new ProductTag("productTagResource", ProductTagArgs.builder()
    .apiManagementName("string")
    .apiManagementProductId("string")
    .resourceGroupName("string")
    .name("string")
    .build());

    product_tag_resource = azure.apimanagement.ProductTag("productTagResource",
    api_management_name="string",
    api_management_product_id="string",
    resource_group_name="string",
    name="string")

    const productTagResource = new azure.apimanagement.ProductTag("productTagResource", {
    apiManagementName: "string",
    apiManagementProductId: "string",
    resourceGroupName: "string",
    name: "string",
});

    type: azure:apimanagement:ProductTag
properties:
    apiManagementName: string
    apiManagementProductId: string
    name: string
    resourceGroupName: string

    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:

    ApiManagementName string
    The name of the API Management Service. Changing this forces a new resource to be created.
    ApiManagementProductId string
    The name of the API Management product. Changing this forces a new resource to be created.
    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.
    Name string
    The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
    ApiManagementName string
    The name of the API Management Service. Changing this forces a new resource to be created.
    ApiManagementProductId string
    The name of the API Management product. Changing this forces a new resource to be created.
    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.
    Name string
    The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
    apiManagementName String
    The name of the API Management Service. Changing this forces a new resource to be created.
    apiManagementProductId String
    The name of the API Management product. Changing this forces a new resource to be created.
    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.
    name String
    The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
    apiManagementName string
    The name of the API Management Service. Changing this forces a new resource to be created.
    apiManagementProductId string
    The name of the API Management product. Changing this forces a new resource to be created.
    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.
    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_name str
    The name of the API Management Service. Changing this forces a new resource to be created.
    api_management_product_id str
    The name of the API Management product. Changing this forces a new resource to be created.
    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.
    name str
    The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created.
    apiManagementName String
    The name of the API Management Service. Changing this forces a new resource to be created.
    apiManagementProductId String
    The name of the API Management product. Changing this forces a new resource to be created.
    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.
    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) -> ProductTag
    func 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.
    The following state arguments are supported:
    ApiManagementName string
    The name of the API Management Service. Changing this forces a new resource to be created.
    ApiManagementProductId string
    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.
    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.
    ApiManagementName string
    The name of the API Management Service. Changing this forces a new resource to be created.
    ApiManagementProductId string
    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.
    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.
    apiManagementName String
    The name of the API Management Service. Changing this forces a new resource to be created.
    apiManagementProductId String
    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.
    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.
    apiManagementName string
    The name of the API Management Service. Changing this forces a new resource to be created.
    apiManagementProductId string
    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.
    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.
    api_management_name str
    The name of the API Management Service. Changing this forces a new resource to be created.
    api_management_product_id str
    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_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.
    apiManagementName String
    The name of the API Management Service. Changing this forces a new resource to be created.
    apiManagementProductId String
    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.
    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.

    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

    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.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure