1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. ApiTagDescription

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

azure.apimanagement.ApiTagDescription

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

    Manages an API Tag Description within an API Management Service.

    Example Usage

    Coming soon!

    Coming soon!

    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());
    
        }
    }
    

    Coming soon!

    Coming soon!

    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleService:
        type: azure:apimanagement:Service
        properties:
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          publisherName: My Company
          publisherEmail: company@terraform.io
          skuName: Developer_1
      exampleApi:
        type: azure:apimanagement:Api
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          apiManagementName: ${exampleService.name}
          revision: '1'
          displayName: Example API
          path: example
          protocols:
            - https
          import:
            contentFormat: swagger-link-json
            contentValue: http://conferenceapi.azurewebsites.net/?format=json
      exampleTag:
        type: azure:apimanagement:Tag
        properties:
          apiManagementId: ${exampleService.id}
      exampleApiTagDescription:
        type: azure:apimanagement:ApiTagDescription
        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
    

    Create ApiTagDescription Resource

    new ApiTagDescription(name: string, args: ApiTagDescriptionArgs, opts?: CustomResourceOptions);
    @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)
    @overload
    def ApiTagDescription(resource_name: str,
                          args: ApiTagDescriptionArgs,
                          opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args ApiTagDescriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args ApiTagDescriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiTagDescriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiTagDescriptionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The ApiTagDescription resource accepts the following input properties:

    ApiTagId 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 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 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 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 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 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 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 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 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 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 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 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
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi