import * as pulumi from "@pulumi/pulumi"; /** * Manages an API Tag Description within an API Management Service. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as azure from "@pulumi/azure"; * * const example = new azure.core.ResourceGroup("example", { * name: "example-resources", * location: "West Europe", * }); * const exampleService = new azure.apimanagement.Service("example", { * name: "example-apim", * location: example.location, * resourceGroupName: example.name, * publisherName: "My Company", * publisherEmail: "company@terraform.io", * skuName: "Developer_1", * }); * const exampleApi = new azure.apimanagement.Api("example", { * name: "example-api", * resourceGroupName: example.name, * apiManagementName: exampleService.name, * revision: "1", * displayName: "Example API", * path: "example", * protocols: ["https"], * "import": { * contentFormat: "swagger-link-json", * contentValue: "https://raw.githubusercontent.com/hashicorp/terraform-provider-azurerm/refs/heads/main/internal/services/apimanagement/testdata/api_management_api_swagger.json", * }, * }); * const exampleTag = new azure.apimanagement.Tag("example", { * apiManagementId: exampleService.id, * name: "example-Tag", * }); * const exampleApiTagDescription = new azure.apimanagement.ApiTagDescription("example", { * 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", * }); * ``` * * ## API Providers * * * This resource uses the following Azure API Providers: * * * `Microsoft.ApiManagement` - 2022-08-01 * * ## Import * * API Management API Schema's can be imported using the `resource id`, e.g. * * ```sh * $ pulumi import azure:apimanagement/apiTagDescription:ApiTagDescription example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.ApiManagement/service/instance1/apis/api1/tagDescriptions/tagDescriptionId1 * ``` */ export declare class ApiTagDescription extends pulumi.CustomResource { /** * Get an existing ApiTagDescription resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: ApiTagDescriptionState, opts?: pulumi.CustomResourceOptions): ApiTagDescription; /** * Returns true if the given object is an instance of ApiTagDescription. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is ApiTagDescription; /** * The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created. */ readonly apiTagId: pulumi.Output; /** * The description of the Tag. */ readonly description: pulumi.Output; /** * The description of the external documentation resources describing the tag. */ readonly externalDocumentationDescription: pulumi.Output; /** * The URL of external documentation resources describing the tag. */ readonly externalDocumentationUrl: pulumi.Output; /** * Create a ApiTagDescription resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: ApiTagDescriptionArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering ApiTagDescription resources. */ export interface ApiTagDescriptionState { /** * The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created. */ apiTagId?: pulumi.Input; /** * The description of the Tag. */ description?: pulumi.Input; /** * The description of the external documentation resources describing the tag. */ externalDocumentationDescription?: pulumi.Input; /** * The URL of external documentation resources describing the tag. */ externalDocumentationUrl?: pulumi.Input; } /** * The set of arguments for constructing a ApiTagDescription resource. */ export interface ApiTagDescriptionArgs { /** * The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created. */ apiTagId: pulumi.Input; /** * The description of the Tag. */ description?: pulumi.Input; /** * The description of the external documentation resources describing the tag. */ externalDocumentationDescription?: pulumi.Input; /** * The URL of external documentation resources describing the tag. */ externalDocumentationUrl?: pulumi.Input; }