Api - List By Tags

Serviço:

API Management

Versão da API:

2024-05-01

Lista uma coleção de apis associadas a marcas.

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

Com parâmetros opcionais:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
$filter	query		string	| Campo | Uso | Operadores com suporte | Funções com suporte | |-------------|-------------|-------------|-------------| | name | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | apiRevision | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | caminho | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | descrição | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | isCurrent | filtro | eq | |
$skip	query		integer (int32) minimum: 0	Número de registros a serem ignoradas.
$top	query		integer (int32) minimum: 1	Número de registros a serem retornados.
includeNotTaggedApis	query		boolean	Incluir APIs não marcadas.

Respostas

Nome	Tipo	Description
200 OK	TagResourceCollection	Lista uma coleção de entidades TagResource.
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementListApisByTags

Solicitação de exemplo

HTTP

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

Java

/**
 * Samples for Api ListByTags.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListApisByTags.json
     */
    /**
     * Sample code: ApiManagementListApisByTags.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListApisByTags(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.apis().listByTags("rg1", "apimService1", 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_apis_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.api.list_by_tags(
        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/ApiManagementListApisByTags.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/ApiManagementListApisByTags.json
func ExampleAPIClient_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.NewAPIClient().NewListByTagsPager("rg1", "apimService1", &armapimanagement.APIClientListByTagsOptions{Filter: nil,
		Top:                  nil,
		Skip:                 nil,
		IncludeNotTaggedApis: 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{
		// 		{
		// 			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"),
		// 			},
		// 	}},
		// }
	}
}

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 apis associated with tags.
 *
 * @summary Lists a collection of apis associated with tags.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListApisByTags.json
 */
