Microsoft.AppPlatform Spring 2023-09-01-preview

Article
12/09/2024

Bicep resource definition

The Spring 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.AppPlatform/Spring resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.AppPlatform/Spring@2023-09-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    infraResourceGroup: 'string'
    maintenanceScheduleConfiguration: {
      frequency: 'string'
      // For remaining properties, see MaintenanceScheduleConfiguration objects
    }
    managedEnvironmentId: 'string'
    marketplaceResource: {
      plan: 'string'
      product: 'string'
      publisher: 'string'
    }
    networkProfile: {
      appNetworkResourceGroup: 'string'
      appSubnetId: 'string'
      ingressConfig: {
        readTimeoutInSeconds: int
      }
      outboundType: 'string'
      serviceCidr: 'string'
      serviceRuntimeNetworkResourceGroup: 'string'
      serviceRuntimeSubnetId: 'string'
    }
    vnetAddons: {
      dataPlanePublicEndpoint: bool
      logStreamPublicEndpoint: bool
    }
    zoneRedundant: bool
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

MaintenanceScheduleConfiguration objects

Set the frequency property to specify the type of object.

For Weekly, use:

{
  day: 'string'
  frequency: 'Weekly'
  hour: int
}

Property Values

ClusterResourceProperties

Name	Description	Value
infraResourceGroup	The name of the resource group that contains the infrastructure resources	string
maintenanceScheduleConfiguration	Additional Service settings for planned maintenance	MaintenanceScheduleConfiguration
managedEnvironmentId	The resource Id of the Managed Environment that the Spring Apps instance builds on	string
marketplaceResource	Purchasing 3rd party product of the Service resource.	MarketplaceResource
networkProfile	Network profile of the Service	NetworkProfile
vnetAddons	Additional Service settings in vnet injection instance	ServiceVNetAddons
zoneRedundant		bool

IngressConfig

Name	Description	Value
readTimeoutInSeconds	Ingress read time out in seconds.	int

MaintenanceScheduleConfiguration

Name	Description	Value
frequency	Set to 'Weekly' for type WeeklyMaintenanceScheduleConfiguration.	'Weekly' (required)

MarketplaceResource

Name	Description	Value
plan	The plan id of the 3rd Party Artifact that is being procured.	string
product	The 3rd Party artifact that is being procured.	string
publisher	The publisher id of the 3rd Party Artifact that is being bought.	string

Microsoft.AppPlatform/Spring

Name	Description	Value
location	The GEO location of the resource.	string
name	The resource name	string Constraints: Pattern = `^[a-z][a-z0-9-]*[a-z0-9]$` (required)
properties	Properties of the Service resource	ClusterResourceProperties
sku	Sku of the Service resource	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

NetworkProfile

Name	Description	Value
appNetworkResourceGroup	Name of the resource group containing network resources for customer apps in Azure Spring Apps	string
appSubnetId	Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps	string
ingressConfig	Ingress configuration payload for Azure Spring Apps resource.	IngressConfig
outboundType	The egress traffic type of Azure Spring Apps VNet instances.	string
serviceCidr	Azure Spring Apps service reserved CIDR	string
serviceRuntimeNetworkResourceGroup	Name of the resource group containing network resources of Azure Spring Apps Service Runtime	string
serviceRuntimeSubnetId	Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime	string

ServiceVNetAddons

Name	Description	Value
dataPlanePublicEndpoint	Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.	bool
logStreamPublicEndpoint	Indicates whether the log stream in vnet injection instance could be accessed from internet.	bool

Sku

Name	Description	Value
capacity	Current capacity of the target resource	int
name	Name of the Sku	string
tier	Tier of the Sku	string

TrackedResourceTags

Name	Description	Value

WeeklyMaintenanceScheduleConfiguration

Name	Description	Value
day	The day to run the maintenance job	'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' (required)
frequency	The frequency to run the maintenance job	'Weekly' (required)
hour	The hour to run the maintenance job	int Constraints: Min value = 0 Max value = 23 (required)

Usage Examples

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.

ARM template resource definition

The Spring 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.AppPlatform/Spring resource, add the following JSON to your template.

