- Reference
- Work:
- Azure Operator Nexus - network cloud
- API version:
- Review 12/12/2022
Create or update a machine without an operating system.
Create a new bare machine or update the properties of an existing one. All user-initiated requests are rejected because the lifecycle of this asset is managed by the system.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}?api-version=2022-12-12-previewParameter-URI
| To do | W | Required | Tip | Description |
|---|---|---|---|---|
to discover | pad | WHERE | series | The name of the bare machine. Sample regular expression: |
blush | pad | WHERE | series | The name of the resource group. The name is not case sensitive. |
Subscription | pad | WHERE | series | Target Subscription ID. |
API version | query | WHERE | series | The API version to use for this operation. |
Request body
| To do | Required | Tip | Description |
|---|---|---|---|
| extensive Location | WHERE | Extended localization | ExtendedLocation represents the custom Azure location where the resource is created. |
| Place | WHERE | series | The geographic location where the resource is located |
| svojstva.bmcConnectionString | WHERE | series | Connection string for the motherboard's management controller, including IP address and protocol. |
| properties.bmcCredentials | WHERE | Administrative credentials | AdministrativeCredentials represents the administrative credentials for a device that requires password-based authentication. |
| properties.bmcMacAddress | WHERE | series | The MAC address of the BMC device. |
| properties.bootMacAddress | WHERE | series | The MAC address of the network adapter connected to the PXE network. |
| properties.machineDetails | WHERE | series | Custom data provided by the customer. |
| characteristics. machine name | WHERE | series | Operating system-level host name assigned to this computer. |
| properties.machineSkuId | WHERE | series | The unique internal SKU ID of the bare machine. |
| properties.Mode ID | WHERE | series | The resource ID of the rack that this bare metal machine resides in. |
| properties.rackSlot | WHERE | round number | The rack slot in which this metal machine is located is arranged from bottom to top, i.e. the lowest slot is 1. |
| properties. serial number | WHERE | series | Serial number of the bare machine. |
| tip | object | Brontags. |
Answers
| To do | Tip | Description |
|---|---|---|
| 200 is great | BareMetalMaszyna | Alright |
| 201 Created | BareMetalMaszyna | made Titles Azure asynchronous operation: string |
| Other status codes | FoutAnwoord | An error response that describes why the operation failed. |
Security
azure_auth
Przepływ Azure Active Directory OAuth2.
Tip:eed2
Currently:allegedly
Authorization URL:https://login.microsoftonline.com/common/oauth2/authorize
It reaches
| To do | Description |
|---|---|
| impersonate the user | impersonate your account |
Examples
Create or update a bare machine
sample request
- HTTP
- Java
- Python
- To go
- javascript
PUT https://management.azure.com/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName?api-version=2022-12-12-preview{ "Lokacija": "Lokacija", " oznake": { "key1": "myvalue1", "key2": "myvalue2" }, "extendedLocation": { "type": "CustomLocation", "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/ Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "rackId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", "machineSkuId": "684E-3B16-399E ", "rackSlot": 1, "machineName": "r01c001", "bootMacAddress": "00:00:4e:00:58:af", "bmcMacAddress": "00:00:4f:00:57:00 ", "bmcCredentials": { "username": "bmcuser", "password": "{password}" }, "bmcConnectionString": "bmcconnectionstring", "machineDetails": "Door gebruiker verstrekte machinegegevens.", "serienummer " : "BM1219XXX" }}Example answer
- Status code:
- 200
{ "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", "name": "bareMetalMachineName", "systemData": { "createdAt": "2021-01-22T13: 27:03.008Z", "createdBy": "identityA", "createdByType": "Aplikacija", "lastModifiedAt": "2021-01-22T13:29:03.001Z", "lastModifiedBy": "tożsamośćB", "lastModifiedByType" : "Użytkownik" }, "type": "Microsoft.NetworkCloud/bareMetalMachines", "location": "lokalizacja", "tags": { "key1": "myvalue1", "key2": "myvalue2" }, "extendedLocation ": { "type": "CustomLocation", "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "rackId": "/subscriptions/ identifikator_subskrypcji/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", "machineSkuId": "684E-3B16-399E", "rackSlot": 1, "machineName": "r01c001", "bootMacAddress": "00: 00:4e:00:58:af", "bmcMacAddress": "00:00:4f:00:57:00", "bmcCredentials": { "gebruikersnaam": "bmcuser" }, "bmcConnectionString": "bmcconnectionstring" , "machineDetails": "Imam veliki broj korisnika u državi.", "serialNumber": "BM1219XXX", "provisioningState": "Uspjelo", "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft .NetworkCloud/ clusters/clusterName", "readyState": "True", "cordonStatus": "Uncordoned", "powerState": "On", "hardwareInventory": { "interfaces": [ { "name": "networkInterfaceName" , "macAddress " ": "2C:54:91:88:C9:E3", "linkStatus": "Omhoog", "networkInterfaceId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/ networkDeviceName/networkInterfaces / networkInterfaceName" } ], "additionalHostInformation": "Specifieke informatie over de maszyny..." }, "detailedStatus": "Stepn", "detailedStatusMessage": "DetailedStatusMessage", "serviceTag": "ST1219XXX", " kubernetesNodeName": " node01" , "kubernetesVersion": "1.21", "osImage": "v20220805e", "oamIpv4Address": "192.0.2.1", "oamIpv6Address": "0:0:0:0:0:FFFF: 7F00:0001" , " hardwareValidationStatus": { "result": "Prošlo", "lastValidationTime": "2022-09-30T13:27:03.008Z" }, "hybridAksClustersAssociatedIds": [ "/subscriptions/subscriptionId/resourceGroups/resourceGroupName /providers/Microsoft .NetworkCloud /hybridAksClusters/hybridAksClusterName" ], "virtualMachinesAssociatedIds": [ "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" ] }}- Status code:
- 201
Azure-AsyncOperation: https://management.azure.com/subscriptions/subscriptionId/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2022-12-12-preview- Response body
{ "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName", "name": "bareMetalMachineName", "systemData": { "createdAt": "2021-01-22T13: 27:03.008Z", "createdBy": "identityA", "createdByType": "Aplikacija", "lastModifiedAt": "2021-01-22T13:29:03.001Z", "lastModifiedBy": "tożsamośćB", "lastModifiedByType" : "Użytkownik" }, "type": "Microsoft.NetworkCloud/bareMetalMachines", "location": "lokalizacja", "tags": { "key1": "myvalue1", "key2": "myvalue2" }, "extendedLocation ": { "type": "CustomLocation", "name": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName" }, "properties": { "rackId": "/subscriptions/ identifikator_subskrypcji/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName", "machineSkuId": "684E-3B16-399E", "rackSlot": 1, "machineName": "r01c001", "bootMacAddress": "00: 00:4e:00:58:af", "bmcMacAddress": "00:00:4f:00:57:00", "bmcCredentials": { "gebruikersnaam": "bmcuser" }, "bmcConnectionString": "bmcconnectionstring" , "machineDetails": "SerialNumber": "BM1219XXX", "provisioningState": "Zaakceptowano", "clusterId": "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/ clusters/clusterName", "readyState": "True", "cordonStatus": "Uncordoned", "powerState": "On", "hardwareInventory": { "interfaces": [ { "name": "networkInterfaceName", "macAddress " ": "2C:54:91 : 88: C9: E3 "," LinkStatus ":" OMHOOG "," NetworkInterfaceid ":" /Subscriptions/subscription/resourcegroups/resourcegroupName/providers/Microsoft.NamanagenFers/NETWORKCENENSE/NETWORDWORDCENSE/NETWORKCIC/NETWORDWORCICENFORGENCES/NETWORNGENSENCIC/NETWORMENFENCENS /NETWORMENFENCENS/NETWOSTWORCIC/NETWORNENFENCENCIJE " : "Specifieke informatie over de maszyny..." }, "detailedStatus": "Stepn", "detailedStatusMessage": "DetailedStatusMessage", "serviceTag": "ST1219XXX", "kubernetesNodeName": " node01" , "kubernetesVersion": " 1.21", "osImage": "v20220805e", "oamIpv4Address": "192.0.2.1", "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001" , " hardwareValidationStatus": { "rezultat ": "Prošlo", "lastValidationTime": "2022-09-30T13:27:03.008Z"}, "hybridAksClustersAssociatedIds": [ "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft .NetworkCloud /hybridAksClusters/hybridAks Naziv klastera" ] , "virtualMachinesAssociatedIds": [ "/subscriptions/subscriptionId/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName" ] }}Definitions
| To do | Description |
|---|---|
| Administrative credentials | AdministrativeCredentials represents the administrative credentials for a device that requires password-based authentication. |
| BareMetalMaszyna | BareMetalMachine is a physical machine in a rack. |
| BareMetalMachineCordonStatus | Bare metal cordon stands for machines. |
| BareMetalMachineDetailedStatus | Detailed condition of the bare machine. |
| BareMetalMachineHardwareValidationResult | Hardware check result. |
| BareMetalMachinePowerState | Power status received from motherboard management controller. |
| BareMetalMachineProvisioningState | Supply state of the bare machine. |
| BareMetalMachineReadyState | An indicator of whether a bare computer is ready to accept workloads. |
| made according to type | The identity type that created the resource. |
| ErrorAdditional information | Additional information about the resource manager error. |
| Error details | Error details. |
| FoutAnwoord | Wrong answer |
| Extended localization | ExtendedLocation represents the custom Azure location where the resource is created. |
| Equipment inventory | HardwareInventory shows the hardware configuration of this machine as available to the customer, including information obtained from the model information and ironic inspector. |
| HardwareInventoryNetworkInterfejs | HardwareInventoryNetworkInterface represents the network interface details as part of the hardware inventory. |
| Hardware check status | HardwareValidationStatus represents the latest hardware validation details performed for this bare machine. |
| LldpSąsiad | Outdated guy. This will be removed in the next version. LldpNeighbor presents detailed information about the device connected to the network card. |
| Nick | Outdated guy. This will be removed in the next version. Nothing represents the network interface card details. |
| system information | Metadata about the creation and last modification of the resource. |
Administrative credentials
AdministrativeCredentials represents the administrative credentials for a device that requires password-based authentication.
| To do | Tip | Description |
|---|---|---|
| password | series | Device administrator password used during initialization. |
| username | series | Device administrator username used during initialization. |
BareMetalMaszyna
BareMetalMachine is a physical machine in a rack.
| To do | Tip | Description |
|---|---|---|
| extensive Location | Extended localization | ExtendedLocation represents the custom Azure location where the resource is created. |
| identification card | series | Potpuni kvalificirani ID resursa za resurs. npr. - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| Place | series | The geographic location where the resource is located |
| To do | series | Source name |
| svojstva.bmcConnectionString | series | Connection string for the motherboard's management controller, including IP address and protocol. |
| properties.bmcCredentials | Administrative credentials | AdministrativeCredentials represents the administrative credentials for a device that requires password-based authentication. |
| properties.bmcMacAddress | series | The MAC address of the BMC device. |
| properties.bootMacAddress | series | The MAC address of the network adapter connected to the PXE network. |
| characteristics. Cluster ID | series | The resource ID of the cluster to which this physical computer is associated. |
| properties. cordonStatus | BareMetalMachineCordonStatus | Bare metal cordon stands for machines. |
| properties.detailedStatus | BareMetalMachineDetailedStatus | Detailed condition of the bare machine. |
| properties.detailedStatusMessage | series | A descriptive message about the current detailed status. |
| properties. equipment. inventory | Equipment inventory | HardwareInventory shows the hardware configuration of this machine as available to the customer, including information obtained from the model information and ironic inspector. |
| properties.hardwareValidationStatus | Hardware check status | HardwareValidationStatus represents the latest hardware validation details performed for this bare machine. |
| properties.hybridAksClustersAssociatedIds | series[] | A list of resource IDs for HybridAksClusters with nodes located on this bare machine. |
| properties.kubernetesNodeName | series | The name of this machine, represented by the host object in the cluster's Kubernetes control plane. |
| properties.kubernetesVersion | series | The version of Kubernetes running on this computer. |
| properties.machineDetails | series | Custom data provided by the customer. |
| characteristics. machine name | series | Operating system-level host name assigned to this computer. |
| properties.machineSkuId | series | The unique internal SKU ID of the bare machine. |
| properties.oamIpv4Address | series | The IPv4 address assigned to the physical computer when the cluster was set up. |
| properties.oamIpv6Address | series | The IPv6 address assigned to the physical computer during cluster setup. |
| properties.osImage | series | The image that is currently on the operating system disk. |
| characteristics. power status | BareMetalMachinePowerState | Power status received from motherboard management controller. |
| properties.provisioningState | BareMetalMachineProvisioningState | Supply state of the bare machine. |
| properties.Mode ID | series | The resource ID of the rack that this bare metal machine resides in. |
| properties.rackSlot | round number | The rack slot in which this metal machine is located is arranged from bottom to top, i.e. the lowest slot is 1. |
| characteristics. wait | BareMetalMachineReadyState | An indicator of whether a bare computer is ready to accept workloads. |
| properties. serial number | series | Serial number of the bare machine. |
| properties. Service mark | series | Detected machine service tag value. |
| svojstva.virtualMachinesAssociatedIds | series[] | List of resource IDs for VMs hosted on this bare machine. |
| system information | system information | Azure Resource Manager metadata that contains information created and modified by it. |
| tip | object | Brontags. |
| tip | series | Tip Zasobu. Np. "Microsoft.Compute/virtualMachines" od "Microsoft.Storage/storageAccounts" |
BareMetalMachineCordonStatus
Bare metal cordon stands for machines.
| To do | Tip | Description |
|---|---|---|
| Fenced | series | |
| No cordon | series |
BareMetalMachineDetailedStatus
Detailed condition of the bare machine.
| To do | Tip | Description |
|---|---|---|
| Available | series | |
| Checkout | series | |
| wrong | series | |
| Preparation | series | |
| Equipped | series | |
| accessories | series |
BareMetalMachineHardwareValidationResult
Hardware check result.
| To do | Tip | Description |
|---|---|---|
| Failure | series | |
| passage | series |
BareMetalMachinePowerState
Power status received from motherboard management controller.
| To do | Tip | Description |
|---|---|---|
| Van | series | |
| AND | series |
BareMetalMachineProvisioningState
Supply state of the bare machine.
| To do | Tip | Description |
|---|---|---|
| Adopted | series | |
| Cancelled | series | |
| lost | series | |
| accessories | series | |
| It worked | series |
BareMetalMachineReadyState
An indicator of whether a bare computer is ready to accept workloads.
| To do | Tip | Description |
|---|---|---|
| LIE | series | |
| WHERE | series |
made according to type
The identity type that created the resource.
| To do | Tip | Description |
|---|---|---|
| application | series | |
| Key | series | |
| Managed identity | series | |
| User | series |
ErrorAdditional information
Additional information about the resource manager error.
| To do | Tip | Description |
|---|---|---|
| information | object | More information. |
| tip | series | An additional type of information. |
Error details
Error details.
| To do | Tip | Description |
|---|---|---|
| More information | ErrorAdditional information[] | Additional information about the error. |
| to code | series | Error code. |
| details | Error details[] | Error details. |
| message | series | Error message. |
| FROM | series | Error target. |
FoutAnwoord
Wrong answer
| To do | Tip | Description |
|---|---|---|
| wrong | Error details | Error object. |
Extended localization
ExtendedLocation represents the custom Azure location where the resource is created.
| To do | Tip | Description |
|---|---|---|
| To do | series | The resource ID of the extended location where the resource was created. |
| tip | series | An extended location type, such as CustomLocation. |
Equipment inventory
HardwareInventory shows the hardware configuration of this machine as available to the customer, including information obtained from the model information and ironic inspector.
| To do | Tip | Description |
|---|---|---|
| additional information about the host | series | All data extracted from the environment for this machine. This information depends on your specific hardware and configuration. |
| interfaces | HardwareInventoryNetworkInterfejs[] | List of network interfaces and related details for a bare computer. |
| nicki | Nick[] | Retired field. This will be removed in the next version. List of network interface cards and related data about a bare metal computer. |
HardwareInventoryNetworkInterfejs
HardwareInventoryNetworkInterface represents the network interface details as part of the hardware inventory.
| To do | Tip | Description |
|---|---|---|
| pairing status | series | Current connection status. |
| mac address | series | The MAC address associated with this interface. |
| To do | series | Interface name. |
| ID of the network interface | series | The network interface resource ID for the port on the switch to which this machine's interface is connected. |
Hardware check status
HardwareValidationStatus represents the latest hardware validation details performed for this bare machine.
| To do | Tip | Description |
|---|---|---|
| lastValidationTime | series | Hardware check execution timestamp. |
| result | BareMetalMachineHardwareValidationResult | Hardware check result. |
LldpSąsiad
Outdated guy. This will be removed in the next version. LldpNeighbor presents detailed information about the device connected to the network card.
| To do | Tip | Description |
|---|---|---|
| port description | series | Descriptive information about the port on the connected device. |
| port name | series | The port name assigned by the system of the connected device. |
| Description of the system | series | Descriptive information about the connected device. |
| system name | series | Name of the connected device assigned by the system. |
Nick
Outdated guy. This will be removed in the next version. Nothing represents the network interface card details.
| To do | Tip | Description |
|---|---|---|
| lldpSąsiad | LldpSąsiad | Outdated guy. This will be removed in the next version. LldpNeighbor presents detailed information about the device connected to the network card. |
| mac address | series | The MAC address associated with this network adapter. |
| To do | series | The name of the network adapter/interface. |
system information
Metadata about the creation and last modification of the resource.
| To do | Tip | Description |
|---|---|---|
| created | series | Resource creation timestamp (UTC). |
| did | series | The identity that created the resource. |
| made according to type | made according to type | The identity type that created the resource. |
| Last changes | series | Resource Last Modified Timestamp (UTC) |
| last modified | series | The identity that last modified the resource. |
| lastModifiedByType | made according to type | The identity type last modified by the resource. |