Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2024-06-01-preview' = {
location: 'string'
name: 'string'
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.ApiManagement/gateways
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 45 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (required) |
| properties | Properties of the API Management gateway. | ApiManagementGatewayProperties (required) |
| sku | SKU properties of the API Management gateway. | ApiManagementGatewaySkuProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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' |
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) |
ApimResourceTags
| Name | Description | Value |
|---|
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 |
FrontendConfiguration
| Name | Description | Value |
|---|
GatewayConfigurationApi
| Name | Description | Value |
|---|
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": "2024-06-01-preview",
"name": "string",
"location": "string",
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {
},
"frontend": {
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.ApiManagement/gateways
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-06-01-preview' |
| location | Resource location. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 45 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (required) |
| properties | Properties of the API Management gateway. | ApiManagementGatewayProperties (required) |
| sku | SKU properties of the API Management gateway. | ApiManagementGatewaySkuProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.ApiManagement/gateways' |
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' |
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) |
ApimResourceTags
| Name | Description | Value |
|---|
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 |
FrontendConfiguration
| Name | Description | Value |
|---|
GatewayConfigurationApi
| Name | Description | Value |
|---|
Usage Examples
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@2024-06-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {
}
frontend = {
}
virtualNetworkType = "string"
}
sku = {
capacity = int
name = "string"
}
}
}
Property Values
Microsoft.ApiManagement/gateways
| Name | Description | Value |
|---|---|---|
| location | Resource location. | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 45 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (required) |
| properties | Properties of the API Management gateway. | ApiManagementGatewayProperties (required) |
| sku | SKU properties of the API Management gateway. | ApiManagementGatewaySkuProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.ApiManagement/gateways@2024-06-01-preview" |
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' |
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) |
ApimResourceTags
| Name | Description | Value |
|---|
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 |
FrontendConfiguration
| Name | Description | Value |
|---|
GatewayConfigurationApi
| Name | Description | Value |
|---|