Microsoft.DeploymentManager rollouts template reference

  • 2 minutes to read

Template format

To create a Microsoft.DeploymentManager/rollouts resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.DeploymentManager/rollouts",
  "apiVersion": "2019-11-01-preview",
  "tags": {},
  "location": "string",
  "identity": {
    "type": "string",
    "identityIds": [
      "string"
    ]
  },
  "properties": {
    "buildVersion": "string",
    "artifactSourceId": "string",
    "targetServiceTopologyId": "string",
    "stepGroups": [
      {
        "name": "string",
        "dependsOnStepGroups": [
          "string"
        ],
        "preDeploymentSteps": [
          {
            "stepId": "string"
          }
        ],
        "deploymentTargetId": "string",
        "postDeploymentSteps": [
          {
            "stepId": "string"
          }
        ]
      }
    ]
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.DeploymentManager/rollouts object

Name Type Required Value
name string Yes The rollout name.
type enum Yes Microsoft.DeploymentManager/rollouts
apiVersion enum Yes 2019-11-01-preview
tags object No Resource tags.
location string Yes The geo-location where the resource lives
identity object Yes Identity for the resource. - Identity object
properties object Yes Defines the properties that make up a rollout request. - RolloutRequestProperties object

Identity object

Name Type Required Value
type string Yes The identity type.
identityIds array Yes The list of identities. - string

RolloutRequestProperties object

Name Type Required Value
buildVersion string Yes The version of the build being deployed.
artifactSourceId string No The reference to the artifact source resource Id where the payload is located.
targetServiceTopologyId string Yes The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
stepGroups array Yes The list of step groups that define the orchestration. - StepGroup object

StepGroup object

Name Type Required Value
name string Yes The name of the step group.
dependsOnStepGroups array No The list of step group names on which this step group depends on. - string
preDeploymentSteps array No The list of steps to be run before deploying the target. - PrePostStep object
deploymentTargetId string Yes The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId
postDeploymentSteps array No The list of steps to be run after deploying the target. - PrePostStep object

PrePostStep object

Name Type Required Value
stepId string Yes The resource Id of the step to be run.