Share via

Rollout interface

Package:
@azure/arm-deploymentmanager

Defines the rollout.

Extends
TrackedResource

Properties

artifactSourceId

The reference to the artifact source resource Id where the payload is located.
buildVersion

The version of the build being deployed.
identity

Identity for the resource.
operationInfo

Operational information of the rollout. NOTE: This property will not be serialized. It can only be populated by the server.
services

The detailed information on the services being deployed. NOTE: This property will not be serialized. It can only be populated by the server.
status

The current status of the rollout. NOTE: This property will not be serialized. It can only be populated by the server.
stepGroups

The list of step groups that define the orchestration.
targetServiceTopologyId

The resource Id of the service topology from which service units are being referenced in step groups to be deployed.
totalRetryAttempts

The cardinal count of total number of retries performed on the rollout at a given time. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

artifactSourceId

The reference to the artifact source resource Id where the payload is located.

artifactSourceId?: string

Property Value

string

buildVersion

The version of the build being deployed.

buildVersion?: string

Property Value

string

identity

Identity for the resource.

identity?: Identity

Property Value

Identity

operationInfo

Operational information of the rollout. NOTE: This property will not be serialized. It can only be populated by the server.

operationInfo?: RolloutOperationInfo

Property Value

RolloutOperationInfo

services

The detailed information on the services being deployed. NOTE: This property will not be serialized. It can only be populated by the server.

services?: Service[]

Property Value

Service[]

status

The current status of the rollout. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

stepGroups

The list of step groups that define the orchestration.

stepGroups?: StepGroup[]

Property Value

StepGroup[]

targetServiceTopologyId

The resource Id of the service topology from which service units are being referenced in step groups to be deployed.

targetServiceTopologyId?: string

Property Value

string

totalRetryAttempts

The cardinal count of total number of retries performed on the rollout at a given time. NOTE: This property will not be serialized. It can only be populated by the server.

totalRetryAttempts?: number

Property Value

number

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type