Operation - List By Tags

Service:

API Management

API-versie:

2024-05-01

Geeft een verzameling bewerkingen weer die zijn gekoppeld aan tags.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
$filter	query		string	| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies | |-------------|-------------|-------------|-------------| | naam | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith | | displayName | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith | | apiName | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith | | beschrijving | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith | | methode | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith | | urlTemplate | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith |
$skip	query		integer (int32) minimum: 0	Het aantal records dat moet worden overgeslagen.
$top	query		integer (int32) minimum: 1	Aantal records dat moet worden geretourneerd.
includeNotTaggedOperations	query		boolean	Neem geen getagde bewerkingen op.

Antwoorden

Name	Type	Description
200 OK	TagResourceCollection	Geeft een verzameling TagResource-entiteiten weer.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementListApiOperationsByTags

Voorbeeldaanvraag

HTTP

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

Java

/**
 * Samples for Operation ListByTags.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListApiOperationsByTags.json
     */
    /**
     * Sample code: ApiManagementListApiOperationsByTags.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListApiOperationsByTags(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.operations().listByTags("rg1", "apimService1", "a1", null, null, null, null,
            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

Python

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_api_operations_by_tags.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="00000000-0000-0000-0000-000000000000",
    )

    response = client.operation.list_by_tags(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="a1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListApiOperationsByTags.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

Go

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListApiOperationsByTags.json
func ExampleOperationClient_NewListByTagsPager() {
	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.NewOperationClient().NewListByTagsPager("rg1", "apimService1", "a1", &armapimanagement.OperationClientListByTagsOptions{Filter: nil,
		Top:                        nil,
		Skip:                       nil,
		IncludeNotTaggedOperations: 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.TagResourceCollection = armapimanagement.TagResourceCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.TagResourceContract{
		// 		{
		// 			Operation: &armapimanagement.OperationTagResourceContractProperties{
		// 				Name: to.Ptr("Create resource"),
		// 				Method: to.Ptr("POST"),
		// 				Description: to.Ptr("A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."),
		// 				APIName: to.Ptr("Echo API"),
		// 				APIRevision: to.Ptr("1"),
		// 				ID: to.Ptr("/apis/echo-api/operations/create-resource"),
		// 				URLTemplate: to.Ptr("/resource"),
		// 			},
		// 			Tag: &armapimanagement.TagResourceContractProperties{
		// 				Name: to.Ptr("awesomeTag"),
		// 				ID: to.Ptr("/tags/apitag123"),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Lists a collection of operations associated with tags.
 *
 * @summary Lists a collection of operations associated with tags.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListApiOperationsByTags.json
 */
async function apiManagementListApiOperationsByTags() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "a1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.operationOperations.listByTags(
    resourceGroupName,
    serviceName,
    apiId,
  )) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListApiOperationsByTags.json
// this example is just showing the usage of "Operation_ListByTags" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiResource created on azure
// for more information of creating ApiResource, please refer to the document of ApiResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "a1";
ResourceIdentifier apiResourceId = ApiResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId);
ApiResource api = client.GetApiResource(apiResourceId);

