Perguntas frequentes sobre gerenciamento de API do AzureAzure API Management FAQs

Obtenha as respostas para perguntas, padrões e práticas recomendadas comuns para o gerenciamento de API do Azure.Get the answers to common questions, patterns, and best practices for Azure API Management.

Nota

Este artigo foi atualizado para utilizar o novo módulo AZ do Azure PowerShell.This article has been updated to use the new Azure PowerShell Az module. Pode continuar a utilizar o módulo AzureRM, que continuará a receber correções de erros até, pelo menos, dezembro de 2020.You can still use the AzureRM module, which will continue to receive bug fixes until at least December 2020. Para obter mais informações sobre o novo módulo Az e a compatibilidade do AzureRM, veja Apresentação do novo módulo Az do Azure PowerShell.To learn more about the new Az module and AzureRM compatibility, see Introducing the new Azure PowerShell Az module. Para obter instruções de instalação do módulo Az, veja Instalar o Azure PowerShell.For Az module installation instructions, see Install Azure PowerShell.

Contacte-nosContact us

Perguntas mais frequentesFrequently asked questions

Como posso fazer uma pergunta à equipe de gerenciamento de API de Microsoft Azure?How can I ask the Microsoft Azure API Management team a question?

Você pode entrar em contato conosco usando uma destas opções:You can contact us by using one of these options:

O que significa quando um recurso está em visualização?What does it mean when a feature is in preview?

Quando um recurso está em visualização, isso significa que estamos buscando ativamente comentários sobre como o recurso está funcionando para você.When a feature is in preview, it means that we're actively seeking feedback on how the feature is working for you. Um recurso na visualização é funcionalmente concluído, mas é possível que possamos fazer uma alteração significativa em resposta aos comentários dos clientes.A feature in preview is functionally complete, but it's possible that we'll make a breaking change in response to customer feedback. É recomendável que você não dependa de um recurso que está em versão prévia em seu ambiente de produção.We recommend that you don't depend on a feature that is in preview in your production environment. Se você tiver algum comentário sobre os recursos de visualização, informe-nos por meio de uma das opções de contato em como posso fazer uma pergunta à equipe de gerenciamento de API de Microsoft Azure?.If you have any feedback on preview features, please let us know through one of the contact options in How can I ask the Microsoft Azure API Management team a question?.

Como posso proteger a conexão entre o gateway de gerenciamento de API e meus serviços de back-end?How can I secure the connection between the API Management gateway and my back-end services?

Você tem várias opções para proteger a conexão entre o gateway de gerenciamento de API e seus serviços de back-end.You have several options to secure the connection between the API Management gateway and your back-end services. Pode:You can:

Como fazer copiar minha instância do serviço de gerenciamento de API para uma nova instância?How do I copy my API Management service instance to a new instance?

Você terá várias opções se desejar copiar uma instância de gerenciamento de API para uma nova instância.You have several options if you want to copy an API Management instance to a new instance. Pode:You can:

Posso gerenciar minha instância de gerenciamento de API de forma programática?Can I manage my API Management instance programmatically?

Sim, você pode gerenciar o gerenciamento de API programaticamente usando:Yes, you can manage API Management programmatically by using:

Como fazer adicionar um usuário ao grupo Administradores?How do I add a user to the Administrators group?

Veja como você pode adicionar um usuário ao grupo Administradores:Here's how you can add a user to the Administrators group:

  1. Inicie sessão no portal do Azure.Sign in to the Azure portal.
  2. Vá para o grupo de recursos que tem a instância de gerenciamento de API que você deseja atualizar.Go to the resource group that has the API Management instance you want to update.
  3. No gerenciamento de API, atribua a função colaborador do serviço de gerenciamento de API ao usuário.In API Management, assign the Api Management Service Contributor role to the user.

Agora o colaborador recém-adicionado pode usar Azure PowerShell cmdlets.Now the newly added contributor can use Azure PowerShell cmdlets. Veja como entrar como administrador:Here's how to sign in as an administrator:

  1. Use o Connect-AzAccount cmdlet para entrar.Use the Connect-AzAccount cmdlet to sign in.
  2. Defina o contexto para a assinatura que tem o serviço usando Set-AzContext -SubscriptionID <subscriptionGUID>.Set the context to the subscription that has the service by using Set-AzContext -SubscriptionID <subscriptionGUID>.
  3. Obtenha uma URL de logon único usando Get-AzApiManagementSsoToken -ResourceGroupName <rgName> -Name <serviceName>o.Get a single sign-on URL by using Get-AzApiManagementSsoToken -ResourceGroupName <rgName> -Name <serviceName>.
  4. Use a URL para acessar o portal de administração.Use the URL to access the admin portal.

