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 Application Deployments (Microsoft.AppPlatform/Spring/apps/deployments) 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/deployments 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/deployments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2020-07-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
deploymentSettings: {
cpu: int
environmentVariables: {
{customized property}: 'string'
}
jvmOptions: 'string'
memoryInGB: int
netCoreMainEntryPath: 'string'
runtimeVersion: 'string'
}
source: {
artifactSelector: 'string'
relativePath: 'string'
type: 'string'
version: 'string'
}
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
}
Property Values
Microsoft.AppPlatform/Spring/apps/deployments
| Name | Description | Value |
|---|---|---|
| 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/apps |
| properties | Properties of the Deployment resource | DeploymentResourceProperties |
| sku | Sku of the Deployment resource | Sku |
DeploymentResourceProperties
| Name | Description | Value |
|---|---|---|
| deploymentSettings | Deployment settings of the Deployment | DeploymentSettings |
| source | Uploaded source information of the deployment. | UserSourceInfo |
DeploymentSettings
| Name | Description | Value |
|---|---|---|
| cpu | Required CPU, basic tier should be 1, standard tier should be in range (1, 4) | int |
| environmentVariables | Collection of environment variables | DeploymentSettingsEnvironmentVariables |
| jvmOptions | JVM parameter | string |
| memoryInGB | Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8) | int |
| netCoreMainEntryPath | The path to the .NET executable relative to zip root | string |
| runtimeVersion | Runtime version | 'Java_11' 'Java_8' 'NetCore_31' |
DeploymentSettingsEnvironmentVariables
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
UserSourceInfo
| Name | Description | Value |
|---|---|---|
| artifactSelector | Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project. |
string |
| relativePath | Relative path of the storage which stores the source | string |
| type | Type of the source uploaded | 'Jar' 'NetCoreZip' 'Source' |
| version | Version of the source | string |
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/deployments 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/deployments resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/apps/deployments",
"apiVersion": "2020-07-01",
"name": "string",
"properties": {
"deploymentSettings": {
"cpu": "int",
"environmentVariables": {
"{customized property}": "string"
},
"jvmOptions": "string",
"memoryInGB": "int",
"netCoreMainEntryPath": "string",
"runtimeVersion": "string"
},
"source": {
"artifactSelector": "string",
"relativePath": "string",
"type": "string",
"version": "string"
}
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
}
}
Property Values
Microsoft.AppPlatform/Spring/apps/deployments
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-07-01' |
| name | The resource name | string (required) |
| properties | Properties of the Deployment resource | DeploymentResourceProperties |
| sku | Sku of the Deployment resource | Sku |
| type | The resource type | 'Microsoft.AppPlatform/Spring/apps/deployments' |
DeploymentResourceProperties
| Name | Description | Value |
|---|---|---|
| deploymentSettings | Deployment settings of the Deployment | DeploymentSettings |
| source | Uploaded source information of the deployment. | UserSourceInfo |
DeploymentSettings
| Name | Description | Value |
|---|---|---|
| cpu | Required CPU, basic tier should be 1, standard tier should be in range (1, 4) | int |
| environmentVariables | Collection of environment variables | DeploymentSettingsEnvironmentVariables |
| jvmOptions | JVM parameter | string |
| memoryInGB | Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8) | int |
| netCoreMainEntryPath | The path to the .NET executable relative to zip root | string |
| runtimeVersion | Runtime version | 'Java_11' 'Java_8' 'NetCore_31' |
DeploymentSettingsEnvironmentVariables
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
UserSourceInfo
| Name | Description | Value |
|---|---|---|
| artifactSelector | Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project. |
string |
| relativePath | Relative path of the storage which stores the source | string |
| type | Type of the source uploaded | 'Jar' 'NetCoreZip' 'Source' |
| version | Version of the source | string |
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/deployments 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/deployments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apps/deployments@2020-07-01"
name = "string"
parent_id = "string"
body = {
properties = {
deploymentSettings = {
cpu = int
environmentVariables = {
{customized property} = "string"
}
jvmOptions = "string"
memoryInGB = int
netCoreMainEntryPath = "string"
runtimeVersion = "string"
}
source = {
artifactSelector = "string"
relativePath = "string"
type = "string"
version = "string"
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.AppPlatform/Spring/apps/deployments
| Name | Description | Value |
|---|---|---|
| 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/apps |
| properties | Properties of the Deployment resource | DeploymentResourceProperties |
| sku | Sku of the Deployment resource | Sku |
| type | The resource type | "Microsoft.AppPlatform/Spring/apps/deployments@2020-07-01" |
DeploymentResourceProperties
| Name | Description | Value |
|---|---|---|
| deploymentSettings | Deployment settings of the Deployment | DeploymentSettings |
| source | Uploaded source information of the deployment. | UserSourceInfo |
DeploymentSettings
| Name | Description | Value |
|---|---|---|
| cpu | Required CPU, basic tier should be 1, standard tier should be in range (1, 4) | int |
| environmentVariables | Collection of environment variables | DeploymentSettingsEnvironmentVariables |
| jvmOptions | JVM parameter | string |
| memoryInGB | Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8) | int |
| netCoreMainEntryPath | The path to the .NET executable relative to zip root | string |
| runtimeVersion | Runtime version | 'Java_11' 'Java_8' 'NetCore_31' |
DeploymentSettingsEnvironmentVariables
| Name | Description | Value |
|---|
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
UserSourceInfo
| Name | Description | Value |
|---|---|---|
| artifactSelector | Selector for the artifact to be used for the deployment for multi-module projects. This should be the relative path to the target module/project. |
string |
| relativePath | Relative path of the storage which stores the source | string |
| type | Type of the source uploaded | 'Jar' 'NetCoreZip' 'Source' |
| version | Version of the source | string |
Usage Examples
Terraform Samples
A basic example of deploying Spring Cloud Deployment.
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 = ["*"]
}
resource "azapi_resource" "deployment" {
type = "Microsoft.AppPlatform/Spring/apps/deployments@2023-05-01-preview"
parent_id = azapi_resource.app.id
name = var.resource_name
body = {
properties = {
deploymentSettings = {
environmentVariables = {
}
}
source = {
customContainer = {
args = [
]
command = [
]
containerImage = "springio/gs-spring-boot-docker"
languageFramework = ""
server = "docker.io"
}
type = "Container"
}
}
sku = {
capacity = 1
name = "E0"
tier = "Enterprise"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}