Api Management Operations - List

Reference

Service:: API Management

API Version:: 2021-08-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=2021-08-01

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string	Version of the API to be used with the client request.

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

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

import com.azure.core.util.Context;

/** Samples for ApiManagementOperations List. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListOperations.json
     */
    /**
     * Sample code: ApiManagementListOperations.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListOperations(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apiManagementOperations().list(Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_operations.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.api_management_operations.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListOperations.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListOperations.json
func ExampleOperationsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewOperationsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.OperationListResult = armapimanagement.OperationListResult{
		// 	Value: []*armapimanagement.Operation{
		// 		{
		// 			Name: to.Ptr("Microsoft.ApiManagement/service/write"),
		// 			Display: &armapimanagement.OperationDisplay{
		// 				Description: to.Ptr("Create a new instance of API Management Service"),
		// 				Operation: to.Ptr("Create a new instance of API Management Service"),
		// 				Provider: to.Ptr("Microsoft API Management"),
		// 				Resource: to.Ptr("Service"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ApiManagement/service/read"),
		// 			Display: &armapimanagement.OperationDisplay{
		// 				Description: to.Ptr("Read metadata for an API Management Service instance"),
		// 				Operation: to.Ptr("Read metadata for an API Management Service instance"),
		// 				Provider: to.Ptr("Microsoft API Management"),
		// 				Resource: to.Ptr("Service"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ApiManagement/service/delete"),
		// 			Display: &armapimanagement.OperationDisplay{
		// 				Description: to.Ptr("Delete API Management Service instance"),
		// 				Operation: to.Ptr("Delete API Management Service instance"),
		// 				Provider: to.Ptr("Microsoft API Management"),
		// 				Resource: to.Ptr("Service"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ApiManagement/service/providers/Microsoft.Insights/diagnosticSettings/write"),
		// 			Display: &armapimanagement.OperationDisplay{
		// 				Description: to.Ptr("Creates or updates the diagnostic setting for API Management service"),
		// 				Operation: to.Ptr("Write diagnostic setting"),
		// 				Provider: to.Ptr("Microsoft API Management"),
		// 				Resource: to.Ptr("Service"),
		// 			},
		// 			Origin: to.Ptr("system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.ApiManagement/service/tenant/operationResults/read"),
		// 			Display: &armapimanagement.OperationDisplay{
		// 				Description: to.Ptr("Get list of operation results or Get result of a specific operation"),
		// 				Operation: to.Ptr("Get operation results or Get operation result"),
		// 				Provider: to.Ptr("Microsoft API Management"),
		// 				Resource: to.Ptr("Results of async operations"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all of the available REST API operations of the Microsoft.ApiManagement provider.
 *
 * @summary Lists all of the available REST API operations of the Microsoft.ApiManagement provider.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListOperations.json
 */
async function apiManagementListOperations() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.apiManagementOperations.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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.
ErrorFieldContract	Error Field contract.
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.

ErrorFieldContract

Error Field contract.

Name	Type	Description
code	string	Property level error code.
message	string	Human-readable representation of property-level error.
target	string	Property name.

ErrorResponse

Error Response.

Name	Type	Description
error.code	string	Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
error.details	ErrorFieldContract[]	The list of invalid fields send in request, in case of validation error.
error.message	string	Human-readable representation of the error.

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

Api Management Operations - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ApiManagementListOperations

Sample request

Sample response

Definitions

Display

ErrorFieldContract

ErrorResponse

Operation

OperationListResult

Additional resources