Share via

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

  • Article

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@2021-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deploymentSettings: {
      containerProbeSettings: {
        disableProbe: bool
      }
      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

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

DeploymentResourceProperties

Name Description Value
deploymentSettings Deployment settings of the Deployment DeploymentSettings
source Uploaded source information of the deployment. UserSourceInfo

DeploymentSettings

Name Description Value
containerProbeSettings Container liveness and readiness probe settings DeploymentSettingsContainerProbeSettings
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-09-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-09-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'

DeploymentSettingsContainerProbeSettings

Name Description Value
disableProbe Indicates whether disable the liveness and readiness probe bool

DeploymentSettingsEnvironmentVariables

Name Description Value

ImageRegistryCredential

Name Description Value
password The password of the image registry credential string
username The username of the image registry credential string

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

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

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
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

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": "2021-09-01-preview",
  "name": "string",
  "properties": {
    "deploymentSettings": {
      "containerProbeSettings": {
        "disableProbe": "bool"
      },
      "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

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

DeploymentResourceProperties

Name Description Value
deploymentSettings Deployment settings of the Deployment DeploymentSettings
source Uploaded source information of the deployment. UserSourceInfo

DeploymentSettings

Name Description Value
containerProbeSettings Container liveness and readiness probe settings DeploymentSettingsContainerProbeSettings
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-09-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-09-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'

DeploymentSettingsContainerProbeSettings

Name Description Value
disableProbe Indicates whether disable the liveness and readiness probe bool

DeploymentSettingsEnvironmentVariables

Name Description Value

ImageRegistryCredential

Name Description Value
password The password of the image registry credential string
username The username of the image registry credential string

Microsoft.AppPlatform/Spring/apps/deployments

Name Description Value
apiVersion The api version '2021-09-01-preview'
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'

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

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
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

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/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-09-01-preview"
  name = "string"
  body = {
    properties = {
      deploymentSettings = {
        containerProbeSettings = {
          disableProbe = bool
        }
        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

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

DeploymentResourceProperties

Name Description Value
deploymentSettings Deployment settings of the Deployment DeploymentSettings
source Uploaded source information of the deployment. UserSourceInfo

DeploymentSettings

Name Description Value
containerProbeSettings Container liveness and readiness probe settings DeploymentSettingsContainerProbeSettings
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-09-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-09-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'

DeploymentSettingsContainerProbeSettings

Name Description Value
disableProbe Indicates whether disable the liveness and readiness probe bool

DeploymentSettingsEnvironmentVariables

Name Description Value

ImageRegistryCredential

Name Description Value
password The password of the image registry credential string
username The username of the image registry credential string

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@2021-09-01-preview"

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

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
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