Microsoft.ApiManagement service/gateways 2020-12-01

The service/gateways resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.ApiManagement/service/gateways resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.ApiManagement/service/gateways@2020-12-01' = {
  name: 'string'
  parent: parentSymbolicName
  properties: {
    description: 'string'
    locationData: {
      city: 'string'
      countryOrRegion: 'string'
      district: 'string'
      name: 'string'
    }
  }
}

Property values

service/gateways

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.ApiManagement/service/gateways'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2020-12-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
parentSymbolicName
properties Properties of the Gateway contract. GatewayContractProperties

GatewayContractProperties

Name Description Value
description Gateway description string
locationData Resource location data properties. ResourceLocationDataContract

ResourceLocationDataContract

Name Description Value
city The city or locality where the resource is located. string
countryOrRegion The country or region where the resource is located. string
district The district, state, or province where the resource is located. string
name A canonical name for the geographic or physical location. string (required)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create API Management in Internal VNet with App Gateway

Deploy to Azure
This template demonstrates how to Create a instance of Azure API Management on a private network protected by Azure Application Gateway.