Bare Metal Machines - Replace

Service:

Operator Nexus - Network Cloud

API Version:

2025-02-01

Replace (service) the bare metal machine.
Replace the provided bare metal machine.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}/replace?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
bmcCredentials	AdministrativeCredentials	AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication. The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead.
bmcMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	The MAC address of the BMC device.
bootMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	The MAC address of a NIC connected to the PXE network.
machineName	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$	The OS-level hostname assigned to this machine.
serialNumber	string minLength: 1 maxLength: 64	The serial number of the bare metal machine.

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

Replace bare metal machine

Sample request

HTTP

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

{
  "bootMacAddress": "00:00:4e:00:58:af",
  "bmcCredentials": {
    "username": "bmcuser",
    "password": "https://keyvaultname.vault.azure.net/secrets/secretName"
  },
  "serialNumber": "BM1219XXX",
  "bmcMacAddress": "00:00:4f:00:57:ad",
  "machineName": "name"
}

Sample response

Status code:

202

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
AdministrativeCredentials	AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.
BareMetalMachineReplaceParameters	BareMetalMachineReplaceParameters represents the body of the request to physically swap a bare metal machine for another.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

AdministrativeCredentials

Object

AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication.

Name	Type	Description
password	string minLength: 1	The password of the administrator of the device used during initialization.
username	string minLength: 1	The username of the administrator of the device used during initialization.

BareMetalMachineReplaceParameters

Object

BareMetalMachineReplaceParameters represents the body of the request to physically swap a bare metal machine for another.

Name	Type	Description
bmcCredentials	AdministrativeCredentials	AdministrativeCredentials represents the admin credentials for the device requiring password-based authentication. The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead.
bmcMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	The MAC address of the BMC device.
bootMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	The MAC address of a NIC connected to the PXE network.
machineName	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$	The OS-level hostname assigned to this machine.
serialNumber	string minLength: 1 maxLength: 64	The serial number of the bare metal machine.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.