Por que a política que desejo adicionar não está disponível no editor de políticas?Why is the policy that I want to add unavailable in the policy editor?

Se a política que você deseja adicionar aparecer esmaecida ou sombreada no editor de política, certifique-se de que você está no escopo correto para a política.If the policy that you want to add appears dimmed or shaded in the policy editor, be sure that you are in the correct scope for the policy. Cada declaração de política é projetada para você usar em escopos específicos e seções de política.Each policy statement is designed for you to use in specific scopes and policy sections. Para examinar as seções e os escopos de política de uma política, consulte a seção uso da política em políticas de gerenciamento de API.To review the policy sections and scopes for a policy, see the policy's Usage section in API Management policies.

Como fazer configurar vários ambientes em uma única API?How do I set up multiple environments in a single API?

Para configurar vários ambientes, por exemplo, um ambiente de teste e um ambiente de produção, em uma única API, você tem duas opções.To set up multiple environments, for example, a test environment and a production environment, in a single API, you have two options. Pode:You can:

  • Hospede diferentes APIs no mesmo locatário.Host different APIs on the same tenant.
  • Hospede as mesmas APIs em locatários diferentes.Host the same APIs on different tenants.

Posso usar o SOAP com o gerenciamento de API?Can I use SOAP with API Management?

O suporte de passagem SOAP agora está disponível.SOAP pass-through support is now available. Os administradores podem importar o WSDL de seu serviço SOAP e o gerenciamento de API do Azure criará um front-end SOAP.Administrators can import the WSDL of their SOAP service, and Azure API Management will create a SOAP front end. Documentação do portal do desenvolvedor, console de teste, políticas e análises estão disponíveis para serviços SOAP.Developer portal documentation, test console, policies and analytics are all available for SOAP services.

Posso configurar um servidor de autorização OAuth 2,0 com segurança AD FS?Can I configure an OAuth 2.0 authorization server with AD FS security?

Para saber como configurar um servidor de autorização OAuth 2,0 com segurança Serviços de Federação do Active Directory (AD FS) (AD FS), consulte usando o ADFS no gerenciamento de API.To learn how to configure an OAuth 2.0 authorization server with Active Directory Federation Services (AD FS) security, see Using ADFS in API Management.

Qual método de roteamento o gerenciamento de API usa em implantações em várias localizações geográficas?What routing method does API Management use in deployments to multiple geographic locations?

O gerenciamento de API usa o método de roteamento de tráfego de desempenho em implantações em várias localizações geográficas.API Management uses the performance traffic routing method in deployments to multiple geographic locations. O tráfego de entrada é roteado para o gateway de API mais próximo.Incoming traffic is routed to the closest API gateway. Se uma região ficar offline, o tráfego de entrada será roteado automaticamente para o gateway mais próximo.If one region goes offline, incoming traffic is automatically routed to the next closest gateway. Saiba mais sobre os métodos de roteamento nos métodos de roteamento do Gerenciador de tráfego.Learn more about routing methods in Traffic Manager routing methods.

Posso usar um modelo de Azure Resource Manager para criar uma instância de serviço de gerenciamento de API?Can I use an Azure Resource Manager template to create an API Management service instance?

Sim.Yes. Consulte os modelos de início rápido do serviço de gerenciamento de API do Azure .See the Azure API Management Service quickstart templates.

Posso usar um certificado SSL autoassinado para um back-end?Can I use a self-signed SSL certificate for a back end?

Sim.Yes. Isso pode ser feito por meio do PowerShell ou enviando diretamente para a API.This can be done through PowerShell or by directly submitting to the API. Isso desabilitará a validação da cadeia de certificados e permitirá que você use certificados autoassinados ou assinados de forma privada ao se comunicar com o gerenciamento de API para os serviços de back-end.This will disable certificate chain validation and will allow you to use self-signed or privately-signed certificates when communicating from API Management to the back end services.

Método do PowerShellPowershell method

Use os New-AzApiManagementBackend cmdlets do PowerShell (para novo Set-AzApiManagementBackend back-end) ou (para back-end existente) -SkipCertificateChainValidation e defina Trueo parâmetro como.Use the New-AzApiManagementBackend (for new back end) or Set-AzApiManagementBackend (for existing back end) PowerShell cmdlets and set the -SkipCertificateChainValidation parameter to True.

