Api Management Operations - List

Referenz

Dienst:: API Management

API-Version:: 2022-08-01

Listet alle verfügbaren REST-API-Vorgänge des Microsoft.ApiManagement-Anbieters auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	OperationListResult	Erfolg. Die Antwort beschreibt die Liste der Vorgänge.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementListOperations

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
Display	Das -Objekt, das den Vorgang beschreibt.
ErrorFieldContract	Fehler Feldvertrag.
ErrorResponse	Fehlerantwort.
Operation	REST-API-Vorgang
OperationListResult	Ergebnis der Anforderung zum Auflisten von REST-API-Vorgängen. Sie enthält eine Liste der Vorgänge und eine URL nextLink, um den nächsten Satz von Ergebnissen zu erhalten.

Display

Das -Objekt, das den Vorgang beschreibt.

Name	Typ	Beschreibung
description	string	Anzeigename des Vorgangs
operation	string	Vorgangstyp: read, write, delete, listKeys/action usw.
provider	string	Anzeigename des Ressourcenanbieters
resource	string	Ressourcentyp, für den der Vorgang ausgeführt wird.

ErrorFieldContract

Fehler Feldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die in der Anforderung gesendet werden, im Falle eines Validierungsfehlers.
error.message	string	Lesbare Darstellung des Fehlers.

Operation

REST-API-Vorgang

Name	Typ	Beschreibung
display	Display	Das -Objekt, das den Vorgang beschreibt.
name	string	Vorgangsname: {provider}/{resource}/{operation}
origin	string	Der Vorgangsursprung.

OperationListResult

Ergebnis der Anforderung zum Auflisten von REST-API-Vorgängen. Sie enthält eine Liste der Vorgänge und eine URL nextLink, um den nächsten Satz von Ergebnissen zu erhalten.

Name	Typ	Beschreibung
nextLink	string	URL zum Abrufen des nächsten Vorgangslistenergebnisses, falls vorhanden.
value	Operation[]	Liste der vom Ressourcenanbieter unterstützten Vorgänge.

Freigeben über

Api Management Operations - List

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementListOperations

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Display

ErrorFieldContract

ErrorResponse

Operation

OperationListResult

Zusätzliche Ressourcen