2026.8.31.6

Overview
Name service
Tag 2026.8.31.6
FullName br:bicepacrdevwcom.azurecr.io/bicep/modules/apimanagement/service:2026.8.31.6
Last updated 2026-08-31 10:46:34:+00:00
Created 2026-08-31 10:46:34:+00:00
Digest sha256:d35edbfe0efbf6901de055ddac47d52f975d4ba133a4320bcce7a5165ae6a5b1

Parameters

Name Type Required Description
tags object Yes Tags to be applied to the resources.
location string No
resourceGroup().location
 The location where the resources will be deployed. Defaults to the resource group location.
env string Yes The environment for the deployment (e.g., dev, test, prod).
system string Yes The system name used to identify the resource group or application.
suffix string Yes A suffix to differentiate between deployments.
skuName string
'Basic',
'BasicV2',
'Consumption',
'Developer',
'Isolated',
'Premium',
'Standard',
'StandardV2'
 No
'StandardV2'
 The SKU name for the API Management instance. Available options are: Basic, BasicV2, Consumption, Developer, Isolated, Premium, Standard, StandardV2.
skuCapacity int No
1
 The capacity of the SKU (number of units).
publisherEmail string Yes The email address of the publisher for API Management.
publisherName string Yes The name of the publisher for API Management.
useVnet bool No
false
 Indicates whether a virtual network should be used.
virtualNetworkType string
'External',
'Internal',
'None'
 No
'None'
 The type of virtual network to be used.
subnetResourceId string No
''
 The resource ID of the subnet to be used when useVnet is true.
apimName string No
format('{0}-apim-{1}-{2}', system, env, suffix)
 The name of the API Management instance.
useCustomDomain bool No
false
 Indicates whether a custom domain should be used.
certificateUri string No
''
 The URI of the certificate to be used when useCustomDomain is true.
customDomainName string No
''
 The name of the custom domain to be used when useCustomDomain is true.
userAssignedIdentityResourceId string No
''
 User assigned identity resource ID
userAssignedIdentityClientId string No
''
 User assigned identity client ID
publicNetworkAccess string
'Enabled',
'Disabled'
 No
'Enabled'
 The public network access setting for the API Management instance.

Outputs

Name Type Description
apimName string The name of the created API Management instance.
apimResourceId string The resource ID of the created API Management instance.
apimGatewayUrl string The gateway URL of the created API Management instance.
apimDefaultHostname string The default hostname of the created API Management instance.
apimInternalIpAddress string Internal IP Address of the API Management instance.
apimManagedIdentityId string Managed identity id of the API Management instance.

Example

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

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

@description('Tags to be applied to the resources.')
param tags object

@description('The system name used to identify the resource group or application.')
param system string

@description('A suffix to differentiate between deployments.')
param suffix string

@description('The email address of the publisher for API Management.')
param publisherEmail string

@description('The name of the publisher for API Management.')
param publisherName string


module service 'br:bicepacrdevwcom.azurecr.io/bicep/modules/apimanagement/service:2026.8.31.6' = {
    name: 'service${env}${version}'
    params: {
      tags: tags
      env: env
      system: system
      suffix: suffix
      publisherEmail: publisherEmail
      publisherName: publisherName
    }
}