Microsoft.ApiManagement gateways
Bicep resource definition
The 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/gateways resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/gateways@2023-09-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
}
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
}
Property values
gateways
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | Resource location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | SKU properties of the API Management gateway. | ApiManagementGatewaySkuProperties (required) |
| properties | Properties of the API Management gateway. | ApiManagementGatewayProperties (required) |
ApiManagementGatewayProperties
| Name | Description | Value |
|---|---|---|
| backend | Information regarding how the gateway should integrate with backend systems. | BackendConfiguration |
| configurationApi | Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU. | GatewayConfigurationApi |
| frontend | Information regarding how the gateway should be exposed. | FrontendConfiguration |
| virtualNetworkType | The type of VPN in which API Management gateway needs to be configured in. | 'External' 'Internal' 'None' |
BackendConfiguration
| Name | Description | Value |
|---|---|---|
| subnet | The default hostname of the data-plane gateway to which requests can be sent. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Name | Description | Value |
|---|---|---|
| id | The ARM ID of the subnet in which the backend systems are hosted. | string |
GatewayConfigurationApi
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
FrontendConfiguration
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ApiManagementGatewaySkuProperties
| Name | Description | Value |
|---|---|---|
| capacity | Capacity of the SKU (number of deployed units of the SKU) | int |
| name | Name of the Sku. | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (required) |
ARM template resource definition
The 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/gateways resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/gateways",
"apiVersion": "2023-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string"
},
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {},
"frontend": {},
"virtualNetworkType": "string"
}
}
Property values
gateways
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/gateways' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name | string (required) |
| location | Resource location. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| sku | SKU properties of the API Management gateway. | ApiManagementGatewaySkuProperties (required) |
| properties | Properties of the API Management gateway. | ApiManagementGatewayProperties (required) |
ApiManagementGatewayProperties
| Name | Description | Value |
|---|---|---|
| backend | Information regarding how the gateway should integrate with backend systems. | BackendConfiguration |
| configurationApi | Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU. | GatewayConfigurationApi |
| frontend | Information regarding how the gateway should be exposed. | FrontendConfiguration |
| virtualNetworkType | The type of VPN in which API Management gateway needs to be configured in. | 'External' 'Internal' 'None' |
BackendConfiguration
| Name | Description | Value |
|---|---|---|
| subnet | The default hostname of the data-plane gateway to which requests can be sent. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Name | Description | Value |
|---|---|---|
| id | The ARM ID of the subnet in which the backend systems are hosted. | string |
GatewayConfigurationApi
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
FrontendConfiguration
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ApiManagementGatewaySkuProperties
| Name | Description | Value |
|---|---|---|
| capacity | Capacity of the SKU (number of deployed units of the SKU) | int |
| name | Name of the Sku. | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (required) |
Terraform (AzAPI provider) resource definition
The 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/gateways resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways@2023-09-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {}
frontend = {}
virtualNetworkType = "string"
}
sku = {
capacity = int
name = "string"
}
})
}
Property values
gateways
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/gateways@2023-09-01-preview" |
| name | The resource name | string (required) |
| location | Resource location. | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | SKU properties of the API Management gateway. | ApiManagementGatewaySkuProperties (required) |
| properties | Properties of the API Management gateway. | ApiManagementGatewayProperties (required) |
ApiManagementGatewayProperties
| Name | Description | Value |
|---|---|---|
| backend | Information regarding how the gateway should integrate with backend systems. | BackendConfiguration |
| configurationApi | Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU. | GatewayConfigurationApi |
| frontend | Information regarding how the gateway should be exposed. | FrontendConfiguration |
| virtualNetworkType | The type of VPN in which API Management gateway needs to be configured in. | "External" "Internal" "None" |
BackendConfiguration
| Name | Description | Value |
|---|---|---|
| subnet | The default hostname of the data-plane gateway to which requests can be sent. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Name | Description | Value |
|---|---|---|
| id | The ARM ID of the subnet in which the backend systems are hosted. | string |
GatewayConfigurationApi
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
FrontendConfiguration
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
ApiManagementGatewaySkuProperties
| Name | Description | Value |
|---|---|---|
| capacity | Capacity of the SKU (number of deployed units of the SKU) | int |
| name | Name of the Sku. | "Standard" "WorkspaceGatewayPremium" "WorkspaceGatewayStandard" (required) |