ApiTagDescriptionArgs

data class ApiTagDescriptionArgs(val apiTagId: Output<String>? = null, val description: Output<String>? = null, val externalDocumentationDescription: Output<String>? = null, val externalDocumentationUrl: Output<String>? = null) : ConvertibleToJava<ApiTagDescriptionArgs>

Manages an API Tag Description within an API Management Service.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.apimanagement.Service;
import com.pulumi.azure.apimanagement.ServiceArgs;
import com.pulumi.azure.apimanagement.Api;
import com.pulumi.azure.apimanagement.ApiArgs;
import com.pulumi.azure.apimanagement.inputs.ApiImportArgs;
import com.pulumi.azure.apimanagement.Tag;
import com.pulumi.azure.apimanagement.TagArgs;
import com.pulumi.azure.apimanagement.ApiTagDescription;
import com.pulumi.azure.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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.publisherName("My Company")
.publisherEmail("company@terraform.io")
.skuName("Developer_1")
.build());
var exampleApi = new Api("exampleApi", ApiArgs.builder()
.resourceGroupName(exampleResourceGroup.name())
.apiManagementName(exampleService.name())
.revision("1")
.displayName("Example API")
.path("example")
.protocols("https")
.import_(ApiImportArgs.builder()
.contentFormat("swagger-link-json")
.contentValue("http://conferenceapi.azurewebsites.net/?format=json")
.build())
.build());
var exampleTag = new Tag("exampleTag", TagArgs.builder()
.apiManagementId(exampleService.id())
.build());
var exampleApiTagDescription = new ApiTagDescription("exampleApiTagDescription", ApiTagDescriptionArgs.builder()
.apiTagId(exampleTag.id())
.description("This is an example description")
.externalDocsUrl("https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs")
.externalDocsDescription("This is an example external docs description")
.build());
}
}

Import

API Management API Schema's can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/apiTagDescription:ApiTagDescription example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/apis/api1/tagDescriptions/tagDescriptionId1

Constructors

Link copied to clipboard
fun ApiTagDescriptionArgs(apiTagId: Output<String>? = null, description: Output<String>? = null, externalDocumentationDescription: Output<String>? = null, externalDocumentationUrl: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): ApiTagDescriptionArgs

Properties

Link copied to clipboard
val apiTagId: Output<String>? = null

The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.

Link copied to clipboard
val description: Output<String>? = null

The description of the Tag.

Link copied to clipboard

The description of the external documentation resources describing the tag.

Link copied to clipboard
val externalDocumentationUrl: Output<String>? = null

The URL of external documentation resources describing the tag.