Virtual Machine Scale Sets - Set Orchestration Service State

  • Reference
Service:
Compute
API Version:
2024-03-01

Changes ServiceState property for a given service

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState?api-version=2024-03-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group.
subscriptionId
 path True

string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmScaleSetName
 path True

string

The name of the virtual machine scale set to create or update.
api-version
 query True

string

Client Api Version.

Request Body

Name Required Type Description
action True

OrchestrationServiceStateAction

The action to be performed.
serviceName True

OrchestrationServiceNames

The name of the service.

Responses

Name Type Description
200 OK

OK
202 Accepted

Accepted
Other Status Codes

CloudError

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

VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen
VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen

VirtualMachineScaleSet_SetOrchestrationServiceState_MaximumSet_Gen

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaa/setOrchestrationServiceState?api-version=2024-03-01

{
  "serviceName": "AutomaticRepairs",
  "action": "Resume"
}

Sample Response

Status code:
200
Status code:
202 
location: https://foo.com/operationstatus

VirtualMachineScaleSet_SetOrchestrationServiceState_MinimumSet_Gen

Sample Request

POST https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaa/setOrchestrationServiceState?api-version=2024-03-01

{
  "serviceName": "AutomaticRepairs",
  "action": "Resume"
}

Sample Response

Status code:
200
Status code:
202 
location: https://foo.com/operationstatus

Definitions

Name Description
ApiError

Api error.
ApiErrorBase

Api error base.
CloudError

An error response from the Compute service.
InnerError

Inner error details.
OrchestrationServiceNames

The name of the service.
OrchestrationServiceStateAction

The action to be performed.
OrchestrationServiceStateInput

The input for OrchestrationServiceState

ApiError

Api error.

Name Type Description
code

string

The error code.
details

ApiErrorBase[]

The Api error details
innererror

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

ApiError

Api error.

InnerError

Inner error details.

Name Type Description
errordetail

string

The internal error message or exception dump.
exceptiontype

string

The exception type.

OrchestrationServiceNames

The name of the service.

Name Type Description
AutomaticRepairs

string

OrchestrationServiceStateAction

The action to be performed.

Name Type Description
Resume

string

Suspend

string

OrchestrationServiceStateInput

The input for OrchestrationServiceState

Name Type Description
action

OrchestrationServiceStateAction

The action to be performed.
serviceName

OrchestrationServiceNames

The name of the service.