// invoke the operation and iterate over the result
await foreach (TagResourceContractDetails item in api.GetOperationsByTagsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Voorbeeldrespons

Statuscode:

200

{
  "value": [
    {
      "tag": {
        "id": "/tags/apitag123",
        "name": "awesomeTag"
      },
      "operation": {
        "id": "/apis/echo-api/operations/create-resource",
        "apiName": "Echo API",
        "apiRevision": "1",
        "name": "Create resource",
        "method": "POST",
        "urlTemplate": "/resource",
        "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."
      }
    }
  ],
  "count": 1
}

Definities

Name	Description
ApiContactInformation	API-contactgegevens
ApiLicenseInformation	API-licentiegegevens
ApiTagResourceContractProperties	API-contracteigenschappen voor de tagbronnen.
ApiType	Type of API.
AuthenticationSettingsContract	API-verificatie-instellingen.
bearerTokenSendingMethods	Token naar de server verzenden.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
OAuth2AuthenticationSettingsContract	Details van verificatie-instellingen voor API OAuth2.
OpenIdAuthenticationSettingsContract	Details van verificatie-instellingen voor API OAuth2.
OperationTagResourceContractProperties	Eigenschappen van bewerkingsentiteitscontract.
ProductState	of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.
ProductTagResourceContractProperties	Productprofiel.
Protocol	Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
SubscriptionKeyParameterNamesContract	Details van parameternamen voor abonnementssleutels.
TagResourceCollection	Weergave van gepaginade taglijst.
TagResourceContract	TagResource-contracteigenschappen.
TagTagResourceContractProperties	Contract voor het definiëren van de eigenschap Tag in het Tag Resource Contract

ApiContactInformation

Object

API-contactgegevens

Name	Type	Description
email	string	Het e-mailadres van de contactpersoon/organisatie. MOET de indeling van een e-mailadres hebben
name	string	De identificatienaam van de contactpersoon/organisatie
url	string	De URL die verwijst naar de contactgegevens. MOET de indeling van een URL hebben

ApiLicenseInformation

Object

API-licentiegegevens

Name	Type	Description
name	string	De licentienaam die wordt gebruikt voor de API
url	string	Een URL naar de licentie die wordt gebruikt voor de API. MOET de indeling van een URL hebben

ApiTagResourceContractProperties

Object

API-contracteigenschappen voor de tagbronnen.

Name	Type	Description
apiRevision	string minLength: 1 maxLength: 100	Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaardrevisie 1 gemaakt
apiRevisionDescription	string maxLength: 256	Beschrijving van de API-revisie.
apiVersion	string maxLength: 100	Geeft de versie-id van de API aan als de API is geversied
apiVersionDescription	string maxLength: 256	Beschrijving van de API-versie.
apiVersionSetId	string	Een resource-id voor de gerelateerde ApiVersionSet.
authenticationSettings	AuthenticationSettingsContract	Verzameling van verificatie-instellingen die zijn opgenomen in deze API.
contact	ApiContactInformation	Contactgegevens voor de API.
description	string	Beschrijving van de API. Kan HTML-opmaaktags bevatten.
id	string	API-id in de vorm /apis/{apiId}.
isCurrent	boolean	Geeft aan of API-revisie de huidige API-revisie is.
isOnline	boolean	Geeft aan of API-revisie toegankelijk is via de gateway.
license	ApiLicenseInformation	Licentiegegevens voor de API.
name	string minLength: 1 maxLength: 300	API-naam.
path	string minLength: 0 maxLength: 400	Relatieve URL die deze API en alle bijbehorende resourcepaden uniek identificeert binnen het API Management-service-exemplaar. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen.
protocols	Protocol[]	Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
serviceUrl	string minLength: 1 maxLength: 2000	Absolute URL van de back-endservice die deze API implementeert.
subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocollen over welke API beschikbaar wordt gemaakt.
subscriptionRequired	boolean	Hiermee geeft u op of een API- of productabonnement vereist is voor toegang tot de API.
termsOfServiceUrl	string	Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.
type	ApiType	Type of API.

ApiType

Inventarisatie

Type of API.

Waarde	Description
graphql
grpc
http
odata
soap
websocket

AuthenticationSettingsContract

Object

API-verificatie-instellingen.

Name	Type	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2-verificatie-instellingen
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Verzameling OAuth2-verificatie-instellingen die zijn opgenomen in deze API.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect-verificatie-instellingen
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Verzameling open ID Connect-verificatie-instellingen die zijn opgenomen in deze API.

bearerTokenSendingMethods

Inventarisatie

Token naar de server verzenden.

Waarde	Description
authorizationHeader	Toegangstoken wordt verzonden in de autorisatieheader met behulp van het Bearer-schema
query	Het toegangstoken wordt verzonden als queryparameters.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

OAuth2AuthenticationSettingsContract

Object

Details van verificatie-instellingen voor API OAuth2.

Name	Type	Description
authorizationServerId	string	OAuth-autorisatieserver-id.
scope	string	bewerkingsbereik.

OpenIdAuthenticationSettingsContract

Object

Details van verificatie-instellingen voor API OAuth2.

Name	Type	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Token naar de server verzenden.
openidProviderId	string	OAuth-autorisatieserver-id.

OperationTagResourceContractProperties

Object

Eigenschappen van bewerkingsentiteitscontract.

Name	Type	Description
apiName	string	API-naam.
apiRevision	string	API-revisie.
apiVersion	string	API-versie.
description	string	Beschrijving van bewerking.
id	string	Id van de bewerking in formulier /operations/{operationId}.
method	string	Een geldige HTTP-bewerkingsmethode. Typische HTTP-methoden zoals GET, PUT, POST, maar niet beperkt door alleen deze methoden.
name	string	Bewerkingsnaam.
urlTemplate	string	Relatieve URL-sjabloon waarmee de doelresource voor deze bewerking wordt geïdentificeerd. Kan parameters bevatten. Voorbeeld: /customers/{cid}/orders/{oid}/?date={date}

ProductState

Inventarisatie

of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.

Waarde	Description
notPublished
published

ProductTagResourceContractProperties

Object

Productprofiel.

Name	Type	Description
approvalRequired	boolean	of goedkeuring van het abonnement vereist is. Als dit onwaar is, worden nieuwe abonnementen automatisch goedgekeurd, zodat ontwikkelaars de API's van het product direct na het abonneren kunnen aanroepen. Indien waar, moeten beheerders het abonnement handmatig goedkeuren voordat de ontwikkelaar de API's van het product kan gebruiken. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
description	string minLength: 0 maxLength: 1000	Productbeschrijving. Kan HTML-opmaaktags bevatten.
id	string	Id van het product in de vorm van /products/{productId}
name	string minLength: 1 maxLength: 300	Productnaam.
state	ProductState	of het product is gepubliceerd of niet. Gepubliceerde producten kunnen worden gedetecteerd door gebruikers van de ontwikkelaarsportal. Niet-gepubliceerde producten zijn alleen zichtbaar voor beheerders. De standaardstatus van Product is niet gepubliceerd.
subscriptionRequired	boolean	Of een productabonnement vereist is voor toegang tot API's die zijn opgenomen in dit product. Indien waar, wordt het product 'beveiligd' genoemd en is een geldige abonnementssleutel vereist voor een aanvraag naar een API die is opgenomen in het product om te slagen. Als dit onwaar is, wordt het product 'open' genoemd en kunnen aanvragen worden gedaan naar een API die is opgenomen in het product zonder abonnementssleutel. Als de eigenschap wordt weggelaten bij het maken van een nieuw product, wordt ervan uitgegaan dat deze waar is.
subscriptionsLimit	integer (int32)	Of het aantal abonnementen dat een gebruiker tegelijkertijd aan dit product kan hebben. Ingesteld op null of weglaten om onbeperkt per gebruikersabonnement toe te staan. Kan alleen aanwezig zijn als de eigenschap subscriptionRequired aanwezig is en de waarde false heeft.
terms	string	Productvoorwaarden. Ontwikkelaars die zich willen abonneren op het product, worden weergegeven en moeten deze voorwaarden accepteren voordat ze het abonnementsproces kunnen voltooien.

Protocol

Inventarisatie

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

Waarde	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Details van parameternamen voor abonnementssleutels.

Name	Type	Description
header	string	Naam van abonnementssleutelheader.
query	string	Naam van queryreeksparameter voor abonnementssleutel.

TagResourceCollection

Object

Weergave van gepaginade taglijst.

Name	Type	Description
count	integer (int64)	Totaal aantal records voor alle pagina's.
nextLink	string	Koppeling naar volgende pagina indien aanwezig.
value	TagResourceContract[]	Paginawaarden.

TagResourceContract

Object

TagResource-contracteigenschappen.

Name	Type	Description
api	ApiTagResourceContractProperties	API die is gekoppeld aan de tag.
operation	OperationTagResourceContractProperties	Bewerking die is gekoppeld aan de tag.
product	ProductTagResourceContractProperties	Product dat is gekoppeld aan de tag.
tag	TagTagResourceContractProperties	Tag die is gekoppeld aan de resource.

TagTagResourceContractProperties

Object

Contract voor het definiëren van de eigenschap Tag in het Tag Resource Contract

Name	Type	Description
id	string	Tag-id
name	string minLength: 1 maxLength: 160	Tagnaam