Microsoft.DeploymentManager rollouts 2018-09-01-preview
Article
10/11/2022
1 contributor
Feedback
In this article
Bicep resource definition
The rollouts resource type can be deployed to:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DeploymentManager/rollouts resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DeploymentManager/rollouts@2018-09-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
identityIds: [
'string'
]
type: 'string'
}
properties: {
artifactSourceId: 'string'
buildVersion: 'string'
stepGroups: [
{
dependsOnStepGroups: [
'string'
]
deploymentTargetId: 'string'
name: 'string'
postDeploymentSteps: [
{
stepId: 'string'
}
]
preDeploymentSteps: [
{
stepId: 'string'
}
]
}
]
targetServiceTopologyId: 'string'
}
}
Property values
rollouts
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
identity
Identity for the resource.
Identity (required)
properties
Defines the properties that make up a rollout request.
RolloutRequestPropertiesOrRolloutProperties (required)
Identity
Name
Description
Value
identityIds
The list of identities.
string[] (required)
type
The identity type.
string (required)
RolloutRequestPropertiesOrRolloutProperties
Name
Description
Value
artifactSourceId
The reference to the artifact source resource Id where the payload is located.
string
buildVersion
The version of the build being deployed.
string (required)
stepGroups
The list of step groups that define the orchestration.
Step [] (required)
targetServiceTopologyId
The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
string (required)
Step
Name
Description
Value
dependsOnStepGroups
The list of step group names on which this step group depends on.
string[]
deploymentTargetId
The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId
string (required)
name
The name of the step group.
string (required)
postDeploymentSteps
The list of steps to be run after deploying the target.
PrePostStep []
preDeploymentSteps
The list of steps to be run before deploying the target.
PrePostStep []
PrePostStep
Name
Description
Value
stepId
The resource Id of the step to be run.
string (required)
ARM template resource definition
The rollouts resource type can be deployed to:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DeploymentManager/rollouts resource, add the following JSON to your template.
{
"type": "Microsoft.DeploymentManager/rollouts",
"apiVersion": "2018-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"identityIds": [ "string" ],
"type": "string"
},
"properties": {
"artifactSourceId": "string",
"buildVersion": "string",
"stepGroups": [
{
"dependsOnStepGroups": [ "string" ],
"deploymentTargetId": "string",
"name": "string",
"postDeploymentSteps": [
{
"stepId": "string"
}
],
"preDeploymentSteps": [
{
"stepId": "string"
}
]
}
],
"targetServiceTopologyId": "string"
}
}
Property values
rollouts
Name
Description
Value
type
The resource type
'Microsoft.DeploymentManager/rollouts'
apiVersion
The resource api version
'2018-09-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
identity
Identity for the resource.
Identity (required)
properties
Defines the properties that make up a rollout request.
RolloutRequestPropertiesOrRolloutProperties (required)
Identity
Name
Description
Value
identityIds
The list of identities.
string[] (required)
type
The identity type.
string (required)
RolloutRequestPropertiesOrRolloutProperties
Name
Description
Value
artifactSourceId
The reference to the artifact source resource Id where the payload is located.
string
buildVersion
The version of the build being deployed.
string (required)
stepGroups
The list of step groups that define the orchestration.
Step [] (required)
targetServiceTopologyId
The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
string (required)
Step
Name
Description
Value
dependsOnStepGroups
The list of step group names on which this step group depends on.
string[]
deploymentTargetId
The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId
string (required)
name
The name of the step group.
string (required)
postDeploymentSteps
The list of steps to be run after deploying the target.
PrePostStep []
preDeploymentSteps
The list of steps to be run before deploying the target.
PrePostStep []
PrePostStep
Name
Description
Value
stepId
The resource Id of the step to be run.
string (required)
The rollouts resource type can be deployed to:
For a list of changed properties in each API version, see change log .
To create a Microsoft.DeploymentManager/rollouts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DeploymentManager/rollouts@2018-09-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
identityIds = [
"string"
]
type = "string"
}
body = jsonencode({
properties = {
artifactSourceId = "string"
buildVersion = "string"
stepGroups = [
{
dependsOnStepGroups = [
"string"
]
deploymentTargetId = "string"
name = "string"
postDeploymentSteps = [
{
stepId = "string"
}
]
preDeploymentSteps = [
{
stepId = "string"
}
]
}
]
targetServiceTopologyId = "string"
}
})
}
Property values
rollouts
Name
Description
Value
type
The resource type
"Microsoft.DeploymentManager/rollouts@2018-09-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.
identity
Identity for the resource.
Identity (required)
properties
Defines the properties that make up a rollout request.
RolloutRequestPropertiesOrRolloutProperties (required)
Identity
Name
Description
Value
identityIds
The list of identities.
string[] (required)
type
The identity type.
string (required)
RolloutRequestPropertiesOrRolloutProperties
Name
Description
Value
artifactSourceId
The reference to the artifact source resource Id where the payload is located.
string
buildVersion
The version of the build being deployed.
string (required)
stepGroups
The list of step groups that define the orchestration.
Step [] (required)
targetServiceTopologyId
The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
string (required)
Step
Name
Description
Value
dependsOnStepGroups
The list of step group names on which this step group depends on.
string[]
deploymentTargetId
The resource Id of service unit to be deployed. The service unit should be from the service topology referenced in targetServiceTopologyId
string (required)
name
The name of the step group.
string (required)
postDeploymentSteps
The list of steps to be run after deploying the target.
PrePostStep []
preDeploymentSteps
The list of steps to be run before deploying the target.
PrePostStep []
PrePostStep
Name
Description
Value
stepId
The resource Id of the step to be run.
string (required)