Operation - List By Tags

Referens

Tjänst:: API Management

API-version:: 2022-08-01

Visar en samling åtgärder som är associerade med taggar.

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

Med valfria parametrar:

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=2022-08-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiId	path	True	string	API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret. Reguljärt uttrycksmönster: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string	Namnet på API Management-tjänsten. Reguljärt uttrycksmönster: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
$filter	query		string	\| Fält \| Användning \| Operatorer som stöds \| Funktioner som stöds \| \|-------------\|-------------\|-------------\|-------------\| \| namn \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| apiName \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| description \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| metod \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| urlTemplate \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \|
$skip	query		integer int32	Antal poster att hoppa över.
$top	query		integer int32	Antal poster som ska returneras.
includeNotTaggedOperations	query		boolean	Inkludera åtgärder som inte är taggade.

Svar

Name	Typ	Description
200 OK	TagResourceCollection	Visar en samling TagResource-entiteter.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementListApiOperationsByTags

Exempelbegäran

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/operationsByTags?api-version=2022-08-01

/** Samples for Operation ListByTags. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-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

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="subid",
    )

    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/2022-08-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

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/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

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

/**
 * 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/2022-08-01/examples/ApiManagementListApiOperationsByTags.json
 */
async function apiManagementListApiOperationsByTags() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  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 (let 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

Exempelsvar

Statuskod:: 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
}

Definitioner

Name	Description
ApiContactInformation	API-kontaktinformation
ApiLicenseInformation	API-licensinformation
ApiTagResourceContractProperties	API-kontraktegenskaper för taggresurserna.
ApiType	Typ av API.
AuthenticationSettingsContract	API-autentiseringsinställningar.
bearerTokenSendingMethods	Skicka token till servern.
ErrorFieldContract	Fel Fältkontrakt.
ErrorResponse	Felsvar.
OAuth2AuthenticationSettingsContract	Information om API OAuth2-autentiseringsinställningar.
OpenIdAuthenticationSettingsContract	Information om API OAuth2-autentiseringsinställningar.
OperationTagResourceContractProperties	Egenskaper för entitetskontrakt för åtgärd.
ProductState	om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Produkt är intePublicerat.
ProductTagResourceContractProperties	Produktprofil.
Protocol	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
SubscriptionKeyParameterNamesContract	Information om namn på prenumerationsnyckelparametrar.
TagResourceCollection	Sidtagglistrepresentation.
TagResourceContract	Egenskaper för TagResource-kontrakt.
TagTagResourceContractProperties	Kontrakt som definierar egenskapen Tagg i taggresurskontraktet

ApiContactInformation

API-kontaktinformation

Name	Typ	Description
email	string	Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress
name	string	Identitetsnamnet för kontaktpersonen/organisationen
url	string	Url:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL

ApiLicenseInformation

API-licensinformation

Name	Typ	Description
name	string	Licensnamnet som används för API:et
url	string	En URL till den licens som används för API:et. MÅSTE vara i formatet för en URL

ApiTagResourceContractProperties

API-kontraktegenskaper för taggresurserna.

Name	Typ	Description
apiRevision	string	Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1
apiRevisionDescription	string	Beskrivning av API Revision.
apiVersion	string	Anger versionsidentifieraren för API:et om API:et är versionshanterat
apiVersionDescription	string	Beskrivning av API-versionen.
apiVersionSetId	string	En resursidentifierare för den relaterade ApiVersionSet.
authenticationSettings	AuthenticationSettingsContract	Samling autentiseringsinställningar som ingår i det här API:et.
contact	ApiContactInformation	Kontaktuppgifter för API:et.
description	string	Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.
id	string	API-identifierare i formatet /apis/{apiId}.
isCurrent	boolean	Anger om API-revision är aktuell API-revision.
isOnline	boolean	Anger om API-revisionen är tillgänglig via gatewayen.
license	ApiLicenseInformation	Licensinformation för API:et.
name	string	API-namn.
path	string	Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.
protocols	Protocol[]	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
serviceUrl	string	Absolut URL för serverdelstjänsten som implementerar det här API:et.
subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokoll över vilka API:et görs tillgängligt.
subscriptionRequired	boolean	Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.
termsOfServiceUrl	string	En URL till användarvillkoren för API:et. MÅSTE vara i formatet för en URL.
type	ApiType	Typ av API.

ApiType

Typ av API.

Name	Typ	Description
graphql	string
http	string
soap	string
websocket	string

AuthenticationSettingsContract

API-autentiseringsinställningar.

Name	Typ	Description
oAuth2	OAuth2AuthenticationSettingsContract	Autentiseringsinställningar för OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Samling OAuth2-autentiseringsinställningar som ingår i det här API:et.
openid	OpenIdAuthenticationSettingsContract	Inställningar för OpenID Connect-autentisering
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Samling av autentiseringsinställningar för Open ID Connect som ingår i det här API:et.

