api_tool

Creates, updates, deletes, gets or lists an api_tool resource.

Overview

Name	api_tool
Type	Resource
Id	azure.api_management.api_tool

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
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.
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}.
systemData	object	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".

list_by_api

Name	Datatype	Description
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.
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}.
systemData	object	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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, api_id, tool_id, subscription_id		Gets the details of the API Tool specified by its identifier.
list_by_api	select	resource_group_name, service_name, api_id, subscription_id	$filter, $top, $skip	Lists a collection of the MCP tools for the specified API.
create_or_update	insert	resource_group_name, service_name, api_id, tool_id, subscription_id		Creates a new tool in the API or updates an existing one.
update	update	resource_group_name, service_name, api_id, tool_id, subscription_id		Updates the details of the tool in the API specified by its identifier.
create_or_update	replace	resource_group_name, service_name, api_id, tool_id, subscription_id		Creates a new tool in the API or updates an existing one.
delete	delete	resource_group_name, service_name, api_id, tool_id, subscription_id		Deletes the specified tool in the API.
get_entity_tag	exec	resource_group_name, service_name, api_id, tool_id, subscription_id		Gets the entity state (Etag) version of the API tool specified by its identifier.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string
tool_id	string	Tool identifier within an API. Must be unique in the current API Management service instance. Required.
$filter	string	| Field | Usage | Supported operators | Supported functions ||-------------|-------------|-------------|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |. Default value is None.
$skip	integer	Number of records to skip. Default value is None.
$top	integer	Number of records to return. Default value is None.

SELECT examples

get

Gets the details of the API Tool specified by its identifier.

SELECT
id,
name,
description,
displayName,
operationId,
systemData,
type
FROM azure.api_management.api_tool
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND tool_id = '{{ tool_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_api

Lists a collection of the MCP tools for the specified API.

SELECT
id,
name,
description,
displayName,
operationId,
systemData,
type
FROM azure.api_management.api_tool
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND api_id = '{{ api_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
;

INSERT examples

create_or_update

Creates a new tool in the API or updates an existing one.

INSERT INTO azure.api_management.api_tool (
properties,
resource_group_name,
service_name,
api_id,
tool_id,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ api_id }}',
'{{ tool_id }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: api_tool
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the api_tool resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the api_tool resource.
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the api_tool resource.
  - name: tool_id
    value: "{{ tool_id }}"
    description: Required parameter for the api_tool resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the api_tool resource.
  - name: properties
    description: |
      Properties of the Tool Contract.
    value:
      displayName: "{{ displayName }}"
      description: "{{ description }}"
      operationId: "{{ operationId }}"

UPDATE examples

update

Updates the details of the tool in the API specified by its identifier.

UPDATE azure.api_management.api_tool
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND tool_id = '{{ tool_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates a new tool in the API or updates an existing one.

REPLACE azure.api_management.api_tool
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND tool_id = '{{ tool_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified tool in the API.

DELETE FROM azure.api_management.api_tool
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND api_id = '{{ api_id }}' --required
AND tool_id = '{{ tool_id }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the API tool specified by its identifier.

EXEC azure.api_management.api_tool.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@api_id='{{ api_id }}' --required, 
@tool_id='{{ tool_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;