Microsoft.DeploymentManager steps 2019-11-01-preview

The steps resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.DeploymentManager/steps resource, add the following Bicep or JSON 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
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.DeploymentManager/steps'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'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 of a step resource. StepProperties (required)

StepProperties

Name Description Value
stepType Set the object type HealthCheck
Wait

HealthCheckStepProperties

Name Description Value
stepType The type of step. 'HealthCheck'
attributes The attributes for the health check step. 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

RestHealthCheckStepAttributes

Name Description Value
type The type of health check. 'REST'
properties The parameters for the REST health check. 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 properties that make up a REST request RestRequest (required)
response The properties that make up the expected REST response RestResponse

RestRequest

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

RestRequestAuthentication

Name Description Value
type Set the object type ApiKey
RolloutIdentity

ApiKeyAuthentication

Name Description Value
type The authentication type. 'ApiKey'
in The location of the authentication key/value pair in the request. 'Header'
'Query'
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'

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'
attributes The parameters for the wait step. WaitStepAttributes (required)

WaitStepAttributes

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