Microsoft.ContainerRegistry registries/buildTasks/steps 2018-02-01-preview

Bicep resource definition

The registries/buildTasks/steps 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.ContainerRegistry/registries/buildTasks/steps resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ContainerRegistry/registries/buildTasks/steps@2018-02-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    type: 'string'
    // For remaining properties, see BuildStepProperties objects
  }
}

BuildStepProperties objects

Set the type property to specify the type of object.

For Docker, use:

  type: 'Docker'
  baseImageTrigger: 'string'
  branch: 'string'
  buildArguments: [
    {
      isSecret: bool
      name: 'string'
      type: 'DockerBuildArgument'
      value: 'string'
    }
  ]
  contextPath: 'string'
  dockerFilePath: 'string'
  imageNames: [
    'string'
  ]
  isPushEnabled: bool
  noCache: bool

Property values

registries/buildTasks/steps

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)

Character limit: 5-50

Valid characters:
Alphanumerics.
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: buildTasks
properties The properties of a build step. BuildStepProperties

BuildStepProperties

Name Description Value
type Set the object type Docker (required)

DockerBuildStep

Name Description Value
type The type of the step. 'Docker' (required)
baseImageTrigger The type of the auto trigger for base image dependency updates. 'All'
'None'
'Runtime'
branch The repository branch name. string
buildArguments The custom arguments for building this build step. BuildArgument[]
contextPath The relative context path for a docker build in the source. string
dockerFilePath The Docker file path relative to the source control root. string
imageNames The fully qualified image names including the repository and tag. string[]
isPushEnabled The value of this property indicates whether the image built should be pushed to the registry or not. bool
noCache The value of this property indicates whether the image cache is enabled or not. bool

BuildArgument

Name Description Value
isSecret Flag to indicate whether the argument represents a secret and want to be removed from build logs. bool
name The name of the argument. string (required)
type The type of the argument. 'DockerBuildArgument' (required)
value The value of the argument. string (required)

ARM template resource definition

The registries/buildTasks/steps 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.ContainerRegistry/registries/buildTasks/steps resource, add the following JSON to your template.

{
  "type": "Microsoft.ContainerRegistry/registries/buildTasks/steps",
  "apiVersion": "2018-02-01-preview",
  "name": "string",
  "properties": {
    "type": "string"
    // For remaining properties, see BuildStepProperties objects
  }
}

BuildStepProperties objects

Set the type property to specify the type of object.

For Docker, use:

  "type": "Docker",
  "baseImageTrigger": "string",
  "branch": "string",
  "buildArguments": [
    {
      "isSecret": "bool",
      "name": "string",
      "type": "DockerBuildArgument",
      "value": "string"
    }
  ],
  "contextPath": "string",
  "dockerFilePath": "string",
  "imageNames": [ "string" ],
  "isPushEnabled": "bool",
  "noCache": "bool"

Property values

registries/buildTasks/steps

Name Description Value
type The resource type 'Microsoft.ContainerRegistry/registries/buildTasks/steps'
apiVersion The resource api version '2018-02-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)

Character limit: 5-50

Valid characters:
Alphanumerics.
properties The properties of a build step. BuildStepProperties

BuildStepProperties

Name Description Value
type Set the object type Docker (required)

DockerBuildStep

Name Description Value
type The type of the step. 'Docker' (required)
baseImageTrigger The type of the auto trigger for base image dependency updates. 'All'
'None'
'Runtime'
branch The repository branch name. string
buildArguments The custom arguments for building this build step. BuildArgument[]
contextPath The relative context path for a docker build in the source. string
dockerFilePath The Docker file path relative to the source control root. string
imageNames The fully qualified image names including the repository and tag. string[]
isPushEnabled The value of this property indicates whether the image built should be pushed to the registry or not. bool
noCache The value of this property indicates whether the image cache is enabled or not. bool

BuildArgument

Name Description Value
isSecret Flag to indicate whether the argument represents a secret and want to be removed from build logs. bool
name The name of the argument. string (required)
type The type of the argument. 'DockerBuildArgument' (required)
value The value of the argument. string (required)

Terraform (AzAPI provider) resource definition

The registries/buildTasks/steps 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.ContainerRegistry/registries/buildTasks/steps resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerRegistry/registries/buildTasks/steps@2018-02-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      type = "string"
      // For remaining properties, see BuildStepProperties objects
    }
  })
}

BuildStepProperties objects

Set the type property to specify the type of object.

For Docker, use:

  type = "Docker"
  baseImageTrigger = "string"
  branch = "string"
  buildArguments = [
    {
      isSecret = bool
      name = "string"
      type = "DockerBuildArgument"
      value = "string"
    }
  ]
  contextPath = "string"
  dockerFilePath = "string"
  imageNames = [
    "string"
  ]
  isPushEnabled = bool
  noCache = bool

Property values

registries/buildTasks/steps

Name Description Value
type The resource type "Microsoft.ContainerRegistry/registries/buildTasks/steps@2018-02-01-preview"
name The resource name string (required)

Character limit: 5-50

Valid characters:
Alphanumerics.
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: buildTasks
properties The properties of a build step. BuildStepProperties

BuildStepProperties

Name Description Value
type Set the object type Docker (required)

DockerBuildStep

Name Description Value
type The type of the step. "Docker" (required)
baseImageTrigger The type of the auto trigger for base image dependency updates. "All"
"None"
"Runtime"
branch The repository branch name. string
buildArguments The custom arguments for building this build step. BuildArgument[]
contextPath The relative context path for a docker build in the source. string
dockerFilePath The Docker file path relative to the source control root. string
imageNames The fully qualified image names including the repository and tag. string[]
isPushEnabled The value of this property indicates whether the image built should be pushed to the registry or not. bool
noCache The value of this property indicates whether the image cache is enabled or not. bool

BuildArgument

Name Description Value
isSecret Flag to indicate whether the argument represents a secret and want to be removed from build logs. bool
name The name of the argument. string (required)
type The type of the argument. "DockerBuildArgument" (required)
value The value of the argument. string (required)