operations

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

Overview

Name	operations
Type	Resource
Id	azure.api_management.operations

Fields

The following fields are returned by SELECT queries:

list_by_tags

Lists a collection of TagResource entities.

Name	Datatype	Description
api	object	API associated with the tag.
operation	object	Operation associated with the tag.
product	object	Product associated with the tag.
tag	object	Tag associated with the resource.

list

Success. The response describes the list of operations.

Name	Datatype	Description
name	string	The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action"
actionType	string	Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
display	object	Localized display information for this particular operation.
isDataAction	boolean	Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations.
origin	string	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_tags	select	resourceGroupName, serviceName, apiId, subscriptionId	$filter, $top, $skip, includeNotTaggedOperations	Lists a collection of operations associated with tags.
list	select			Lists all of the available REST API operations of the Microsoft.ApiManagement provider.
perform_connectivity_check_async	exec	resourceGroupName, serviceName, subscriptionId, source, destination		Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.

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
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.
subscriptionId	string	The ID of the target subscription.
$filter	string	| Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>
$skip	integer (int32)	Number of records to skip.
$top	integer (int32)	Number of records to return.
includeNotTaggedOperations	boolean	Include not tagged Operations.

SELECT examples

list_by_tags

Lists a collection of operations associated with tags.

SELECT
api,
operation,
product,
tag
FROM azure.api_management.operations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND includeNotTaggedOperations = '{{ includeNotTaggedOperations }}'
;

list

Lists all of the available REST API operations of the Microsoft.ApiManagement provider.

SELECT
name,
actionType,
display,
isDataAction,
origin
FROM azure.api_management.operations
;

Lifecycle Methods

perform_connectivity_check_async

Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.

EXEC azure.api_management.operations.perform_connectivity_check_async 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@serviceName='{{ serviceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"source": "{{ source }}", 
"destination": "{{ destination }}", 
"preferredIPVersion": "{{ preferredIPVersion }}", 
"protocol": "{{ protocol }}", 
"protocolConfiguration": "{{ protocolConfiguration }}"
}'
;