Microsoft.AppPlatform Spring
- 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 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 resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.AppPlatform/Spring@2024-05-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
identity: {
type: 'string'
}
properties: {
infraResourceGroup: 'string'
maintenanceScheduleConfiguration: {
frequency: 'string'
// For remaining properties, see MaintenanceScheduleConfiguration objects
}
managedEnvironmentId: 'string'
marketplaceResource: {
plan: 'string'
product: 'string'
publisher: 'string'
}
networkProfile: {
appNetworkResourceGroup: 'string'
appSubnetId: 'string'
ingressConfig: {
readTimeoutInSeconds: int
}
outboundType: 'string'
serviceCidr: 'string'
serviceRuntimeNetworkResourceGroup: 'string'
serviceRuntimeSubnetId: 'string'
}
vnetAddons: {
dataPlanePublicEndpoint: bool
logStreamPublicEndpoint: bool
privateDnsZoneId: 'string'
privateStorageAccess: 'string'
}
zoneRedundant: bool
}
}
MaintenanceScheduleConfiguration objects
Set the frequency property to specify the type of object.
For Weekly, use:
frequency: 'Weekly'
day: 'string'
hour: int
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 |
| identity | Managed Identity of the Service resource | SystemAssignedServiceIdentity |
| properties | Properties of the Service resource | ClusterResourceProperties |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | 'None' 'SystemAssigned' (required) |
ClusterResourceProperties
| Name | Description | Value |
|---|---|---|
| infraResourceGroup | The name of the resource group that contains the infrastructure resources | string |
| maintenanceScheduleConfiguration | Additional Service settings for planned maintenance | MaintenanceScheduleConfiguration |
| managedEnvironmentId | The resource Id of the Managed Environment that the Spring Apps instance builds on | string |
| 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 |
MaintenanceScheduleConfiguration
| Name | Description | Value |
|---|---|---|
| frequency | Set the object type | Weekly (required) |
WeeklyMaintenanceScheduleConfiguration
| Name | Description | Value |
|---|---|---|
| frequency | The frequency to run the maintenance job | 'Weekly' (required) |
| day | The day to run the maintenance job | 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' (required) |
| hour | The hour to run the maintenance job | int (required) Constraints: Min value = 0 Max value = 23 |
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 |
| outboundType | The egress traffic type of Azure Spring Apps VNet instances. | string |
| 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 |
|---|---|---|
| dataPlanePublicEndpoint | Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet. | bool |
| logStreamPublicEndpoint | Indicates whether the log stream in vnet injection instance could be accessed from internet. | bool |
| privateDnsZoneId | Fully qualified resource Id of the Private DNS zone to link with the customer virtual network. | string |
| privateStorageAccess | Indicates whether the vnet injection service enables private links for backend storage account and container registry. | 'Disabled' 'Enabled' |
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 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 resource, add the following JSON to your template.
{
"type": "Microsoft.AppPlatform/Spring",
"apiVersion": "2024-05-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"identity": {
"type": "string"
},
"properties": {
"infraResourceGroup": "string",
"maintenanceScheduleConfiguration": {
"frequency": "string"
// For remaining properties, see MaintenanceScheduleConfiguration objects
},
"managedEnvironmentId": "string",
"marketplaceResource": {
"plan": "string",
"product": "string",
"publisher": "string"
},
"networkProfile": {
"appNetworkResourceGroup": "string",
"appSubnetId": "string",
"ingressConfig": {
"readTimeoutInSeconds": "int"
},
"outboundType": "string",
"serviceCidr": "string",
"serviceRuntimeNetworkResourceGroup": "string",
"serviceRuntimeSubnetId": "string"
},
"vnetAddons": {
"dataPlanePublicEndpoint": "bool",
"logStreamPublicEndpoint": "bool",
"privateDnsZoneId": "string",
"privateStorageAccess": "string"
},
"zoneRedundant": "bool"
}
}
MaintenanceScheduleConfiguration objects
Set the frequency property to specify the type of object.
For Weekly, use:
"frequency": "Weekly",
"day": "string",
"hour": "int"
Property values
Spring
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.AppPlatform/Spring' |
| apiVersion | The resource api version | '2024-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 |
| identity | Managed Identity of the Service resource | SystemAssignedServiceIdentity |
| properties | Properties of the Service resource | ClusterResourceProperties |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | 'None' 'SystemAssigned' (required) |
ClusterResourceProperties
| Name | Description | Value |
|---|---|---|
| infraResourceGroup | The name of the resource group that contains the infrastructure resources | string |
| maintenanceScheduleConfiguration | Additional Service settings for planned maintenance | MaintenanceScheduleConfiguration |
| managedEnvironmentId | The resource Id of the Managed Environment that the Spring Apps instance builds on | string |
| 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 |
MaintenanceScheduleConfiguration
| Name | Description | Value |
|---|---|---|
| frequency | Set the object type | Weekly (required) |
WeeklyMaintenanceScheduleConfiguration
| Name | Description | Value |
|---|---|---|
| frequency | The frequency to run the maintenance job | 'Weekly' (required) |
| day | The day to run the maintenance job | 'Friday' 'Monday' 'Saturday' 'Sunday' 'Thursday' 'Tuesday' 'Wednesday' (required) |
| hour | The hour to run the maintenance job | int (required) Constraints: Min value = 0 Max value = 23 |
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 |
| outboundType | The egress traffic type of Azure Spring Apps VNet instances. | string |
| 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 |
|---|---|---|
| dataPlanePublicEndpoint | Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet. | bool |
| logStreamPublicEndpoint | Indicates whether the log stream in vnet injection instance could be accessed from internet. | bool |
| privateDnsZoneId | Fully qualified resource Id of the Private DNS zone to link with the customer virtual network. | string |
| privateStorageAccess | Indicates whether the vnet injection service enables private links for backend storage account and container registry. | 'Disabled' 'Enabled' |
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 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@2024-05-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
infraResourceGroup = "string"
maintenanceScheduleConfiguration = {
frequency = "string"
// For remaining properties, see MaintenanceScheduleConfiguration objects
}
managedEnvironmentId = "string"
marketplaceResource = {
plan = "string"
product = "string"
publisher = "string"
}
networkProfile = {
appNetworkResourceGroup = "string"
appSubnetId = "string"
ingressConfig = {
readTimeoutInSeconds = int
}
outboundType = "string"
serviceCidr = "string"
serviceRuntimeNetworkResourceGroup = "string"
serviceRuntimeSubnetId = "string"
}
vnetAddons = {
dataPlanePublicEndpoint = bool
logStreamPublicEndpoint = bool
privateDnsZoneId = "string"
privateStorageAccess = "string"
}
zoneRedundant = bool
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
MaintenanceScheduleConfiguration objects
Set the frequency property to specify the type of object.
For Weekly, use:
frequency = "Weekly"
day = "string"
hour = int
Property values
Spring
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.AppPlatform/Spring@2024-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 |
| identity | Managed Identity of the Service resource | SystemAssignedServiceIdentity |
| properties | Properties of the Service resource | ClusterResourceProperties |
SystemAssignedServiceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (either system assigned, or none). | "SystemAssigned" (required) |
ClusterResourceProperties
| Name | Description | Value |
|---|---|---|
| infraResourceGroup | The name of the resource group that contains the infrastructure resources | string |
| maintenanceScheduleConfiguration | Additional Service settings for planned maintenance | MaintenanceScheduleConfiguration |
| managedEnvironmentId | The resource Id of the Managed Environment that the Spring Apps instance builds on | string |
| 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 |
MaintenanceScheduleConfiguration
| Name | Description | Value |
|---|---|---|
| frequency | Set the object type | Weekly (required) |
WeeklyMaintenanceScheduleConfiguration
| Name | Description | Value |
|---|---|---|
| frequency | The frequency to run the maintenance job | "Weekly" (required) |
| day | The day to run the maintenance job | "Friday" "Monday" "Saturday" "Sunday" "Thursday" "Tuesday" "Wednesday" (required) |
| hour | The hour to run the maintenance job | int (required) Constraints: Min value = 0 Max value = 23 |
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 |
| outboundType | The egress traffic type of Azure Spring Apps VNet instances. | string |
| 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 |
|---|---|---|
| dataPlanePublicEndpoint | Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet. | bool |
| logStreamPublicEndpoint | Indicates whether the log stream in vnet injection instance could be accessed from internet. | bool |
| privateDnsZoneId | Fully qualified resource Id of the Private DNS zone to link with the customer virtual network. | string |
| privateStorageAccess | Indicates whether the vnet injection service enables private links for backend storage account and container registry. | "Disabled" "Enabled" |
Sku
| Name | Description | Value |
|---|---|---|
| capacity | Current capacity of the target resource | int |
| name | Name of the Sku | string |
| tier | Tier of the Sku | string |