IVirtualMachineScaleSetsOperations.PowerOffWithHttpMessagesAsync Method

Definition

Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> PowerOffWithHttpMessagesAsync (string resourceGroupName, string vmScaleSetName, bool? skipShutdown = False, System.Collections.Generic.IList<string> instanceIds = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member PowerOffWithHttpMessagesAsync : string * string * Nullable<bool> * System.Collections.Generic.IList<string> * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function PowerOffWithHttpMessagesAsync (resourceGroupName As String, vmScaleSetName As String, Optional skipShutdown As Nullable(Of Boolean) = False, Optional instanceIds As IList(Of String) = Nothing, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse)

Parameters

resourceGroupName
String

The name of the resource group.

vmScaleSetName
String

The name of the VM scale set.

skipShutdown
Nullable<Boolean>

The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified

instanceIds
IList<String>

The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to