$context = New-AzApiManagementContext -resourcegroup 'ContosoResourceGroup' -servicename 'ContosoAPIMService'
New-AzApiManagementBackend -Context  $context -Url 'https://contoso.com/myapi' -Protocol http -SkipCertificateChainValidation $true

Método de atualização de API diretaDirect API update method

  1. Crie uma entidade de back-end usando o gerenciamento de API.Create a Backend entity by using API Management.
  2. Defina a propriedade skipCertificateChainValidation como true.Set the skipCertificateChainValidation property to true.
  3. Se você não quiser mais permitir certificados autoassinados, exclua a entidade de back-end ou defina a propriedade skipCertificateChainValidation como false.If you no longer want to allow self-signed certificates, delete the Backend entity, or set the skipCertificateChainValidation property to false.

Por que recebo uma falha de autenticação quando tento clonar um repositório git?Why do I get an authentication failure when I try to clone a Git repository?

Se você usar o Gerenciador de credenciais do git ou se estiver tentando clonar um repositório git usando o Visual Studio, poderá encontrar um problema conhecido com a caixa de diálogo credenciais do Windows.If you use Git Credential Manager, or if you're trying to clone a Git repository by using Visual Studio, you might run into a known issue with the Windows credentials dialog box. A caixa de diálogo limita o tamanho da senha a 127 caracteres e trunca a senha gerada pela Microsoft.The dialog box limits password length to 127 characters, and it truncates the Microsoft-generated password. Estamos trabalhando para reduzir a senha.We are working on shortening the password. Por enquanto, use o Git bash para clonar seu repositório git.For now, please use Git Bash to clone your Git repository.

O gerenciamento de API funciona com o Azure ExpressRoute?Does API Management work with Azure ExpressRoute?

Sim.Yes. O gerenciamento de API funciona com o Azure ExpressRoute.API Management works with Azure ExpressRoute.

Por que exigimos uma sub-rede dedicada no estilo do Resource Manager VNETs quando o gerenciamento de API é implantado neles?Why do we require a dedicated subnet in Resource Manager style VNETs when API Management is deployed into them?

O requisito de sub-rede dedicado para o gerenciamento de API é proveniente do fato de que ele se baseia no modelo de implantação clássico (camada PAAS v1).The dedicated subnet requirement for API Management comes from the fact, that it is built on Classic (PAAS V1 layer) deployment model. Embora possamos implantar em uma VNET do Resource Manager (camada v2), há conseqüências para isso.While we can deploy into a Resource Manager VNET (V2 layer), there are consequences to that. O modelo de implantação clássico no Azure não está intimamente acoplado ao modelo do Resource Manager e, portanto, se você criar um recurso na camada v2, a camada v1 não saberá disso e poderão ocorrer problemas, como o gerenciamento de API, tentando usar um IP que já está alocado a uma NIC (criado em v2).The Classic deployment model in Azure is not tightly coupled with the Resource Manager model and so if you create a resource in V2 layer, the V1 layer doesn't know about it and problems can happen, such as API Management trying to use an IP that is already allocated to a NIC (built on V2). Para saber mais sobre a diferença entre os modelos clássico e do Resource Manager no Azure, consulte diferença nos modelos de implantação.To learn more about difference of Classic and Resource Manager models in Azure refer to difference in deployment models.

Qual é o tamanho mínimo de sub-rede necessário ao implantar o gerenciamento de API em uma VNET?What is the minimum subnet size needed when deploying API Management into a VNET?

O tamanho mínimo de sub-rede necessário para implantar o gerenciamento de API é /29, que é o tamanho mínimo de sub-rede ao qual o Azure dá suporte.The minimum subnet size needed to deploy API Management is /29, which is the minimum subnet size that Azure supports.

Posso mover um serviço de gerenciamento de API de uma assinatura para outra?Can I move an API Management service from one subscription to another?

Sim.Yes. Para saber como, consulte mover recursos para um novo grupo de recursos ou assinatura.To learn how, see Move resources to a new resource group or subscription.

Há restrições ou problemas conhecidos com a importação da minha API?Are there restrictions on or known issues with importing my API?

Problemas conhecidos e restrições para os formatos Swagger (Open API), WSDL e WADL.Known issues and restrictions for Open API(Swagger), WSDL and WADL formats.