Share via

BareMetalMachine interface

  • Reference
Package:
@azure/arm-networkcloud

BareMetalMachine represents the physical machine in the rack.

Extends
TrackedResource

Properties

associatedResourceIds

The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. NOTE: This property will not be serialized. It can only be populated by the server.
bmcConnectionString

The connection string for the baseboard management controller including IP address and protocol.
bmcCredentials

The credentials of the baseboard management controller on this bare metal machine.
bmcMacAddress

The MAC address of the BMC device.
bootMacAddress

The MAC address of a NIC connected to the PXE network.
clusterId

The resource ID of the cluster this bare metal machine is associated with. NOTE: This property will not be serialized. It can only be populated by the server.
cordonStatus

The cordon status of the bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatus

The more detailed status of the bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.
detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.
extendedLocation

The extended location of the cluster associated with the resource.
hardwareInventory

The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. NOTE: This property will not be serialized. It can only be populated by the server.
hardwareValidationStatus

The details of the latest hardware validation performed for this bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.
hybridAksClustersAssociatedIds

Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.
kubernetesNodeName

The name of this machine represented by the host object in the Cluster's Kubernetes control plane. NOTE: This property will not be serialized. It can only be populated by the server.
kubernetesVersion

The version of Kubernetes running on this machine. NOTE: This property will not be serialized. It can only be populated by the server.
machineDetails

The custom details provided by the customer.
machineName

The OS-level hostname assigned to this machine.
machineSkuId

The unique internal identifier of the bare metal machine SKU.
oamIpv4Address

The IPv4 address that is assigned to the bare metal machine during the cluster deployment. NOTE: This property will not be serialized. It can only be populated by the server.
oamIpv6Address

The IPv6 address that is assigned to the bare metal machine during the cluster deployment. NOTE: This property will not be serialized. It can only be populated by the server.
osImage

The image that is currently provisioned to the OS disk. NOTE: This property will not be serialized. It can only be populated by the server.
powerState

The power state derived from the baseboard management controller. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.
rackId

The resource ID of the rack where this bare metal machine resides.
rackSlot

The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1.
readyState

The indicator of whether the bare metal machine is ready to receive workloads. NOTE: This property will not be serialized. It can only be populated by the server.
serialNumber

The serial number of the bare metal machine.
serviceTag

The discovered value of the machine's service tag. NOTE: This property will not be serialized. It can only be populated by the server.
virtualMachinesAssociatedIds

Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
location

The geo-location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

associatedResourceIds

The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. NOTE: This property will not be serialized. It can only be populated by the server.

associatedResourceIds?: string[]

Property Value

string[]

bmcConnectionString

The connection string for the baseboard management controller including IP address and protocol.

bmcConnectionString: string

Property Value

string

bmcCredentials

The credentials of the baseboard management controller on this bare metal machine.

bmcCredentials: AdministrativeCredentials

Property Value

AdministrativeCredentials

bmcMacAddress

The MAC address of the BMC device.

bmcMacAddress: string

Property Value

string

bootMacAddress

The MAC address of a NIC connected to the PXE network.

bootMacAddress: string

Property Value

string

clusterId

The resource ID of the cluster this bare metal machine is associated with. NOTE: This property will not be serialized. It can only be populated by the server.

clusterId?: string

Property Value

string

cordonStatus

The cordon status of the bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.

cordonStatus?: string

Property Value

string

detailedStatus

The more detailed status of the bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatus?: string

Property Value

string

detailedStatusMessage

The descriptive message about the current detailed status. NOTE: This property will not be serialized. It can only be populated by the server.

detailedStatusMessage?: string

Property Value

string

extendedLocation

The extended location of the cluster associated with the resource.

extendedLocation: ExtendedLocation

Property Value

ExtendedLocation

hardwareInventory

The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. NOTE: This property will not be serialized. It can only be populated by the server.

hardwareInventory?: HardwareInventory

Property Value

HardwareInventory

hardwareValidationStatus

The details of the latest hardware validation performed for this bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.

hardwareValidationStatus?: HardwareValidationStatus

Property Value

HardwareValidationStatus

hybridAksClustersAssociatedIds

Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the HybridAksClusters that have nodes hosted on this bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.

hybridAksClustersAssociatedIds?: string[]

Property Value

string[]

kubernetesNodeName

The name of this machine represented by the host object in the Cluster's Kubernetes control plane. NOTE: This property will not be serialized. It can only be populated by the server.

kubernetesNodeName?: string

Property Value

string

kubernetesVersion

The version of Kubernetes running on this machine. NOTE: This property will not be serialized. It can only be populated by the server.

kubernetesVersion?: string

Property Value

string

machineDetails

The custom details provided by the customer.

machineDetails: string

Property Value

string

machineName

The OS-level hostname assigned to this machine.

machineName: string

Property Value

string

machineSkuId

The unique internal identifier of the bare metal machine SKU.

machineSkuId: string

Property Value

string

oamIpv4Address

The IPv4 address that is assigned to the bare metal machine during the cluster deployment. NOTE: This property will not be serialized. It can only be populated by the server.

oamIpv4Address?: string

Property Value

string

oamIpv6Address

The IPv6 address that is assigned to the bare metal machine during the cluster deployment. NOTE: This property will not be serialized. It can only be populated by the server.

oamIpv6Address?: string

Property Value

string

osImage

The image that is currently provisioned to the OS disk. NOTE: This property will not be serialized. It can only be populated by the server.

osImage?: string

Property Value

string

powerState

The power state derived from the baseboard management controller. NOTE: This property will not be serialized. It can only be populated by the server.

powerState?: string

Property Value

string

provisioningState

The provisioning state of the bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

rackId

The resource ID of the rack where this bare metal machine resides.

rackId: string

Property Value

string

rackSlot

The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1.

rackSlot: number

Property Value

number

readyState

The indicator of whether the bare metal machine is ready to receive workloads. NOTE: This property will not be serialized. It can only be populated by the server.

readyState?: string

Property Value

string

serialNumber

The serial number of the bare metal machine.

serialNumber: string

Property Value

string

serviceTag

The discovered value of the machine's service tag. NOTE: This property will not be serialized. It can only be populated by the server.

serviceTag?: string

Property Value

string

virtualMachinesAssociatedIds

Field Deprecated. These fields will be empty/omitted. The list of the resource IDs for the VirtualMachines that are hosted on this bare metal machine. NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachinesAssociatedIds?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type