IVirtualMachineScaleSetVMsOperations.PowerOffWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.Compute

Assembly:

Microsoft.Azure.Management.Compute.dll

Package:

Microsoft.Azure.Management.Compute v61.0.0

Power off (stop) a virtual machine 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, string instanceId, bool? skipShutdown = False, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PowerOffWithHttpMessagesAsync : string * 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>

Public Function PowerOffWithHttpMessagesAsync (resourceGroupName As String, vmScaleSetName As String, instanceId As String, Optional skipShutdown As Nullable(Of Boolean) = False, 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.

instanceId

String

The instance ID of the virtual machine.

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

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse>

Exceptions

CloudException

Thrown when the operation returned an invalid status code

ValidationException

Thrown when a required parameter is null