Tag Resource - List By Service

Servicio:

API Management

Versión de la API:

2024-05-01

Enumera una colección de recursos asociados a etiquetas.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
$filter	query		string	| Campo | Uso | Operadores admitidos | Funciones admitidas | |-------------|-------------|-------------|-------------| | aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | 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 | | apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | método | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq | | | isCurrent | filter | eq | |
$skip	query		integer (int32) minimum: 0	Número de registros que se van a omitir.
$top	query		integer (int32) minimum: 1	Número de registros que se van a devolver.

Respuestas

Nombre	Tipo	Description
200 OK	TagResourceCollection	Enumera una colección de entidades TagResource.
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementListTagResources

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for TagResource ListByService.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListTagResources.json
     */
    /**
     * Sample code: ApiManagementListTagResources.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListTagResources(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.tagResources().listByService("rg1", "apimService1", 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_tag_resources.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.tag_resource.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListTagResources.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/ApiManagementListTagResources.json
func ExampleTagResourceClient_NewListByServicePager() {
	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.NewTagResourceClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.TagResourceClientListByServiceOptions{Filter: nil,
		Top:  nil,
		Skip: 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{
		// 	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"),
		// 			},
		// 		},
		// 		{
		// 			API: &armapimanagement.APITagResourceContractProperties{
		// 				APIRevision: to.Ptr("1"),
		// 				IsCurrent: to.Ptr(true),
		// 				Name: to.Ptr("Echo API"),
		// 				Path: to.Ptr("echo"),
		// 				ID: to.Ptr("/apis/echo-api"),
		// 				ServiceURL: to.Ptr("http://echoapi.cloudapp.net/api"),
		// 			},
		// 			Tag: &armapimanagement.TagResourceContractProperties{
		// 				Name: to.Ptr("awesomeTag"),
		// 				ID: to.Ptr("/tags/apitag123"),
		// 			},
		// 		},
		// 		{
		// 			Product: &armapimanagement.ProductTagResourceContractProperties{
		// 				Description: to.Ptr("Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week."),
		// 				ApprovalRequired: to.Ptr(false),
		// 				State: to.Ptr(armapimanagement.ProductStatePublished),
		// 				SubscriptionRequired: to.Ptr(true),
		// 				SubscriptionsLimit: to.Ptr[int32](1),
		// 				Terms: to.Ptr(""),
		// 				Name: to.Ptr("Starter"),
		// 				ID: to.Ptr("/products/starter"),
		// 			},
		// 			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 resources associated with tags.
 *
 * @summary Lists a collection of resources associated with tags.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListTagResources.json
 */
async function apiManagementListTagResources() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.tagResource.listByService(resourceGroupName, serviceName)) {
    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 System.Xml;
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/ApiManagementListTagResources.json
// this example is just showing the usage of "TagResource_ListByService" 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 ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
await foreach (TagResourceContractDetails item in apiManagementService.GetTagResourcesAsync())
{
    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

Respuesta de muestra

status code:

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."
      }
    },
    {
      "tag": {
        "id": "/tags/apitag123",
        "name": "awesomeTag"
      },
      "api": {
        "id": "/apis/echo-api",
        "name": "Echo API",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "echo",
        "isCurrent": true
      }
    },
    {
      "tag": {
        "id": "/tags/apitag123",
        "name": "awesomeTag"
      },
      "product": {
        "id": "/products/starter",
        "name": "Starter",
        "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
        "terms": "",
        "subscriptionRequired": true,
        "approvalRequired": false,
        "subscriptionsLimit": 1,
        "state": "published"
      }
    }
  ]
}

Definiciones

Nombre	Description
ApiContactInformation	Información de contacto de API
ApiLicenseInformation	Información de licencia de API
ApiTagResourceContractProperties	Propiedades del contrato de API para los recursos de etiqueta.
ApiType	Tipo de API.
AuthenticationSettingsContract	Configuración de autenticación de API.
bearerTokenSendingMethods	Cómo enviar el token al servidor.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
OAuth2AuthenticationSettingsContract	Detalles de la configuración de autenticación de OAuth2 de API.
OpenIdAuthenticationSettingsContract	Detalles de la configuración de autenticación de OAuth2 de API.
OperationTagResourceContractProperties	Propiedades del contrato de entidad de operación.
ProductState	si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished.
ProductTagResourceContractProperties	Perfil de producto.
Protocol	Describe en qué protocolos se pueden invocar las operaciones de esta API.
SubscriptionKeyParameterNamesContract	Detalles de los nombres de parámetro clave de suscripción.
TagResourceCollection	Representación de la lista etiqueta paginada.
TagResourceContract	Propiedades del contrato TagResource.
TagTagResourceContractProperties	Contrato que define la propiedad Tag en el contrato de recursos de etiqueta

