Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. WorkspaceTag
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.WorkspaceTag

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Tag Contract details.

Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-09-01-preview.

Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Example Usage

ApiManagementCreateWorkspaceTag

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

return await Deployment.RunAsync(() => 
{
    var workspaceTag = new AzureNative.ApiManagement.WorkspaceTag("workspaceTag", new()
    {
        DisplayName = "tag1",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        TagId = "tagId1",
        WorkspaceId = "wks1",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewWorkspaceTag(ctx, "workspaceTag", &apimanagement.WorkspaceTagArgs{
			DisplayName:       pulumi.String("tag1"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			TagId:             pulumi.String("tagId1"),
			WorkspaceId:       pulumi.String("wks1"),
		})
		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.WorkspaceTag;
import com.pulumi.azurenative.apimanagement.WorkspaceTagArgs;
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 workspaceTag = new WorkspaceTag("workspaceTag", WorkspaceTagArgs.builder()
            .displayName("tag1")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tagId("tagId1")
            .workspaceId("wks1")
            .build());

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

const workspaceTag = new azure_native.apimanagement.WorkspaceTag("workspaceTag", {
    displayName: "tag1",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    tagId: "tagId1",
    workspaceId: "wks1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace_tag = azure_native.apimanagement.WorkspaceTag("workspaceTag",
    display_name="tag1",
    resource_group_name="rg1",
    service_name="apimService1",
    tag_id="tagId1",
    workspace_id="wks1")
Copy
resources:
  workspaceTag:
    type: azure-native:apimanagement:WorkspaceTag
    properties:
      displayName: tag1
      resourceGroupName: rg1
      serviceName: apimService1
      tagId: tagId1
      workspaceId: wks1
Copy

Create WorkspaceTag Resource

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

Constructor syntax

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

@overload
def WorkspaceTag(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 service_name: Optional[str] = None,
                 workspace_id: Optional[str] = None,
                 tag_id: Optional[str] = None)
func NewWorkspaceTag(ctx *Context, name string, args WorkspaceTagArgs, opts ...ResourceOption) (*WorkspaceTag, error)
public WorkspaceTag(string name, WorkspaceTagArgs args, CustomResourceOptions? opts = null)
public WorkspaceTag(String name, WorkspaceTagArgs args)
public WorkspaceTag(String name, WorkspaceTagArgs args, CustomResourceOptions options)

type: azure-native:apimanagement:WorkspaceTag
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. WorkspaceTagArgs
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. WorkspaceTagArgs
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. WorkspaceTagArgs
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. WorkspaceTagArgs
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. WorkspaceTagArgs
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 workspaceTagResource = new AzureNative.ApiManagement.WorkspaceTag("workspaceTagResource", new()
{
    DisplayName = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    WorkspaceId = "string",
    TagId = "string",
});
Copy
example, err := apimanagement.NewWorkspaceTag(ctx, "workspaceTagResource", &apimanagement.WorkspaceTagArgs{
	DisplayName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	WorkspaceId:       pulumi.String("string"),
	TagId:             pulumi.String("string"),
})
Copy
var workspaceTagResource = new WorkspaceTag("workspaceTagResource", WorkspaceTagArgs.builder()
    .displayName("string")
    .resourceGroupName("string")
    .serviceName("string")
    .workspaceId("string")
    .tagId("string")
    .build());
Copy
workspace_tag_resource = azure_native.apimanagement.WorkspaceTag("workspaceTagResource",
    display_name="string",
    resource_group_name="string",
    service_name="string",
    workspace_id="string",
    tag_id="string")
Copy
const workspaceTagResource = new azure_native.apimanagement.WorkspaceTag("workspaceTagResource", {
    displayName: "string",
    resourceGroupName: "string",
    serviceName: "string",
    workspaceId: "string",
    tagId: "string",
});
Copy
type: azure-native:apimanagement:WorkspaceTag
properties:
    displayName: string
    resourceGroupName: string
    serviceName: string
    tagId: string
    workspaceId: string
Copy

WorkspaceTag 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 WorkspaceTag 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.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
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.
WorkspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
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.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
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.
workspaceId
This property is required.
Changes to this property will trigger replacement.
string
Workspace identifier. Must be unique in the current API Management service instance.
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.
workspace_id
This property is required.
Changes to this property will trigger replacement.
str
Workspace identifier. Must be unique in the current API Management service instance.
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.
workspaceId
This property is required.
Changes to this property will trigger replacement.
String
Workspace identifier. Must be unique in the current API Management service instance.
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 WorkspaceTag resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
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"
AzureApiVersion string
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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"
azureApiVersion string
The Azure API version of the resource.
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"
azure_api_version str
The Azure API version of the resource.
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"
azureApiVersion String
The Azure API version of the resource.
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:WorkspaceTag tagId1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native