Api Management Operations - List

Reference

Service:: API Management

API Version:: 2024-05-01

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

GET https://management.azure.com/providers/Microsoft.ApiManagement/operations?api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	OperationListResult	Success. The response describes the list of operations.
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

ApiManagementListOperations

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.ApiManagement/operations?api-version=2024-05-01

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "Microsoft.ApiManagement/service/write",
      "display": {
        "provider": "Microsoft API Management",
        "resource": "Service",
        "operation": "Create a new instance of API Management Service",
        "description": "Create a new instance of API Management Service"
      }
    },
    {
      "name": "Microsoft.ApiManagement/service/read",
      "display": {
        "provider": "Microsoft API Management",
        "resource": "Service",
        "operation": "Read metadata for an API Management Service instance",
        "description": "Read metadata for an API Management Service instance"
      }
    },
    {
      "name": "Microsoft.ApiManagement/service/delete",
      "display": {
        "provider": "Microsoft API Management",
        "resource": "Service",
        "operation": "Delete API Management Service instance",
        "description": "Delete API Management Service instance"
      }
    },
    {
      "origin": "system",
      "name": "Microsoft.ApiManagement/service/providers/Microsoft.Insights/diagnosticSettings/write",
      "display": {
        "provider": "Microsoft API Management",
        "resource": "Service",
        "operation": "Write diagnostic setting",
        "description": "Creates or updates the diagnostic setting for API Management service"
      }
    },
    {
      "name": "Microsoft.ApiManagement/service/tenant/operationResults/read",
      "display": {
        "provider": "Microsoft API Management",
        "resource": "Results of async operations",
        "operation": "Get operation results or Get operation result",
        "description": "Get list of operation results or Get result of a specific operation"
      }
    }
  ]
}

Definitions

Name	Description
Display	The object that describes the operation.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Operation	REST API operation
OperationListResult	Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

Display

The object that describes the operation.

Name	Type	Description
description	string	Friendly name of the operation
operation	string	Operation type: read, write, delete, listKeys/action, etc.
provider	string	Friendly name of the resource provider
resource	string	Resource type on which the operation is performed.

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.

Operation

REST API operation

Name	Type	Description
display	Display	The object that describes the operation.
name	string	Operation name: {provider}/{resource}/{operation}
origin	string	The operation origin.

OperationListResult

Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

Name	Type	Description
nextLink	string	URL to get the next set of operation list results if there are any.
value	Operation[]	List of operations supported by the resource provider.

Share via