bearerTokenSendingMethods

Skicka token till servern.

Name	Typ	Description
authorizationHeader	string	Åtkomsttoken överförs i auktoriseringshuvudet med hjälp av ägarschemat
query	string	Åtkomsttoken överförs som frågeparametrar.

ErrorFieldContract

Fel Fältkontrakt.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Felsvar.

Name	Typ	Description
error.code	string	Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message	string	Mänsklig läsbar representation av felet.

OAuth2AuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name	Typ	Description
authorizationServerId	string	OAuth-auktoriseringsserveridentifierare.
scope	string	omfång för åtgärder.

OpenIdAuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name	Typ	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Skicka token till servern.
openidProviderId	string	OAuth-auktoriseringsserveridentifierare.

OperationTagResourceContractProperties

Egenskaper för entitetskontrakt för åtgärd.

Name	Typ	Description
apiName	string	API-namn.
apiRevision	string	API Revision.
apiVersion	string	API-version.
description	string	Åtgärdsbeskrivning.
id	string	Identifierare för åtgärden i formatet /operations/{operationId}.
method	string	En giltig HTTP-åtgärdsmetod. Typiska HTTP-metoder som GET, PUT, POST men inte begränsat av dem.
name	string	Åtgärdsnamn.
urlTemplate	string	Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: /customers/{cid}/orders/{oid}/?date={date}

ProductState

om produkten har publicerats eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Produkt är intePublicerat.

Name	Typ	Description
notPublished	string
published	string

ProductTagResourceContractProperties

Produktprofil.

Name	Typ	Description
approvalRequired	boolean	om prenumerationsgodkännande krävs. Om det är falskt godkänns nya prenumerationer automatiskt så att utvecklare kan anropa produktens API:er omedelbart efter prenumerationen. Om det är sant måste administratörer godkänna prenumerationen manuellt innan utvecklaren kan någon av produktens API:er. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.
description	string	Produktbeskrivning. Kan innehålla HTML-formateringstaggar.
id	string	Identifierare för produkten i form av /products/{productId}
name	string	Produktnamn.
state	ProductState	om produkten publiceras eller inte. Publicerade produkter kan identifieras av användare av utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer. Standardtillståndet för Product är intePublicerat.
subscriptionRequired	boolean	Om en produktprenumeration krävs för åtkomst till API:er som ingår i den här produkten. Om det är sant kallas produkten "skyddad" och en giltig prenumerationsnyckel krävs för att en begäran till ett API som ingår i produkten ska lyckas. Om det är falskt kallas produkten "öppen" och begäranden till ett API som ingår i produkten kan göras utan en prenumerationsnyckel. Om egenskapen utelämnas när en ny produkt skapas antas värdet vara sant.
subscriptionsLimit	integer	Om antalet prenumerationer som en användare kan ha till den här produkten samtidigt. Ange till null eller utelämna om du vill tillåta obegränsade prenumerationer per användare. Kan bara finnas om egenskapen subscriptionRequired finns och har värdet false.
terms	string	Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste godkänna dessa villkor innan de kan slutföra prenumerationsprocessen.

Protocol

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

Name	Typ	Description
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

Information om namn på prenumerationsnyckelparametrar.

Name	Typ	Description
header	string	Namn på prenumerationsnyckelhuvud.
query	string	Parameternamn för frågesträng för prenumerationsnyckel.

TagResourceCollection

Sidtagglistrepresentation.

Name	Typ	Description
count	integer	Totalt antal poster på alla sidor.
nextLink	string	Om det finns någon länk till nästa sida.
value	TagResourceContract[]	Sidvärden.

TagResourceContract

Egenskaper för TagResource-kontrakt.

Name	Typ	Description
api	ApiTagResourceContractProperties	API som är associerat med taggen.
operation	OperationTagResourceContractProperties	Åtgärd som är associerad med taggen.
product	ProductTagResourceContractProperties	Produkt som är associerad med taggen.
tag	TagTagResourceContractProperties	Tagg som är associerad med resursen.

TagTagResourceContractProperties

Kontrakt som definierar egenskapen Tagg i taggresurskontraktet

Name	Typ	Description
id	string	Taggidentifierare
name	string	Taggnamn

Dela via

Operation - List By Tags

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementListApiOperationsByTags

Exempelbegäran

Exempelsvar

Definitioner

ApiContactInformation

ApiLicenseInformation

ApiTagResourceContractProperties

ApiType

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorFieldContract

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

OperationTagResourceContractProperties

ProductState

ProductTagResourceContractProperties

Protocol

SubscriptionKeyParameterNamesContract

TagResourceCollection

TagResourceContract

TagTagResourceContractProperties

Ytterligare resurser