Microsoft.ApiManagement service/gateways 2023-09-01-preview

• Latest
• 2023-09-01-preview
• 2022-08-01
• 2021-08-01

Bicep resource definition

The service/gateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.ApiManagement/service/gateways@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    locationData: {
      city: 'string'
      countryOrRegion: 'string'
      district: 'string'
      name: 'string'
    }
  }
}

Property values

service/gateways

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	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.	Symbolic name for resource of type: service
properties	Gateway details.	GatewayContractProperties

GatewayContractProperties

Name	Description	Value
description	Gateway description	string Constraints: Max length = 1000
locationData	Gateway location.	ResourceLocationDataContract

ResourceLocationDataContract

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create API Management in Internal VNet with App Gateway	This template demonstrates how to Create a instance of Azure API Management on a private network protected by Azure Application Gateway.

ARM template resource definition

The service/gateways resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.ApiManagement/service/gateways",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "locationData": {
      "city": "string",
      "countryOrRegion": "string",
      "district": "string",
      "name": "string"
    }
  }
}

Property values

service/gateways

Name	Description	Value
type	The resource type	'Microsoft.ApiManagement/service/gateways'
apiVersion	The resource api version	'2023-09-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
properties	Gateway details.	GatewayContractProperties

GatewayContractProperties

Name	Description	Value
description	Gateway description	string Constraints: Max length = 1000
locationData	Gateway location.	ResourceLocationDataContract

ResourceLocationDataContract

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create API Management in Internal VNet with App Gateway	This template demonstrates how to Create a instance of Azure API Management on a private network protected by Azure Application Gateway.

Terraform (AzAPI provider) resource definition

The service/gateways resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/gateways@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      locationData = {
        city = "string"
        countryOrRegion = "string"
        district = "string"
        name = "string"
      }
    }
  })
}

Property values

service/gateways

Name	Description	Value
type	The resource type	"Microsoft.ApiManagement/service/gateways@2023-09-01-preview"
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: service
properties	Gateway details.	GatewayContractProperties

GatewayContractProperties

Name	Description	Value
description	Gateway description	string Constraints: Max length = 1000
locationData	Gateway location.	ResourceLocationDataContract

ResourceLocationDataContract

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