TOC.yml

- name: Azure API Management Documentation
  href: index.yml
- name: Overview
  items:
      - name: About API Management
        displayName: Overview
        href: api-management-key-concepts.md
      - name: API Management features availability
        href: api-management-features.md
      - name: Service limits
        href: ../azure-resource-manager/management/azure-subscription-service-limits.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json#api-management-limits
- name: Quickstarts
  expanded: true
  items:
      - name: Create an instance - CLI
        href: get-started-create-service-instance-cli.md
      - name: Create an instance - Portal
        href: get-started-create-service-instance.md
      - name: Create an instance - PowerShell
        href: powershell-create-service-instance.md
      - name: Create an instance - Visual Studio Code
        href: vscode-create-service-instance.md
      - name: Create an instance - Bicep
        displayName: Resource Manager, ARM, Bicep
        href: quickstart-bicep.md
      - name: Create an instance - ARM template
        displayName: Resource Manager
        href: quickstart-arm-template.md
- name: Tutorials
  items:
      - name: 1 - Import your first API
        href: import-and-publish.md
      - name: 2 - Create and publish a product
        displayName: Azure CLI, az apim product
        href: api-management-howto-add-products.md
      - name: 3 - Mock API responses
        displayName: Azure CLI, az apim api operation
        href: mock-api-responses.md
      - name: 4 - Protect your API
        href: transform-api.md
      - name: 5 - Monitor published APIs
        href: api-management-howto-use-azure-monitor.md
      - name: 6 - Debug your APIs
        href: api-management-howto-api-inspector.md
      - name: 7 - Add revisions
        displayName: Azure CLI, az apim api release
        href: api-management-get-started-revise-api.md
      - name: 8 - Add multiple versions
        displayName: Azure CLI, az apim api versionset
        href: api-management-get-started-publish-versions.md
      - name: 9 - Customize developer portal
        href: api-management-howto-developer-portal-customize.md
      - name: 10 - Manage APIs in Visual Studio Code
        href: visual-studio-code-tutorial.md
- name: Samples
  items:
      - name: Policies
        href: ./policies/index.md
      - name: Azure PowerShell
        href: powershell-samples.md
- name: Concepts
  items:
      - name: Terminology
        href: api-management-terminology.md
      - name: API Management policies
        href: api-management-howto-policies.md
      - name: Self-hosted gateway
        href: self-hosted-gateway-overview.md
      - name: Networking
        href: virtual-network-concepts.md
      - name: Security
        items:
            - name: Security controls by Azure Policy
              href: ./security-controls-policy.md
            - name: Security baseline
              href: /security/benchmark/azure/baselines/api-management-security-baseline?toc=/azure/api-management/&bc=/azure/api-management/breadcrumb/toc.json
      - name: Observability
        href: observability.md
      - name: APIs
        items:
            - name: API design ebook
              href: https://azure.microsoft.com/mediahandler/files/resourcefiles/api-design/Azure_API-Design_Guide_eBook.pdf?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
            - name: RESTful web API design
              href: /azure/architecture/best-practices/api-design?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
            - name: Web API implementation
              href: /azure/architecture/best-practices/api-implementation?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
      - name: Microservices as APIs
        items:
            - name: Manage microservices deployed in AKS
              href: api-management-kubernetes.md
            - name: Integrate with Service Fabric
              href: ../service-fabric/service-fabric-api-management-overview.md?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
