Api Management Operations - List

Başvuru

Service:: API Management

API Version:: 2022-08-01

Microsoft.ApiManagement sağlayıcısının tüm kullanılabilir REST API işlemlerini listeler.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	OperationListResult	Başarılı. Yanıt, işlemlerin listesini açıklar.
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

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	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementListOperations

Sample Request

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

/** Samples for ApiManagementOperations List. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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(com.azure.core.util.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/2022-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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-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/2022-08-01/examples/ApiManagementListOperations.json
 */
async function apiManagementListOperations() {
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential);
  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"
      }
    }
  ]
}

Tanımlar

Name	Description
Display	İşlemi açıklayan nesne.
ErrorFieldContract	Hata Alanı sözleşmesi.
ErrorResponse	Hata Yanıtı.
Operation	REST API işlemi
OperationListResult	REST API işlemlerini listeleme isteğinin sonucu. Sonraki sonuç kümesini almak için işlemlerin listesini ve nextLink URL'sini içerir.

Display

İşlemi açıklayan nesne.

Name	Tür	Description
description	string	İşlemin kolay adı
operation	string	İşlem türü: okuma, yazma, silme, listKeys/action vb.
provider	string	Kaynak sağlayıcısının kolay adı
resource	string	İşlemin gerçekleştirildiği kaynak türü.

ErrorFieldContract

Hata Alanı sözleşmesi.

Name	Tür	Description
code	string	Özellik düzeyi hata kodu.
message	string	Özellik düzeyi hatanın insan tarafından okunabilir gösterimi.
target	string	Özellik adı.

ErrorResponse

Hata Yanıtı.

Name	Tür	Description
error.code	string	Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür.
error.details	ErrorFieldContract[]	Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi.
error.message	string	Hatanın insan tarafından okunabilir gösterimi.

Operation

REST API işlemi

Name	Tür	Description
display	Display	İşlemi açıklayan nesne.
name	string	İşlem adı: {provider}/{resource}/{operation}
origin	string	İşlem başlangıcı.

OperationListResult

REST API işlemlerini listeleme isteğinin sonucu. Sonraki sonuç kümesini almak için işlemlerin listesini ve nextLink URL'sini içerir.

Name	Tür	Description
nextLink	string	Varsa sonraki işlem listesi sonuçlarını almak için URL.
value	Operation[]	Kaynak sağlayıcısı tarafından desteklenen işlemlerin listesi.

Api Management Operations - List

URI Parametreleri

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

ApiManagementListOperations

Sample Request

Sample Response

Tanımlar

Display

ErrorFieldContract

ErrorResponse

Operation

OperationListResult

Ek kaynaklar