Azure Native v1.102.0, May 2 23

azure-native.apimanagement.ApiTagDescription

Explore with Pulumi AI

Contract details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateApiTagDescription

using System.Collections.Generic;
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/go/azure/apimanagement"
	"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 pulumi
import pulumi_azure_native as azure_native

api_tag_description = azure_native.apimanagement.ApiTagDescription("apiTagDescription",
    api_id="5931a75ae4bbd512a88c680b",
    description="Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    external_docs_description="Description of the external docs resource",
    external_docs_url="http://some.url/additionaldoc",
    resource_group_name="rg1",
    service_name="apimService1",
    tag_description_id="tagId1")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiTagDescription = new azure_native.apimanagement.ApiTagDescription("apiTagDescription", {
    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",
});

resources:
  apiTagDescription:
    type: azure-native:apimanagement:ApiTagDescription
    properties:
      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

Create ApiTagDescription Resource

new ApiTagDescription(name: string, args: ApiTagDescriptionArgs, opts?: CustomResourceOptions);

@overload
def ApiTagDescription(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      api_id: Optional[str] = None,
                      description: Optional[str] = None,
                      external_docs_description: Optional[str] = None,
                      external_docs_url: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      tag_description_id: 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-native: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:

ApiId string: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
Description string: Description of the Tag.
ExternalDocsDescription string: Description of the external resources describing the tag.
ExternalDocsUrl string: Absolute URL of external resources describing the tag.
TagDescriptionId string: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

ApiId string: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.
Description string: Description of the Tag.
ExternalDocsDescription string: Description of the external resources describing the tag.
ExternalDocsUrl string: Absolute URL of external resources describing the tag.
TagDescriptionId string: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

apiId String: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
description String: Description of the Tag.
externalDocsDescription String: Description of the external resources describing the tag.
externalDocsUrl String: Absolute URL of external resources describing the tag.
tagDescriptionId String: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

apiId string: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.
description string: Description of the Tag.
externalDocsDescription string: Description of the external resources describing the tag.
externalDocsUrl string: Absolute URL of external resources describing the tag.
tagDescriptionId string: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

api_id str: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resource_group_name str: The name of the resource group.
service_name str: The name of the API Management service.
description str: Description of the Tag.
external_docs_description str: Description of the external resources describing the tag.
external_docs_url str: Absolute URL of external resources describing the tag.
tag_description_id str: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

apiId String: API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.
description String: Description of the Tag.
externalDocsDescription String: Description of the external resources describing the tag.
externalDocsUrl String: Absolute URL of external resources describing the tag.
tagDescriptionId String: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

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.
Name string: Resource name.
Type string: Resource type for API Management resource.
DisplayName string: Tag name.
TagId string: Identifier of the tag in the form of /tags/{tagId}

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name.
Type string: Resource type for API Management resource.
DisplayName string: Tag name.
TagId string: Identifier of the tag in the form of /tags/{tagId}

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.
displayName String: Tag name.
tagId String: Identifier of the tag in the form of /tags/{tagId}

id string: The provider-assigned unique ID for this managed resource.
name string: Resource name.
type string: Resource type for API Management resource.
displayName string: Tag name.
tagId string: Identifier of the tag in the form of /tags/{tagId}

id str: The provider-assigned unique ID for this managed resource.
name str: Resource name.
type str: Resource type for API Management resource.
display_name str: Tag name.
tag_id str: Identifier of the tag in the form of /tags/{tagId}

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name.
type String: Resource type for API Management resource.
displayName String: Tag name.
tagId String: Identifier of the tag in the form of /tags/{tagId}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:ApiTagDescription tagId1 /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0