This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.69.0 published on Monday, Oct 28, 2024 by Pulumi
azure-native.apimanagement.getApiTagDescription
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.69.0 published on Monday, Oct 28, 2024 by Pulumi
Get Tag description in scope of API Azure REST API version: 2022-08-01.
Other available API versions: 2019-01-01, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-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:
- Api
Id 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.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Tag
Description stringId - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- Api
Id 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.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Tag
Description stringId - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- api
Id 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- tag
Description StringId - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- api
Id 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.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- tag
Description stringId - 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_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- tag_
description_ strid - Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
- api
Id 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- tag
Description StringId - 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
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Description string
- Description of the Tag.
- Display
Name string - Tag name.
- External
Docs stringDescription - Description of the external resources describing the tag.
- External
Docs stringUrl - Absolute URL of external resources describing the tag.
- Tag
Id string - Identifier of the tag in the form of /tags/{tagId}
- Id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Name string
- The name of the resource
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Description string
- Description of the Tag.
- Display
Name string - Tag name.
- External
Docs stringDescription - Description of the external resources describing the tag.
- External
Docs stringUrl - Absolute URL of external resources describing the tag.
- Tag
Id string - Identifier of the tag in the form of /tags/{tagId}
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description String
- Description of the Tag.
- display
Name String - Tag name.
- external
Docs StringDescription - Description of the external resources describing the tag.
- external
Docs StringUrl - Absolute URL of external resources describing the tag.
- tag
Id String - Identifier of the tag in the form of /tags/{tagId}
- id string
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name string
- The name of the resource
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description string
- Description of the Tag.
- display
Name string - Tag name.
- external
Docs stringDescription - Description of the external resources describing the tag.
- external
Docs stringUrl - Absolute URL of external resources describing the tag.
- tag
Id string - Identifier of the tag in the form of /tags/{tagId}
- id str
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name str
- The name of the resource
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description str
- Description of the Tag.
- display_
name str - Tag name.
- external_
docs_ strdescription - Description of the external resources describing the tag.
- external_
docs_ strurl - Absolute URL of external resources describing the tag.
- tag_
id str - Identifier of the tag in the form of /tags/{tagId}
- id String
- Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- name String
- The name of the resource
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- description String
- Description of the Tag.
- display
Name String - Tag name.
- external
Docs StringDescription - Description of the external resources describing the tag.
- external
Docs StringUrl - Absolute URL of external resources describing the tag.
- tag
Id String - Identifier of the tag in the form of /tags/{tagId}
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.69.0 published on Monday, Oct 28, 2024 by Pulumi