async function apiManagementListApisByTags() {
  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.api.listByTags(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/ApiManagementListApisByTags.json
// this example is just showing the usage of "Api_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 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.GetApisByTagsAsync())
{
    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

Resposta de exemplo

Código de status:

200

{
  "value": [
    {
      "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
      }
    }
  ],
  "count": 1
}

Definições

Nome	Description
ApiContactInformation	Informações de contato da API
ApiLicenseInformation	Informações de licença de API
ApiTagResourceContractProperties	Propriedades do contrato de API para os Recursos de Marcação.
ApiType	Tipo de API.
AuthenticationSettingsContract	Configurações de Autenticação de API.
bearerTokenSendingMethods	Como enviar token para o servidor.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
OAuth2AuthenticationSettingsContract	Detalhes das configurações de Autenticação OAuth2 da API.
OpenIdAuthenticationSettingsContract	Detalhes das configurações de Autenticação OAuth2 da API.
OperationTagResourceContractProperties	Propriedades do contrato da Entidade de Operação.
ProductState	se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não está publicado.
ProductTagResourceContractProperties	Perfil do produto.
Protocol	Descreve em quais protocolos as operações nesta API podem ser invocadas.
SubscriptionKeyParameterNamesContract	Detalhes dos nomes dos parâmetros da chave de assinatura.
TagResourceCollection	Representação de lista de marcas paginada.
TagResourceContract	Propriedades do contrato TagResource.
TagTagResourceContractProperties	Contrato definindo a propriedade Tag no Contrato de Recurso de Marca

ApiContactInformation

Objeto

Informações de contato da API

Nome	Tipo	Description
email	string	O endereço de email da pessoa de contato/organização. DEVE estar no formato de um endereço de email
name	string	O nome de identificação da pessoa/organização do contato
url	string	A URL que aponta para as informações de contato. DEVE estar no formato de uma URL

ApiLicenseInformation

Objeto

Informações de licença de API

Nome	Tipo	Description
name	string	O nome da licença usado para a API
url	string	Uma URL para a licença usada para a API. DEVE estar no formato de uma URL

ApiTagResourceContractProperties

Objeto

Propriedades do contrato de API para os Recursos de Marcação.

Nome	Tipo	Description
apiRevision	string minLength: 1 maxLength: 100	Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada
apiRevisionDescription	string maxLength: 256	Descrição da Revisão da API.
apiVersion	string maxLength: 100	Indica o identificador de versão da API se a API for versão
apiVersionDescription	string maxLength: 256	Descrição da versão da API.
apiVersionSetId	string	Um identificador de recurso para o ApiVersionSet relacionado.
authenticationSettings	AuthenticationSettingsContract	Coleção de configurações de autenticação incluídas nessa API.
contact	ApiContactInformation	Informações de contato para a API.
description	string	Descrição da API. Pode incluir marcas de formatação HTML.
id	string	Identificador de API no formulário /apis/{apiId}.
isCurrent	boolean	Indica se a revisão da API é a revisão de API atual.
isOnline	boolean	Indica se a revisão da API está acessível por meio do gateway.
license	ApiLicenseInformation	Informações de licença para a API.
name	string minLength: 1 maxLength: 300	Nome da API.
path	string minLength: 0 maxLength: 400	URL relativa identificando exclusivamente essa API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do ponto de extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.
protocols	Protocol[]	Descreve em quais protocolos as operações nesta API podem ser invocadas.
serviceUrl	string minLength: 1 maxLength: 2000	URL absoluta do serviço de back-end que implementa essa API.
subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolos sobre os quais a API é disponibilizada.
subscriptionRequired	boolean	Especifica se uma assinatura de API ou produto é necessária para acessar a API.
termsOfServiceUrl	string	Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.
type	ApiType	Tipo de API.

ApiType

Enumeração

Tipo de API.

Valor	Description
graphql
grpc
http
odata
soap
websocket

AuthenticationSettingsContract

Objeto

Configurações de Autenticação de API.

Nome	Tipo	Description
oAuth2	OAuth2AuthenticationSettingsContract	Configurações de Autenticação OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Coleção de configurações de autenticação OAuth2 incluídas nessa API.
openid	OpenIdAuthenticationSettingsContract	Configurações de autenticação do OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Coleção de configurações de autenticação do Open ID Connect incluídas nessa API.

bearerTokenSendingMethods

Enumeração

Como enviar token para o servidor.

Valor	Description
authorizationHeader	O token de acesso será transmitido no cabeçalho autorização usando o esquema de portador
query	O token de acesso será transmitido como parâmetros de consulta.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

OAuth2AuthenticationSettingsContract

Objeto

Detalhes das configurações de Autenticação OAuth2 da API.

Nome	Tipo	Description
authorizationServerId	string	Identificador do servidor de autorização OAuth.
scope	string	escopo de operações.

OpenIdAuthenticationSettingsContract

Objeto

Detalhes das configurações de Autenticação OAuth2 da API.

Nome	Tipo	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Como enviar token para o servidor.
openidProviderId	string	Identificador do servidor de autorização OAuth.

OperationTagResourceContractProperties

Objeto

Propriedades do contrato da Entidade de Operação.

Nome	Tipo	Description
apiName	string	Nome da API.
apiRevision	string	Revisão da API.
apiVersion	string	Versão da API.
description	string	Descrição da operação.
id	string	Identificador da operação no formulário /operations/{operationId}.
method	string	Um método de operação HTTP válido. Métodos Http típicos como GET, PUT, POST, mas não limitados apenas por eles.
name	string	Nome da operação.
urlTemplate	string	Modelo de URL relativo que identifica o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}

ProductState

Enumeração

se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não está publicado.

Valor	Description
notPublished
published

ProductTagResourceContractProperties

Objeto

Perfil do produto.

Nome	Tipo	Description
approvalRequired	boolean	se a aprovação da assinatura é necessária. Se for falso, novas assinaturas serão aprovadas automaticamente, permitindo que os desenvolvedores chamem as APIs do produto imediatamente após a assinatura. Se for true, os administradores deverão aprovar manualmente a assinatura antes que o desenvolvedor possa fazer qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor falso.
description	string minLength: 0 maxLength: 1000	Descrição do produto. Pode incluir marcas de formatação HTML.
id	string	Identificador do produto na forma de /products/{productId}
name	string minLength: 1 maxLength: 300	Nome do produto.
state	ProductState	se o produto é publicado ou não. Os produtos publicados são detectáveis por usuários do portal do desenvolvedor. Os produtos não publicados são visíveis apenas para os administradores. O estado padrão do Produto não está publicado.
subscriptionRequired	boolean	Se uma assinatura de produto é necessária para acessar APIs incluídas neste produto. Se for true, o produto será chamado de "protegido" e uma chave de assinatura válida será necessária para que uma solicitação a uma API incluída no produto seja bem-sucedida. Se for falso, o produto será chamado de "aberto" e as solicitações para uma API incluída no produto poderão ser feitas sem uma chave de assinatura. Se a propriedade for omitida ao criar um novo produto, seu valor será considerado verdadeiro.
subscriptionsLimit	integer (int32)	Se o número de assinaturas que um usuário pode ter para este produto ao mesmo tempo. Defina como nulo ou omita para permitir assinaturas ilimitadas por usuário. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor falso.
terms	string	Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto serão apresentados e obrigados a aceitar esses termos antes de concluir o processo de assinatura.

Protocol

Enumeração

Descreve em quais protocolos as operações nesta API podem ser invocadas.

Valor	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objeto

Detalhes dos nomes dos parâmetros da chave de assinatura.

Nome	Tipo	Description
header	string	Nome do cabeçalho da chave de assinatura.
query	string	Nome do parâmetro da cadeia de caracteres de consulta da chave de assinatura.

TagResourceCollection

Objeto

Representação de lista de marcas paginada.

Nome	Tipo	Description
count	integer (int64)	Número total de contagem de registros em todas as páginas.
nextLink	string	Link da próxima página, se houver.
value	TagResourceContract[]	Valores de página.

TagResourceContract

Objeto

Propriedades do contrato TagResource.

Nome	Tipo	Description
api	ApiTagResourceContractProperties	API associada à marca.
operation	OperationTagResourceContractProperties	Operação associada à marca.
product	ProductTagResourceContractProperties	Produto associado à marca.
tag	TagTagResourceContractProperties	Marca associada ao recurso.

TagTagResourceContractProperties

Objeto

Contrato definindo a propriedade Tag no Contrato de Recurso de Marca

Nome	Tipo	Description
id	string	Identificador de marca
name	string minLength: 1 maxLength: 160	Nome da marca