Azure API Management FAQ | Microsoft Docs

Table of Contents1 What does it mean when a feature is in preview? 2 How can I secure the connection between the API Management gateway and my back-end services? 3 How do I copy my API Management service instance to a new instance? 4 Can I manage my API Management […]

Get the answers to common questions, patterns, and best practices for Azure API Management.

What does it mean when a feature is in preview?

When a feature is in preview, it means that we’re actively seeking feedback on how the feature is working for you. A feature in preview is functionally complete, but it’s possible that we’ll make a breaking change in response to customer feedback. We recommend that you don’t depend on a feature that is in preview in your production environment.

How can I secure the connection between the API Management gateway and my back-end services?

You have several options to secure the connection between the API Management gateway and your back-end services. You can:

How do I copy my API Management service instance to a new instance?

You have several options if you want to copy an API Management instance to a new instance. You can:

Can I manage my API Management instance programmatically?

Yes, you can manage API Management programmatically by using:

How do I add a user to the Administrators group?

Administrators group is an immutable system group. Azure subscription administrators are members of this group. You can’t add a user to this group. See How to create and use groups to manage developer accounts in Azure API Management for more information.

You can change the administrator email settings that are used in notifications sent to developers from your API Management instance.

Why is the policy that I want to add unavailable in the policy editor?

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. Each policy statement is designed for you to use in specific scopes and policy sections. To review the policy sections and scopes for a policy, see the policy’s Usage section in API Management policies.

How do I set up multiple environments in a single API?

To set up multiple environments, for example, a test environment and a production environment, in a single API, you have two options. You can:

  • Host different APIs on the same tenant.
  • Host the same APIs on different tenants.

Can I use SOAP with API Management?

SOAP pass-through support is now available. Administrators can import the WSDL of their SOAP service, and Azure API Management will create a SOAP front end. Developer portal documentation, test console, policies and analytics are all available for SOAP services.

Can I configure an OAuth 2.0 authorization server with AD FS security?

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.

What routing method does API Management use in deployments to multiple geographic locations?

API Management uses the performance traffic routing method in deployments to multiple geographic locations. Incoming traffic is routed to the closest API gateway. If one region goes offline, incoming traffic is automatically routed to the next closest gateway. Learn more about routing methods in Traffic Manager routing methods.

Can I use an Azure Resource Manager template to create an API Management service instance?

Yes. See the Azure API Management Service quickstart templates.

Can I use a self-signed TLS/SSL certificate for a back end?

Yes. This can be done through PowerShell or by directly submitting to the API. 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.

PowerShell method

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 '' -Protocol http -SkipCertificateChainValidation $true

Direct API update method

  1. Create a Backend entity by using API Management.
  2. Set the skipCertificateChainValidation property to true.
  3. If you no longer want to allow self-signed certificates, delete the Backend entity, or set the skipCertificateChainValidation property to false.

Why do I get an authentication failure when I try to clone a Git repository?

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. The dialog box limits password length to 127 characters, and it truncates the Microsoft-generated password. We are working on shortening the password. For now, please use Git Bash to clone your Git repository.

Does API Management work with Azure ExpressRoute?

Yes. API Management works with Azure ExpressRoute.

Why do we require a dedicated subnet in Resource Manager style VNETs when API Management is deployed into them?

The dedicated subnet requirement for API Management comes from the fact, that it is built on Classic (PAAS V1 layer) deployment model. While we can deploy into a Resource Manager VNET (V2 layer), there are consequences to that. 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).
To learn more about difference of Classic and Resource Manager models in Azure refer to difference in deployment models.

What is the minimum subnet size needed when deploying API Management into a VNET?

The minimum subnet size needed to deploy API Management is /29, which is the minimum subnet size that Azure supports.

Can I move an API Management service from one subscription to another?

Yes. To learn how, see Move resources to a new resource group or subscription.

Are there restrictions on or known issues with importing my API?

Known issues and restrictions for Open API(Swagger), WSDL and WADL formats.

How does API Management handle trailing slashes when calling backend services?

Historically and by convention a URL ending with a trailing slash is treated as a Directory, for example “” whereas the same URL without the trailing slash “” would be indicative of a file. This is not mandated, so some systems will consider those two URLs unique, whilst others will consider them the same URL. API Management doesn’t make a distinction thus a single operation “resource” will accept “resource” and “resource/”. However, whilst the distinction doesn’t matter to API Management it may matter to the backend host. Some web servers will automatically redirect a URL not ending with a trailing slash, to the same URL ending in a trailing slash. As API Management is the client to the backend (server) an automatic redirect is not always desirable. If needed create a Rewrite URL policy to ensure a trailing slash is always added to the outbound backend call.

Source Article

Next Post

Integrate Azure Automation Update Management with Microsoft Endpoint Configuration Manager

Thu Jun 23 , 2022
Table of Contents0.1 In this article1 Prerequisites2 Manage software updates from Microsoft Endpoint Configuration Manager3 Manage software updates from Azure Automation4 Next steps Article 07/14/2021 3 minutes to read 3 contributors In this article Customers who have invested […]
Exit mobile version