{
  "type": "Microsoft.AppPlatform/Spring",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "infraResourceGroup": "string",
    "maintenanceScheduleConfiguration": {
      "frequency": "string"
      // For remaining properties, see MaintenanceScheduleConfiguration objects
    },
    "managedEnvironmentId": "string",
    "marketplaceResource": {
      "plan": "string",
      "product": "string",
      "publisher": "string"
    },
    "networkProfile": {
      "appNetworkResourceGroup": "string",
      "appSubnetId": "string",
      "ingressConfig": {
        "readTimeoutInSeconds": "int"
      },
      "outboundType": "string",
      "serviceCidr": "string",
      "serviceRuntimeNetworkResourceGroup": "string",
      "serviceRuntimeSubnetId": "string"
    },
    "vnetAddons": {
      "dataPlanePublicEndpoint": "bool",
      "logStreamPublicEndpoint": "bool"
    },
    "zoneRedundant": "bool"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

MaintenanceScheduleConfiguration objects

Set the frequency property to specify the type of object.

For Weekly, use:

{
  "day": "string",
  "frequency": "Weekly",
  "hour": "int"
}

Property Values

ClusterResourceProperties

Name	Description	Value
infraResourceGroup	The name of the resource group that contains the infrastructure resources	string
maintenanceScheduleConfiguration	Additional Service settings for planned maintenance	MaintenanceScheduleConfiguration
managedEnvironmentId	The resource Id of the Managed Environment that the Spring Apps instance builds on	string
marketplaceResource	Purchasing 3rd party product of the Service resource.	MarketplaceResource
networkProfile	Network profile of the Service	NetworkProfile
vnetAddons	Additional Service settings in vnet injection instance	ServiceVNetAddons
zoneRedundant		bool

IngressConfig

Name	Description	Value
readTimeoutInSeconds	Ingress read time out in seconds.	int

MaintenanceScheduleConfiguration

Name	Description	Value
frequency	Set to 'Weekly' for type WeeklyMaintenanceScheduleConfiguration.	'Weekly' (required)

MarketplaceResource

Name	Description	Value
plan	The plan id of the 3rd Party Artifact that is being procured.	string
product	The 3rd Party artifact that is being procured.	string
publisher	The publisher id of the 3rd Party Artifact that is being bought.	string

Microsoft.AppPlatform/Spring

Name	Description	Value
apiVersion	The api version	'2023-09-01-preview'
location	The GEO location of the resource.	string
name	The resource name	string Constraints: Pattern = `^[a-z][a-z0-9-]*[a-z0-9]$` (required)
properties	Properties of the Service resource	ClusterResourceProperties
sku	Sku of the Service resource	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.AppPlatform/Spring'

NetworkProfile

Name	Description	Value
appNetworkResourceGroup	Name of the resource group containing network resources for customer apps in Azure Spring Apps	string
appSubnetId	Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps	string
ingressConfig	Ingress configuration payload for Azure Spring Apps resource.	IngressConfig
outboundType	The egress traffic type of Azure Spring Apps VNet instances.	string
serviceCidr	Azure Spring Apps service reserved CIDR	string
serviceRuntimeNetworkResourceGroup	Name of the resource group containing network resources of Azure Spring Apps Service Runtime	string
serviceRuntimeSubnetId	Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime	string

ServiceVNetAddons

Name	Description	Value
dataPlanePublicEndpoint	Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.	bool
logStreamPublicEndpoint	Indicates whether the log stream in vnet injection instance could be accessed from internet.	bool

Sku

Name	Description	Value
capacity	Current capacity of the target resource	int
name	Name of the Sku	string
tier	Tier of the Sku	string

TrackedResourceTags

Name	Description	Value

WeeklyMaintenanceScheduleConfiguration

Name	Description	Value
day	The day to run the maintenance job	'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' (required)
frequency	The frequency to run the maintenance job	'Weekly' (required)
hour	The hour to run the maintenance job	int Constraints: Min value = 0 Max value = 23 (required)

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

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

Terraform (AzAPI provider) resource definition

The Spring 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.AppPlatform/Spring resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring@2023-09-01-preview"
  name = "string"
  location = "string"
  sku = {
    capacity = int
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      infraResourceGroup = "string"
      maintenanceScheduleConfiguration = {
        frequency = "string"
        // For remaining properties, see MaintenanceScheduleConfiguration objects
      }
      managedEnvironmentId = "string"
      marketplaceResource = {
        plan = "string"
        product = "string"
        publisher = "string"
      }
      networkProfile = {
        appNetworkResourceGroup = "string"
        appSubnetId = "string"
        ingressConfig = {
          readTimeoutInSeconds = int
        }
        outboundType = "string"
        serviceCidr = "string"
        serviceRuntimeNetworkResourceGroup = "string"
        serviceRuntimeSubnetId = "string"
      }
      vnetAddons = {
        dataPlanePublicEndpoint = bool
        logStreamPublicEndpoint = bool
      }
      zoneRedundant = bool
    }
  })
}

