pulumi-azure-native-kotlin/com.pulumi.azurenative.apimanagement.kotlin/ApiTagDescriptionArgs

ApiTagDescriptionArgs

data class ApiTagDescriptionArgs(val apiId: Output<String>? = null, val description: Output<String>? = null, val externalDocsDescription: Output<String>? = null, val externalDocsUrl: Output<String>? = null, val resourceGroupName: Output<String>? = null, val serviceName: Output<String>? = null, val tagDescriptionId: Output<String>? = null) : ConvertibleToJava<ApiTagDescriptionArgs>

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

Example Usage

ApiManagementCreateApiTagDescription

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var apiTagDescription = new AzureNative.ApiManagement.ApiTagDescription("apiTagDescription", new()
    {
        ApiId = "5931a75ae4bbd512a88c680b",
        Description = "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
        ExternalDocsDescription = "Description of the external docs resource",
        ExternalDocsUrl = "http://some.url/additionaldoc",
        ResourceGroupName = "rg1",
        ServiceName = "apimService1",
        TagDescriptionId = "tagId1",
    });
});

package main
import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewApiTagDescription(ctx, "apiTagDescription", &apimanagement.ApiTagDescriptionArgs{
			ApiId:                   pulumi.String("5931a75ae4bbd512a88c680b"),
			Description:             pulumi.String("Some description that will be displayed for operation's tag if the tag is assigned to operation of the API"),
			ExternalDocsDescription: pulumi.String("Description of the external docs resource"),
			ExternalDocsUrl:         pulumi.String("http://some.url/additionaldoc"),
			ResourceGroupName:       pulumi.String("rg1"),
			ServiceName:             pulumi.String("apimService1"),
			TagDescriptionId:        pulumi.String("tagId1"),
		})
		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.ApiTagDescription;
import com.pulumi.azurenative.apimanagement.ApiTagDescriptionArgs;
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 apiTagDescription = new ApiTagDescription("apiTagDescription", ApiTagDescriptionArgs.builder()
            .apiId("5931a75ae4bbd512a88c680b")
            .description("Some description that will be displayed for operation's tag if the tag is assigned to operation of the API")
            .externalDocsDescription("Description of the external docs resource")
            .externalDocsUrl("http://some.url/additionaldoc")
            .resourceGroupName("rg1")
            .serviceName("apimService1")
            .tagDescriptionId("tagId1")
            .build());
    }
}

Import

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

$ pulumi import azure-native:apimanagement:ApiTagDescription tagId1 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1

Constructors

ApiTagDescriptionArgs

constructor(apiId: Output<String>? = null, description: Output<String>? = null, externalDocsDescription: Output<String>? = null, externalDocsUrl: Output<String>? = null, resourceGroupName: Output<String>? = null, serviceName: Output<String>? = null, tagDescriptionId: Output<String>? = null)

Properties

apiId

val apiId: Output<String>? = null

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.

description

val description: Output<String>? = null

Description of the Tag.

externalDocsDescription

val externalDocsDescription: Output<String>? = null

Description of the external resources describing the tag.

externalDocsUrl

val externalDocsUrl: Output<String>? = null

Absolute URL of external resources describing the tag.

resourceGroupName

val resourceGroupName: Output<String>? = null

The name of the resource group.