Share via

Microsoft.AppPlatform Spring/apps 2022-04-01

  • Article

Bicep resource definition

The Spring/apps resource type can be deployed with operations that target:

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

Resource format

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

resource symbolicname 'Microsoft.AppPlatform/Spring/apps@2022-04-01' = {
  parent: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    addonConfigs: {
      {customized property}: {
        {customized property}: any(...)
      }
    }
    enableEndToEndTLS: bool
    fqdn: 'string'
    httpsOnly: bool
    loadedCertificates: [
      {
        loadTrustStore: bool
        resourceId: 'string'
      }
    ]
    persistentDisk: {
      mountPath: 'string'
      sizeInGB: int
    }
    public: bool
    temporaryDisk: {
      mountPath: 'string'
      sizeInGB: int
    }
  }
}

Property Values

AddonProfile

Name Description Value

AppResourceProperties

Name Description Value
addonConfigs Collection of addons AppResourcePropertiesAddonConfigs
enableEndToEndTLS Indicate if end to end TLS is enabled. bool
fqdn Fully qualified dns Name. string
httpsOnly Indicate if only https is allowed. bool
loadedCertificates Collection of loaded certificates LoadedCertificate[]
persistentDisk Persistent disk settings PersistentDisk
public Indicates whether the App exposes public endpoint bool
temporaryDisk Temporary disk settings TemporaryDisk

AppResourcePropertiesAddonConfigs

Name Description Value

LoadedCertificate

Name Description Value
loadTrustStore Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. bool
resourceId Resource Id of loaded certificate string (required)

ManagedIdentityProperties

Name Description Value
principalId Principal Id of system-assigned managed identity. string
tenantId Tenant Id of system-assigned managed identity. string
type Type of the managed identity 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'

Microsoft.AppPlatform/Spring/apps

Name Description Value
identity The Managed Identity type of the app resource ManagedIdentityProperties
location The GEO location of the application, always the same with its parent resource string
name The resource name 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: Spring
properties Properties of the App resource AppResourceProperties

PersistentDisk

Name Description Value
mountPath Mount path of the persistent disk string
sizeInGB Size of the persistent disk in GB int

Constraints:
Min value = 0
Max value = 50

TemporaryDisk

Name Description Value
mountPath Mount path of the temporary disk string
sizeInGB Size of the temporary disk in GB int

Constraints:
Min value = 0
Max value = 5

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/apps resource type can be deployed with operations that target:

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

Resource format

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

{
  "type": "Microsoft.AppPlatform/Spring/apps",
  "apiVersion": "2022-04-01",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "addonConfigs": {
      "{customized property}": {
        "{customized property}": {}
      }
    },
    "enableEndToEndTLS": "bool",
    "fqdn": "string",
    "httpsOnly": "bool",
    "loadedCertificates": [
      {
        "loadTrustStore": "bool",
        "resourceId": "string"
      }
    ],
    "persistentDisk": {
      "mountPath": "string",
      "sizeInGB": "int"
    },
    "public": "bool",
    "temporaryDisk": {
      "mountPath": "string",
      "sizeInGB": "int"
    }
  }
}

Property Values

AddonProfile

Name Description Value

AppResourceProperties

Name Description Value
addonConfigs Collection of addons AppResourcePropertiesAddonConfigs
enableEndToEndTLS Indicate if end to end TLS is enabled. bool
fqdn Fully qualified dns Name. string
httpsOnly Indicate if only https is allowed. bool
loadedCertificates Collection of loaded certificates LoadedCertificate[]
persistentDisk Persistent disk settings PersistentDisk
public Indicates whether the App exposes public endpoint bool
temporaryDisk Temporary disk settings TemporaryDisk

AppResourcePropertiesAddonConfigs

Name Description Value

LoadedCertificate

Name Description Value
loadTrustStore Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. bool
resourceId Resource Id of loaded certificate string (required)

ManagedIdentityProperties

Name Description Value
principalId Principal Id of system-assigned managed identity. string
tenantId Tenant Id of system-assigned managed identity. string
type Type of the managed identity 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'

Microsoft.AppPlatform/Spring/apps

Name Description Value
apiVersion The api version '2022-04-01'
identity The Managed Identity type of the app resource ManagedIdentityProperties
location The GEO location of the application, always the same with its parent resource string
name The resource name string (required)
properties Properties of the App resource AppResourceProperties
type The resource type 'Microsoft.AppPlatform/Spring/apps'

PersistentDisk

Name Description Value
mountPath Mount path of the persistent disk string
sizeInGB Size of the persistent disk in GB int

Constraints:
Min value = 0
Max value = 50

TemporaryDisk

Name Description Value
mountPath Mount path of the temporary disk string
sizeInGB Size of the temporary disk in GB int

Constraints:
Min value = 0
Max value = 5

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Deploy a simple Azure Spring Apps microservice application

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

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring/apps@2022-04-01"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
  }
  location = "string"
  body = jsonencode({
    properties = {
      addonConfigs = {
        {customized property} = {
          {customized property} = ?
        }
      }
      enableEndToEndTLS = bool
      fqdn = "string"
      httpsOnly = bool
      loadedCertificates = [
        {
          loadTrustStore = bool
          resourceId = "string"
        }
      ]
      persistentDisk = {
        mountPath = "string"
        sizeInGB = int
      }
      public = bool
      temporaryDisk = {
        mountPath = "string"
        sizeInGB = int
      }
    }
  })
}

Property Values

AddonProfile

Name Description Value

AppResourceProperties

Name Description Value
addonConfigs Collection of addons AppResourcePropertiesAddonConfigs
enableEndToEndTLS Indicate if end to end TLS is enabled. bool
fqdn Fully qualified dns Name. string
httpsOnly Indicate if only https is allowed. bool
loadedCertificates Collection of loaded certificates LoadedCertificate[]
persistentDisk Persistent disk settings PersistentDisk
public Indicates whether the App exposes public endpoint bool
temporaryDisk Temporary disk settings TemporaryDisk

AppResourcePropertiesAddonConfigs

Name Description Value

LoadedCertificate

Name Description Value
loadTrustStore Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. bool
resourceId Resource Id of loaded certificate string (required)

ManagedIdentityProperties

Name Description Value
principalId Principal Id of system-assigned managed identity. string
tenantId Tenant Id of system-assigned managed identity. string
type Type of the managed identity 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'

Microsoft.AppPlatform/Spring/apps

Name Description Value
identity The Managed Identity type of the app resource ManagedIdentityProperties
location The GEO location of the application, always the same with its parent resource string
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: Spring
properties Properties of the App resource AppResourceProperties
type The resource type "Microsoft.AppPlatform/Spring/apps@2022-04-01"

PersistentDisk

Name Description Value
mountPath Mount path of the persistent disk string
sizeInGB Size of the persistent disk in GB int

Constraints:
Min value = 0
Max value = 50

TemporaryDisk

Name Description Value
mountPath Mount path of the temporary disk string
sizeInGB Size of the temporary disk in GB int

Constraints:
Min value = 0
Max value = 5