Share via


IVirtualMachineScaleSetsOperations.ConvertToSinglePlacementGroupWithHttpMessagesAsync Method

Definition

Converts SinglePlacementGroup property to false for a existing virtual machine scale set.

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse> ConvertToSinglePlacementGroupWithHttpMessagesAsync (string resourceGroupName, string vmScaleSetName, string activePlacementGroupId = default, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ConvertToSinglePlacementGroupWithHttpMessagesAsync : string * string * string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse>
Public Function ConvertToSinglePlacementGroupWithHttpMessagesAsync (resourceGroupName As String, vmScaleSetName As String, Optional activePlacementGroupId As 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 virtual machine scale set to create or update.

activePlacementGroupId
String

Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances.

customHeaders
Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken
CancellationToken

The cancellation token.

Returns

Exceptions

Thrown when the operation returned an invalid status code

Thrown when a required parameter is null

Applies to