ApiTagDescription

class ApiTagDescription : KotlinCustomResource

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-08-01. Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 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/#accessing-any-api-version-via-local-packages for details.

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/v3"
"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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

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

Description of the Tag.

Link copied to clipboard
val displayName: Output<String>?

Tag name.

Link copied to clipboard

Description of the external resources describing the tag.

Link copied to clipboard
val externalDocsUrl: Output<String>?

Absolute URL of external resources describing the tag.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tagId: Output<String>?

Identifier of the tag in the form of /tags/{tagId}

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>