Microsoft.App builders 2023-11-02-preview

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

Bicep resource definition

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

resource symbolicname 'Microsoft.App/builders@2023-11-02-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    containerRegistries: [
      {
        containerRegistryServer: 'string'
        identityResourceId: 'string'
      }
    ]
    environmentId: 'string'
  }
}

Property values

builders

Name	Description	Value
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
properties	The resource-specific properties for this resource.	BuilderProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

BuilderProperties

Name	Description	Value
containerRegistries	List of mappings of container registries and the managed identity used to connect to it.	ContainerRegistry[]
environmentId	Resource ID of the container apps environment that the builder is associated with.	string (required)

ContainerRegistry

Name	Description	Value
containerRegistryServer	Login server of the container registry.	string (required)
identityResourceId	Resource ID of the managed identity.	string (required)

ARM template resource definition

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

{
  "type": "Microsoft.App/builders",
  "apiVersion": "2023-11-02-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "containerRegistries": [
      {
        "containerRegistryServer": "string",
        "identityResourceId": "string"
      }
    ],
    "environmentId": "string"
  }
}

Property values

builders

Name	Description	Value
type	The resource type	'Microsoft.App/builders'
apiVersion	The resource api version	'2023-11-02-preview'
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
properties	The resource-specific properties for this resource.	BuilderProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

BuilderProperties

Name	Description	Value
containerRegistries	List of mappings of container registries and the managed identity used to connect to it.	ContainerRegistry[]
environmentId	Resource ID of the container apps environment that the builder is associated with.	string (required)

ContainerRegistry

Name	Description	Value
containerRegistryServer	Login server of the container registry.	string (required)
identityResourceId	Resource ID of the managed identity.	string (required)

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.App/builders@2023-11-02-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      containerRegistries = [
        {
          containerRegistryServer = "string"
          identityResourceId = "string"
        }
      ]
      environmentId = "string"
    }
  })
}

Property values

builders

Name	Description	Value
type	The resource type	"Microsoft.App/builders@2023-11-02-preview"
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
parent_id	To deploy to a resource group, use the ID of that resource group.	string (required)
tags	Resource tags.	Dictionary of tag names and values.
identity	The managed service identities assigned to this resource.	ManagedServiceIdentity
properties	The resource-specific properties for this resource.	BuilderProperties

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	"SystemAssigned" "SystemAssigned,UserAssigned" "UserAssigned" (required)
identity_ids	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	Array of user identity IDs.

UserAssignedIdentities

Name	Description	Value
{customized property}		UserAssignedIdentity

UserAssignedIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

BuilderProperties

Name	Description	Value
containerRegistries	List of mappings of container registries and the managed identity used to connect to it.	ContainerRegistry[]
environmentId	Resource ID of the container apps environment that the builder is associated with.	string (required)

ContainerRegistry

Name	Description	Value
containerRegistryServer	Login server of the container registry.	string (required)
identityResourceId	Resource ID of the managed identity.	string (required)