Microsoft.AppPlatform Spring/gateways

Remarks

Note: Azure Spring Apps Gateways (Microsoft.AppPlatform/Spring/gateways) is now deprecated and will be retired on 2028-05-31. See https://aka.ms/asaretirement for more information.

Bicep resource definition

The Spring/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.

Usage Examples

Bicep Samples

A basic example of deploying Spring Cloud Gateway.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource spring 'Microsoft.AppPlatform/Spring@2023-05-01-preview' = {
  name: resourceName
  location: location
  sku: {
    name: 'E0'
  }
  properties: {
    zoneRedundant: false
  }
}

resource gateway 'Microsoft.AppPlatform/Spring/gateways@2023-05-01-preview' = {
  name: 'default'
  parent: spring
  sku: {
    capacity: 1
    name: 'E0'
    tier: 'Enterprise'
  }
  properties: {
    httpsOnly: false
    public: false
  }
}

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
Deploy a simple Azure Spring Apps microservice application	This template deploys a simple Azure Spring Apps microservice application to run on Azure.

Resource format

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

resource symbolicname 'Microsoft.AppPlatform/Spring/gateways@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    addonConfigs: {
      {customized property}: any(...)
    }
    apiMetadataProperties: {
      description: 'string'
      documentation: 'string'
      serverUrl: 'string'
      title: 'string'
      version: 'string'
    }
    apms: [
      {
        resourceId: 'string'
      }
    ]
    apmTypes: [
      'string'
    ]
    clientAuth: {
      certificates: [
        'string'
      ]
      certificateVerification: 'string'
    }
    corsProperties: {
      allowCredentials: bool
      allowedHeaders: [
        'string'
      ]
      allowedMethods: [
        'string'
      ]
      allowedOriginPatterns: [
        'string'
      ]
      allowedOrigins: [
        'string'
      ]
      exposedHeaders: [
        'string'
      ]
      maxAge: int
    }
    environmentVariables: {
      properties: {
        {customized property}: 'string'
      }
      secrets: {
        {customized property}: 'string'
      }
    }
    httpsOnly: bool
    public: bool
    resourceRequests: {
      cpu: 'string'
      memory: 'string'
    }
    responseCacheProperties: {
      responseCacheType: 'string'
      // For remaining properties, see GatewayResponseCacheProperties objects
    }
    ssoProperties: {
      clientId: 'string'
      clientSecret: 'string'
      issuerUri: 'string'
      scope: [
        'string'
      ]
    }
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
}

GatewayResponseCacheProperties objects

Set the responseCacheType property to specify the type of object.

For LocalCachePerInstance, use:

{
  responseCacheType: 'LocalCachePerInstance'
  size: 'string'
  timeToLive: 'string'
}

For LocalCachePerRoute, use:

{
  responseCacheType: 'LocalCachePerRoute'
  size: 'string'
  timeToLive: 'string'
}

Property Values