Microsoft.Web customApis

Template format

To create a Microsoft.Web/customApis resource, add the following JSON to the resources section of your template.

  "name": "string",
  "type": "Microsoft.Web/customApis",
  "apiVersion": "2016-06-01",
  "location": "string",
  "tags": {},
  "properties": {
    "connectionParameters": {},
    "runtimeUrls": [
    "capabilities": [
    "swagger": {},
    "brandColor": "string",
    "description": "string",
    "displayName": "string",
    "iconUri": "string",
    "backendService": {
      "serviceUrl": "string"
    "apiDefinitions": {
      "originalSwaggerUrl": "string",
      "modifiedSwaggerUrl": "string"
    "apiType": "string",
    "wsdlDefinition": {
      "url": "string",
      "content": "string",
      "service": {
        "qualifiedName": "string",
        "endpointQualifiedNames": [
      "importMethod": "string"

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Web/customApis object


In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes API name
type enum Yes For JSON - Microsoft.Web/customApis
apiVersion enum Yes For JSON - 2016-06-01
location string No Resource location
tags object No
properties object Yes CustomApiPropertiesDefinition object

CustomApiPropertiesDefinition object

Name Type Required Value
connectionParameters object No Connection parameters
runtimeUrls array No Runtime URLs - string
capabilities array No The custom API capabilities - string
swagger object No The JSON representation of the swagger
brandColor string No Brand color
description string No The custom API description
displayName string No The display name
iconUri string No The icon URI
backendService object No ApiResourceBackendService object
apiDefinitions object No ApiResourceDefinitions object
apiType enum No NotSpecified, Rest, Soap
wsdlDefinition object No WsdlDefinition object

ApiResourceBackendService object

Name Type Required Value
serviceUrl string No The service URL

ApiResourceDefinitions object

Name Type Required Value
originalSwaggerUrl string No The original swagger URL
modifiedSwaggerUrl string No The modified swagger URL

WsdlDefinition object

Name Type Required Value
url string No The WSDL URL
content string No The WSDL content
service object No WsdlService object
importMethod enum No NotSpecified, SoapToRest, SoapPassThrough

WsdlService object

Name Type Required Value
qualifiedName string Yes The service's qualified name
endpointQualifiedNames array No List of the endpoints' qualified names - string