- name: How-to guides
  items:
      - name: Provision and scale
        items:
            - name: Use capacity for scaling decisions
              href: api-management-capacity.md
            - name: Plan and manage costs
              href: plan-manage-costs.md
            - name: Upgrade and scale
              href: upgrade-and-scale.md
            - name: Configure autoscale
              href: api-management-howto-autoscale.md
            - name: Configure a custom domain
              href: configure-custom-domain.md
            - name: Deploy to multiple Azure regions
              href: api-management-howto-deploy-multi-region.md
            - name: Enable zone redundancy
              displayName: Availability zones
              href: zone-redundancy.md
            - name: Compute platform
              href: compute-infrastructure.md
            - name: Set up DR using backup/restore
              href: api-management-howto-disaster-recovery-backup-restore.md
            - name: Use role-based access control
              href: api-management-role-based-access-control.md
            - name: Use managed identities for Azure resources
              href: api-management-howto-use-managed-service-identity.md
            - name: Send events to Event Grid
              href: how-to-event-grid.md
            - name: Move instances between regions
              href: api-management-howto-migrate.md
            - name: Recover a deleted instance
              displayName: soft delete
              href: soft-delete.md
            - name: Configure networking
              items:
                - name: Connect to a virtual network
                  href: api-management-using-with-vnet.md
                - name: Connect to an internal virtual network
                  href: api-management-using-with-internal-vnet.md
                - name: Integrate Application Gateway in an internal virtual network
                  href: api-management-howto-integrate-internal-vnet-appgateway.md
                - name: Connect privately using private endpoint
                  href: private-endpoint.md
                - name: Retrieve IP addresses
                  href: api-management-howto-ip-addresses.md
            - name: Configuration management
              items:
              - name: Landing zone accelerator
                href: /azure/cloud-adoption-framework/scenarios/app-platform/api-management/landing-zone-accelerator?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
              - name: CI/CD using ARM templates
                href: devops-api-development-templates.md
              - name: Manage using automation
                href: automation-manage-api-management.md
              - name: Configure using Git
                href: api-management-configuration-repository-git.md
              - name: Validate service updates
                href: validate-service-updates.md
            - name: Self-host the gateway
              items:
                - name: Provision a self-hosted gateway
                  href: api-management-howto-provision-self-hosted-gateway.md
                - name: Deploy an Azure API Management gateway on Azure Arc
                  href: how-to-deploy-self-hosted-gateway-azure-arc.md
                - name: Deploy a self-hosted gateway to Azure Kubernetes Service
                  href: how-to-deploy-self-hosted-gateway-azure-kubernetes-service.md
                - name: Deploy a self-hosted gateway to Kubernetes (YAML)
                  href: how-to-deploy-self-hosted-gateway-kubernetes.md
                - name: Deploy a self-hosted gateway to Kubernetes (Helm)
                  href: how-to-deploy-self-hosted-gateway-kubernetes-helm.md
                - name: Deploy self-hosted gateway to Kubernetes with OpenTelemetry Collector integration
                  href: how-to-deploy-self-hosted-gateway-kubernetes-opentelemetry.md
                - name: Guidance for running on Kubernetes
                  href: how-to-self-hosted-gateway-on-kubernetes-in-production.md
                - name: Deploy a self-hosted gateway to Docker
                  href: how-to-deploy-self-hosted-gateway-docker.md
                - name: Configure custom domain for self-hosted gateway
                  href: api-management-howto-configure-custom-domain-gateway.md
                - name: Configure cloud metrics and logs for self-hosted gateway
                  href: how-to-configure-cloud-metrics-logs.md
                - name: Configure local metrics and logs for self-hosted gateway
                  href: how-to-configure-local-metrics-logs.md
      - name: Define and manage APIs
        items:
          - name: Create APIs
            items:
                - name: Add an API manually
                  href: add-api-manually.md
                - name: Import an OpenAPI Specification
                  href: import-api-from-oas.md
                - name: Import a SOAP API
                  href: import-soap-api.md
                - name: Import a SOAP API and convert to REST
                  href: restify-soap-api.md
                - name: Import a WebSocket API
                  href: websocket-api.md
                - name: Import a GraphQL API
                  href: graphql-api.md
                - name: Import and resolve GraphQL schema
                  href: graphql-schema-resolve-api.md
                  displayName: synthetic GraphQL
                - name: Import an App Service web API
                  href: import-app-service-as-api.md
                - name: Import a Container App web API
                  href: import-container-app-with-oas.md
                - name: Import a Function App web API
                  href: import-function-app-as-api.md
                - name: Import a Logic App
                  href: import-logic-app-as-api.md
                - name: Configure Service Fabric backend
                  href: how-to-configure-service-fabric-backend.md
                - name: Import SAP OData metadata
                  href: sap-api.md
                - name: Configure API for SSE
                  href: how-to-server-sent-events.md
                - name: API import restrictions
                  href: api-management-api-import-restrictions.md
          - name: Define APIs
            items:
                - name: Edit an API
                  href: edit-api.md
                - name: Versions
                  href: api-management-versions.md
                - name: Revisions
                  href: api-management-revisions.md
                - name: Backends
                  href: backends.md
                - name: Export APIs to the Power Platform
                  href: export-api-power-platform.md
                - name: Automate API deployments
                  href: /azure/architecture/example-scenario/devops/automated-api-deployments-apiops?toc=%2Fazure%2Fapi-management%2Ftoc.json&bc=/azure/api-management/breadcrumb/toc.json
          - name: Cache
            items:
                - name: Add caching to improve performance
                  href: api-management-howto-cache.md
                - name: Use an external cache
                  href: api-management-howto-cache-external.md
                - name: Custom caching
                  href: api-management-sample-cache-by-key.md
          - name: Define policies
            items:
                - name: Set or edit policies
                  href: set-edit-policies.md
                - name: Debug policies in VS Code
                  href: api-management-debug-policies.md
                - name: Policy expressions
                  href: api-management-policy-expressions.md
                - name: Reuse policy configurations
                  href: policy-fragments.md
                  displayName: policy fragments
                - name: Error handling
                  href: api-management-error-handling-policies.md
                - name: Advanced monitoring
                  href: api-management-log-to-eventhub-sample.md
                - name: Advanced request throttling
                  href: api-management-sample-flexible-throttling.md
                - name: Using external services
                  href: api-management-sample-send-request.md
                - name: Manage secrets using named values
                  displayName: Azure CLI, az apim nv
                  href: api-management-howto-properties.md
      - name: Secure your APIs
        items:
          - name: Secure API access
            items:
            - name: Protect your API with Azure AD
              href: api-management-howto-protect-backend-with-aad.md
            - name: Protect your API with Azure AD B2C
              href: howto-protect-backend-frontend-azure-ad-b2c.md
            - name: Secure APIs using client certificate authentication
              href: api-management-howto-mutual-certificates-for-clients.md
            - name: Manage CA certificates
              href: api-management-howto-ca-certificates.md
            - name: Manage protocols and ciphers
              href: api-management-howto-manage-protocols-ciphers.md
            - name: Mitigate OWASP API threats
              href: mitigate-owasp-api-threats.md
              displayName: OWASP top 10, vulnerability, vulnerabilities
          - name: Manage API authorizations
            items:
            - name: Authorizations overview
              href: authorizations-overview.md
            - name: Configure and use authorization
              href: authorizations-how-to.md
          - name: Set up backend authentication
            items:
            - name: Mutual certificate authentication
              href: api-management-howto-mutual-certificates.md
      - name: Publish APIs
        items:
            - name: Use subscriptions
              items:
                  - name: Subscriptions
                    href: api-management-subscriptions.md
                  - name: Create subscriptions
                    href: api-management-howto-create-subscriptions.md
            - name: Manage users
              items:
                  - name: Manage user accounts
                    href: api-management-howto-create-or-invite-developers.md
                  - name: Manage groups
                    href: api-management-howto-create-groups.md
                  - name: Authenticate with Azure AD
                    href: api-management-howto-aad.md
                  - name: Authenticate with Azure AD B2C
                    href: api-management-howto-aad-b2c.md
                  - name: Delegate authentication
                    href: api-management-howto-setup-delegation.md
                  - name: Email notifications and templates
                    href: api-management-howto-configure-notifications.md
            - name: Monetize APIs
              items:
                - name: Monetization overview
                  href: monetization-overview.md
                - name: How API Management supports monetization
                  href: monetization-support.md
            - name: Customize the developer portal
              items:
                  - name: Understand the developer portal
                    href: api-management-howto-developer-portal.md
                  - name: Frequently asked questions
                    href: developer-portal-faq.md
                  - name: Automate portal deployments
                    href: automate-portal-deployments.md
                  - name: Migrate from deprecated to new developer portal
                    href: developer-portal-deprecated-migration.md
                  - name: Enable console OAuth support
                    href: api-management-howto-oauth2.md
                  - name: Integrate Application Insights
                    href: developer-portal-integrate-application-insights.md
                  - name: Integrate Google Tag Manager
                    href: developer-portal-integrate-google-tag-manager.md
            - name: Self-host the developer portal
              items:
                - name: Create self-hosted portal
                  href: developer-portal-self-host.md
                - name: Alternative approaches to self-hosting
                  href: developer-portal-alternative-processes-self-host.md
                - name: Implement widgets
                  href: developer-portal-implement-widgets.md
                - name: Contribute widgets
                  href: developer-portal-widget-contribution-guidelines.md
                - name: Use community widgets
                  href: developer-portal-use-community-widgets.md
                - name: Test self-hosted portal
                  href: developer-portal-testing.md
      - name: Monitor APIs
        items:
        - name: Get API analytics
          href: howto-use-analytics.md
        - name: Log events to Azure Event Hubs
          href: api-management-howto-log-event-hubs.md
        - name: Log requests with Azure Application Insights
          href: api-management-howto-app-insights.md
      - name: Troubleshoot
        items:
          - name: Diagnose issues in production
            href: diagnose-solve-problems.md
          - name: Troubleshoot failed to update hostnames error
            href: api-management-troubleshoot-cannot-add-custom-domain.md
          - name: Troubleshoot response timeouts and errors
            href: troubleshoot-response-timeout-and-errors.md
