api_operations

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

Overview

Name	api_operations
Type	Resource
Id	azure.api_management.api_operations

Fields

The following fields are returned by SELECT queries:

get

The response body contains the specified Operation entity.

Name	Datatype	Description
properties	object	Properties of the Operation Contract.

list_by_api

A collection of operation summary entities at the API level.

Name	Datatype	Description
properties	object	Properties of the Operation Contract.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceName, apiId, operationId, subscriptionId		Gets the details of the API Operation specified by its identifier.
list_by_api	select	resourceGroupName, serviceName, apiId, subscriptionId	$filter, $top, $skip, tags	Lists a collection of the operations for the specified API.
create_or_update	insert	resourceGroupName, serviceName, apiId, operationId, subscriptionId	If-Match	Creates a new operation in the API or updates an existing one.
update	update	resourceGroupName, serviceName, apiId, operationId, If-Match, subscriptionId		Updates the details of the operation in the API specified by its identifier.
delete	delete	resourceGroupName, serviceName, apiId, operationId, If-Match, subscriptionId		Deletes the specified operation in the API.

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
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.
operationId	string	The ID of an ongoing async operation.
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>| method | 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>| 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.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.
tags	string	Include tags in the response.

SELECT examples

get

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

SELECT
properties
FROM azure.api_management.api_operations
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceName = '{{ serviceName }}' -- required
AND apiId = '{{ apiId }}' -- required
AND operationId = '{{ operationId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_api

Lists a collection of the operations for the specified API.

SELECT
properties
FROM azure.api_management.api_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 tags = '{{ tags }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.api_management.api_operations (
data__properties,
resourceGroupName,
serviceName,
apiId,
operationId,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ apiId }}',
'{{ operationId }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: api_operations
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the api_operations resource.
    - name: serviceName
      value: string
      description: Required parameter for the api_operations resource.
    - name: apiId
      value: string
      description: Required parameter for the api_operations resource.
    - name: operationId
      value: string
      description: Required parameter for the api_operations resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the api_operations resource.
    - name: properties
      value: object
      description: |
        Properties of the Operation Contract.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

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

UPDATE azure.api_management.api_operations
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apiId = '{{ apiId }}' --required
AND operationId = '{{ operationId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
properties;

DELETE examples

delete

Deletes the specified operation in the API.

DELETE FROM azure.api_management.api_operations
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND apiId = '{{ apiId }}' --required
AND operationId = '{{ operationId }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;