ApiContactInformation

Object

Información de contacto de API

Nombre	Tipo	Description
email	string	Dirección de correo electrónico de la persona o organización de contacto. DEBE estar en el formato de una dirección de correo electrónico.
name	string	Nombre de identificación de la persona o organización de contacto
url	string	Dirección URL que apunta a la información de contacto. DEBE estar en el formato de una dirección URL.

ApiLicenseInformation

Object

Información de licencia de API

Nombre	Tipo	Description
name	string	Nombre de licencia usado para la API
url	string	Dirección URL de la licencia usada para la API. DEBE estar en el formato de una dirección URL.

ApiTagResourceContractProperties

Object

Propiedades del contrato de API para los recursos de etiqueta.

Nombre	Tipo	Description
apiRevision	string minLength: 1 maxLength: 100	Describe la revisión de la API. Si no se proporciona ningún valor, se crea la revisión 1 predeterminada.
apiRevisionDescription	string maxLength: 256	Descripción de la revisión de API.
apiVersion	string maxLength: 100	Indica el identificador de versión de la API si la API tiene versiones
apiVersionDescription	string maxLength: 256	Descripción de la versión de la API.
apiVersionSetId	string	Identificador de recurso para apiVersionSet relacionado.
authenticationSettings	AuthenticationSettingsContract	Colección de opciones de configuración de autenticación incluidas en esta API.
contact	ApiContactInformation	Información de contacto de la API.
description	string	Descripción de la API. Puede incluir etiquetas de formato HTML.
id	string	Identificador de API con el formato /apis/{apiId}.
isCurrent	boolean	Indica si la revisión de API es la revisión de API actual.
isOnline	boolean	Indica si la revisión de API es accesible a través de la puerta de enlace.
license	ApiLicenseInformation	Información de licencia de la API.
name	string minLength: 1 maxLength: 300	Nombre de LA API.
path	string minLength: 0 maxLength: 400	Dirección URL relativa que identifica de forma única esta API y todas sus rutas de acceso de recursos dentro de la instancia del servicio API Management. Se anexa a la dirección URL base del punto de conexión de API especificada durante la creación de la instancia de servicio para formar una dirección URL pública para esta API.
protocols	Protocol[]	Describe en qué protocolos se pueden invocar las operaciones de esta API.
serviceUrl	string minLength: 1 maxLength: 2000	Dirección URL absoluta del servicio back-end que implementa esta API.
subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolos sobre los que está disponible la API.
subscriptionRequired	boolean	Especifica si se requiere una suscripción de API o Producto para acceder a la API.
termsOfServiceUrl	string	Una dirección URL a los Términos del servicio para la API. DEBE estar en el formato de una dirección URL.
type	ApiType	Tipo de API.

ApiType

Enumeración

Tipo de API.

Valor	Description
graphql
grpc
http
odata
soap
websocket

AuthenticationSettingsContract

Object

Configuración de autenticación de API.

Nombre	Tipo	Description
oAuth2	OAuth2AuthenticationSettingsContract	Configuración de autenticación de OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Colección de la configuración de autenticación de OAuth2 incluida en esta API.
openid	OpenIdAuthenticationSettingsContract	Configuración de autenticación de OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Colección de la configuración de autenticación de Open ID Connect incluida en esta API.

bearerTokenSendingMethods

Enumeración

Cómo enviar el token al servidor.

Valor	Description
authorizationHeader	El token de acceso se transmitirá en el encabezado de autorización mediante el esquema de portador
query	El token de acceso se transmitirá como parámetros de consulta.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

OAuth2AuthenticationSettingsContract

Object

Detalles de la configuración de autenticación de OAuth2 de API.

