Gateway Api - List By Service

Serviço:

API Management

Versão da API:

2021-08-01

Lista uma coleção de APIs associadas a um gateway.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
gatewayId	path	True	string	Identificador de entidade de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.
$filter	query		string	| Campo | Utilização | Operadores suportados | Funções suportadas | |-------------|-------------|-------------|-------------| | nome | filtro | ge, le, eq, ne, gt, lt | subcadeia, contém, começa com, termina com |
$skip	query		integer int32	Número de registos a ignorar.
$top	query		integer int32	Número de registos a devolver.

Respostas

Name	Tipo	Description
200 OK	ApiCollection	O corpo da resposta contém uma coleção de entidades da API no gateway.
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementListGatewayApis

Pedido de amostra

HTTP

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

Java

import com.azure.core.util.Context;

/** Samples for GatewayApi ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
     */
    /**
     * Sample code: ApiManagementListGatewayApis.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListGatewayApis(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.gatewayApis().listByService("rg1", "apimService1", "gw1", null, null, null, 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_gateway_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.gateway_api.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
        gateway_id="gw1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
func ExampleGatewayAPIClient_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.NewGatewayAPIClient().NewListByServicePager("rg1", "apimService1", "gw1", &armapimanagement.GatewayAPIClientListByServiceOptions{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/gateways/apis"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/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 gateway.
 *
 * @summary Lists a collection of the APIs associated with a gateway.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
 */
async function apiManagementListGatewayApis() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const gatewayId = "gw1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.gatewayApi.listByService(
    resourceGroupName,
    serviceName,
    gatewayId
  )) {
    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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListGatewayApis.json
// this example is just showing the usage of "GatewayApi_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 ApiManagementGatewayResource created on azure
// for more information of creating ApiManagementGatewayResource, please refer to the document of ApiManagementGatewayResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string gatewayId = "gw1";
ResourceIdentifier apiManagementGatewayResourceId = ApiManagementGatewayResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, gatewayId);
ApiManagementGatewayResource apiManagementGateway = client.GetApiManagementGatewayResource(apiManagementGatewayResourceId);

// invoke the operation and iterate over the result
await foreach (GatewayApiData item in apiManagementGateway.GetGatewayApisByServiceAsync())
{
    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 da amostra

Código de estado:

200

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/gateways/gw1/apis/57681820a40f7eb6c49f6aca",
      "type": "Microsoft.ApiManagement/service/gateways/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

Name	Description
ApiCollection	Representação da lista de API paginada.
ApiContactInformation	Informações de contacto da API
ApiContract	Detalhes da API.
ApiLicenseInformation	Informações da licença da API
ApiType	Tipo de API.
ApiVersionSetContractDetails	Um Conjunto de Versões da API contém a configuração comum para um conjunto de Versões da API relacionadas
AuthenticationSettingsContract	Definições de Autenticação de API.
bearerTokenSendingMethods	Como enviar o token para o servidor.
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.
OAuth2AuthenticationSettingsContract	Detalhes das definições de Autenticação OAuth2 da API.
OpenIdAuthenticationSettingsContract	Detalhes das definições de Autenticação OAuth2 da API.
Protocol	Descreve os protocolos que as operações nesta API podem ser invocadas.
SubscriptionKeyParameterNamesContract	Detalhes dos nomes dos parâmetros da chave de subscrição.

ApiCollection

Representação da lista de API paginada.

Name	Tipo	Description
count	integer	Número total de contagem de registos em todas as páginas.
nextLink	string	Ligação da página seguinte, se existir.
value	ApiContract[]	Valores de página.

ApiContactInformation

Informações de contacto da API

Name	Tipo	Description
email	string	O endereço de e-mail da pessoa/organização do contacto. TEM de estar no formato de um endereço de e-mail
name	string	O nome de identificação da pessoa/organização do contacto
url	string	O URL que aponta para as informações de contacto. TEM de estar no formato de um URL

ApiContract

Detalhes da API.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado 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 não for fornecido nenhum valor, é criada a revisão predefinida 1
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 uma 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 recursos para o ApiVersionSet relacionado.
properties.authenticationSettings	AuthenticationSettingsContract	Coleção de definições de autenticação incluídas nesta API.
properties.contact	ApiContactInformation	Informações de contacto da API.
properties.description	string	Descrição da API. Pode incluir etiquetas de formatação HTML.
properties.displayName	string	Nome da API. Tem de ter entre 1 e 300 carateres.
properties.isCurrent	boolean	Indica se a revisão da API é a revisão atual da API.
properties.isOnline	boolean	Indica se a revisão da API está acessível através do gateway.
properties.license	ApiLicenseInformation	Informações de licença para a API.
properties.path	string	O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API.
properties.protocols	Protocol[]	Descreve os protocolos que as operações nesta API podem ser invocadas.
properties.serviceUrl	string	URL absoluto do serviço de back-end que implementa esta API. Não pode ter mais de 2000 carateres.
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 é necessária uma subscrição de API ou Produto para aceder à API.
properties.termsOfServiceUrl	string	Um URL para os Termos de Serviço da API. TEM de estar no formato de um URL.
properties.type	ApiType	Tipo de API.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Informações da licença da API

Name	Tipo	Description
name	string	O nome da licença utilizado para a API
url	string	Um URL para a licença utilizada para a API. TEM de estar no formato de um URL

ApiType

Tipo de API.

Name	Tipo	Description
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

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

Name	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 este valor para criar um novo Conjunto de Versões.
name	string	O Nome a apresentar 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 como query.
versioningScheme	enum: Header Query Segment	Um valor que determina onde o identificador da Versão da API estará localizado num pedido HTTP.

AuthenticationSettingsContract

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

Name	Tipo	Description
oAuth2	OAuth2AuthenticationSettingsContract	Definições de Autenticação OAuth2
openid	OpenIdAuthenticationSettingsContract	Definições de Autenticação do OpenID Connect

bearerTokenSendingMethods

Como enviar o token para o servidor.

Name	Tipo	Description
authorizationHeader	string	O token de acesso será transmitido no cabeçalho Autorização com o esquema do Portador
query	string	O token de acesso será transmitido como parâmetros de consulta.

ErrorFieldContract

Contrato de campo de erro.

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

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

OAuth2AuthenticationSettingsContract

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

Name	Tipo	Description
authorizationServerId	string	Identificador do servidor de autorização OAuth.
scope	string	âmbito de operações.

OpenIdAuthenticationSettingsContract

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

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

Protocol

Descreve os protocolos que as operações nesta API podem ser invocadas.

Name	Tipo	Description
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

Detalhes dos nomes dos parâmetros da chave de subscrição.

Name	Tipo	Description
header	string	Nome do cabeçalho da chave de subscrição.
query	string	Nome do parâmetro da cadeia de consulta da chave de subscrição.