Microsoft.App managedEnvironments/javaComponents 2024-08-02-preview

• Latest
• 2024-10-02-preview
• 2024-08-02-preview
• 2024-02-02-preview
• 2023-11-02-preview

Bicep resource definition

The managedEnvironments/javaComponents 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.App/managedEnvironments/javaComponents resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.App/managedEnvironments/javaComponents@2024-08-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    configurations: [
      {
        propertyName: 'string'
        value: 'string'
      }
    ]
    scale: {
      maxReplicas: int
      minReplicas: int
    }
    serviceBinds: [
      {
        name: 'string'
        serviceId: 'string'
      }
    ]
    componentType: 'string'
    // For remaining properties, see JavaComponentProperties objects
  }
}

JavaComponentProperties objects

Set the componentType property to specify the type of object.

For Nacos, use:

{
  componentType: 'Nacos'
  ingress: {}
}

For SpringBootAdmin, use:

{
  componentType: 'SpringBootAdmin'
  ingress: {}
}

For SpringCloudConfig, use:

{
  componentType: 'SpringCloudConfig'
}

For SpringCloudEureka, use:

{
  componentType: 'SpringCloudEureka'
  ingress: {}
}

For SpringCloudGateway, use:

{
  componentType: 'SpringCloudGateway'
  ingress: {}
  springCloudGatewayRoutes: [
    {
      filters: [
        'string'
      ]
      id: 'string'
      order: int
      predicates: [
        'string'
      ]
      uri: 'string'
    }
  ]
}

Property values

JavaComponentConfigurationProperty

Name	Description	Value
propertyName	The name of the property	string
value	The value of the property	string

JavaComponentIngress

Name	Description	Value

JavaComponentProperties

Name	Description	Value
componentType	Set to 'Nacos' for type NacosComponent. Set to 'SpringBootAdmin' for type SpringBootAdminComponent. Set to 'SpringCloudConfig' for type SpringCloudConfigComponent. Set to 'SpringCloudEureka' for type SpringCloudEurekaComponent. Set to 'SpringCloudGateway' for type SpringCloudGatewayComponent.	'Nacos' 'SpringBootAdmin' 'SpringCloudConfig' 'SpringCloudEureka' 'SpringCloudGateway' (required)
configurations	List of Java Components configuration properties	JavaComponentConfigurationProperty[]
scale	Java component scaling configurations	JavaComponentPropertiesScale
serviceBinds	List of Java Components that are bound to the Java component	JavaComponentServiceBind[]

JavaComponentPropertiesScale

Name	Description	Value
maxReplicas	Optional. Maximum number of Java component replicas	int
minReplicas	Optional. Minimum number of Java component replicas. Defaults to 1 if not set	int

JavaComponentServiceBind

Name	Description	Value
name	Name of the service bind	string
serviceId	Resource id of the target service	string

Microsoft.App/managedEnvironments/javaComponents

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[-\w\._\(\)]+$ (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: managedEnvironments
properties	Java Component resource specific properties	JavaComponentProperties

NacosComponent

Name	Description	Value
componentType	Type of the Java Component.	'Nacos' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

ScgRoute

Name	Description	Value
filters	Filters of the route	string[]
id	Id of the route	string (required)
order	Order of the route	int
predicates	Predicates of the route	string[]
uri	Uri of the route	string (required)

SpringBootAdminComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringBootAdmin' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

SpringCloudConfigComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudConfig' (required)

SpringCloudEurekaComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudEureka' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

SpringCloudGatewayComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudGateway' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress
springCloudGatewayRoutes	Gateway route definition	ScgRoute[]

ARM template resource definition

The managedEnvironments/javaComponents 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.App/managedEnvironments/javaComponents resource, add the following JSON to your template.

{
  "type": "Microsoft.App/managedEnvironments/javaComponents",
  "apiVersion": "2024-08-02-preview",
  "name": "string",
  "properties": {
    "configurations": [
      {
        "propertyName": "string",
        "value": "string"
      }
    ],
    "scale": {
      "maxReplicas": "int",
      "minReplicas": "int"
    },
    "serviceBinds": [
      {
        "name": "string",
        "serviceId": "string"
      }
    ],
    "componentType": "string"
    // For remaining properties, see JavaComponentProperties objects
  }
}

JavaComponentProperties objects

Set the componentType property to specify the type of object.

For Nacos, use:

{
  "componentType": "Nacos",
  "ingress": {
  }
}

For SpringBootAdmin, use:

{
  "componentType": "SpringBootAdmin",
  "ingress": {
  }
}

For SpringCloudConfig, use:

{
  "componentType": "SpringCloudConfig"
}

For SpringCloudEureka, use:

{
  "componentType": "SpringCloudEureka",
  "ingress": {
  }
}

For SpringCloudGateway, use:

{
  "componentType": "SpringCloudGateway",
  "ingress": {
  },
  "springCloudGatewayRoutes": [
    {
      "filters": [ "string" ],
      "id": "string",
      "order": "int",
      "predicates": [ "string" ],
      "uri": "string"
    }
  ]
}

Property values

JavaComponentConfigurationProperty

Name	Description	Value
propertyName	The name of the property	string
value	The value of the property	string

JavaComponentIngress

Name	Description	Value

JavaComponentProperties

Name	Description	Value
componentType	Set to 'Nacos' for type NacosComponent. Set to 'SpringBootAdmin' for type SpringBootAdminComponent. Set to 'SpringCloudConfig' for type SpringCloudConfigComponent. Set to 'SpringCloudEureka' for type SpringCloudEurekaComponent. Set to 'SpringCloudGateway' for type SpringCloudGatewayComponent.	'Nacos' 'SpringBootAdmin' 'SpringCloudConfig' 'SpringCloudEureka' 'SpringCloudGateway' (required)
configurations	List of Java Components configuration properties	JavaComponentConfigurationProperty[]
scale	Java component scaling configurations	JavaComponentPropertiesScale
serviceBinds	List of Java Components that are bound to the Java component	JavaComponentServiceBind[]

JavaComponentPropertiesScale

Name	Description	Value
maxReplicas	Optional. Maximum number of Java component replicas	int
minReplicas	Optional. Minimum number of Java component replicas. Defaults to 1 if not set	int

JavaComponentServiceBind

Name	Description	Value
name	Name of the service bind	string
serviceId	Resource id of the target service	string

Microsoft.App/managedEnvironments/javaComponents

Name	Description	Value
apiVersion	The api version	'2024-08-02-preview'
name	The resource name	string Constraints: Pattern = ^[-\w\._\(\)]+$ (required)
properties	Java Component resource specific properties	JavaComponentProperties
type	The resource type	'Microsoft.App/managedEnvironments/javaComponents'

NacosComponent

Name	Description	Value
componentType	Type of the Java Component.	'Nacos' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

ScgRoute

Name	Description	Value
filters	Filters of the route	string[]
id	Id of the route	string (required)
order	Order of the route	int
predicates	Predicates of the route	string[]
uri	Uri of the route	string (required)

SpringBootAdminComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringBootAdmin' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

SpringCloudConfigComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudConfig' (required)

SpringCloudEurekaComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudEureka' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

SpringCloudGatewayComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudGateway' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress
springCloudGatewayRoutes	Gateway route definition	ScgRoute[]

Terraform (AzAPI provider) resource definition

The managedEnvironments/javaComponents 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.App/managedEnvironments/javaComponents resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/managedEnvironments/javaComponents@2024-08-02-preview"
  name = "string"
  body = jsonencode({
    properties = {
      configurations = [
        {
          propertyName = "string"
          value = "string"
        }
      ]
      scale = {
        maxReplicas = int
        minReplicas = int
      }
      serviceBinds = [
        {
          name = "string"
          serviceId = "string"
        }
      ]
      componentType = "string"
      // For remaining properties, see JavaComponentProperties objects
    }
  })
}

