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.
- Latest
- 2024-05-01-preview
- 2024-01-01-preview
- 2023-12-01
- 2023-11-01-preview
- 2023-09-01-preview
- 2023-07-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2023-01-01-preview
- 2022-12-01
- 2022-11-01-preview
- 2022-09-01-preview
- 2022-05-01-preview
- 2022-04-01
- 2022-03-01-preview
- 2022-01-01-preview
- 2021-09-01-preview
- 2021-06-01-preview
- 2020-11-01-preview
- 2020-07-01
Remarks
Note: Azure Spring Apps Applications (Microsoft.AppPlatform/Spring/apps) is now deprecated and will be retired on 2028-05-31. See https://aka.ms/asaretirement for more information.
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@2020-07-01' = {
parent: resourceSymbolicName
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
activeDeploymentName: 'string'
fqdn: 'string'
httpsOnly: bool
persistentDisk: {
mountPath: 'string'
sizeInGB: int
}
public: bool
temporaryDisk: {
mountPath: 'string'
sizeInGB: int
}
}
}
Property Values
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 |
AppResourceProperties
| Name | Description | Value |
|---|---|---|
| activeDeploymentName | Name of the active deployment of the App | string |
| fqdn | Fully qualified dns Name. | string |
| httpsOnly | Indicate if only https is allowed. | bool |
| persistentDisk | Persistent disk settings | PersistentDisk |
| public | Indicates whether the App exposes public endpoint | bool |
| temporaryDisk | Temporary disk settings | TemporaryDisk |
ManagedIdentityProperties
| Name | Description | Value |
|---|---|---|
| principalId | Principal Id | string |
| tenantId | Tenant Id | string |
| type | Type of the managed identity | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
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": "2020-07-01",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string"
},
"location": "string",
"properties": {
"activeDeploymentName": "string",
"fqdn": "string",
"httpsOnly": "bool",
"persistentDisk": {
"mountPath": "string",
"sizeInGB": "int"
},
"public": "bool",
"temporaryDisk": {
"mountPath": "string",
"sizeInGB": "int"
}
}
}
Property Values
Microsoft.AppPlatform/Spring/apps
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-07-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' |
AppResourceProperties
| Name | Description | Value |
|---|---|---|
| activeDeploymentName | Name of the active deployment of the App | string |
| fqdn | Fully qualified dns Name. | string |
| httpsOnly | Indicate if only https is allowed. | bool |
| persistentDisk | Persistent disk settings | PersistentDisk |
| public | Indicates whether the App exposes public endpoint | bool |
| temporaryDisk | Temporary disk settings | TemporaryDisk |
ManagedIdentityProperties
| Name | Description | Value |
|---|---|---|
| principalId | Principal Id | string |
| tenantId | Tenant Id | string |
| type | Type of the managed identity | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
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 |
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:
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@2020-07-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
body = {
properties = {
activeDeploymentName = "string"
fqdn = "string"
httpsOnly = bool
persistentDisk = {
mountPath = "string"
sizeInGB = int
}
public = bool
temporaryDisk = {
mountPath = "string"
sizeInGB = int
}
}
}
}
Property Values
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@2020-07-01" |
AppResourceProperties
| Name | Description | Value |
|---|---|---|
| activeDeploymentName | Name of the active deployment of the App | string |
| fqdn | Fully qualified dns Name. | string |
| httpsOnly | Indicate if only https is allowed. | bool |
| persistentDisk | Persistent disk settings | PersistentDisk |
| public | Indicates whether the App exposes public endpoint | bool |
| temporaryDisk | Temporary disk settings | TemporaryDisk |
ManagedIdentityProperties
| Name | Description | Value |
|---|---|---|
| principalId | Principal Id | string |
| tenantId | Tenant Id | string |
| type | Type of the managed identity | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' |
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
Terraform Samples
A basic example of deploying an Azure Spring Cloud Application.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "Spring" {
type = "Microsoft.AppPlatform/Spring@2023-05-01-preview"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
zoneRedundant = false
}
sku = {
name = "E0"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "app" {
type = "Microsoft.AppPlatform/Spring/apps@2023-05-01-preview"
parent_id = azapi_resource.Spring.id
name = var.resource_name
location = var.location
body = {
properties = {
customPersistentDisks = [
]
enableEndToEndTLS = false
public = false
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}