Product Api - List By Product

Service:

API Management

API Version:

2022-08-01

Lista uma coleção das APIs associadas a um produto.

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
productId	path	True	string	Identificador do produto. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
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 | | description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip	query		integer int32	Número de registros a serem ignorados.
$top	query		integer int32	Número de registros a serem retornados.

Respostas

Nome	Tipo	Description
200 OK	ApiCollection	O corpo da resposta contém uma coleção de entidades de API no produto.
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

ApiManagementListProductApis

Sample Request

HTTP

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

Java

/** Samples for ProductApi ListByProduct. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductApis.json
     */
    /**
     * Sample code: ApiManagementListProductApis.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListProductApis(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .productApis()
            .listByProduct(
                "rg1", "apimService1", "5768181ea40f7eb6c49f6ac7", 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_product_apis.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.product_api.list_by_product(
        resource_group_name="rg1",
        service_name="apimService1",
        product_id="5768181ea40f7eb6c49f6ac7",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductApis.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/ApiManagementListProductApis.json
func ExampleProductAPIClient_NewListByProductPager() {
	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.NewProductAPIClient().NewListByProductPager("rg1", "apimService1", "5768181ea40f7eb6c49f6ac7", &armapimanagement.ProductAPIClientListByProductOptions{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.APICollection = armapimanagement.APICollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.APIContract{
		// 		{
		// 			Name: to.Ptr("57681820a40f7eb6c49f6aca"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/products/apis"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca"),
		// 			Properties: &armapimanagement.APIContractProperties{
		// 				Description: to.Ptr("description_57681820a40f7eb6c49f6acc"),
		// 				APIRevision: to.Ptr("1"),
		// 				IsCurrent: to.Ptr(true),
		// 				Path: to.Ptr("suffix_57681820a40f7eb6c49f6ace"),
		// 				DisplayName: to.Ptr("api_57681820a40f7eb6c49f6acb"),
		// 				Protocols: []*armapimanagement.Protocol{
		// 					to.Ptr(armapimanagement.ProtocolHTTPS)},
		// 					ServiceURL: to.Ptr("http://contoso/57681820a40f7eb6c49f6acd"),
		// 				},
		// 		}},
		// 	}
	}
}

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 the APIs associated with a product.
 *
 * @summary Lists a collection of the APIs associated with a product.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductApis.json
 */
async function apiManagementListProductApis() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const productId = "5768181ea40f7eb6c49f6ac7";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.productApi.listByProduct(
    resourceGroupName,
    serviceName,
    productId
  )) {
    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": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca",
      "type": "Microsoft.ApiManagement/service/products/apis",
      "name": "57681820a40f7eb6c49f6aca",
      "properties": {
        "displayName": "api_57681820a40f7eb6c49f6acb",
        "apiRevision": "1",
        "description": "description_57681820a40f7eb6c49f6acc",
        "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd",
        "path": "suffix_57681820a40f7eb6c49f6ace",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definições

Nome	Description
ApiCollection	Representação de lista de API paginada.
ApiContactInformation	Informações de contato da API
ApiContract	Detalhes da API.
ApiLicenseInformation	Informações de licença de API
ApiType	Tipo de API.
ApiVersionSetContractDetails	Um conjunto de versões de API contém a configuração comum para um conjunto de versões de API relacionadas
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.
Protocol	Descreve em quais protocolos as operações nessa API podem ser invocadas.
SubscriptionKeyParameterNamesContract	Detalhes dos nomes dos parâmetros da chave de assinatura.
versioningScheme	Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP.

ApiCollection

Representação de lista de API 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	ApiContract[]	Valores de página.

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

ApiContract

Detalhes da API.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.apiRevision	string	Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada
properties.apiRevisionDescription	string	Descrição da Revisão da API.
properties.apiVersion	string	Indica o identificador de versão da API se a API tiver controle de versão
properties.apiVersionDescription	string	Descrição da versão da API.
properties.apiVersionSet	ApiVersionSetContractDetails	Detalhes do conjunto de versões
properties.apiVersionSetId	string	Um identificador de recurso para o ApiVersionSet relacionado.
properties.authenticationSettings	AuthenticationSettingsContract	Coleção de configurações de autenticação incluídas nessa API.
properties.contact	ApiContactInformation	Informações de contato para a API.
properties.description	string	A descrição da API. Pode incluir marcas de formatação HTML.
properties.displayName	string	Nome da API. Deve ter de 1 a 300 caracteres.
properties.isCurrent	boolean	Indica se a revisão de API é a revisão de API atual.
properties.isOnline	boolean	Indica se a revisão da API está acessível por meio do gateway.
properties.license	ApiLicenseInformation	Informações de licença para a API.
properties.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.
properties.protocols	Protocol[]	Descreve em quais protocolos as operações nessa API podem ser invocadas.
properties.serviceUrl	string	A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres.
properties.sourceApiId	string	Identificador de API da API de origem.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocolos sobre os quais a API é disponibilizada.
properties.subscriptionRequired	boolean	Especifica se uma assinatura de API ou produto é necessária para acessar a API.
properties.termsOfServiceUrl	string	Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.
properties.type	ApiType	Tipo de API.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

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

ApiType

Tipo de API.

Nome	Tipo	Description
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

Um conjunto de versões de API contém a configuração comum para um conjunto de versões de API relacionadas

Nome	Tipo	Description
description	string	Descrição do Conjunto de Versões da API.
id	string	Identificador do Conjunto de Versões da API existente. Omita esse valor para criar um novo Conjunto de Versões.
name	string	O nome de exibição do conjunto de versões da API.
versionHeaderName	string	Nome do parâmetro de cabeçalho HTTP que indica a Versão da API se versioningScheme estiver definido como header.
versionQueryName	string	Nome do parâmetro de consulta que indica a Versão da API se versioningScheme estiver definido querycomo .
versioningScheme	versioningScheme	Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP.

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.

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.

versioningScheme

Um valor que determina onde o identificador de Versão da API estará localizado em uma solicitação HTTP.

Nome	Tipo	Description
Header	string	A Versão da API é passada em um cabeçalho HTTP.
Query	string	A Versão da API é passada em um parâmetro de consulta.
Segment	string	A Versão da API é passada em um segmento de caminho.