- name: Reference
  items:
      - name: Azure CLI
        href: /cli/azure/apim
      - name: Azure PowerShell
        href: /powershell/module/az.apimanagement/
      - name: REST API
        href: /rest/api/apimanagement/
      - name: REST API SDKs
        items:
          - name: .NET
            href: /dotnet/api/overview/azure/apimanagement
          - name: JavaScript
            href: /javascript/api/overview/azure/apimanagement
          - name: Java
            href: /java/api/overview/azure/apimanagement
          - name: Python
            href: https://pypi.org/project/azure-mgmt-apimanagement
          - name: Go
            href: https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/services/apimanagement
          - name: Ruby
            href: https://rubygems.org/gems/azure_mgmt_api_management
      - name: Resource Manager template
        href: /azure/templates/microsoft.apimanagement/allversions
      - name: Terraform provider
        href: https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/api_management
      - name: API Management policies
        items:
            - name: Policy reference index
              href: api-management-policies.md
            - name: Access restriction policies
              href: api-management-access-restriction-policies.md
            - name: Advanced policies
              href: api-management-advanced-policies.md
            - name: Authentication policies
              href: api-management-authentication-policies.md
            - name: Caching policies
              href: api-management-caching-policies.md
            - name: Cross-domain policies
              href: api-management-cross-domain-policies.md
            - name: Distributed Application Runtime (Dapr) integration policies
              href: api-management-dapr-policies.md
            - name: GraphQL API policies
              href: graphql-policies.md
            - name: Transformation policies
              href: api-management-transformation-policies.md
            - name: Validation policies
              href: validation-policies.md
      - name: Authorizations - identity providers
        href: authorizations-reference.md
      - name: Azure Policy built-ins
        displayName: samples, policies, definitions
        href: ./policy-reference.md
      - name: Resource log schema
        href: gateway-log-schema-reference.md
      - name: Event Grid events schema
        href: ../event-grid/event-schema-api-management.md?toc=/azure/api-management/toc.json&bc=/azure/api-management/breadcrumb/toc.json
      - name: Virtual network configuration
        href: virtual-network-reference.md
