Virtual Machine Scale Sets - Delete Instances
Deletes virtual machines in a VM scale set.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete?api-version=2023-09-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete?forceDeletion={forceDeletion}&api-version=2023-09-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
vm
|
path | True |
string |
The name of the VM scale set. |
api-version
|
query | True |
string |
Client Api Version. |
force
|
query |
boolean |
Optional parameter to force delete virtual machines from the VM scale set. (Feature in Preview) |
Request Body
Name | Required | Type | Description |
---|---|---|---|
instanceIds | True |
string[] |
The virtual machine scale set instance ids. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
202 Accepted |
Accepted |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Virtual |
Virtual |
VirtualMachineScaleSet_DeleteInstances_MaximumSet_Gen
Sample request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaa/delete?forceDeletion=True&api-version=2023-09-01
{
"instanceIds": [
"aaaaaaaaaaaaaaaaaaaaaaaaa"
]
}
Sample response
location: https://foo.com/operationstatus
VirtualMachineScaleSet_DeleteInstances_MinimumSet_Gen
Sample request
POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaa/delete?api-version=2023-09-01
{
"instanceIds": [
"aaaaaaaaaaaaaaaaaaaaaaaaa"
]
}
Sample response
location: https://foo.com/operationstatus
Definitions
Name | Description |
---|---|
Api |
Api error. |
Api |
Api error base. |
Cloud |
An error response from the Compute service. |
Inner |
Inner error details. |
Virtual |
Specifies a list of virtual machine instance IDs from the VM scale set. |
ApiError
Api error.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
details |
The Api error details |
|
innererror |
The Api inner error |
|
message |
string |
The error message. |
target |
string |
The target of the particular error. |
ApiErrorBase
Api error base.
Name | Type | Description |
---|---|---|
code |
string |
The error code. |
message |
string |
The error message. |
target |
string |
The target of the particular error. |
CloudError
An error response from the Compute service.
Name | Type | Description |
---|---|---|
error |
Api error. |
InnerError
Inner error details.
Name | Type | Description |
---|---|---|
errordetail |
string |
The internal error message or exception dump. |
exceptiontype |
string |
The exception type. |
VirtualMachineScaleSetVMInstanceRequiredIDs
Specifies a list of virtual machine instance IDs from the VM scale set.
Name | Type | Description |
---|---|---|
instanceIds |
string[] |
The virtual machine scale set instance ids. |