ARM Template

Deploys an Azure Resource Manager template to Microsoft Azure.

Object Representation (YAML)

id: String
name: String
type: String
depends: [String]
tags: [String]
condition: Boolean
each: Array
while: String
until: String
verbosity: String
ignore_errors: Boolean
tool_options: Object
properties:
  name: String
  resource_group: String
  incremental: Boolean
  template_content: String
  template_path: String
  template_url: String
  parameters_content: String
  parameters_path: String
  parameters_url: String
  credential: String

Fields

Property Details
id *

String

A unique identifier for the step.

Can contain hyphens and underscores, but not spaces.
name *

String

A friendly name for the step. This name will appear in the pipeline designer and run output.
type *

String

The type of the step. Can be pipeline or a step module type.
depends[]

[String]

A list of dependencies of this step.

This step will not be executed until all steps with ids in this list are finished executing.
tags[]

[String]

Tags are used to group related steps. Steps with the same tag can be retrieved using the findStepsByTag() helper function.

Can contain hyphens and underscores, but not spaces.
condition

Boolean

An expression which is evaluated before the step executes. If it evaluates to false, the step will be skipped. The step.result.status field will be "Skipped".
each

Array

An expression which evaluates to an array. It is evaluated once before the first iteration. There will be one iteration for each element of the array. An empty array ([]) will results in no iterations being executed.
while

String

A boolean expression evaluated before each iteration. When the expression evaluates to false, iteration stops. If false before the first iteration, no iterations will be executed.
until

String

A boolean expression evaluated after each iteration. When the expression evaluates to true, iteration stops. The first iteration will always be excuted with no regard for the value of the expression.
verbosity

String

Step event verbosity. Determines how much information about step execution is sent back to the application.
ignore_errors

Boolean

If true, errors in the step module will not halt pipeline execution, and subsequent steps will still be executed. The step.result.status field will be "Failed" if the step encounters an error.
tool_options

Object

-

properties.name *

String

Name of the ARM deployment. This name will appear in the "Deployments" section of the Azure portal.
properties.resource_group *

String

Name of the resource group where the deployment will be created.
properties.incremental *

Boolean

If true, deploys the template in Incremental mode, which will not destroy resources that are not included in the template.
properties.template_content

String

Inline ARM template content. Provide exactly one of template_content, template_path, or template_url.
properties.template_path

String

Path to an existing ARM template on the agent. Provide exactly one of template_content, template_path, or template_url.
properties.template_url

String

Public URL of an existing ARM template. The template will be downloaded by Azure. Provide exactly one of template_content, template_path, or template_url.
properties.parameters_content

String

Inline ARM parameters content. Provide exactly one of parameters_content, parameters_path, or parameters_url.
properties.parameters_path

String

Path to an existing ARM parameters file on the agent. Provide exactly one of parameters_content, parameters_path, or parameters_url.
properties.parameters_url

String

Public URL of an existing ARM parameters file. The parameters will be downloaded by Azure, which means you cannot use expressions in your parameters file when using this option. Provide exactly one of parameters_content, parameters_path, or parameters_url.
properties.credential *

String

The ID of an Azure Service Principal credential. See here for more information.

Result Fields

The following are the step execution result fields available at steps.<step id>.result after a step executes.

Key Details
result.status

String

A string indicating the step execution status. Can be Succeeded, Failed, or Skipped.
result.outputs

Object

The evaluated ARM template outputs. Access a given output value with result.outputs.my_output.value.