Tool details.
Uses Azure REST API version 2025-03-01-preview.
Example Usage
ApiManagementCreateApiTool
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var apiTool = new AzureNative.ApiManagement.ApiTool("apiTool", new()
{
ApiId = "github-mcp-api",
Description = "This is a MCP tool to create an issue in a github repository",
DisplayName = "createIssue",
OperationId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/github-rest-api/operations/createIssue",
ResourceGroupName = "rg1",
ServiceName = "apimService1",
ToolId = "createIssue",
});
});
package main
import (
apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apimanagement.NewApiTool(ctx, "apiTool", &apimanagement.ApiToolArgs{
ApiId: pulumi.String("github-mcp-api"),
Description: pulumi.String("This is a MCP tool to create an issue in a github repository"),
DisplayName: pulumi.String("createIssue"),
OperationId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/github-rest-api/operations/createIssue"),
ResourceGroupName: pulumi.String("rg1"),
ServiceName: pulumi.String("apimService1"),
ToolId: pulumi.String("createIssue"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.ApiTool;
import com.pulumi.azurenative.apimanagement.ApiToolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var apiTool = new ApiTool("apiTool", ApiToolArgs.builder()
.apiId("github-mcp-api")
.description("This is a MCP tool to create an issue in a github repository")
.displayName("createIssue")
.operationId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/github-rest-api/operations/createIssue")
.resourceGroupName("rg1")
.serviceName("apimService1")
.toolId("createIssue")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const apiTool = new azure_native.apimanagement.ApiTool("apiTool", {
apiId: "github-mcp-api",
description: "This is a MCP tool to create an issue in a github repository",
displayName: "createIssue",
operationId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/github-rest-api/operations/createIssue",
resourceGroupName: "rg1",
serviceName: "apimService1",
toolId: "createIssue",
});
import pulumi
import pulumi_azure_native as azure_native
api_tool = azure_native.apimanagement.ApiTool("apiTool",
api_id="github-mcp-api",
description="This is a MCP tool to create an issue in a github repository",
display_name="createIssue",
operation_id="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/github-rest-api/operations/createIssue",
resource_group_name="rg1",
service_name="apimService1",
tool_id="createIssue")
resources:
apiTool:
type: azure-native:apimanagement:ApiTool
properties:
apiId: github-mcp-api
description: This is a MCP tool to create an issue in a github repository
displayName: createIssue
operationId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/github-rest-api/operations/createIssue
resourceGroupName: rg1
serviceName: apimService1
toolId: createIssue
Create ApiTool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiTool(name: string, args: ApiToolArgs, opts?: CustomResourceOptions);@overload
def ApiTool(resource_name: str,
args: ApiToolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiTool(resource_name: str,
opts: Optional[ResourceOptions] = None,
api_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
service_name: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
operation_id: Optional[str] = None,
tool_id: Optional[str] = None)func NewApiTool(ctx *Context, name string, args ApiToolArgs, opts ...ResourceOption) (*ApiTool, error)public ApiTool(string name, ApiToolArgs args, CustomResourceOptions? opts = null)
public ApiTool(String name, ApiToolArgs args)
public ApiTool(String name, ApiToolArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:ApiTool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApiToolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiToolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiToolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiToolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiToolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var apiToolResource = new AzureNative.ApiManagement.ApiTool("apiToolResource", new()
{
ApiId = "string",
ResourceGroupName = "string",
ServiceName = "string",
Description = "string",
DisplayName = "string",
OperationId = "string",
ToolId = "string",
});
example, err := apimanagement.NewApiTool(ctx, "apiToolResource", &apimanagement.ApiToolArgs{
ApiId: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
OperationId: pulumi.String("string"),
ToolId: pulumi.String("string"),
})
var apiToolResource = new ApiTool("apiToolResource", ApiToolArgs.builder()
.apiId("string")
.resourceGroupName("string")
.serviceName("string")
.description("string")
.displayName("string")
.operationId("string")
.toolId("string")
.build());
api_tool_resource = azure_native.apimanagement.ApiTool("apiToolResource",
api_id="string",
resource_group_name="string",
service_name="string",
description="string",
display_name="string",
operation_id="string",
tool_id="string")
const apiToolResource = new azure_native.apimanagement.ApiTool("apiToolResource", {
apiId: "string",
resourceGroupName: "string",
serviceName: "string",
description: "string",
displayName: "string",
operationId: "string",
toolId: "string",
});
type: azure-native:apimanagement:ApiTool
properties:
apiId: string
description: string
displayName: string
operationId: string
resourceGroupName: string
serviceName: string
toolId: string
ApiTool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ApiTool resource accepts the following input properties:
- 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.
- Description string
- Description of the tool.
- Display
Name string - Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
- Operation
Id string - Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.
- Tool
Id string - Tool identifier within an API. Must be unique in the current API Management service instance.
- 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.
- Description string
- Description of the tool.
- Display
Name string - Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
- Operation
Id string - Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.
- Tool
Id string - Tool identifier within an API. Must be unique in the current API Management service instance.
- 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.
- description String
- Description of the tool.
- display
Name String - Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
- operation
Id String - Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.
- tool
Id String - Tool identifier within an API. Must be unique in the current API Management service instance.
- 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.
- description string
- Description of the tool.
- display
Name string - Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
- operation
Id string - Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.
- tool
Id 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_ strname - The name of the resource group. The name is case insensitive.
- service_
name str - The name of the API Management service.
- 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}.
- tool_
id str - Tool identifier within an API. Must be unique in the current API Management service instance.
- 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.
- description String
- Description of the tool.
- display
Name String - Tool Name. MCP tool name must contain only letters, numbers, underscores, and hyphens.
- operation
Id String - Identifier of the operation this MCP tool is associated with in the form of /apis/{apiId}/operations/{operationId}.
- tool
Id String - Tool identifier within an API. Must be unique in the current API Management service instance.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiTool resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Api Management. Outputs. System Data Response - 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"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- system_
data SystemData Response - 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"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- system
Data 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"
Supporting Types
SystemDataResponse, SystemDataResponseArgs
Metadata pertaining to creation and last modification of the resource.- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:ApiTool createIssue /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tools/{toolId}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
