Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. apimanagement
  5. Tag
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.apimanagement.Tag

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.82.0 published on Friday, Jan 10, 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

ApiManagementCreateTag

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

return await Deployment.RunAsync(() => 
{
    var tag = new AzureNative.ApiManagement.Tag("tag", new()
    {
        DisplayName = "tag1",
        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.NewTag(ctx, "tag", &apimanagement.TagArgs{
			DisplayName:       pulumi.String("tag1"),
			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.Tag;
import com.pulumi.azurenative.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 tag = new Tag("tag", TagArgs.builder()
            .displayName("tag1")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tagId("tagId1")
            .build());

    }
}
Copy
import pulumi
import pulumi_azure_native as azure_native

tag = azure_native.apimanagement.Tag("tag",
    display_name="tag1",
    resource_group_name="rg1",
    service_name="apimService1",
    tag_id="tagId1")
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const tag = new azure_native.apimanagement.Tag("tag", {
    displayName: "tag1",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    tagId: "tagId1",
});
Copy
resources:
  tag:
    type: azure-native:apimanagement:Tag
    properties:
      displayName: tag1
      resourceGroupName: rg1
      serviceName: apimService1
      tagId: tagId1
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,
        display_name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        service_name: Optional[str] = None,
        tag_id: 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-native: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 AzureNative.Apimanagement.Tag("tagResource", new()
{
    DisplayName = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    TagId = "string",
});
Copy
example, err := apimanagement.NewTag(ctx, "tagResource", &apimanagement.TagArgs{
	DisplayName:       "string",
	ResourceGroupName: "string",
	ServiceName:       "string",
	TagId:             "string",
})
Copy
var tagResource = new Tag("tagResource", TagArgs.builder()
    .displayName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .tagId("string")
    .build());
Copy
tag_resource = azure_native.apimanagement.Tag("tagResource",
    display_name=string,
    resource_group_name=string,
    service_name=string,
    tag_id=string)
Copy
const tagResource = new azure_native.apimanagement.Tag("tagResource", {
    displayName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    tagId: "string",
});
Copy
type: azure-native:apimanagement:Tag
properties:
    displayName: string
    resourceGroupName: string
    serviceName: string
    tagId: 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:

DisplayName This property is required. string
Tag name.
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.
DisplayName This property is required. string
Tag name.
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.
displayName This property is required. String
Tag name.
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.
displayName This property is required. string
Tag name.
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.
display_name This property is required. str
Tag name.
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.
displayName This property is required. String
Tag name.
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 Tag resource produces the following output properties:

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"
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"
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"
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"
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"
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:Tag tagId1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/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.82.0 published on Friday, Jan 10, 2025 by Pulumi
pulumi/pulumi-azure-native