Overview

Parameters

'xml'

Outputs

Example

@description('The target environment.')
param env string

@description('The deployment version.')
param version string = '1.0.0.0'

@description('The name of the API Management service. This should match an existing API Management instance.')
param apiManagementName string

@description('The Application Insights instrumentation key used for logging and monitoring. This key is stored as a named value for use by the logger.')
param appInsightsInstrumentationKey string

@description('The global policy value (typically an XML policy) that is applied to the API Management service, usually loaded via loadTextContent(). This policy governs behavior across the service.')
param globalPolicyValue string

@description('### Description
An array of API definitions that configure individual APIs in the service. Each object should include:
- **name**: A unique identifier for the API.
- **apimPath**: The path segment for the API within API Management.
- **description**: A short description of the API (optional).
- **format**: The format of the API specification (optional, default "openapi").
- **subscriptionRequired**: Indicates if a subscription is required to access the API (optional, default true).
- **apiSpecValue**: The API specification content, usually loaded via loadTextContent().
- **policy**: The policy content for the API, typically loaded using loadTextContent().
- **backendUrl**: The URL of the backend service.
- **backendHeaderValue**: The value for the backend header used for authentication (optional).
- **backendProtocol**: The protocol used to access the backend service (optional, default "http").
- **backendHeaderKey**: The header key for backend authentication (optional, default "x-functions-key").

### Example

var apiDefinitions = { name: 'apiName' apimPath: 'apiPath' description: 'apiDescription' format: 'openapi' subscriptionRequired: true apiSpecValue: loadTextContent('config/openapi/apiDefinition.yaml') policy: loadTextContent('config/policies/policy.template.hbs') backendUrl: 'https://myApi.azurewebsites.net' backendHeaderValue: 'MyTopSecretKey' backendProtocol: 'http' backendHeaderKey: 'x-functions-key' }

')
param apiDefinitions array


module apis 'br:bicepacrdevwcom.azurecr.io/bicep/modules/apimanagement/apis:2026.9.9.2' = {
    name: 'apis${env}${version}'
    params: {
      apiManagementName: apiManagementName
      appInsightsInstrumentationKey: appInsightsInstrumentationKey
      globalPolicyValue: globalPolicyValue
      apiDefinitions: apiDefinitions
    }
}