Microsoft.AppPlatform Spring/apps 2021-09-01-preview

Article
08/15/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.AppPlatform/Spring/apps@2021-09-01-preview' = {
  name: 'string'
  location: 'string'
  parent: resourceSymbolicName
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
  }
  properties: {
    activeDeploymentName: 'string'
    customPersistentDisks: [
      {
        customPersistentDiskProperties: {
          mountOptions: [
            'string'
          ]
          mountPath: 'string'
          readOnly: bool
          type: 'string'
          // For remaining properties, see CustomPersistentDiskProperties objects
        }
        storageId: 'string'
      }
    ]
    enableEndToEndTLS: bool
    fqdn: 'string'
    httpsOnly: bool
    loadedCertificates: [
      {
        loadTrustStore: bool
        resourceId: 'string'
      }
    ]
    persistentDisk: {
      mountPath: 'string'
      sizeInGB: int
    }
    public: bool
    temporaryDisk: {
      mountPath: 'string'
      sizeInGB: int
    }
  }
}

CustomPersistentDiskProperties objects

Set the type property to specify the type of object.

For AzureFileVolume, use:

  type: 'AzureFileVolume'
  shareName: 'string'

Property values

Spring/apps

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
location	The GEO location of the application, always the same with its parent resource	string
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
identity	The Managed Identity type of the app resource	ManagedIdentityProperties
properties	Properties of the App resource	AppResourceProperties

ManagedIdentityProperties

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

AppResourceProperties

Name	Description	Value
activeDeploymentName	Name of the active deployment of the App	string
customPersistentDisks	List of custom persistent disks	CustomPersistentDiskResource[]
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

CustomPersistentDiskResource

Name	Description	Value
customPersistentDiskProperties	Properties of the custom persistent disk resource payload.	CustomPersistentDiskProperties
storageId	The resource id of Azure Spring Cloud Storage resource.	string (required)

CustomPersistentDiskProperties

Name	Description	Value
mountOptions	These are the mount options for a persistent disk.	string[]
mountPath	The mount path of the persistent disk.	string (required)
readOnly	Indicates whether the persistent disk is a readOnly one.	bool
type	Set the object type	AzureFileVolume (required)

AzureFileVolume

Name	Description	Value
type	The type of the underlying resource to mount as a persistent disk.	'AzureFileVolume' (required)
shareName	The share name of the Azure File share.	string (required)

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)

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

Quickstart templates

The following 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.

ARM template resource definition

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

{
  "type": "Microsoft.AppPlatform/Spring/apps",
  "apiVersion": "2021-09-01-preview",
  "name": "string",
  "location": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string"
  },
  "properties": {
    "activeDeploymentName": "string",
    "customPersistentDisks": [
      {
        "customPersistentDiskProperties": {
          "mountOptions": [ "string" ],
          "mountPath": "string",
          "readOnly": "bool",
          "type": "string"
          // For remaining properties, see CustomPersistentDiskProperties objects
        },
        "storageId": "string"
      }
    ],
    "enableEndToEndTLS": "bool",
    "fqdn": "string",
    "httpsOnly": "bool",
    "loadedCertificates": [
      {
        "loadTrustStore": "bool",
        "resourceId": "string"
      }
    ],
    "persistentDisk": {
      "mountPath": "string",
      "sizeInGB": "int"
    },
    "public": "bool",
    "temporaryDisk": {
      "mountPath": "string",
      "sizeInGB": "int"
    }
  }
}

CustomPersistentDiskProperties objects

Set the type property to specify the type of object.

For AzureFileVolume, use:

  "type": "AzureFileVolume",
  "shareName": "string"

Property values

Spring/apps

Name	Description	Value
type	The resource type	'Microsoft.AppPlatform/Spring/apps'
apiVersion	The resource api version	'2021-09-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	The GEO location of the application, always the same with its parent resource	string
identity	The Managed Identity type of the app resource	ManagedIdentityProperties
properties	Properties of the App resource	AppResourceProperties

ManagedIdentityProperties

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

AppResourceProperties

Name	Description	Value
activeDeploymentName	Name of the active deployment of the App	string
customPersistentDisks	List of custom persistent disks	CustomPersistentDiskResource[]
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

CustomPersistentDiskResource

