APIM对接Service Fabric时inbound策略中backend-id取值疑问

Hey Peter, I’ve wrestled with this exact issue before when setting up APIM with Service Fabric—let’s clear up the confusion around backend-id and get your POC back on track!

First: What exactly is backend-id? #

It’s not any piece of metadata from your Service Fabric cluster (like cluster name, node ID, or service display name). Instead, it’s the unique identifier of a Backend entity you create directly in Azure API Management—this entity acts as the bridge between APIM and your SF cluster, storing all the connection details (management endpoint, security certs, etc.) APIM needs to talk to SF.

How to get the correct backend-id value #

Follow these steps to make sure you’re using the right ID:

1. Create a Service Fabric Backend in APIM

   • Log into your APIM instance’s Azure portal dashboard
   • Navigate to the Backends section under the "APIs" menu
   • Click Add, then select the Service Fabric backend type
   • Fill in the required details:
     • Your SF cluster’s management endpoint (e.g., https://your-sf-cluster-name:19080)
     • Security credentials (cluster certificate thumbprint or client certificate, if your SF cluster is secured)
     • Most importantly: Set a custom ID for this backend (e.g., sf-webapi-backend—this is the value you’ll use for backend-id)
   • Save the backend configuration

2. Match the backend-id in your inbound policy exactly
   In your APIM inbound policy, the backend-id must match the ID you set for the Backend in step 1—including capitalization and any special characters. For example:

   <inbound>
     <base />
     <set-backend-service backend-id="sf-webapi-backend" sf-service-instance-name="your-stateless-webapi-service" />
   </inbound>
   

   The sf-service-instance-name here is the actual name of your WebAPI stateless service in SF (e.g., fabric:/MyApp/MyWebApiService), but the backend-id is strictly tied to the APIM Backend you created.

Common Pitfalls to Avoid #

• ❌ Don’t use SF cluster metadata (like cluster name or service name) as backend-id—this is the most common mistake
• ❌ Double-check for typos: Even a single wrong character will trigger the "Backend with id X could not be found" error
• ❌ Ensure your APIM instance has network access to your SF cluster’s management endpoint (e.g., if SF is in a VNet, make sure APIM is peered or has access via a private endpoint)
• ❌ If you created the Backend via ARM template or CLI, verify the name property in your template matches the backend-id you’re using

The example value "servicefabric" you saw in docs is just a placeholder for the ID of a sample Backend—you need to replace it with your own custom Backend ID that you created in APIM.

内容的提问来源于stack exchange，提问作者Pepe Ki