azure-native.apimanagement.getApiTool

Azure Native v3.13.0, Jan 28 26

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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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.13.0 published on Wednesday, Jan 28, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

Using getApiTool

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 getApiTool(args: GetApiToolArgs, opts?: InvokeOptions): Promise<GetApiToolResult>
function getApiToolOutput(args: GetApiToolOutputArgs, opts?: InvokeOptions): Output<GetApiToolResult>

def get_api_tool(api_id: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 service_name: Optional[str] = None,
                 tool_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetApiToolResult
def get_api_tool_output(api_id: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 service_name: Optional[pulumi.Input[str]] = None,
                 tool_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetApiToolResult]

func LookupApiTool(ctx *Context, args *LookupApiToolArgs, opts ...InvokeOption) (*LookupApiToolResult, error)
func LookupApiToolOutput(ctx *Context, args *LookupApiToolOutputArgs, opts ...InvokeOption) LookupApiToolResultOutput

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

public static class GetApiTool 
{
    public static Task<GetApiToolResult> InvokeAsync(GetApiToolArgs args, InvokeOptions? opts = null)
    public static Output<GetApiToolResult> Invoke(GetApiToolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiToolResult> getApiTool(GetApiToolArgs args, InvokeOptions options)
public static Output<GetApiToolResult> getApiTool(GetApiToolArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:apimanagement:getApiTool
  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. The name is case insensitive.
ServiceName string: The name of the API Management service.
ToolId string: Tool identifier within an API. Must be unique in the current API Management service instance.

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. The name is case insensitive.
ServiceName string: The name of the API Management service.
ToolId string: Tool identifier within an API. Must be unique in the current API Management service instance.

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. The name is case insensitive.
serviceName String: The name of the API Management service.
toolId String: Tool identifier within an API. Must be unique in the current API Management service instance.

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. The name is case insensitive.
serviceName string: The name of the API Management service.
toolId string: Tool identifier within an API. Must be unique in the current API Management service instance.

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. The name is case insensitive.
service_name str: The name of the API Management service.
tool_id str: Tool identifier within an API. Must be unique in the current API Management service instance.

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. The name is case insensitive.
serviceName String: The name of the API Management service.
toolId String: Tool identifier within an API. Must be unique in the current API Management service instance.

getApiTool Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
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
SystemData Pulumi.AzureNative.ApiManagement.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string: Description of the tool.
DisplayName string: Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
OperationId string: Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.

AzureApiVersion string: The Azure API version of the resource.
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
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Description string: Description of the tool.
DisplayName string: Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
OperationId string: Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.

azureApiVersion String: The Azure API version of the resource.
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
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String: Description of the tool.
displayName String: Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
operationId String: Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.

azureApiVersion string: The Azure API version of the resource.
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
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description string: Description of the tool.
displayName string: Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
operationId string: Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.

azure_api_version str: The Azure API version of the resource.
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
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description str: Description of the tool.
display_name str: Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
operation_id str: Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.

azureApiVersion String: The Azure API version of the resource.
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
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
description String: Description of the tool.
displayName String: Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
operationId String: Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.

Supporting Types

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.