JavaComponentProperties objects

Set the componentType property to specify the type of object.

For Nacos, use:

{
  componentType = "Nacos"
  ingress = {
  }
}

For SpringBootAdmin, use:

{
  componentType = "SpringBootAdmin"
  ingress = {
  }
}

For SpringCloudConfig, use:

{
  componentType = "SpringCloudConfig"
}

For SpringCloudEureka, use:

{
  componentType = "SpringCloudEureka"
  ingress = {
  }
}

For SpringCloudGateway, use:

{
  componentType = "SpringCloudGateway"
  ingress = {
  }
  springCloudGatewayRoutes = [
    {
      filters = [
        "string"
      ]
      id = "string"
      order = int
      predicates = [
        "string"
      ]
      uri = "string"
    }
  ]
}

Property values

JavaComponentConfigurationProperty

Name	Description	Value
propertyName	The name of the property	string
value	The value of the property	string

JavaComponentIngress

Name	Description	Value

JavaComponentProperties

Name	Description	Value
componentType	Set to 'Nacos' for type NacosComponent. Set to 'SpringBootAdmin' for type SpringBootAdminComponent. Set to 'SpringCloudConfig' for type SpringCloudConfigComponent. Set to 'SpringCloudEureka' for type SpringCloudEurekaComponent. Set to 'SpringCloudGateway' for type SpringCloudGatewayComponent.	'Nacos' 'SpringBootAdmin' 'SpringCloudConfig' 'SpringCloudEureka' 'SpringCloudGateway' (required)
configurations	List of Java Components configuration properties	JavaComponentConfigurationProperty[]
scale	Java component scaling configurations	JavaComponentPropertiesScale
serviceBinds	List of Java Components that are bound to the Java component	JavaComponentServiceBind[]

JavaComponentPropertiesScale

Name	Description	Value
maxReplicas	Optional. Maximum number of Java component replicas	int
minReplicas	Optional. Minimum number of Java component replicas. Defaults to 1 if not set	int

JavaComponentServiceBind

Name	Description	Value
name	Name of the service bind	string
serviceId	Resource id of the target service	string

Microsoft.App/managedEnvironments/javaComponents

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[-\w\._\(\)]+$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: managedEnvironments
properties	Java Component resource specific properties	JavaComponentProperties
type	The resource type	"Microsoft.App/managedEnvironments/javaComponents@2024-08-02-preview"

NacosComponent

Name	Description	Value
componentType	Type of the Java Component.	'Nacos' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

ScgRoute

Name	Description	Value
filters	Filters of the route	string[]
id	Id of the route	string (required)
order	Order of the route	int
predicates	Predicates of the route	string[]
uri	Uri of the route	string (required)

SpringBootAdminComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringBootAdmin' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

SpringCloudConfigComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudConfig' (required)

SpringCloudEurekaComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudEureka' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress

SpringCloudGatewayComponent

Name	Description	Value
componentType	Type of the Java Component.	'SpringCloudGateway' (required)
ingress	Java Component Ingress configurations.	JavaComponentIngress
springCloudGatewayRoutes	Gateway route definition	ScgRoute[]