Azure Native v1.102.0, May 2 23

azure-native.apimanagement.getApiTagDescription

Explore with Pulumi AI

Get Tag description in scope of API API Version: 2020-12-01.

Using getApiTagDescription

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiTagDescription(args: GetApiTagDescriptionArgs, opts?: InvokeOptions): Promise<GetApiTagDescriptionResult>
function getApiTagDescriptionOutput(args: GetApiTagDescriptionOutputArgs, opts?: InvokeOptions): Output<GetApiTagDescriptionResult>

def get_api_tag_description(api_id: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            service_name: Optional[str] = None,
                            tag_description_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetApiTagDescriptionResult
def get_api_tag_description_output(api_id: Optional[pulumi.Input[str]] = None,
                            resource_group_name: Optional[pulumi.Input[str]] = None,
                            service_name: Optional[pulumi.Input[str]] = None,
                            tag_description_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetApiTagDescriptionResult]

func LookupApiTagDescription(ctx *Context, args *LookupApiTagDescriptionArgs, opts ...InvokeOption) (*LookupApiTagDescriptionResult, error)
func LookupApiTagDescriptionOutput(ctx *Context, args *LookupApiTagDescriptionOutputArgs, opts ...InvokeOption) LookupApiTagDescriptionResultOutput

> Note: This function is named LookupApiTagDescription in the Go SDK.

public static class GetApiTagDescription 
{
    public static Task<GetApiTagDescriptionResult> InvokeAsync(GetApiTagDescriptionArgs args, InvokeOptions? opts = null)
    public static Output<GetApiTagDescriptionResult> Invoke(GetApiTagDescriptionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiTagDescriptionResult> getApiTagDescription(GetApiTagDescriptionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:apimanagement:getApiTagDescription
  arguments:
    # arguments dictionary

The following arguments are supported:

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.
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.
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.
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.
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.
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.
tagDescriptionId String: Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

getApiTagDescription Result

The following output properties are available:

Id string: Resource ID.
Name string: Resource name.
Type string: Resource type for API Management resource.
Description string: Description of the Tag.
DisplayName string: Tag name.
ExternalDocsDescription string: Description of the external resources describing the tag.
ExternalDocsUrl string: Absolute URL of external resources describing the tag.
TagId string: Identifier of the tag in the form of /tags/{tagId}

Id string: Resource ID.
Name string: Resource name.
Type string: Resource type for API Management resource.
Description string: Description of the Tag.
DisplayName string: Tag name.
ExternalDocsDescription string: Description of the external resources describing the tag.
ExternalDocsUrl string: Absolute URL of external resources describing the tag.
TagId string: Identifier of the tag in the form of /tags/{tagId}

id String: Resource ID.
name String: Resource name.
type String: Resource type for API Management resource.
description String: Description of the Tag.
displayName String: Tag name.
externalDocsDescription String: Description of the external resources describing the tag.
externalDocsUrl String: Absolute URL of external resources describing the tag.
tagId String: Identifier of the tag in the form of /tags/{tagId}

id string: Resource ID.
name string: Resource name.
type string: Resource type for API Management resource.
description string: Description of the Tag.
displayName string: Tag name.
externalDocsDescription string: Description of the external resources describing the tag.
externalDocsUrl string: Absolute URL of external resources describing the tag.
tagId string: Identifier of the tag in the form of /tags/{tagId}

id str: Resource ID.
name str: Resource name.
type str: Resource type for API Management resource.
description str: Description of the Tag.
display_name str: Tag name.
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_id str: Identifier of the tag in the form of /tags/{tagId}

id String: Resource ID.
name String: Resource name.
type String: Resource type for API Management resource.
description String: Description of the Tag.
displayName String: Tag name.
externalDocsDescription String: Description of the external resources describing the tag.
externalDocsUrl String: Absolute URL of external resources describing the tag.
tagId String: Identifier of the tag in the form of /tags/{tagId}

Package Details

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

azure-native.apimanagement.getApiTagDescription

Using getApiTagDescription

getApiTagDescription Result

Package Details

On this page

On this page