Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. TagByProduct
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.TagByProduct

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Tag Contract details. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.

Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

Example Usage

ApiManagementCreateProductTag

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var tagByProduct = new AzureNative.ApiManagement.TagByProduct("tagByProduct", new()
    {
        ProductId = "5931a75ae4bbd512a88c680b",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        TagId = "tagId1",
    });

});
Copy
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewTagByProduct(ctx, "tagByProduct", &apimanagement.TagByProductArgs{
			ProductId:         pulumi.String("5931a75ae4bbd512a88c680b"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			TagId:             pulumi.String("tagId1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.TagByProduct;
import com.pulumi.azurenative.apimanagement.TagByProductArgs;
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 tagByProduct = new TagByProduct("tagByProduct", TagByProductArgs.builder()
            .productId("5931a75ae4bbd512a88c680b")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tagId("tagId1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const tagByProduct = new azure_native.apimanagement.TagByProduct("tagByProduct", {
    productId: "5931a75ae4bbd512a88c680b",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    tagId: "tagId1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

tag_by_product = azure_native.apimanagement.TagByProduct("tagByProduct",
    product_id="5931a75ae4bbd512a88c680b",
    resource_group_name="rg1",
    service_name="apimService1",
    tag_id="tagId1")
Copy
resources:
  tagByProduct:
    type: azure-native:apimanagement:TagByProduct
    properties:
      productId: 5931a75ae4bbd512a88c680b
      resourceGroupName: rg1
      serviceName: apimService1
      tagId: tagId1
Copy

Create TagByProduct Resource

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

Constructor syntax

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

@overload
def TagByProduct(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 product_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 service_name: Optional[str] = None,
                 tag_id: Optional[str] = None)
func NewTagByProduct(ctx *Context, name string, args TagByProductArgs, opts ...ResourceOption) (*TagByProduct, error)
public TagByProduct(string name, TagByProductArgs args, CustomResourceOptions? opts = null)
public TagByProduct(String name, TagByProductArgs args)
public TagByProduct(String name, TagByProductArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TagByProductArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. TagByProductArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. TagByProductArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TagByProductArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TagByProductArgs
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 tagByProductResource = new AzureNative.Apimanagement.TagByProduct("tagByProductResource", new()
{
    ProductId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    TagId = "string",
});
Copy
example, err := apimanagement.NewTagByProduct(ctx, "tagByProductResource", &apimanagement.TagByProductArgs{
	ProductId:         "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	TagId:             "string",
})
Copy
var tagByProductResource = new TagByProduct("tagByProductResource", TagByProductArgs.builder()
    .productId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .tagId("string")
    .build());
Copy
tag_by_product_resource = azure_native.apimanagement.TagByProduct("tagByProductResource",
    product_id=string,
    resource_group_name=string,
    service_name=string,
    tag_id=string)
Copy
const tagByProductResource = new azure_native.apimanagement.TagByProduct("tagByProductResource", {
    productId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    tagId: "string",
});
Copy
type: azure-native:apimanagement:TagByProduct
properties:
    productId: string
    resourceGroupName: string
    serviceName: string
    tagId: string
Copy

TagByProduct Resource Properties

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

Inputs

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

The TagByProduct resource accepts the following input properties:

ProductId
This property is required.
Changes to this property will trigger replacement.
string
Product identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
TagId Changes to this property will trigger replacement. string
Tag identifier. Must be unique in the current API Management service instance.
ProductId
This property is required.
Changes to this property will trigger replacement.
string
Product identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
TagId Changes to this property will trigger replacement. string
Tag identifier. Must be unique in the current API Management service instance.
productId
This property is required.
Changes to this property will trigger replacement.
String
Product identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
tagId Changes to this property will trigger replacement. String
Tag identifier. Must be unique in the current API Management service instance.
productId
This property is required.
Changes to this property will trigger replacement.
string
Product identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
tagId Changes to this property will trigger replacement. string
Tag identifier. Must be unique in the current API Management service instance.
product_id
This property is required.
Changes to this property will trigger replacement.
str
Product identifier. Must be unique in the current API Management service instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
tag_id Changes to this property will trigger replacement. str
Tag identifier. Must be unique in the current API Management service instance.
productId
This property is required.
Changes to this property will trigger replacement.
String
Product identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
tagId Changes to this property will trigger replacement. String
Tag identifier. Must be unique in the current API Management service instance.

Outputs

All input properties are implicitly available as output properties. Additionally, the TagByProduct resource produces the following output properties:

DisplayName string
Tag name.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
DisplayName string
Tag name.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
displayName String
Tag name.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
displayName string
Tag name.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
display_name str
Tag name.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
displayName String
Tag name.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:TagByProduct tagId1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/tags/{tagId}
Copy

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

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native