Api - List By Tags

Service:

API Management

API Version:

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

With optional parameters:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName	path	True	string	O nome do serviço Gerenciamento de API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	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 | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | displayName | 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 | | isCurrent | filter | eq | |
$skip	query		integer int32	Número de registros a serem ignorados.
$top	query		integer int32	Número de registros a serem retornados.
includeNotTaggedApis	query		boolean	Inclua 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ApiManagementListApisByTags

Sample Request

HTTP

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

Java

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

    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/2022-08-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/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/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");

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

Sample Response

Status code:

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.
ApiType	Tipo de API.
AuthenticationSettingsContract	Configurações de Autenticação de API.
bearerTokenSendingMethods	Como enviar o token para o servidor.
ErrorFieldContract	Contrato de Campo de 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 de 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 é Publicado.
ProductTagResourceContractProperties	Perfil do produto.
Protocol	Descreve em quais protocolos as operações nessa 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 que define a propriedade Tag no Contrato de Recurso de Marca

ApiContactInformation

Informações de contato da API

Nome	Tipo	Description
email	string	O endereço de email da pessoa/organização do contato. 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

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

Propriedades do contrato de API para os Recursos de Marca.

Nome	Tipo	Description
apiRevision	string	Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada
apiRevisionDescription	string	Descrição da Revisão da API.
apiVersion	string	Indica o identificador de versão da API se a API tiver controle de versão
apiVersionDescription	string	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	A descrição da API. Pode incluir marcas de formatação HTML.
id	string	Identificador de API no formato /apis/{apiId}.
isCurrent	boolean	Indica se a revisão de 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	Nome da API.
path	string	A URL relativa que identifica exclusivamente esta 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 nessa API podem ser invocadas.
serviceUrl	string	A URL absoluta do serviço de back-end implementado esta 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

Tipo de API.

Nome	Tipo	Description
graphql	string
http	string
soap	string
websocket	string

AuthenticationSettingsContract

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

Como enviar o token para o servidor.

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

ErrorFieldContract

Contrato de Campo de Erro.

Nome	Tipo	Description
code	string	Código de erro no nível da propriedade.
message	string	Representação legível por humanos do erro no nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message	string	Representação legível ao olho humano do erro.

OAuth2AuthenticationSettingsContract

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

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

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

OperationTagResourceContractProperties

Propriedades do contrato de entidade de operação.

Nome	Tipo	Description
apiName	string	Nome da API.
apiRevision	string	Revisão de API.
apiVersion	string	Versão da API.
description	string	Descrição da Operação.
id	string	Identificador da operação no formato /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 relativa identificando o recurso de destino para esta operação. Pode incluir parâmetros. Exemplo: /customers/{cid}/orders/{oid}/?date={date}

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 é Publicado.

Nome	Tipo	Description
notPublished	string
published	string

ProductTagResourceContractProperties

Perfil do produto.

Nome	Tipo	Description
approvalRequired	boolean	se a aprovação da assinatura é necessária. Se for false, 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 qualquer uma das APIs do produto. Só poderá estar presente se a propriedade subscriptionRequired estiver presente e tiver um valor false.
description	string	Descrição do produto. Pode incluir marcas de formatação HTML.
id	string	Identificador do produto na forma de /products/{productId}
name	string	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 é 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	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 false.
terms	string	Termos de uso do produto. Os desenvolvedores que tentarem assinar o produto verão e deverão aceitar esses termos para concluir o processo de assinatura.

Protocol

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

Nome	Tipo	Description
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

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

Representação de lista de marcas paginada.

Nome	Tipo	Description
count	integer	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

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

Contrato que define a propriedade Tag no Contrato de Recurso de Marca

Nome	Tipo	Description
id	string	Identificador da etiqueta
name	string	Nome da marca