Skip to content

Azure Docs: API Management#554

Open
HarshCasper wants to merge 2 commits intomainfrom
api-management
Open

Azure Docs: API Management#554
HarshCasper wants to merge 2 commits intomainfrom
api-management

Conversation

@HarshCasper
Copy link
Copy Markdown
Member

@HarshCasper HarshCasper commented Apr 14, 2026

Fixes DOC-157

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 14, 2026

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: a318c17
Status: ✅  Deploy successful!
Preview URL: https://d0589f13.localstack-docs.pages.dev
Branch Preview URL: https://api-management.localstack-docs.pages.dev

View logs

@HarshCasper HarshCasper requested a review from a team April 14, 2026 15:54
@paolosalvatori
Copy link
Copy Markdown
Contributor

Thanks @HarshCasper! As we discussed on Slack yesterday, I’ve broken out the API Management into another article in PR #562. Since this article now provide comprehensive coverage of the topic, I’d suggest closing this PR in favor of that approach.

@paolosalvatori
Copy link
Copy Markdown
Contributor

@HarshCasper I integrated part of the article in the article I create in #562 . You can close this PR, thanks for the great contribution!

Copy link
Copy Markdown
Contributor

@paolosalvatori paolosalvatori left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @HarshCasper! As we discussed on Slack yesterday, I’ve broken out the API Management into another article in PR #562. Since this article now provide comprehensive coverage of the topic. Please close this PR, thanks.

This combines the information from #596 into the original PR.
@remotesynth
Copy link
Copy Markdown
Collaborator

@HarshCasper @paolosalvatori we had two conflicting PRs with the same information [#596] and this one. I compared both and merged the information into the original PR so that they are aligned.

However, @paolosalvatori I am confused by the request to close this PR since you opened a separate PR (noted above) that covers the exact same service in almost the exact same manner.

@paolosalvatori
Copy link
Copy Markdown
Contributor

paolosalvatori commented Apr 22, 2026

@remotesynth because my version added the part below. None of @HarshCasper articles contain this part. I added this part to all the articles, included those that were already published.

Features

  • Full CRUD lifecycle: Create, read, update, and delete APIM service instances.
  • API management: Create, read, and delete API definitions within a service.
  • API operations: Register and retrieve API operation definitions.
  • Backend management: Define and manage backend service configurations.
  • API gateway management: Create and manage self-hosted API gateways.
  • API policies: Attach XML policy documents to APIs (stored but not evaluated).
  • Name availability check: Validate service name uniqueness via the checkNameAvailability action.
  • Service listing: List all APIM services in a subscription or resource group.

Limitations

  • No gateway proxy: Incoming API calls are not proxied through LocalStack. The APIM gateway does not process requests, apply policies, or forward traffic to backends.
  • No policy evaluation: Inbound, outbound, and error policies are stored in the ARM model but are not executed.
  • No developer portal: The APIM developer portal and its OAuth/subscription flows are not emulated.
  • No subscription keys: API subscriptions and key-based authentication are not enforced.
  • No rate limiting or quotas: Throttling, quota, and cache policies have no effect.
  • Consumption plan only for creation: SKU differences between Developer, Basic, Standard, Premium, and Consumption tiers are not emulated.

Samples

Explore end-to-end examples in the LocalStack for Azure Samples repository.

@paolosalvatori
Copy link
Copy Markdown
Contributor

paolosalvatori commented Apr 22, 2026

These are differences:

Differences found

1. Introduction — first sentence

  • Doc 1: "Azure API Management (APIM) is a fully managed service..."
  • Doc 2: "Azure API Management (APIM) is a managed service..." (word fully removed)

2. Introduction — link text

  • Doc 1: [What is Azure API Management?]
  • Doc 2: [Azure API Management overview]

3. Import statement — quote style

  • Doc 1: uses double quotes → from "../../../../components/feature-coverage/AzureFeatureCoverage";
  • Doc 2: uses single quotes → from '../../../../components/feature-coverage/AzureFeatureCoverage';

Same for the frontmatter title: Doc 1 uses "API Management", Doc 2 uses 'API Management'.

4. "Getting started" intro paragraph

  • Doc 1: ends after "...adding an API, and registering a backend."
  • Doc 2: "...adding an API, and defining and updating an operation. It is designed for users new to API Management and assumes basic knowledge of the Azure CLI and our azlocal wrapper script."

(Note: Doc 1 says "registering a backend" but the guide never actually registers a backend — Doc 2's wording matches the actual content.)

5. az group create command formatting

  • Doc 1: single line → az group create --name rg-apim-demo --location westeurope
  • Doc 2: multi-line with backslash continuations

6. Resource group output — location field

  • Doc 1: "location": "eastus" (⚠️ inconsistent — the command specified westeurope)
  • Doc 2: "location": "westeurope" (correct)

7. Resource group output — trailing fields

  • Doc 1: includes "type": "Microsoft.Resources/resourceGroups" before the closing brace
  • Doc 2: ends with ... (type field omitted)

8. APIM service name

  • Doc 1: my-apim throughout
  • Doc 2: apimdoc86 throughout

9. az apim create — publisher fields order and values

  • Doc 1: --publisher-email admin@example.com --publisher-name "My Organization"
  • Doc 2: --publisher-name "LocalStack" --publisher-email "dev@localstack.cloud" (order swapped, values differ, quotes added around email)

10. az apim create output

  • Doc 1: fields ordered as gatewayUrl, id, location, name, provisioningState, publisherEmail, publisherName, resourceGroup, sku, type; location value is "East US"
  • Doc 2: fields ordered as id, name, location, provisioningState, publisherName, publisherEmail, gatewayUrl, sku; location value is "West Europe"; type and resourceGroup omitted

11. "Show and list services" heading and intro sentence

  • Doc 1: has a ### Show and list services heading with intro text "Retrieve the details of the service instance and list all instances in the resource group:"
  • Doc 2: no separate heading — az apim show flows directly under the create section with just "Get and list API Management services:"

12. az apim show output — location value

  • Doc 1: "location": "East US" (⚠️ again inconsistent with the westeurope input)
  • Doc 2: "location": "West Europe" (consistent)

13. az apim show / az apim list command formatting

  • Doc 1: single-line commands
  • Doc 2: multi-line with backslash continuations

14. Operation update command — --set vs --display-name

  • Doc 1: --set displayName="Get all orders"
  • Doc 2: --display-name "Get all orders"

Both are valid with the Azure CLI, but they are different flag forms.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants