Microsoft.AppPlatform Spring/apps/deployments 2021-06-01-preview
- 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
Bicep resource definition
The Spring/apps/deployments 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/deployments resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppPlatform/Spring/apps/deployments@2021-06-01-preview' = {
name: 'string'
sku: {
capacity: int
name: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
deploymentSettings: {
cpu: int
environmentVariables: {
{customized property}: 'string'
}
jvmOptions: 'string'
memoryInGB: int
netCoreMainEntryPath: 'string'
resourceRequests: {
cpu: 'string'
memory: 'string'
}
runtimeVersion: 'string'
}
source: {
artifactSelector: 'string'
customContainer: {
args: [
'string'
]
command: [
'string'
]
containerImage: 'string'
imageRegistryCredential: {
password: 'string'
username: 'string'
}
server: 'string'
}
relativePath: 'string'
type: 'string'
version: 'string'
}
}
}
Property values
Spring/apps/deployments
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| sku | Sku of the Deployment resource | Sku |
| 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: apps |
| properties | Properties of the Deployment resource | DeploymentResourceProperties |
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. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the CPU size. | int |
| environmentVariables | Collection of environment variables | DeploymentSettingsEnvironmentVariables |
| jvmOptions | JVM parameter | string |
| memoryInGB | Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the the memory size. | int |
| netCoreMainEntryPath | The path to the .NET executable relative to zip root | string |
| resourceRequests | The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later. | ResourceRequests |
| runtimeVersion | Runtime version | 'Java_11' 'Java_8' 'NetCore_31' |
DeploymentSettingsEnvironmentVariables
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ResourceRequests
| Name | Description | Value |
|---|---|---|
| cpu | Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. | string |
| memory | Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. | 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 |
| customContainer | Custom container payload | CustomContainer |
| relativePath | Relative path of the storage which stores the source | string |
| type | Type of the source uploaded | 'Container' 'Jar' 'NetCoreZip' 'Source' |
| version | Version of the source | string |
CustomContainer
| Name | Description | Value |
|---|---|---|
| args | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. | string[] |
| command | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. | string[] |
| containerImage | Container image of the custom container. This should be in the form of {repository}:{tag} without the server name of the registry | string |
| imageRegistryCredential | Credential of the image registry | ImageRegistryCredential |
| server | The name of the registry that contains the container image | string |
ImageRegistryCredential
| Name | Description | Value |
|---|---|---|
| password | The password of the image registry credential | string |
| username | The username of the image registry credential | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
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/deployments 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/deployments resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring/apps/deployments",
"apiVersion": "2021-06-01-preview",
"name": "string",
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"properties": {
"deploymentSettings": {
"cpu": "int",
"environmentVariables": {
"{customized property}": "string"
},
"jvmOptions": "string",
"memoryInGB": "int",
"netCoreMainEntryPath": "string",
"resourceRequests": {
"cpu": "string",
"memory": "string"
},
"runtimeVersion": "string"
},
"source": {
"artifactSelector": "string",
"customContainer": {
"args": [ "string" ],
"command": [ "string" ],
"containerImage": "string",
"imageRegistryCredential": {
"password": "string",
"username": "string"
},
"server": "string"
},
"relativePath": "string",
"type": "string",
"version": "string"
}
}
}
Property values
Spring/apps/deployments
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.AppPlatform/Spring/apps/deployments' |
| apiVersion | The resource api version | '2021-06-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| sku | Sku of the Deployment resource | Sku |
| properties | Properties of the Deployment resource | DeploymentResourceProperties |
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. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the CPU size. | int |
| environmentVariables | Collection of environment variables | DeploymentSettingsEnvironmentVariables |
| jvmOptions | JVM parameter | string |
| memoryInGB | Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the the memory size. | int |
| netCoreMainEntryPath | The path to the .NET executable relative to zip root | string |
| resourceRequests | The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later. | ResourceRequests |
| runtimeVersion | Runtime version | 'Java_11' 'Java_8' 'NetCore_31' |
DeploymentSettingsEnvironmentVariables
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ResourceRequests
| Name | Description | Value |
|---|---|---|
| cpu | Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. | string |
| memory | Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. | 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 |
| customContainer | Custom container payload | CustomContainer |
| relativePath | Relative path of the storage which stores the source | string |
| type | Type of the source uploaded | 'Container' 'Jar' 'NetCoreZip' 'Source' |
| version | Version of the source | string |
CustomContainer
| Name | Description | Value |
|---|---|---|
| args | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. | string[] |
| command | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. | string[] |
| containerImage | Container image of the custom container. This should be in the form of {repository}:{tag} without the server name of the registry | string |
| imageRegistryCredential | Credential of the image registry | ImageRegistryCredential |
| server | The name of the registry that contains the container image | string |
ImageRegistryCredential
| Name | Description | Value |
|---|---|---|
| password | The password of the image registry credential | string |
| username | The username of the image registry credential | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |
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/deployments 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/deployments resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.AppPlatform/Spring/apps/deployments@2021-06-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deploymentSettings = {
cpu = int
environmentVariables = {
{customized property} = "string"
}
jvmOptions = "string"
memoryInGB = int
netCoreMainEntryPath = "string"
resourceRequests = {
cpu = "string"
memory = "string"
}
runtimeVersion = "string"
}
source = {
artifactSelector = "string"
customContainer = {
args = [
"string"
]
command = [
"string"
]
containerImage = "string"
imageRegistryCredential = {
password = "string"
username = "string"
}
server = "string"
}
relativePath = "string"
type = "string"
version = "string"
}
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
Property values
Spring/apps/deployments
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.AppPlatform/Spring/apps/deployments@2021-06-01-preview" |
| 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: apps |
| sku | Sku of the Deployment resource | Sku |
| properties | Properties of the Deployment resource | DeploymentResourceProperties |
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. This should be 1 for Basic tier, and in range [1, 4] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the CPU size. | int |
| environmentVariables | Collection of environment variables | DeploymentSettingsEnvironmentVariables |
| jvmOptions | JVM parameter | string |
| memoryInGB | Required Memory size in GB. This should be in range [1, 2] for Basic tier, and in range [1, 8] for Standard tier. This is deprecated starting from API version 2021-06-01-preview. Please use the resourceRequests field to set the the memory size. | int |
| netCoreMainEntryPath | The path to the .NET executable relative to zip root | string |
| resourceRequests | The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later. | ResourceRequests |
| runtimeVersion | Runtime version | "Java_11" "Java_8" "NetCore_31" |
DeploymentSettingsEnvironmentVariables
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ResourceRequests
| Name | Description | Value |
|---|---|---|
| cpu | Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. | string |
| memory | Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. | 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 |
| customContainer | Custom container payload | CustomContainer |
| relativePath | Relative path of the storage which stores the source | string |
| type | Type of the source uploaded | "Container" "Jar" "NetCoreZip" "Source" |
| version | Version of the source | string |
CustomContainer
| Name | Description | Value |
|---|---|---|
| args | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. | string[] |
| command | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. | string[] |
| containerImage | Container image of the custom container. This should be in the form of {repository}:{tag} without the server name of the registry | string |
| imageRegistryCredential | Credential of the image registry | ImageRegistryCredential |
| server | The name of the registry that contains the container image | string |
ImageRegistryCredential
| Name | Description | Value |
|---|---|---|
| password | The password of the image registry credential | string |
| username | The username of the image registry credential | string |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |