IRolloutsOperations.RestartWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.DeploymentManager

Assembly:

Microsoft.Azure.Management.DeploymentManager.dll

Package:

Microsoft.Azure.Management.DeploymentManager v0.9.1-preview

Restarts a failed rollout and optionally skips all succeeded steps.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DeploymentManager.Models.Rollout>> RestartWithHttpMessagesAsync (string resourceGroupName, string rolloutName, bool? skipSucceeded = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member RestartWithHttpMessagesAsync : string * string * Nullable<bool> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.DeploymentManager.Models.Rollout>>

Public Function RestartWithHttpMessagesAsync (resourceGroupName As String, rolloutName As String, Optional skipSucceeded As Nullable(Of Boolean) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of Rollout))

Parameters

resourceGroupName

String

The name of the resource group. The name is case insensitive.

rolloutName

String

The rollout name.

skipSucceeded

Nullable<Boolean>

If true, will skip all succeeded steps so far in the rollout. If false, will execute the entire rollout again regardless of the current state of individual resources. Defaults to false if not specified.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<Rollout>>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Remarks

Only failed rollouts can be restarted.