Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. ApiTagDescription

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.ApiTagDescription

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages an API Tag Description within an API Management Service.

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: My Company
      publisherEmail: company@terraform.io
      skuName: Developer_1
  exampleApi:
    type: azure:apimanagement:Api
    name: example
    properties:
      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
  exampleTag:
    type: azure:apimanagement:Tag
    name: example
    properties:
      apiManagementId: ${exampleService.id}
      name: example-Tag
  exampleApiTagDescription:
    type: azure:apimanagement:ApiTagDescription
    name: example
    properties:
      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
Copy

Create ApiTagDescription Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiTagDescription(name: string, args: ApiTagDescriptionArgs, opts?: CustomResourceOptions);
@overload
def ApiTagDescription(resource_name: str,
                      args: ApiTagDescriptionArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ApiTagDescription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      api_tag_id: Optional[str] = None,
                      description: Optional[str] = None,
                      external_documentation_description: Optional[str] = None,
                      external_documentation_url: Optional[str] = None)
func NewApiTagDescription(ctx *Context, name string, args ApiTagDescriptionArgs, opts ...ResourceOption) (*ApiTagDescription, error)
public ApiTagDescription(string name, ApiTagDescriptionArgs args, CustomResourceOptions? opts = null)
public ApiTagDescription(String name, ApiTagDescriptionArgs args)
public ApiTagDescription(String name, ApiTagDescriptionArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiTagDescriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApiTagDescriptionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApiTagDescriptionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiTagDescriptionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiTagDescriptionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var apiTagDescriptionResource = new Azure.ApiManagement.ApiTagDescription("apiTagDescriptionResource", new()
{
    ApiTagId = "string",
    Description = "string",
    ExternalDocumentationDescription = "string",
    ExternalDocumentationUrl = "string",
});
Copy
example, err := apimanagement.NewApiTagDescription(ctx, "apiTagDescriptionResource", &apimanagement.ApiTagDescriptionArgs{
	ApiTagId:                         pulumi.String("string"),
	Description:                      pulumi.String("string"),
	ExternalDocumentationDescription: pulumi.String("string"),
	ExternalDocumentationUrl:         pulumi.String("string"),
})
Copy
var apiTagDescriptionResource = new ApiTagDescription("apiTagDescriptionResource", ApiTagDescriptionArgs.builder()
    .apiTagId("string")
    .description("string")
    .externalDocumentationDescription("string")
    .externalDocumentationUrl("string")
    .build());
Copy
api_tag_description_resource = azure.apimanagement.ApiTagDescription("apiTagDescriptionResource",
    api_tag_id="string",
    description="string",
    external_documentation_description="string",
    external_documentation_url="string")
Copy
const apiTagDescriptionResource = new azure.apimanagement.ApiTagDescription("apiTagDescriptionResource", {
    apiTagId: "string",
    description: "string",
    externalDocumentationDescription: "string",
    externalDocumentationUrl: "string",
});
Copy
type: azure:apimanagement:ApiTagDescription
properties:
    apiTagId: string
    description: string
    externalDocumentationDescription: string
    externalDocumentationUrl: string
Copy

ApiTagDescription Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ApiTagDescription resource accepts the following input properties:

ApiTagId
This property is required.
Changes to this property will trigger replacement.
string
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
Description string
The description of the Tag.
ExternalDocumentationDescription string
The description of the external documentation resources describing the tag.
ExternalDocumentationUrl string
The URL of external documentation resources describing the tag.
ApiTagId
This property is required.
Changes to this property will trigger replacement.
string
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
Description string
The description of the Tag.
ExternalDocumentationDescription string
The description of the external documentation resources describing the tag.
ExternalDocumentationUrl string
The URL of external documentation resources describing the tag.
apiTagId
This property is required.
Changes to this property will trigger replacement.
String
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description String
The description of the Tag.
externalDocumentationDescription String
The description of the external documentation resources describing the tag.
externalDocumentationUrl String
The URL of external documentation resources describing the tag.
apiTagId
This property is required.
Changes to this property will trigger replacement.
string
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description string
The description of the Tag.
externalDocumentationDescription string
The description of the external documentation resources describing the tag.
externalDocumentationUrl string
The URL of external documentation resources describing the tag.
api_tag_id
This property is required.
Changes to this property will trigger replacement.
str
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description str
The description of the Tag.
external_documentation_description str
The description of the external documentation resources describing the tag.
external_documentation_url str
The URL of external documentation resources describing the tag.
apiTagId
This property is required.
Changes to this property will trigger replacement.
String
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description String
The description of the Tag.
externalDocumentationDescription String
The description of the external documentation resources describing the tag.
externalDocumentationUrl String
The URL of external documentation resources describing the tag.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiTagDescription resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ApiTagDescription Resource

Get an existing ApiTagDescription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ApiTagDescriptionState, opts?: CustomResourceOptions): ApiTagDescription
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_tag_id: Optional[str] = None,
        description: Optional[str] = None,
        external_documentation_description: Optional[str] = None,
        external_documentation_url: Optional[str] = None) -> ApiTagDescription
func GetApiTagDescription(ctx *Context, name string, id IDInput, state *ApiTagDescriptionState, opts ...ResourceOption) (*ApiTagDescription, error)
public static ApiTagDescription Get(string name, Input<string> id, ApiTagDescriptionState? state, CustomResourceOptions? opts = null)
public static ApiTagDescription get(String name, Output<String> id, ApiTagDescriptionState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:ApiTagDescription    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiTagId Changes to this property will trigger replacement. string
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
Description string
The description of the Tag.
ExternalDocumentationDescription string
The description of the external documentation resources describing the tag.
ExternalDocumentationUrl string
The URL of external documentation resources describing the tag.
ApiTagId Changes to this property will trigger replacement. string
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
Description string
The description of the Tag.
ExternalDocumentationDescription string
The description of the external documentation resources describing the tag.
ExternalDocumentationUrl string
The URL of external documentation resources describing the tag.
apiTagId Changes to this property will trigger replacement. String
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description String
The description of the Tag.
externalDocumentationDescription String
The description of the external documentation resources describing the tag.
externalDocumentationUrl String
The URL of external documentation resources describing the tag.
apiTagId Changes to this property will trigger replacement. string
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description string
The description of the Tag.
externalDocumentationDescription string
The description of the external documentation resources describing the tag.
externalDocumentationUrl string
The URL of external documentation resources describing the tag.
api_tag_id Changes to this property will trigger replacement. str
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description str
The description of the Tag.
external_documentation_description str
The description of the external documentation resources describing the tag.
external_documentation_url str
The URL of external documentation resources describing the tag.
apiTagId Changes to this property will trigger replacement. String
The The ID of the API Management API Tag. Changing this forces a new API Management API Tag Description to be created.
description String
The description of the Tag.
externalDocumentationDescription String
The description of the external documentation resources describing the tag.
externalDocumentationUrl String
The URL of external documentation resources describing the tag.

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
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure