Microsoft.AppPlatform Spring 2022-05-01-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.AppPlatform/Spring@2022-05-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  properties: {
    marketplaceResource: {
      plan: 'string'
      product: 'string'
      publisher: 'string'
    }
    networkProfile: {
      appNetworkResourceGroup: 'string'
      appSubnetId: 'string'
      ingressConfig: {
        readTimeoutInSeconds: int
      }
      serviceCidr: 'string'
      serviceRuntimeNetworkResourceGroup: 'string'
      serviceRuntimeSubnetId: 'string'
    }
    vnetAddons: {
      logStreamPublicEndpoint: bool
    }
    zoneRedundant: bool
  }
}

Property values

Spring

Name Description Value
name The resource name string (required)

Character limit: 4-32

Valid characters:
Lowercase letters, numbers, and hyphens.

Resource name must be unique across Azure.
location The GEO location of the resource. string
tags Tags of the service which is a list of key value pairs that describe the resource. Dictionary of tag names and values. See Tags in templates
sku Sku of the Service resource Sku
properties Properties of the Service resource ClusterResourceProperties

ClusterResourceProperties

Name Description Value
marketplaceResource Purchasing 3rd party product of the Service resource. MarketplaceResource
networkProfile Network profile of the Service NetworkProfile
vnetAddons Additional Service settings in vnet injection instance ServiceVNetAddons
zoneRedundant bool

MarketplaceResource

Name Description Value
plan The plan id of the 3rd Party Artifact that is being procured. string
product The 3rd Party artifact that is being procured. string
publisher The publisher id of the 3rd Party Artifact that is being bought. string

NetworkProfile

Name Description Value
appNetworkResourceGroup Name of the resource group containing network resources for customer apps in Azure Spring Apps string
appSubnetId Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps string
ingressConfig Ingress configuration payload for Azure Spring Apps resource. IngressConfig
serviceCidr Azure Spring Apps service reserved CIDR string
serviceRuntimeNetworkResourceGroup Name of the resource group containing network resources of Azure Spring Apps Service Runtime string
serviceRuntimeSubnetId Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime string

IngressConfig

Name Description Value
readTimeoutInSeconds Ingress read time out in seconds. int

ServiceVNetAddons

Name Description Value
logStreamPublicEndpoint Indicates whether the log stream in vnet injection instance could be accessed from internet. bool

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

Deploy to Azure
This template deploys a simple Azure Spring Apps microservice application to run on Azure.

ARM template resource definition

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

{
  "type": "Microsoft.AppPlatform/Spring",
  "apiVersion": "2022-05-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "marketplaceResource": {
      "plan": "string",
      "product": "string",
      "publisher": "string"
    },
    "networkProfile": {
      "appNetworkResourceGroup": "string",
      "appSubnetId": "string",
      "ingressConfig": {
        "readTimeoutInSeconds": "int"
      },
      "serviceCidr": "string",
      "serviceRuntimeNetworkResourceGroup": "string",
      "serviceRuntimeSubnetId": "string"
    },
    "vnetAddons": {
      "logStreamPublicEndpoint": "bool"
    },
    "zoneRedundant": "bool"
  }
}

Property values

Spring

Name Description Value
type The resource type 'Microsoft.AppPlatform/Spring'
apiVersion The resource api version '2022-05-01-preview'
name The resource name string (required)

Character limit: 4-32

Valid characters:
Lowercase letters, numbers, and hyphens.

Resource name must be unique across Azure.
location The GEO location of the resource. string
tags Tags of the service which is a list of key value pairs that describe the resource. Dictionary of tag names and values. See Tags in templates
sku Sku of the Service resource Sku
properties Properties of the Service resource ClusterResourceProperties

ClusterResourceProperties

Name Description Value
marketplaceResource Purchasing 3rd party product of the Service resource. MarketplaceResource
networkProfile Network profile of the Service NetworkProfile
vnetAddons Additional Service settings in vnet injection instance ServiceVNetAddons
zoneRedundant bool

MarketplaceResource

Name Description Value
plan The plan id of the 3rd Party Artifact that is being procured. string
product The 3rd Party artifact that is being procured. string
publisher The publisher id of the 3rd Party Artifact that is being bought. string

NetworkProfile

Name Description Value
appNetworkResourceGroup Name of the resource group containing network resources for customer apps in Azure Spring Apps string
appSubnetId Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps string
ingressConfig Ingress configuration payload for Azure Spring Apps resource. IngressConfig
serviceCidr Azure Spring Apps service reserved CIDR string
serviceRuntimeNetworkResourceGroup Name of the resource group containing network resources of Azure Spring Apps Service Runtime string
serviceRuntimeSubnetId Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime string

IngressConfig

Name Description Value
readTimeoutInSeconds Ingress read time out in seconds. int

ServiceVNetAddons

Name Description Value
logStreamPublicEndpoint Indicates whether the log stream in vnet injection instance could be accessed from internet. bool

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

Deploy to Azure
This template deploys a simple Azure Spring Apps microservice application to run on Azure.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AppPlatform/Spring@2022-05-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      marketplaceResource = {
        plan = "string"
        product = "string"
        publisher = "string"
      }
      networkProfile = {
        appNetworkResourceGroup = "string"
        appSubnetId = "string"
        ingressConfig = {
          readTimeoutInSeconds = int
        }
        serviceCidr = "string"
        serviceRuntimeNetworkResourceGroup = "string"
        serviceRuntimeSubnetId = "string"
      }
      vnetAddons = {
        logStreamPublicEndpoint = bool
      }
      zoneRedundant = bool
    }
    sku = {
      capacity = int
      name = "string"
      tier = "string"
    }
  })
}

Property values

Spring

Name Description Value
type The resource type "Microsoft.AppPlatform/Spring@2022-05-01-preview"
name The resource name string (required)

Character limit: 4-32

Valid characters:
Lowercase letters, numbers, and hyphens.

Resource name must be unique across Azure.
location The GEO location of the resource. string
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Tags of the service which is a list of key value pairs that describe the resource. Dictionary of tag names and values.
sku Sku of the Service resource Sku
properties Properties of the Service resource ClusterResourceProperties

ClusterResourceProperties

Name Description Value
marketplaceResource Purchasing 3rd party product of the Service resource. MarketplaceResource
networkProfile Network profile of the Service NetworkProfile
vnetAddons Additional Service settings in vnet injection instance ServiceVNetAddons
zoneRedundant bool

MarketplaceResource

Name Description Value
plan The plan id of the 3rd Party Artifact that is being procured. string
product The 3rd Party artifact that is being procured. string
publisher The publisher id of the 3rd Party Artifact that is being bought. string

NetworkProfile

Name Description Value
appNetworkResourceGroup Name of the resource group containing network resources for customer apps in Azure Spring Apps string
appSubnetId Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps string
ingressConfig Ingress configuration payload for Azure Spring Apps resource. IngressConfig
serviceCidr Azure Spring Apps service reserved CIDR string
serviceRuntimeNetworkResourceGroup Name of the resource group containing network resources of Azure Spring Apps Service Runtime string
serviceRuntimeSubnetId Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime string

IngressConfig

Name Description Value
readTimeoutInSeconds Ingress read time out in seconds. int

ServiceVNetAddons

Name Description Value
logStreamPublicEndpoint Indicates whether the log stream in vnet injection instance could be accessed from internet. bool

Sku

Name Description Value
capacity Current capacity of the target resource int
name Name of the Sku string
tier Tier of the Sku string