Api Operation - List By Api

Reference

Service:: API Management

API Version:: 2024-05-01

Lists a collection of the operations for the specified API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?api-version=2024-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations?$filter={$filter}&$top={$top}&$skip={$skip}&tags={tags}&api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
apiId	path	True	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. Regex pattern: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.
$filter	query		string	\| Field \| Usage \| Supported operators \| Supported functions \| \|-------------\|-------------\|-------------\|-------------\| \| name \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| method \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| description \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| urlTemplate \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer int32	Number of records to skip.
$top	query		integer int32	Number of records to return.
tags	query		string	Include tags in the response.

Responses

Name	Type	Description
200 OK	OperationCollection	A collection of operation summary entities at the API level.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementListApiOperations

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "displayName": "CancelOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/CancelOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cda",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cda",
      "properties": {
        "displayName": "GetMostRecentOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetMostRecentOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd9",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd9",
      "properties": {
        "displayName": "GetOpenOrders",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOpenOrders"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cdb",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cdb",
      "properties": {
        "displayName": "GetOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/GetOrder"
      }
    },
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/operations/57d2ef278aa04f0ad01d6cd8",
      "type": "Microsoft.ApiManagement/service/apis/operations",
      "name": "57d2ef278aa04f0ad01d6cd8",
      "properties": {
        "displayName": "submitOrder",
        "method": "POST",
        "urlTemplate": "/?soapAction=http://tempuri.org/IFazioService/submitOrder"
      }
    }
  ],
  "count": 5,
  "nextLink": ""
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OperationCollection	Paged Operation list representation.
OperationContract	API Operation details.
ParameterContract	Operation parameters details.
ParameterExampleContract	Parameter example.
RepresentationContract	Operation request/response representation details.
RequestContract	Operation request details.
ResponseContract	Operation response details.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

OperationCollection

Paged Operation list representation.

Name	Type	Description
count	integer	Total record count number across all pages.
nextLink	string	Next page link if any.
value	OperationContract[]	Page values.

OperationContract

API Operation details.

Name	Type	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
properties.description	string	Description of the operation. May include HTML formatting tags.
properties.displayName	string	Operation Name.
properties.method	string	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
properties.policies	string	Operation Policies
properties.request	RequestContract	An entity containing request details.
properties.responses	ResponseContract[]	Array of Operation responses.
properties.templateParameters	ParameterContract[]	Collection of URL template parameters.
properties.urlTemplate	string	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ParameterContract

Operation parameters details.

Name	Type	Description
defaultValue	string	Default parameter value.
description	string	Parameter description.
examples	<string, ParameterExampleContract>	Exampled defined for the parameter.
name	string	Parameter name.
required	boolean	Specifies whether parameter is required or not.
schemaId	string	Schema identifier.
type	string	Parameter type.
typeName	string	Type name defined by the schema.
values	string[]	Parameter values.

ParameterExampleContract

Parameter example.

Name	Type	Description
description	string	Long description for the example
externalValue	string	A URL that points to the literal example
summary	string	Short description for the example
value		Example value. May be a primitive value, or an object.

RepresentationContract

Operation request/response representation details.

Name	Type	Description
contentType	string	Specifies a registered or custom content type for this representation, e.g. application/xml.
examples	<string, ParameterExampleContract>	Exampled defined for the representation.
formParameters	ParameterContract[]	Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
schemaId	string	Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
typeName	string	Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.

RequestContract

Operation request details.

Name	Type	Description
description	string	Operation request description.
headers	ParameterContract[]	Collection of operation request headers.
queryParameters	ParameterContract[]	Collection of operation request query parameters.
representations	RepresentationContract[]	Collection of operation request representations.

ResponseContract

Operation response details.

Name	Type	Description
description	string	Operation response description.
headers	ParameterContract[]	Collection of operation response headers.
representations	RepresentationContract[]	Collection of operation response representations.
statusCode	integer	Operation response HTTP status code.

Share via