Package-level declarations

Types

Link copied to clipboard
data class ApiKeyAuthenticationResponse(val in: String, val name: String, val type: String, val value: String)

ApiKey authentication gives a name and a value that can be included in either the request header or query parameters.

Link copied to clipboard
data class CloudErrorBodyResponse(val code: String, val details: List<CloudErrorBodyResponse>? = null, val message: String, val target: String? = null)

Detailed error information of any failure.

Link copied to clipboard
data class GetArtifactSourceResult(val artifactRoot: String? = null, val authentication: SasAuthenticationResponse, val id: String, val location: String, val name: String, val sourceType: String, val tags: Map<String, String>? = null, val type: String)

The resource that defines the source location where the artifacts are located.

Link copied to clipboard
data class GetRolloutResult(val artifactSourceId: String? = null, val buildVersion: String, val id: String, val identity: IdentityResponse? = null, val location: String, val name: String, val operationInfo: RolloutOperationInfoResponse, val services: List<ServiceResponse>, val status: String, val stepGroups: List<StepGroupResponse>, val tags: Map<String, String>? = null, val targetServiceTopologyId: String, val totalRetryAttempts: Int, val type: String)

Defines the rollout.

Link copied to clipboard
data class GetServiceResult(val id: String, val location: String, val name: String, val tags: Map<String, String>? = null, val targetLocation: String, val targetSubscriptionId: String, val type: String)

The resource representation of a service in a service topology.

Link copied to clipboard
data class GetServiceTopologyResult(val artifactSourceId: String? = null, val id: String, val location: String, val name: String, val tags: Map<String, String>? = null, val type: String)

The resource representation of a service topology.

Link copied to clipboard
data class GetServiceUnitResult(val artifacts: ServiceUnitArtifactsResponse? = null, val deploymentMode: String, val id: String, val location: String, val name: String, val tags: Map<String, String>? = null, val targetResourceGroup: String, val type: String)

Represents the response of a service unit resource.

Link copied to clipboard
data class GetStepResult(val id: String, val location: String, val name: String, val properties: Either<HealthCheckStepPropertiesResponse, WaitStepPropertiesResponse>, val tags: Map<String, String>? = null, val type: String)

The resource representation of a rollout step.

Link copied to clipboard

Defines the properties of a health check step.

Link copied to clipboard
data class IdentityResponse(val identityIds: List<String>, val type: String)

Identity for the resource.

Link copied to clipboard
data class MessageResponse(val message: String, val timeStamp: String)

Supplementary contextual messages during a rollout.

Link copied to clipboard
data class PrePostStepResponse(val stepId: String)

The properties that define a step.

Link copied to clipboard
data class ResourceOperationResponse(val operationId: String, val provisioningState: String, val resourceName: String? = null, val resourceType: String? = null, val statusCode: String, val statusMessage: String)

Individual resource operation information.

Link copied to clipboard
data class RestHealthCheckResponse(val name: String, val request: RestRequestResponse, val response: RestResponseResponse? = null)

A REST based health check

Link copied to clipboard
data class RestHealthCheckStepAttributesResponse(val healthChecks: List<RestHealthCheckResponse>, val healthyStateDuration: String, val maxElasticDuration: String? = null, val type: String, val waitDuration: String? = null)

Defines the REST health check step properties.

Link copied to clipboard
data class RestRequestResponse(val authentication: Either<ApiKeyAuthenticationResponse, RolloutIdentityAuthenticationResponse>, val method: String, val uri: String)

The properties that make up a REST request

Link copied to clipboard
data class RestResponseResponse(val regex: RestResponseResponseRegex? = null, val successStatusCodes: List<String>? = null)

The properties that make up the expected REST response

Link copied to clipboard
data class RestResponseResponseRegex(val matchQuantifier: String? = null, val matches: List<String>? = null)

The regular expressions to match the response content with.

Link copied to clipboard

RolloutIdentity uses the user-assigned managed identity authentication context specified in the Identity property during rollout creation.

Link copied to clipboard
data class RolloutOperationInfoResponse(val endTime: String, val error: CloudErrorBodyResponse, val retryAttempt: Int, val skipSucceededOnRetry: Boolean, val startTime: String)

Detailed runtime information of the rollout.

Link copied to clipboard
data class RolloutStepResponse(val messages: List<MessageResponse>, val name: String, val operationInfo: StepOperationInfoResponse, val resourceOperations: List<ResourceOperationResponse>, val status: String, val stepGroup: String? = null)

Defines a specific step on a target service unit.

Link copied to clipboard
data class SasAuthenticationResponse(val sasUri: String, val type: String)

Defines the properties to access the artifacts using an Azure Storage SAS URI.

Link copied to clipboard
data class ServiceResponse(val name: String? = null, val serviceUnits: List<ServiceUnitResponse>? = null, val targetLocation: String, val targetSubscriptionId: String)

Defines a service.

Link copied to clipboard
data class ServiceUnitArtifactsResponse(val parametersArtifactSourceRelativePath: String? = null, val parametersUri: String? = null, val templateArtifactSourceRelativePath: String? = null, val templateUri: String? = null)

Defines the artifacts of a service unit.

Link copied to clipboard
data class ServiceUnitResponse(val artifacts: ServiceUnitArtifactsResponse? = null, val deploymentMode: String, val name: String? = null, val steps: List<RolloutStepResponse>? = null, val targetResourceGroup: String)

Defines a service unit.

Link copied to clipboard
data class StepGroupResponse(val dependsOnStepGroups: List<String>? = null, val deploymentTargetId: String, val name: String, val postDeploymentSteps: List<PrePostStepResponse>? = null, val preDeploymentSteps: List<PrePostStepResponse>? = null)

The properties that define a Step group in a rollout.

Link copied to clipboard
data class StepOperationInfoResponse(val correlationId: String, val deploymentName: String, val endTime: String, val error: CloudErrorBodyResponse? = null, val lastUpdatedTime: String, val startTime: String)

Detailed information of a specific step run.

Link copied to clipboard
data class WaitStepAttributesResponse(val duration: String)

The parameters for the wait step.

Link copied to clipboard
data class WaitStepPropertiesResponse(val attributes: WaitStepAttributesResponse, val stepType: String)

Defines the properties of a Wait step.