Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. Tag

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.Tag

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a API Management 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: "Consumption_0",
});
const exampleTag = new azure.apimanagement.Tag("example", {
    apiManagementId: exampleService.id,
    name: "example-Tag",
});
Copy
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="Consumption_0")
example_tag = azure.apimanagement.Tag("example",
    api_management_id=example_service.id,
    name="example-Tag")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/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("Consumption_0"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewTag(ctx, "example", &apimanagement.TagArgs{
			ApiManagementId: exampleService.ID(),
			Name:            pulumi.String("example-Tag"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "Consumption_0",
    });

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

});
Copy
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.Tag;
import com.pulumi.azure.apimanagement.TagArgs;
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("Consumption_0")
            .build());

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

    }
}
Copy
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: Consumption_0
  exampleTag:
    type: azure:apimanagement:Tag
    name: example
    properties:
      apiManagementId: ${exampleService.id}
      name: example-Tag
Copy

Create Tag Resource

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

Constructor syntax

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

@overload
def Tag(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None)
func NewTag(ctx *Context, name string, args TagArgs, opts ...ResourceOption) (*Tag, error)
public Tag(string name, TagArgs args, CustomResourceOptions? opts = null)
public Tag(String name, TagArgs args)
public Tag(String name, TagArgs args, CustomResourceOptions options)

type: azure:apimanagement:Tag
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. TagArgs
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. TagArgs
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. TagArgs
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. TagArgs
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. TagArgs
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 tagResource = new Azure.ApiManagement.Tag("tagResource", new()
{
    ApiManagementId = "string",
    DisplayName = "string",
    Name = "string",
});
Copy
example, err := apimanagement.NewTag(ctx, "tagResource", &apimanagement.TagArgs{
	ApiManagementId: pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	Name:            pulumi.String("string"),
})
Copy
var tagResource = new Tag("tagResource", TagArgs.builder()
    .apiManagementId("string")
    .displayName("string")
    .name("string")
    .build());
Copy
tag_resource = azure.apimanagement.Tag("tagResource",
    api_management_id="string",
    display_name="string",
    name="string")
Copy
const tagResource = new azure.apimanagement.Tag("tagResource", {
    apiManagementId: "string",
    displayName: "string",
    name: "string",
});
Copy
type: azure:apimanagement:Tag
properties:
    apiManagementId: string
    displayName: string
    name: string
Copy

Tag 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 Tag resource accepts the following input properties:

ApiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the API Management. Changing this forces a new API Management Tag to be created.
DisplayName string
The display name of the API Management Tag. Defaults to the name.
Name Changes to this property will trigger replacement. string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
ApiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the API Management. Changing this forces a new API Management Tag to be created.
DisplayName string
The display name of the API Management Tag. Defaults to the name.
Name Changes to this property will trigger replacement. string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the API Management. Changing this forces a new API Management Tag to be created.
displayName String
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the API Management. Changing this forces a new API Management Tag to be created.
displayName string
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
api_management_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the API Management. Changing this forces a new API Management Tag to be created.
display_name str
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. str
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
apiManagementId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the API Management. Changing this forces a new API Management Tag to be created.
displayName String
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.

Outputs

All input properties are implicitly available as output properties. Additionally, the Tag 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 Tag Resource

Get an existing Tag 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?: TagState, opts?: CustomResourceOptions): Tag
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_id: Optional[str] = None,
        display_name: Optional[str] = None,
        name: Optional[str] = None) -> Tag
func GetTag(ctx *Context, name string, id IDInput, state *TagState, opts ...ResourceOption) (*Tag, error)
public static Tag Get(string name, Input<string> id, TagState? state, CustomResourceOptions? opts = null)
public static Tag get(String name, Output<String> id, TagState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:Tag    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApiManagementId Changes to this property will trigger replacement. string
The ID of the API Management. Changing this forces a new API Management Tag to be created.
DisplayName string
The display name of the API Management Tag. Defaults to the name.
Name Changes to this property will trigger replacement. string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
ApiManagementId Changes to this property will trigger replacement. string
The ID of the API Management. Changing this forces a new API Management Tag to be created.
DisplayName string
The display name of the API Management Tag. Defaults to the name.
Name Changes to this property will trigger replacement. string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
apiManagementId Changes to this property will trigger replacement. String
The ID of the API Management. Changing this forces a new API Management Tag to be created.
displayName String
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
apiManagementId Changes to this property will trigger replacement. string
The ID of the API Management. Changing this forces a new API Management Tag to be created.
displayName string
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. string
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
api_management_id Changes to this property will trigger replacement. str
The ID of the API Management. Changing this forces a new API Management Tag to be created.
display_name str
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. str
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.
apiManagementId Changes to this property will trigger replacement. String
The ID of the API Management. Changing this forces a new API Management Tag to be created.
displayName String
The display name of the API Management Tag. Defaults to the name.
name Changes to this property will trigger replacement. String
The name which should be used for this API Management Tag. Changing this forces a new API Management Tag to be created. The name must be unique in the API Management Service.

Import

API Management Tags can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/tag:Tag example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/tags/tag1
Copy

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.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure