Microsoft.DeploymentManager steps

Article
10/11/2022

Bicep resource definition

The steps resource type can be deployed to:

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

resource symbolicname 'Microsoft.DeploymentManager/steps@2019-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    stepType: 'string'
    // For remaining properties, see StepProperties objects
  }
}

StepProperties objects

Set the stepType property to specify the type of object.

For HealthCheck, use:

  stepType: 'HealthCheck'
  attributes: {
    healthyStateDuration: 'string'
    maxElasticDuration: 'string'
    waitDuration: 'string'
    type: 'string'
    // For remaining properties, see HealthCheckStepAttributes objects
  }

For Wait, use:

  stepType: 'Wait'
  attributes: {
    duration: 'string'
  }

HealthCheckStepAttributes objects

Set the type property to specify the type of object.

For REST, use:

  type: 'REST'
  properties: {
    healthChecks: [
      {
        name: 'string'
        request: {
          authentication: {
            type: 'string'
            // For remaining properties, see RestRequestAuthentication objects
          }
          method: 'string'
          uri: 'string'
        }
        response: {
          regex: {
            matches: [
              'string'
            ]
            matchQuantifier: 'string'
          }
          successStatusCodes: [
            'string'
          ]
        }
      }
    ]
  }

RestRequestAuthentication objects

Set the type property to specify the type of object.

For ApiKey, use:

  type: 'ApiKey'
  in: 'string'
  name: 'string'
  value: 'string'

For RolloutIdentity, use:

  type: 'RolloutIdentity'

Property values

steps

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
properties	The properties that define the step.	StepProperties (required)

StepProperties

Name	Description	Value
stepType	Set the object type	HealthCheck Wait (required)

HealthCheckStepProperties

Name	Description	Value
stepType	The type of step.	'HealthCheck' (required)
attributes	The health check step attributes	HealthCheckStepAttributes (required)

HealthCheckStepAttributes

Name	Description	Value
healthyStateDuration	The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.	string (required)
maxElasticDuration	The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.	string
waitDuration	The duration in ISO 8601 format for which health check waits idly without any checks.	string
type	Set the object type	REST (required)

RestHealthCheckStepAttributes

Name	Description	Value
type	The type of health check.	'REST' (required)
properties	The REST health check parameters.	RestParameters

RestParameters

Name	Description	Value
healthChecks	The list of checks that form the health check step.	RestHealthCheck[] (required)

RestHealthCheck

Name	Description	Value
name	A unique name for this check.	string (required)
request	The request to the health provider.	RestRequest (required)
response	The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.	RestResponse

RestRequest

Name	Description	Value
authentication	The authentication information required in the request to the health provider.	RestRequestAuthentication (required)
method	The HTTP method to use for the request.	'GET' 'POST' (required)
uri	The HTTP URI to use for the request.	string (required)

RestRequestAuthentication

Name	Description	Value
type	Set the object type	ApiKey RolloutIdentity (required)

ApiKeyAuthentication

Name	Description	Value
type	The authentication type.	'ApiKey' (required)
in	The location of the authentication key/value pair in the request.	'Header' 'Query' (required)
name	The key name of the authentication key/value pair.	string (required)
value	The value of the authentication key/value pair.	string (required)

RolloutIdentityAuthentication

Name	Description	Value
type	The authentication type.	'RolloutIdentity' (required)

RestResponse

Name	Description	Value
regex	The regular expressions to match the response content with.	RestResponseRegex
successStatusCodes	The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.	string[]

RestResponseRegex

Name	Description	Value
matches	The list of regular expressions.	string[]
matchQuantifier	Indicates whether any or all of the expressions should match with the response content.	'All' 'Any'

WaitStepProperties

Name	Description	Value
stepType	The type of step.	'Wait' (required)
attributes	The Wait attributes	WaitStepAttributes (required)

WaitStepAttributes

Name	Description	Value
duration	The duration in ISO 8601 format of how long the wait should be.	string (required)

ARM template resource definition

The steps resource type can be deployed to:

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

{
  "type": "Microsoft.DeploymentManager/steps",
  "apiVersion": "2019-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "stepType": "string"
    // For remaining properties, see StepProperties objects
  }
}

StepProperties objects

Set the stepType property to specify the type of object.

For HealthCheck, use:

  "stepType": "HealthCheck",
  "attributes": {
    "healthyStateDuration": "string",
    "maxElasticDuration": "string",
    "waitDuration": "string",
    "type": "string"
    // For remaining properties, see HealthCheckStepAttributes objects
  }

For Wait, use:

  "stepType": "Wait",
  "attributes": {
    "duration": "string"
  }

HealthCheckStepAttributes objects

Set the type property to specify the type of object.

For REST, use:

  "type": "REST",
  "properties": {
    "healthChecks": [
      {
        "name": "string",
        "request": {
          "authentication": {
            "type": "string"
            // For remaining properties, see RestRequestAuthentication objects
          },
          "method": "string",
          "uri": "string"
        },
        "response": {
          "regex": {
            "matches": [ "string" ],
            "matchQuantifier": "string"
          },
          "successStatusCodes": [ "string" ]
        }
      }
    ]
  }

RestRequestAuthentication objects

Set the type property to specify the type of object.

For ApiKey, use:

  "type": "ApiKey",
  "in": "string",
  "name": "string",
  "value": "string"

For RolloutIdentity, use:

  "type": "RolloutIdentity"

Property values

steps

Name	Description	Value
type	The resource type	'Microsoft.DeploymentManager/steps'
apiVersion	The resource api version	'2019-11-01-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
properties	The properties that define the step.	StepProperties (required)

StepProperties

Name	Description	Value
stepType	Set the object type	HealthCheck Wait (required)

HealthCheckStepProperties

Name	Description	Value
stepType	The type of step.	'HealthCheck' (required)
attributes	The health check step attributes	HealthCheckStepAttributes (required)

HealthCheckStepAttributes

Name	Description	Value
healthyStateDuration	The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.	string (required)
maxElasticDuration	The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.	string
waitDuration	The duration in ISO 8601 format for which health check waits idly without any checks.	string
type	Set the object type	REST (required)

RestHealthCheckStepAttributes

Name	Description	Value
type	The type of health check.	'REST' (required)
properties	The REST health check parameters.	RestParameters

RestParameters

Name	Description	Value
healthChecks	The list of checks that form the health check step.	RestHealthCheck[] (required)

RestHealthCheck

Name	Description	Value
name	A unique name for this check.	string (required)
request	The request to the health provider.	RestRequest (required)
response	The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.	RestResponse

RestRequest

Name	Description	Value
authentication	The authentication information required in the request to the health provider.	RestRequestAuthentication (required)
method	The HTTP method to use for the request.	'GET' 'POST' (required)
uri	The HTTP URI to use for the request.	string (required)

RestRequestAuthentication

Name	Description	Value
type	Set the object type	ApiKey RolloutIdentity (required)

ApiKeyAuthentication

Name	Description	Value
type	The authentication type.	'ApiKey' (required)
in	The location of the authentication key/value pair in the request.	'Header' 'Query' (required)
name	The key name of the authentication key/value pair.	string (required)
value	The value of the authentication key/value pair.	string (required)

RolloutIdentityAuthentication

Name	Description	Value
type	The authentication type.	'RolloutIdentity' (required)

RestResponse

Name	Description	Value
regex	The regular expressions to match the response content with.	RestResponseRegex
successStatusCodes	The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.	string[]

RestResponseRegex

Name	Description	Value
matches	The list of regular expressions.	string[]
matchQuantifier	Indicates whether any or all of the expressions should match with the response content.	'All' 'Any'

WaitStepProperties

Name	Description	Value
stepType	The type of step.	'Wait' (required)
attributes	The Wait attributes	WaitStepAttributes (required)

WaitStepAttributes

Name	Description	Value
duration	The duration in ISO 8601 format of how long the wait should be.	string (required)

Terraform (AzAPI provider) resource definition

The steps resource type can be deployed to:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DeploymentManager/steps resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeploymentManager/steps@2019-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      stepType = "string"
      // For remaining properties, see StepProperties objects
    }
  })
}

StepProperties objects

Set the stepType property to specify the type of object.

For HealthCheck, use:

  stepType = "HealthCheck"
  attributes = {
    healthyStateDuration = "string"
    maxElasticDuration = "string"
    waitDuration = "string"
    type = "string"
    // For remaining properties, see HealthCheckStepAttributes objects
  }

For Wait, use:

  stepType = "Wait"
  attributes = {
    duration = "string"
  }

HealthCheckStepAttributes objects

Set the type property to specify the type of object.

For REST, use:

  type = "REST"
  properties = {
    healthChecks = [
      {
        name = "string"
        request = {
          authentication = {
            type = "string"
            // For remaining properties, see RestRequestAuthentication objects
          }
          method = "string"
          uri = "string"
        }
        response = {
          regex = {
            matches = [
              "string"
            ]
            matchQuantifier = "string"
          }
          successStatusCodes = [
            "string"
          ]
        }
      }
    ]
  }

RestRequestAuthentication objects

Set the type property to specify the type of object.

For ApiKey, use:

  type = "ApiKey"
  in = "string"
  name = "string"
  value = "string"

For RolloutIdentity, use:

  type = "RolloutIdentity"

Property values

steps

Name	Description	Value
type	The resource type	"Microsoft.DeploymentManager/steps@2019-11-01-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.
properties	The properties that define the step.	StepProperties (required)

StepProperties

Name	Description	Value
stepType	Set the object type	HealthCheck Wait (required)

HealthCheckStepProperties

Name	Description	Value
stepType	The type of step.	"HealthCheck" (required)
attributes	The health check step attributes	HealthCheckStepAttributes (required)

HealthCheckStepAttributes

Name	Description	Value
healthyStateDuration	The duration in ISO 8601 format for which the resource is expected to be continuously healthy. If maxElasticDuration is specified, healthy state duration is enforced after the detection of first healthy signal.	string (required)
maxElasticDuration	The duration in ISO 8601 format for which the health check waits for the resource to become healthy. Health check fails if it doesn't. Health check starts to enforce healthyStateDuration once resource becomes healthy.	string
waitDuration	The duration in ISO 8601 format for which health check waits idly without any checks.	string
type	Set the object type	REST (required)

RestHealthCheckStepAttributes

Name	Description	Value
type	The type of health check.	"REST" (required)
properties	The REST health check parameters.	RestParameters

RestParameters

Name	Description	Value
healthChecks	The list of checks that form the health check step.	RestHealthCheck[] (required)

RestHealthCheck

Name	Description	Value
name	A unique name for this check.	string (required)
request	The request to the health provider.	RestRequest (required)
response	The expected response from the health provider. If no expected response is provided, the default is to expect the received response to have an HTTP status code of 200 OK.	RestResponse

RestRequest

Name	Description	Value
authentication	The authentication information required in the request to the health provider.	RestRequestAuthentication (required)
method	The HTTP method to use for the request.	"GET" "POST" (required)
uri	The HTTP URI to use for the request.	string (required)

RestRequestAuthentication

Name	Description	Value
type	Set the object type	ApiKey RolloutIdentity (required)

ApiKeyAuthentication

Name	Description	Value
type	The authentication type.	"ApiKey" (required)
in	The location of the authentication key/value pair in the request.	"Header" "Query" (required)
name	The key name of the authentication key/value pair.	string (required)
value	The value of the authentication key/value pair.	string (required)

RolloutIdentityAuthentication

Name	Description	Value
type	The authentication type.	"RolloutIdentity" (required)

RestResponse

Name	Description	Value
regex	The regular expressions to match the response content with.	RestResponseRegex
successStatusCodes	The HTTP status codes expected in a successful health check response. The response is expected to match one of the given status codes. If no expected status codes are provided, default expected status code is 200 OK.	string[]

RestResponseRegex

Name	Description	Value
matches	The list of regular expressions.	string[]
matchQuantifier	Indicates whether any or all of the expressions should match with the response content.	"All" "Any"

WaitStepProperties

Name	Description	Value
stepType	The type of step.	"Wait" (required)
attributes	The Wait attributes	WaitStepAttributes (required)

WaitStepAttributes

Name	Description	Value
duration	The duration in ISO 8601 format of how long the wait should be.	string (required)

Microsoft.DeploymentManager steps

Bicep resource definition

Resource format

StepProperties objects

HealthCheckStepAttributes objects

RestRequestAuthentication objects

Property values

steps

StepProperties

HealthCheckStepProperties

HealthCheckStepAttributes

RestHealthCheckStepAttributes

RestParameters

RestHealthCheck

RestRequest

RestRequestAuthentication

ApiKeyAuthentication

RolloutIdentityAuthentication

RestResponse

RestResponseRegex

WaitStepProperties

WaitStepAttributes

ARM template resource definition

Resource format

StepProperties objects

HealthCheckStepAttributes objects

RestRequestAuthentication objects

Property values

steps

StepProperties

HealthCheckStepProperties

HealthCheckStepAttributes

RestHealthCheckStepAttributes

RestParameters

RestHealthCheck

RestRequest

RestRequestAuthentication

ApiKeyAuthentication

RolloutIdentityAuthentication

RestResponse

RestResponseRegex

WaitStepProperties

WaitStepAttributes

Terraform (AzAPI provider) resource definition

Resource format

StepProperties objects

HealthCheckStepAttributes objects

RestRequestAuthentication objects

Property values

steps

StepProperties

HealthCheckStepProperties

HealthCheckStepAttributes

RestHealthCheckStepAttributes

RestParameters

RestHealthCheck

RestRequest

RestRequestAuthentication

ApiKeyAuthentication

RolloutIdentityAuthentication

RestResponse

RestResponseRegex

WaitStepProperties

WaitStepAttributes

Feedback

Feedback

Additional resources