Nombre	Tipo	Description
authorizationServerId	string	Identificador del servidor de autorización de OAuth.
scope	string	ámbito de operaciones.

OpenIdAuthenticationSettingsContract

Object

Detalles de la configuración de autenticación de OAuth2 de API.

Nombre	Tipo	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Cómo enviar el token al servidor.
openidProviderId	string	Identificador del servidor de autorización de OAuth.

OperationTagResourceContractProperties

Object

Propiedades del contrato de entidad de operación.

Nombre	Tipo	Description
apiName	string	Nombre de LA API.
apiRevision	string	Revisión de API.
apiVersion	string	Versión de API.
description	string	Descripción de la operación.
id	string	Identificador de la operación en forma /operations/{operationId}.
method	string	Un método de operación HTTP válido. Métodos HTTP típicos, como GET, PUT, POST, pero no limitados solo por ellos.
name	string	Nombre de la operación.
urlTemplate	string	Plantilla de dirección URL relativa que identifica el recurso de destino para esta operación. Puede incluir parámetros. Ejemplo: /customers/{cid}/orders/{oid}/?date={date}

ProductState

Enumeración

si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished.

Valor	Description
notPublished
published

ProductTagResourceContractProperties

Object

Perfil de producto.

Nombre	Tipo	Description
approvalRequired	boolean	si se requiere la aprobación de la suscripción. Si es false, las nuevas suscripciones se aprobarán automáticamente, lo que permitirá a los desarrolladores llamar a las API del producto inmediatamente después de suscribirse. Si es true, los administradores deben aprobar manualmente la suscripción antes de que el desarrollador pueda cualquiera de las API del producto. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false.
description	string minLength: 0 maxLength: 1000	Descripción del producto. Puede incluir etiquetas de formato HTML.
id	string	Identificador del producto en forma de /products/{productId}
name	string minLength: 1 maxLength: 300	Nombre del producto.
state	ProductState	si el producto se publica o no. Los usuarios del portal para desarrolladores pueden detectar los productos publicados. Los productos no publicados solo son visibles para los administradores. El estado predeterminado de Product no esPublished.
subscriptionRequired	boolean	Si se requiere una suscripción de producto para acceder a las API incluidas en este producto. Si es true, el producto se conoce como "protegido" y se requiere una clave de suscripción válida para que una solicitud a una API incluida en el producto se realice correctamente. Si es false, el producto se conoce como "abierto" y se pueden realizar solicitudes a una API incluida en el producto sin una clave de suscripción. Si se omite la propiedad al crear un nuevo producto, se supone que el valor es true.
subscriptionsLimit	integer (int32)	Indica si el número de suscripciones que un usuario puede tener en este producto al mismo tiempo. Establezca en NULL o omita para permitir suscripciones ilimitadas por usuario. Solo puede estar presente si la propiedad subscriptionRequired está presente y tiene un valor false.
terms	string	Términos de uso del producto. Los desarrolladores que intentan suscribirse al producto se mostrarán y tendrán que aceptar estos términos para poder completar el proceso de suscripción.

Protocol

Enumeración

Describe en qué protocolos se pueden invocar las operaciones de esta API.

Valor	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Detalles de los nombres de parámetro clave de suscripción.

Nombre	Tipo	Description
header	string	Nombre del encabezado de clave de suscripción.
query	string	Nombre del parámetro de la cadena de consulta de clave de suscripción.

TagResourceCollection

Object

Representación de la lista etiqueta paginada.

Nombre	Tipo	Description
count	integer (int64)	Número total de recuento de registros en todas las páginas.
nextLink	string	Vínculo de página siguiente si existe.
value	TagResourceContract[]	Valores de página.

TagResourceContract

Object

Propiedades del contrato TagResource.

Nombre	Tipo	Description
api	ApiTagResourceContractProperties	API asociada a la etiqueta .
operation	OperationTagResourceContractProperties	Operación asociada a la etiqueta .
product	ProductTagResourceContractProperties	Producto asociado a la etiqueta .
tag	TagTagResourceContractProperties	Etiqueta asociada al recurso.

TagTagResourceContractProperties

Object

Contrato que define la propiedad Tag en el contrato de recursos de etiqueta

Nombre	Tipo	Description
id	string	Identificador de etiqueta
name	string minLength: 1 maxLength: 160	Nombre de etiqueta