Name	Description	Value
customPersistentDiskProperties	Properties of the custom persistent disk resource payload.	CustomPersistentDiskProperties
storageId	The resource id of Azure Spring Cloud Storage resource.	string (required)

CustomPersistentDiskProperties

Name	Description	Value
mountOptions	These are the mount options for a persistent disk.	string[]
mountPath	The mount path of the persistent disk.	string (required)
readOnly	Indicates whether the persistent disk is a readOnly one.	bool
type	Set the object type	AzureFileVolume (required)

AzureFileVolume

Name	Description	Value
type	The type of the underlying resource to mount as a persistent disk.	'AzureFileVolume' (required)
shareName	The share name of the Azure File share.	string (required)

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)

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

Quickstart templates

The following 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/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@2021-09-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  identity {
    type = "string"
  }
  body = jsonencode({
    properties = {
      activeDeploymentName = "string"
      customPersistentDisks = [
        {
          customPersistentDiskProperties = {
            mountOptions = [
              "string"
            ]
            mountPath = "string"
            readOnly = bool
            type = "string"
            // For remaining properties, see CustomPersistentDiskProperties objects
          }
          storageId = "string"
        }
      ]
      enableEndToEndTLS = bool
      fqdn = "string"
      httpsOnly = bool
      loadedCertificates = [
        {
          loadTrustStore = bool
          resourceId = "string"
        }
      ]
      persistentDisk = {
        mountPath = "string"
        sizeInGB = int
      }
      public = bool
      temporaryDisk = {
        mountPath = "string"
        sizeInGB = int
      }
    }
  })
}

CustomPersistentDiskProperties objects

Set the type property to specify the type of object.

For AzureFileVolume, use:

  type = "AzureFileVolume"
  shareName = "string"

Property values

Spring/apps

Name	Description	Value
type	The resource type	"Microsoft.AppPlatform/Spring/apps@2021-09-01-preview"
name	The resource name	string (required)
location	The GEO location of the application, always the same with its parent resource	string
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: Spring
identity	The Managed Identity type of the app resource	ManagedIdentityProperties
properties	Properties of the App resource	AppResourceProperties

ManagedIdentityProperties

Name	Description	Value
type	Type of the managed identity	"SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned"

AppResourceProperties

Name	Description	Value
activeDeploymentName	Name of the active deployment of the App	string
customPersistentDisks	List of custom persistent disks	CustomPersistentDiskResource[]
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

CustomPersistentDiskResource

Name	Description	Value
customPersistentDiskProperties	Properties of the custom persistent disk resource payload.	CustomPersistentDiskProperties
storageId	The resource id of Azure Spring Cloud Storage resource.	string (required)

CustomPersistentDiskProperties

Name	Description	Value
mountOptions	These are the mount options for a persistent disk.	string[]
mountPath	The mount path of the persistent disk.	string (required)
readOnly	Indicates whether the persistent disk is a readOnly one.	bool
type	Set the object type	AzureFileVolume (required)

AzureFileVolume

Name	Description	Value
type	The type of the underlying resource to mount as a persistent disk.	"AzureFileVolume" (required)
shareName	The share name of the Azure File share.	string (required)

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)

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

Share via

Microsoft.AppPlatform Spring/apps 2021-09-01-preview

Bicep resource definition

Resource format

CustomPersistentDiskProperties objects

Property values

Spring/apps

ManagedIdentityProperties

AppResourceProperties

CustomPersistentDiskResource

CustomPersistentDiskProperties

AzureFileVolume

LoadedCertificate

PersistentDisk

TemporaryDisk

Quickstart templates

ARM template resource definition

Resource format

CustomPersistentDiskProperties objects

Property values

Spring/apps

ManagedIdentityProperties

AppResourceProperties

CustomPersistentDiskResource

CustomPersistentDiskProperties

AzureFileVolume

LoadedCertificate

PersistentDisk

TemporaryDisk

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

CustomPersistentDiskProperties objects

Property values

Spring/apps

ManagedIdentityProperties

AppResourceProperties

CustomPersistentDiskResource

CustomPersistentDiskProperties

AzureFileVolume

LoadedCertificate

PersistentDisk

TemporaryDisk

Feedback

Additional resources