Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The bareMetalMachines resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetworkCloud/bareMetalMachines resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetworkCloud/bareMetalMachines@2024-07-01' = {
extendedLocation: {
name: 'string'
type: 'string'
}
location: 'string'
name: 'string'
properties: {
bmcConnectionString: 'string'
bmcCredentials: {
password: 'string'
username: 'string'
}
bmcMacAddress: 'string'
bootMacAddress: 'string'
machineClusterVersion: 'string'
machineDetails: 'string'
machineName: 'string'
machineSkuId: 'string'
rackId: 'string'
rackSlot: int
serialNumber: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.NetworkCloud/bareMetalMachines
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ (required) |
| properties | The list of the resource properties. | BareMetalMachineProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AdministrativeCredentials
| Name | Description | Value |
|---|---|---|
| password | The password of the administrator of the device used during initialization. | string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. (required) |
| username | The username of the administrator of the device used during initialization. | string Constraints: Min length = 1 (required) |
BareMetalMachineProperties
| Name | Description | Value |
|---|---|---|
| bmcConnectionString | The connection string for the baseboard management controller including IP address and protocol. | string (required) |
| bmcCredentials | The credentials of the baseboard management controller on this bare metal machine. | AdministrativeCredentials (required) |
| bmcMacAddress | The MAC address of the BMC device. | string Constraints: Pattern = ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ (required) |
| bootMacAddress | The MAC address of a NIC connected to the PXE network. | string Constraints: Pattern = ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ (required) |
| machineClusterVersion | The cluster version that has been applied to this machine during deployment or a version update. | string |
| machineDetails | The custom details provided by the customer. | string Constraints: Max length = 256 (required) |
| machineName | The OS-level hostname assigned to this machine. | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ (required) |
| machineSkuId | The unique internal identifier of the bare metal machine SKU. | string (required) |
| rackId | The resource ID of the rack where this bare metal machine resides. | string (required) |
| rackSlot | The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. | int Constraints: Min value = 1 Max value = 256 (required) |
| serialNumber | The serial number of the bare metal machine. | string Constraints: Min length = 1 Max length = 64 (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The bareMetalMachines resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetworkCloud/bareMetalMachines resource, add the following JSON to your template.
{
"type": "Microsoft.NetworkCloud/bareMetalMachines",
"apiVersion": "2024-07-01",
"name": "string",
"extendedLocation": {
"name": "string",
"type": "string"
},
"location": "string",
"properties": {
"bmcConnectionString": "string",
"bmcCredentials": {
"password": "string",
"username": "string"
},
"bmcMacAddress": "string",
"bootMacAddress": "string",
"machineClusterVersion": "string",
"machineDetails": "string",
"machineName": "string",
"machineSkuId": "string",
"rackId": "string",
"rackSlot": "int",
"serialNumber": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.NetworkCloud/bareMetalMachines
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-07-01' |
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ (required) |
| properties | The list of the resource properties. | BareMetalMachineProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NetworkCloud/bareMetalMachines' |
AdministrativeCredentials
| Name | Description | Value |
|---|---|---|
| password | The password of the administrator of the device used during initialization. | string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. (required) |
| username | The username of the administrator of the device used during initialization. | string Constraints: Min length = 1 (required) |
BareMetalMachineProperties
| Name | Description | Value |
|---|---|---|
| bmcConnectionString | The connection string for the baseboard management controller including IP address and protocol. | string (required) |
| bmcCredentials | The credentials of the baseboard management controller on this bare metal machine. | AdministrativeCredentials (required) |
| bmcMacAddress | The MAC address of the BMC device. | string Constraints: Pattern = ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ (required) |
| bootMacAddress | The MAC address of a NIC connected to the PXE network. | string Constraints: Pattern = ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ (required) |
| machineClusterVersion | The cluster version that has been applied to this machine during deployment or a version update. | string |
| machineDetails | The custom details provided by the customer. | string Constraints: Max length = 256 (required) |
| machineName | The OS-level hostname assigned to this machine. | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ (required) |
| machineSkuId | The unique internal identifier of the bare metal machine SKU. | string (required) |
| rackId | The resource ID of the rack where this bare metal machine resides. | string (required) |
| rackSlot | The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. | int Constraints: Min value = 1 Max value = 256 (required) |
| serialNumber | The serial number of the bare metal machine. | string Constraints: Min length = 1 Max length = 64 (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The bareMetalMachines resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetworkCloud/bareMetalMachines resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetworkCloud/bareMetalMachines@2024-07-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
extendedLocation = {
name = "string"
type = "string"
}
properties = {
bmcConnectionString = "string"
bmcCredentials = {
password = "string"
username = "string"
}
bmcMacAddress = "string"
bootMacAddress = "string"
machineClusterVersion = "string"
machineDetails = "string"
machineName = "string"
machineSkuId = "string"
rackId = "string"
rackSlot = int
serialNumber = "string"
}
}
}
Property Values
Microsoft.NetworkCloud/bareMetalMachines
| Name | Description | Value |
|---|---|---|
| extendedLocation | The extended location of the cluster associated with the resource. | ExtendedLocation (required) |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ (required) |
| properties | The list of the resource properties. | BareMetalMachineProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NetworkCloud/bareMetalMachines@2024-07-01" |
AdministrativeCredentials
| Name | Description | Value |
|---|---|---|
| password | The password of the administrator of the device used during initialization. | string Constraints: Min length = 1 Sensitive value. Pass in as a secure parameter. (required) |
| username | The username of the administrator of the device used during initialization. | string Constraints: Min length = 1 (required) |
BareMetalMachineProperties
| Name | Description | Value |
|---|---|---|
| bmcConnectionString | The connection string for the baseboard management controller including IP address and protocol. | string (required) |
| bmcCredentials | The credentials of the baseboard management controller on this bare metal machine. | AdministrativeCredentials (required) |
| bmcMacAddress | The MAC address of the BMC device. | string Constraints: Pattern = ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ (required) |
| bootMacAddress | The MAC address of a NIC connected to the PXE network. | string Constraints: Pattern = ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ (required) |
| machineClusterVersion | The cluster version that has been applied to this machine during deployment or a version update. | string |
| machineDetails | The custom details provided by the customer. | string Constraints: Max length = 256 (required) |
| machineName | The OS-level hostname assigned to this machine. | string Constraints: Pattern = ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$ (required) |
| machineSkuId | The unique internal identifier of the bare metal machine SKU. | string (required) |
| rackId | The resource ID of the rack where this bare metal machine resides. | string (required) |
| rackSlot | The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1. | int Constraints: Min value = 1 Max value = 256 (required) |
| serialNumber | The serial number of the bare metal machine. | string Constraints: Min length = 1 Max length = 64 (required) |
ExtendedLocation
| Name | Description | Value |
|---|---|---|
| name | The resource ID of the extended location on which the resource will be created. | string (required) |
| type | The extended location type, for example, CustomLocation. | string (required) |
TrackedResourceTags
| Name | Description | Value |
|---|