BareMetalMachine interface
BareMetalMachine represents the physical machine in the rack.
- Extends
Properties
| action |
The current state of any in progress or completed actions. The most recent known instance of each action type is shown. |
| associated |
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network. |
| bmc |
The connection string for the baseboard management controller including IP address and protocol. |
| bmc |
The credentials of the baseboard management controller on this bare metal machine. |
| bmc |
The IPv4 address of the BMC interface for the bare metal machine. |
| bmc |
The IPv6 address of the BMC interface for the bare metal machine. |
| bmc |
The MAC address of the BMC device. |
| boot |
The MAC address of a NIC connected to the PXE network. |
| ca |
The CA certificate information issued by the platform for connecting to TLS interfaces for the bare metal machine. Callers add this certificate to the trusted CA store on the Kubernetes control plane nodes to allow secure communication with the bare metal machine. |
| cluster |
The resource ID of the cluster this bare metal machine is associated with. |
| cordon |
The cordon status of the bare metal machine. |
| detailed |
The more detailed status of the bare metal machine. |
| detailed |
The descriptive message about the current detailed status. |
| etag | "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") |
| extended |
The extended location of the resource. This property is required when creating the resource. |
| hardware |
The hardware inventory, including information acquired from the model/sku information and from the ironic inspector. |
| hardware |
The details of the latest hardware validation performed for this bare metal machine. |
| hybrid |
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. |
| kubernetes |
The name of this machine represented by the host object in the Cluster's Kubernetes control plane. |
| kubernetes |
The version of Kubernetes running on this machine. |
| machine |
The cluster version that has been applied to this machine during deployment or a version update. |
| machine |
The custom details provided by the customer. |
| machine |
The OS-level hostname assigned to this machine. |
| machine |
The list of roles that are assigned to the cluster node running on this machine. |
| machine |
The unique internal identifier of the bare metal machine SKU. |
| monitoring |
The monitoring configuration status of the bare metal machine. |
| oam |
The IPv4 address that is assigned to the bare metal machine during the cluster deployment. |
| oam |
The IPv6 address that is assigned to the bare metal machine during the cluster deployment. |
| os |
The image that is currently provisioned to the OS disk. |
| power |
The power state derived from the baseboard management controller. |
| provisioning |
The provisioning state of the bare metal machine. |
| rack |
The resource ID of the rack where this bare metal machine resides. |
| rack |
The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. |
| ready |
The indicator of whether the bare metal machine is ready to receive workloads. |
| runtime |
The runtime protection status of the bare metal machine. |
| secret |
The list of statuses that represent secret rotation activity. |
| serial |
The serial number of the bare metal machine. |
| service |
The discovered value of the machine's service tag. |
| virtual |
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. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| location | The geo-location where the resource lives |
| name | The name of the resource |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
Property Details
actionStates
The current state of any in progress or completed actions. The most recent known instance of each action type is shown.
actionStates?: ActionState[]Property Value
associatedResourceIds
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
associatedResourceIds?: string[]Property Value
string[]
bmcConnectionString
The connection string for the baseboard management controller including IP address and protocol.
bmcConnectionString: stringProperty Value
string
bmcCredentials
The credentials of the baseboard management controller on this bare metal machine.
bmcCredentials: AdministrativeCredentialsProperty Value
bmcIpv4Address
The IPv4 address of the BMC interface for the bare metal machine.
bmcIpv4Address?: stringProperty Value
string
bmcIpv6Address
The IPv6 address of the BMC interface for the bare metal machine.
bmcIpv6Address?: stringProperty Value
string
bmcMacAddress
The MAC address of the BMC device.
bmcMacAddress: stringProperty Value
string
bootMacAddress
The MAC address of a NIC connected to the PXE network.
bootMacAddress: stringProperty Value
string
caCertificate
The CA certificate information issued by the platform for connecting to TLS interfaces for the bare metal machine. Callers add this certificate to the trusted CA store on the Kubernetes control plane nodes to allow secure communication with the bare metal machine.
caCertificate?: CertificateInfoProperty Value
clusterId
The resource ID of the cluster this bare metal machine is associated with.
clusterId?: stringProperty Value
string
cordonStatus
The cordon status of the bare metal machine.
cordonStatus?: stringProperty Value
string
detailedStatus
The more detailed status of the bare metal machine.
detailedStatus?: stringProperty Value
string
detailedStatusMessage
The descriptive message about the current detailed status.
detailedStatusMessage?: stringProperty Value
string
etag
"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.")
etag?: stringProperty Value
string
extendedLocation
The extended location of the resource. This property is required when creating the resource.
extendedLocation: ExtendedLocationProperty Value
hardwareInventory
The hardware inventory, including information acquired from the model/sku information and from the ironic inspector.
hardwareInventory?: HardwareInventoryProperty Value
hardwareValidationStatus
The details of the latest hardware validation performed for this bare metal machine.
hardwareValidationStatus?: HardwareValidationStatusProperty Value
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.
hybridAksClustersAssociatedIds?: string[]Property Value
string[]
kubernetesNodeName
The name of this machine represented by the host object in the Cluster's Kubernetes control plane.
kubernetesNodeName?: stringProperty Value
string
kubernetesVersion
The version of Kubernetes running on this machine.
kubernetesVersion?: stringProperty Value
string
machineClusterVersion
The cluster version that has been applied to this machine during deployment or a version update.
machineClusterVersion?: stringProperty Value
string
machineDetails
The custom details provided by the customer.
machineDetails: stringProperty Value
string
machineName
The OS-level hostname assigned to this machine.
machineName: stringProperty Value
string
machineRoles
The list of roles that are assigned to the cluster node running on this machine.
machineRoles?: string[]Property Value
string[]
machineSkuId
The unique internal identifier of the bare metal machine SKU.
machineSkuId: stringProperty Value
string
monitoringConfigurationStatus
The monitoring configuration status of the bare metal machine.
monitoringConfigurationStatus?: BareMetalMachineMonitoringConfigurationStatusProperty Value
oamIpv4Address
The IPv4 address that is assigned to the bare metal machine during the cluster deployment.
oamIpv4Address?: stringProperty Value
string
oamIpv6Address
The IPv6 address that is assigned to the bare metal machine during the cluster deployment.
oamIpv6Address?: stringProperty Value
string
osImage
The image that is currently provisioned to the OS disk.
osImage?: stringProperty Value
string
powerState
The power state derived from the baseboard management controller.
powerState?: stringProperty Value
string
provisioningState
The provisioning state of the bare metal machine.
provisioningState?: stringProperty Value
string
rackId
The resource ID of the rack where this bare metal machine resides.
rackId: stringProperty 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: numberProperty Value
number
readyState
The indicator of whether the bare metal machine is ready to receive workloads.
readyState?: stringProperty Value
string
runtimeProtectionStatus
The runtime protection status of the bare metal machine.
runtimeProtectionStatus?: RuntimeProtectionStatusProperty Value
secretRotationStatus
The list of statuses that represent secret rotation activity.
secretRotationStatus?: SecretRotationStatus[]Property Value
serialNumber
The serial number of the bare metal machine.
serialNumber: stringProperty Value
string
serviceTag
The discovered value of the machine's service tag.
serviceTag?: stringProperty 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.
virtualMachinesAssociatedIds?: string[]Property Value
string[]
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: Record<string, string>Property Value
Record<string, string>
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
type?: stringProperty Value
string
Inherited From TrackedResource.type
