RolloutProperties interface
The properties that define a rollout.
Inherited Properties
| artifact |
The reference to the artifact source resource Id where the payload is located. |
| build |
The version of the build being deployed. |
| operation |
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. |
| step |
The list of step groups that define the orchestration. |
| target |
The resource Id of the service topology from which service units are being referenced in step groups to be deployed. |
| total |
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 Property Details
artifactSourceId
The reference to the artifact source resource Id where the payload is located.
artifactSourceId?: string
Property Value
string
Inherited From RolloutRequestProperties.artifactSourceId
buildVersion
The version of the build being deployed.
buildVersion: string
Property Value
string
Inherited From RolloutRequestProperties.buildVersion
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
Inherited From RolloutPropertiesAutoGenerated.operationInfo
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[]
Inherited From RolloutPropertiesAutoGenerated.services
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
Inherited From RolloutPropertiesAutoGenerated.status
stepGroups
The list of step groups that define the orchestration.
stepGroups: StepGroup[]
Property Value
Inherited From RolloutRequestProperties.stepGroups
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
Inherited From RolloutRequestProperties.targetServiceTopologyId
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 From RolloutPropertiesAutoGenerated.totalRetryAttempts