← All packages

Azure Native

Pulumi Official

Package maintained by Pulumi

v1.64.0 published on Wednesday, May 4, 2022 by Pulumi

Source code

TagByApi

Tag Contract details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateApiTag

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var tagByApi = new AzureNative.ApiManagement.TagByApi("tagByApi", new AzureNative.ApiManagement.TagByApiArgs
        {
            ApiId = "5931a75ae4bbd512a88c680b",
            ResourceGroupName = "rg1",
            ServiceName = "apimService1",
            TagId = "tagId1",
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewTagByApi(ctx, "tagByApi", &apimanagement.TagByApiArgs{
			ApiId:             pulumi.String("5931a75ae4bbd512a88c680b"),
			ResourceGroupName: pulumi.String("rg1"),
			ServiceName:       pulumi.String("apimService1"),
			TagId:             pulumi.String("tagId1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var tagByApi = new TagByApi("tagByApi", TagByApiArgs.builder()        
            .apiId("5931a75ae4bbd512a88c680b")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tagId("tagId1")
            .build());

        }
}

import pulumi
import pulumi_azure_native as azure_native

tag_by_api = azure_native.apimanagement.TagByApi("tagByApi",
    api_id="5931a75ae4bbd512a88c680b",
    resource_group_name="rg1",
    service_name="apimService1",
    tag_id="tagId1")

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

const tagByApi = new azure_native.apimanagement.TagByApi("tagByApi", {
    apiId: "5931a75ae4bbd512a88c680b",
    resourceGroupName: "rg1",
    serviceName: "apimService1",
    tagId: "tagId1",
});

resources:
  tagByApi:
    type: azure-native:apimanagement:TagByApi
    properties:
      apiId: 5931a75ae4bbd512a88c680b
      resourceGroupName: rg1
      serviceName: apimService1
      tagId: tagId1

Create a TagByApi Resource

new TagByApi(name: string, args: TagByApiArgs, opts?: CustomResourceOptions);

@overload
def TagByApi(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)
@overload
def TagByApi(resource_name: str,
             args: TagByApiArgs,
             opts: Optional[ResourceOptions] = None)

func NewTagByApi(ctx *Context, name string, args TagByApiArgs, opts ...ResourceOption) (*TagByApi, error)

public TagByApi(string name, TagByApiArgs args, CustomResourceOptions? opts = null)

public TagByApi(String name, TagByApiArgs args)
public TagByApi(String name, TagByApiArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args TagByApiArgs: 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 TagByApiArgs: 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 TagByApiArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TagByApiArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TagByApiArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

TagByApi Resource Properties

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

Inputs

The TagByApi resource accepts the following input properties:

ApiId string: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
TagId string: Tag identifier. Must be unique in the current API Management service instance.

ApiId string: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
TagId string: Tag identifier. Must be unique in the current API Management service instance.

apiId String: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
tagId String: Tag identifier. Must be unique in the current API Management service instance.

apiId string: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.
tagId string: Tag identifier. Must be unique in the current API Management service instance.

api_id str: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resource_group_name str: The name of the resource group.
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.

apiId String: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
tagId 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 TagByApi resource produces the following output properties:

DisplayName string: Tag name.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.

DisplayName string: Tag name.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.

displayName String: Tag name.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.

displayName string: Tag name.
id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
type string: Resource type for API Management resource.

display_name str: Tag name.
id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
type str: Resource type for API Management resource.

displayName String: Tag name.
id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.

Import

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

$ pulumi import azure-native:apimanagement:TagByApi tagId1 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1

Package Details

Repository: https://github.com/pulumi/pulumi-azure-native
License: Apache-2.0