Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getTagByApi
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getTagByApi

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get tag associated with the API.

Uses Azure REST API version 2022-09-01-preview.

Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native apimanagement [ApiVersion]. See the version guide for details.

Using getTagByApi

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 getTagByApi(args: GetTagByApiArgs, opts?: InvokeOptions): Promise<GetTagByApiResult>
function getTagByApiOutput(args: GetTagByApiOutputArgs, opts?: InvokeOptions): Output<GetTagByApiResult>
Copy
def get_tag_by_api(api_id: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   tag_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetTagByApiResult
def get_tag_by_api_output(api_id: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   service_name: Optional[pulumi.Input[str]] = None,
                   tag_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetTagByApiResult]
Copy
func LookupTagByApi(ctx *Context, args *LookupTagByApiArgs, opts ...InvokeOption) (*LookupTagByApiResult, error)
func LookupTagByApiOutput(ctx *Context, args *LookupTagByApiOutputArgs, opts ...InvokeOption) LookupTagByApiResultOutput
Copy

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

public static class GetTagByApi 
{
    public static Task<GetTagByApiResult> InvokeAsync(GetTagByApiArgs args, InvokeOptions? opts = null)
    public static Output<GetTagByApiResult> Invoke(GetTagByApiInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTagByApiResult> getTagByApi(GetTagByApiArgs args, InvokeOptions options)
public static Output<GetTagByApiResult> getTagByApi(GetTagByApiArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getTagByApi
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
TagId
This property is required.
Changes to this property will trigger replacement.
string
Tag identifier. Must be unique in the current API Management service instance.
ApiId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
TagId
This property is required.
Changes to this property will trigger replacement.
string
Tag identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
tagId
This property is required.
Changes to this property will trigger replacement.
String
Tag identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
tagId
This property is required.
Changes to this property will trigger replacement.
string
Tag identifier. Must be unique in the current API Management service instance.
api_id
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
tag_id
This property is required.
Changes to this property will trigger replacement.
str
Tag identifier. Must be unique in the current API Management service instance.
apiId
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
tagId
This property is required.
Changes to this property will trigger replacement.
String
Tag identifier. Must be unique in the current API Management service instance.

getTagByApi Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
DisplayName string
Tag name.
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"
AzureApiVersion string
The Azure API version of the resource.
DisplayName string
Tag name.
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"
azureApiVersion String
The Azure API version of the resource.
displayName String
Tag name.
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"
azureApiVersion string
The Azure API version of the resource.
displayName string
Tag name.
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"
azure_api_version str
The Azure API version of the resource.
display_name str
Tag name.
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"
azureApiVersion String
The Azure API version of the resource.
displayName String
Tag name.
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"

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 v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native