Share via


Bare Metal Machines - Cordon

Cordon the bare metal machine.
Cordon the provided bare metal machine's Kubernetes node.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/cordon?api-version=2025-02-01

URI Parameters

Name In Required Type Description
bareMetalMachineName
path True

string

pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

The name of the bare metal machine.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.

subscriptionId
path True

string (uuid)

The ID of the target subscription. The value must be an UUID.

api-version
query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
evacuate

BareMetalMachineEvacuate

The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.

Responses

Name Type Description
202 Accepted

The action has been initiated for the resource.

Headers

Location: string

Other Status Codes

ErrorResponse

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

Cordon bare metal machine

Sample request

POST https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName/cordon?api-version=2025-02-01

{
  "evacuate": "True"
}

Sample response

Location: https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2025-02-01

Definitions

Name Description
BareMetalMachineCordonParameters

BareMetalMachineCordonParameters represents the body of the request to evacuate workloads from node on a bare metal machine.

BareMetalMachineEvacuate

The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

BareMetalMachineCordonParameters

BareMetalMachineCordonParameters represents the body of the request to evacuate workloads from node on a bare metal machine.

Name Type Default value Description
evacuate

BareMetalMachineEvacuate

False

The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.

BareMetalMachineEvacuate

The indicator of whether to evacuate the node workload when the bare metal machine is cordoned.

Value Description
True
False

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.