- name: Resources
  items:
      - name: FAQ
        href: api-management-faq.yml
      - name: Pricing
        href: https://aka.ms/apimpricing
      - name: Product updates
        href: https://aka.ms/apimupdates
      - name: Release notes
        href: https://aka.ms/apim/releases
      - name: Retiring features
        items:
          - name: Deprecated developer portal
            items:
                - name: Deprecated portal - customize the portal
                  href: api-management-customize-styles.md
                - name: Deprecated portal - modify pages and layouts
                  href: api-management-modify-content-layout.md
                - name: Deprecated portal - customize with templates
                  href: api-management-developer-portal-templates.md
                - name: Deprecated portal templates
                  items:
                    - name: Data model reference
                      href: api-management-template-data-model-reference.md
                    - name: Page controls
                      href: api-management-page-controls.md
                    - name: Templates
                      href: api-management-developer-portal-templates-reference.md
                    - name: APIs
                      href: api-management-api-templates.md
                    - name: Products
                      href: api-management-product-templates.md
                    - name: Applications
                      href: api-management-application-templates.md
                    - name: Issues
                      href: api-management-issue-templates.md
                    - name: User profile
                      href: api-management-user-profile-templates.md
                    - name: Pages
                      href: api-management-page-templates.md
                    - name: Template resources
                      href: api-management-template-resources.md
      - name: Breaking changes
        items:
            - name: Breaking changes overview
              href: breaking-changes/overview.md
            - name: Virtual network changes (March 2023)
              href: breaking-changes/rp-source-ip-address-change-mar2023.md
      - name: Regional availability
        href: https://azure.microsoft.com/global-infrastructure/services/
      - name: Microsoft Q&A question page
        href: /answers/topics/azure-api-management.html
      - name: Stack Overflow
        href: https://stackoverflow.com/questions/tagged/azure-api-management
      - name: Additional resources
        href: https://aka.ms/apimlove