MaintenanceScheduleConfiguration objects

Set the frequency property to specify the type of object.

For Weekly, use:

{
  day = "string"
  frequency = "Weekly"
  hour = int
}

Property Values

ClusterResourceProperties

Name	Description	Value
infraResourceGroup	The name of the resource group that contains the infrastructure resources	string
maintenanceScheduleConfiguration	Additional Service settings for planned maintenance	MaintenanceScheduleConfiguration
managedEnvironmentId	The resource Id of the Managed Environment that the Spring Apps instance builds on	string
marketplaceResource	Purchasing 3rd party product of the Service resource.	MarketplaceResource
networkProfile	Network profile of the Service	NetworkProfile
vnetAddons	Additional Service settings in vnet injection instance	ServiceVNetAddons
zoneRedundant		bool

IngressConfig

Name	Description	Value
readTimeoutInSeconds	Ingress read time out in seconds.	int

MaintenanceScheduleConfiguration

Name	Description	Value
frequency	Set to 'Weekly' for type WeeklyMaintenanceScheduleConfiguration.	'Weekly' (required)

MarketplaceResource

Name	Description	Value
plan	The plan id of the 3rd Party Artifact that is being procured.	string
product	The 3rd Party artifact that is being procured.	string
publisher	The publisher id of the 3rd Party Artifact that is being bought.	string

Microsoft.AppPlatform/Spring

Name	Description	Value
location	The GEO location of the resource.	string
name	The resource name	string Constraints: Pattern = `^[a-z][a-z0-9-]*[a-z0-9]$` (required)
properties	Properties of the Service resource	ClusterResourceProperties
sku	Sku of the Service resource	Sku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.AppPlatform/Spring@2023-09-01-preview"

NetworkProfile

Name	Description	Value
appNetworkResourceGroup	Name of the resource group containing network resources for customer apps in Azure Spring Apps	string
appSubnetId	Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps	string
ingressConfig	Ingress configuration payload for Azure Spring Apps resource.	IngressConfig
outboundType	The egress traffic type of Azure Spring Apps VNet instances.	string
serviceCidr	Azure Spring Apps service reserved CIDR	string
serviceRuntimeNetworkResourceGroup	Name of the resource group containing network resources of Azure Spring Apps Service Runtime	string
serviceRuntimeSubnetId	Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime	string

ServiceVNetAddons

Name	Description	Value
dataPlanePublicEndpoint	Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.	bool
logStreamPublicEndpoint	Indicates whether the log stream in vnet injection instance could be accessed from internet.	bool

Sku

Name	Description	Value
capacity	Current capacity of the target resource	int
name	Name of the Sku	string
tier	Tier of the Sku	string

TrackedResourceTags

Name	Description	Value

WeeklyMaintenanceScheduleConfiguration

Name	Description	Value
day	The day to run the maintenance job	'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' (required)
frequency	The frequency to run the maintenance job	'Weekly' (required)
hour	The hour to run the maintenance job	int Constraints: Min value = 0 Max value = 23 (required)

Share via

Microsoft.AppPlatform Spring 2023-09-01-preview

Bicep resource definition

Resource format

MaintenanceScheduleConfiguration objects

Property Values

ClusterResourceProperties

IngressConfig

MaintenanceScheduleConfiguration

MarketplaceResource

Microsoft.AppPlatform/Spring

NetworkProfile

ServiceVNetAddons

Sku

TrackedResourceTags

WeeklyMaintenanceScheduleConfiguration

Usage Examples

Azure Quickstart Samples

ARM template resource definition

Resource format

MaintenanceScheduleConfiguration objects

Property Values

ClusterResourceProperties

IngressConfig

MaintenanceScheduleConfiguration

MarketplaceResource

Microsoft.AppPlatform/Spring

NetworkProfile

ServiceVNetAddons

Sku

TrackedResourceTags

WeeklyMaintenanceScheduleConfiguration

Usage Examples

Azure Quickstart Templates

Terraform (AzAPI provider) resource definition

Resource format

MaintenanceScheduleConfiguration objects

Property Values

ClusterResourceProperties

IngressConfig

MaintenanceScheduleConfiguration

MarketplaceResource

Microsoft.AppPlatform/Spring

NetworkProfile

ServiceVNetAddons

Sku

TrackedResourceTags

WeeklyMaintenanceScheduleConfiguration

Feedback

Additional resources