Microsoft.App builders/builds

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

Bicep resource definition

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

resource symbolicname 'Microsoft.App/builders/builds@2024-10-02-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    configuration: {
      baseOs: 'string'
      environmentVariables: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      platform: 'string'
      platformVersion: 'string'
      preBuildSteps: [
        {
          description: 'string'
          httpGet: {
            fileName: 'string'
            headers: [
              'string'
            ]
            url: 'string'
          }
          scripts: [
            'string'
          ]
        }
      ]
    }
    destinationContainerRegistry: {
      image: 'string'
      server: 'string'
    }
  }
}

Property values

BuildConfiguration

Name	Description	Value
baseOs	Base OS used to build and run the app.	string
environmentVariables	List of environment variables to be passed to the build, secrets should not be used in environment variable.	EnvironmentVariable[]
platform	Platform to be used to build and run the app.	string
platformVersion	Platform version to be used to build and run the app.	string
preBuildSteps	List of steps to perform before the build.	PreBuildStep[]

BuildProperties

Name	Description	Value
configuration	Configuration of the build.	BuildConfiguration
destinationContainerRegistry	Container registry that the final image will be uploaded to.	ContainerRegistryWithCustomImage

ContainerRegistryWithCustomImage

Name	Description	Value
image	Full name that the final image should be uploaded as, including both image name and tag.	string
server	Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it.	string (required)

EnvironmentVariable

Name	Description	Value
name	Environment variable name.	string (required)
value	Environment variable value.	string (required)

HttpGet

Name	Description	Value
fileName	Name of the file that the request should be saved to.	string
headers	List of headers to send with the request.	string[]
url	URL to make HTTP GET request against.	string (required)

Microsoft.App/builders/builds

Name	Description	Value
name	The resource name	string Constraints: Min length = 2 Max length = 2 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: builders
properties	The resource-specific properties for this resource.	BuildProperties

PreBuildStep

Name	Description	Value
description	Description of the pre-build step.	string
httpGet	Http get request to send before the build.	HttpGet
scripts	List of custom commands to run.	string[]

ARM template resource definition

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

{
  "type": "Microsoft.App/builders/builds",
  "apiVersion": "2024-10-02-preview",
  "name": "string",
  "properties": {
    "configuration": {
      "baseOs": "string",
      "environmentVariables": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "platform": "string",
      "platformVersion": "string",
      "preBuildSteps": [
        {
          "description": "string",
          "httpGet": {
            "fileName": "string",
            "headers": [ "string" ],
            "url": "string"
          },
          "scripts": [ "string" ]
        }
      ]
    },
    "destinationContainerRegistry": {
      "image": "string",
      "server": "string"
    }
  }
}

Property values

BuildConfiguration

Name	Description	Value
baseOs	Base OS used to build and run the app.	string
environmentVariables	List of environment variables to be passed to the build, secrets should not be used in environment variable.	EnvironmentVariable[]
platform	Platform to be used to build and run the app.	string
platformVersion	Platform version to be used to build and run the app.	string
preBuildSteps	List of steps to perform before the build.	PreBuildStep[]

BuildProperties

Name	Description	Value
configuration	Configuration of the build.	BuildConfiguration
destinationContainerRegistry	Container registry that the final image will be uploaded to.	ContainerRegistryWithCustomImage

ContainerRegistryWithCustomImage

Name	Description	Value
image	Full name that the final image should be uploaded as, including both image name and tag.	string
server	Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it.	string (required)

EnvironmentVariable

Name	Description	Value
name	Environment variable name.	string (required)
value	Environment variable value.	string (required)

HttpGet

Name	Description	Value
fileName	Name of the file that the request should be saved to.	string
headers	List of headers to send with the request.	string[]
url	URL to make HTTP GET request against.	string (required)

Microsoft.App/builders/builds

Name	Description	Value
apiVersion	The api version	'2024-10-02-preview'
name	The resource name	string Constraints: Min length = 2 Max length = 2 Pattern = ^[-\w\._\(\)]+$ (required)
properties	The resource-specific properties for this resource.	BuildProperties
type	The resource type	'Microsoft.App/builders/builds'

PreBuildStep

Name	Description	Value
description	Description of the pre-build step.	string
httpGet	Http get request to send before the build.	HttpGet
scripts	List of custom commands to run.	string[]

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/builders/builds@2024-10-02-preview"
  name = "string"
  body = jsonencode({
    properties = {
      configuration = {
        baseOs = "string"
        environmentVariables = [
          {
            name = "string"
            value = "string"
          }
        ]
        platform = "string"
        platformVersion = "string"
        preBuildSteps = [
          {
            description = "string"
            httpGet = {
              fileName = "string"
              headers = [
                "string"
              ]
              url = "string"
            }
            scripts = [
              "string"
            ]
          }
        ]
      }
      destinationContainerRegistry = {
        image = "string"
        server = "string"
      }
    }
  })
}

Property values

BuildConfiguration

Name	Description	Value
baseOs	Base OS used to build and run the app.	string
environmentVariables	List of environment variables to be passed to the build, secrets should not be used in environment variable.	EnvironmentVariable[]
platform	Platform to be used to build and run the app.	string
platformVersion	Platform version to be used to build and run the app.	string
preBuildSteps	List of steps to perform before the build.	PreBuildStep[]

BuildProperties

Name	Description	Value
configuration	Configuration of the build.	BuildConfiguration
destinationContainerRegistry	Container registry that the final image will be uploaded to.	ContainerRegistryWithCustomImage

ContainerRegistryWithCustomImage

Name	Description	Value
image	Full name that the final image should be uploaded as, including both image name and tag.	string
server	Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it.	string (required)

EnvironmentVariable

Name	Description	Value
name	Environment variable name.	string (required)
value	Environment variable value.	string (required)

HttpGet

Name	Description	Value
fileName	Name of the file that the request should be saved to.	string
headers	List of headers to send with the request.	string[]
url	URL to make HTTP GET request against.	string (required)

Microsoft.App/builders/builds

Name	Description	Value
name	The resource name	string Constraints: Min length = 2 Max length = 2 Pattern = ^[-\w\._\(\)]+$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: builders
properties	The resource-specific properties for this resource.	BuildProperties
type	The resource type	"Microsoft.App/builders/builds@2024-10-02-preview"

PreBuildStep

Name	Description	Value
description	Description of the pre-build step.	string
httpGet	Http get request to send before the build.	HttpGet
scripts	List of custom commands to run.	string[]