@kengachu-pulumi/azure-native-apimanagement/getApiTool.d.ts

Pulumi Azure Native package for apimanagement

import * as pulumi from "@pulumi/pulumi";
import * as types from "./types";
/**
 * Gets the details of the API Tool specified by its identifier.
 *
 * Uses Azure REST API version 2025-03-01-preview.
 */
export declare function getApiTool(args: GetApiToolArgs, opts?: pulumi.InvokeOptions): Promise<GetApiToolResult>;
export interface GetApiToolArgs {
    /**
     * 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.
     */
    apiId: string;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: string;
    /**
     * The name of the API Management service.
     */
    serviceName: string;
    /**
     * Tool identifier within an API. Must be unique in the current API Management service instance.
     */
    toolId: string;
}
/**
 * Tool details.
 */
export interface GetApiToolResult {
    /**
     * The Azure API version of the resource.
     */
    readonly azureApiVersion: string;
    /**
     * Description of the tool.
     */
    readonly description?: string;
    /**
     * Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
     */
    readonly displayName?: string;
    /**
     * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
     */
    readonly id: string;
    /**
     * The name of the resource
     */
    readonly name: string;
    /**
     * Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.
     */
    readonly operationId?: string;
    /**
     * Azure Resource Manager metadata containing createdBy and modifiedBy information.
     */
    readonly systemData: types.outputs.SystemDataResponse;
    /**
     * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
     */
    readonly type: string;
}
/**
 * Gets the details of the API Tool specified by its identifier.
 *
 * Uses Azure REST API version 2025-03-01-preview.
 */
export declare function getApiToolOutput(args: GetApiToolOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetApiToolResult>;
export interface GetApiToolOutputArgs {
    /**
     * 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.
     */
    apiId: pulumi.Input<string>;
    /**
     * The name of the resource group. The name is case insensitive.
     */
    resourceGroupName: pulumi.Input<string>;
    /**
     * The name of the API Management service.
     */
    serviceName: pulumi.Input<string>;
    /**
     * Tool identifier within an API. Must be unique in the current API Management service instance.
     */
    toolId: pulumi.Input<string>;
}