azure-native.apimanagement.WorkspaceTagApiLink
Explore with Pulumi AI
Tag-API link details. Azure REST 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.
Example Usage
ApiManagementCreateWorkspaceTagApiLink
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var workspaceTagApiLink = new AzureNative.ApiManagement.WorkspaceTagApiLink("workspaceTagApiLink", new()
    {
        ApiId = "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
        ApiLinkId = "link1",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        TagId = "tag1",
        WorkspaceId = "wks1",
    });
});
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.NewWorkspaceTagApiLink(ctx, "workspaceTagApiLink", &apimanagement.WorkspaceTagApiLinkArgs{
			ApiId:             pulumi.String("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api"),
			ApiLinkId:         pulumi.String("link1"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			TagId:             pulumi.String("tag1"),
			WorkspaceId:       pulumi.String("wks1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.WorkspaceTagApiLink;
import com.pulumi.azurenative.apimanagement.WorkspaceTagApiLinkArgs;
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 workspaceTagApiLink = new WorkspaceTagApiLink("workspaceTagApiLink", WorkspaceTagApiLinkArgs.builder()
            .apiId("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api")
            .apiLinkId("link1")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tagId("tag1")
            .workspaceId("wks1")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const workspaceTagApiLink = new azure_native.apimanagement.WorkspaceTagApiLink("workspaceTagApiLink", {
    apiId: "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
    apiLinkId: "link1",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    tagId: "tag1",
    workspaceId: "wks1",
});
import pulumi
import pulumi_azure_native as azure_native
workspace_tag_api_link = azure_native.apimanagement.WorkspaceTagApiLink("workspaceTagApiLink",
    api_id="/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api",
    api_link_id="link1",
    resource_group_name="rg1",
    service_name="apimService1",
    tag_id="tag1",
    workspace_id="wks1")
resources:
  workspaceTagApiLink:
    type: azure-native:apimanagement:WorkspaceTagApiLink
    properties:
      apiId: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api
      apiLinkId: link1
      resourceGroupName: rg1
      serviceName: apimService1
      tagId: tag1
      workspaceId: wks1
Create WorkspaceTagApiLink Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new WorkspaceTagApiLink(name: string, args: WorkspaceTagApiLinkArgs, opts?: CustomResourceOptions);@overload
def WorkspaceTagApiLink(resource_name: str,
                        args: WorkspaceTagApiLinkArgs,
                        opts: Optional[ResourceOptions] = None)
@overload
def WorkspaceTagApiLink(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        api_id: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        tag_id: Optional[str] = None,
                        workspace_id: Optional[str] = None,
                        api_link_id: Optional[str] = None)func NewWorkspaceTagApiLink(ctx *Context, name string, args WorkspaceTagApiLinkArgs, opts ...ResourceOption) (*WorkspaceTagApiLink, error)public WorkspaceTagApiLink(string name, WorkspaceTagApiLinkArgs args, CustomResourceOptions? opts = null)
public WorkspaceTagApiLink(String name, WorkspaceTagApiLinkArgs args)
public WorkspaceTagApiLink(String name, WorkspaceTagApiLinkArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:WorkspaceTagApiLink
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 WorkspaceTagApiLinkArgs
- 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 WorkspaceTagApiLinkArgs
- 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 WorkspaceTagApiLinkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args WorkspaceTagApiLinkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args WorkspaceTagApiLinkArgs
- 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 workspaceTagApiLinkResource = new AzureNative.ApiManagement.WorkspaceTagApiLink("workspaceTagApiLinkResource", new()
{
    ApiId = "string",
    ResourceGroupName = "string",
    ServiceName = "string",
    TagId = "string",
    WorkspaceId = "string",
    ApiLinkId = "string",
});
example, err := apimanagement.NewWorkspaceTagApiLink(ctx, "workspaceTagApiLinkResource", &apimanagement.WorkspaceTagApiLinkArgs{
	ApiId:             pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ServiceName:       pulumi.String("string"),
	TagId:             pulumi.String("string"),
	WorkspaceId:       pulumi.String("string"),
	ApiLinkId:         pulumi.String("string"),
})
var workspaceTagApiLinkResource = new WorkspaceTagApiLink("workspaceTagApiLinkResource", WorkspaceTagApiLinkArgs.builder()
    .apiId("string")
    .resourceGroupName("string")
    .serviceName("string")
    .tagId("string")
    .workspaceId("string")
    .apiLinkId("string")
    .build());
workspace_tag_api_link_resource = azure_native.apimanagement.WorkspaceTagApiLink("workspaceTagApiLinkResource",
    api_id="string",
    resource_group_name="string",
    service_name="string",
    tag_id="string",
    workspace_id="string",
    api_link_id="string")
const workspaceTagApiLinkResource = new azure_native.apimanagement.WorkspaceTagApiLink("workspaceTagApiLinkResource", {
    apiId: "string",
    resourceGroupName: "string",
    serviceName: "string",
    tagId: "string",
    workspaceId: "string",
    apiLinkId: "string",
});
type: azure-native:apimanagement:WorkspaceTagApiLink
properties:
    apiId: string
    apiLinkId: string
    resourceGroupName: string
    serviceName: string
    tagId: string
    workspaceId: string
WorkspaceTagApiLink 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 WorkspaceTagApiLink resource accepts the following input properties:
- ApiId string
- Full resource Id of an API.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- TagId string
- Tag identifier. Must be unique in the current API Management service instance.
- WorkspaceId string
- Workspace identifier. Must be unique in the current API Management service instance.
- ApiLink stringId 
- Tag-API link identifier. Must be unique in the current API Management service instance.
- ApiId string
- Full resource Id of an API.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- TagId string
- Tag identifier. Must be unique in the current API Management service instance.
- WorkspaceId string
- Workspace identifier. Must be unique in the current API Management service instance.
- ApiLink stringId 
- Tag-API link identifier. Must be unique in the current API Management service instance.
- apiId String
- Full resource Id of an API.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
- tagId String
- Tag identifier. Must be unique in the current API Management service instance.
- workspaceId String
- Workspace identifier. Must be unique in the current API Management service instance.
- apiLink StringId 
- Tag-API link identifier. Must be unique in the current API Management service instance.
- apiId string
- Full resource Id of an API.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- serviceName string
- The name of the API Management service.
- tagId string
- Tag identifier. Must be unique in the current API Management service instance.
- workspaceId string
- Workspace identifier. Must be unique in the current API Management service instance.
- apiLink stringId 
- Tag-API link identifier. Must be unique in the current API Management service instance.
- api_id str
- Full resource Id of an API.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- service_name str
- The name of the API Management service.
- tag_id str
- Tag identifier. Must be unique in the current API Management service instance.
- workspace_id str
- Workspace identifier. Must be unique in the current API Management service instance.
- api_link_ strid 
- Tag-API link identifier. Must be unique in the current API Management service instance.
- apiId String
- Full resource Id of an API.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
- tagId String
- Tag identifier. Must be unique in the current API Management service instance.
- workspaceId String
- Workspace identifier. Must be unique in the current API Management service instance.
- apiLink StringId 
- Tag-API link identifier. Must be unique in the current API Management service instance.
Outputs
All input properties are implicitly available as output properties. Additionally, the WorkspaceTagApiLink resource produces the following output properties:
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:WorkspaceTagApiLink link1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/tags/{tagId}/apiLinks/{apiLinkId} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0