Bare Metal Machines - Create Or Update

Service:

Operator Nexus - Network Cloud

API-versie:

2024-07-01

Maak of werk de bare-metalmachine bij.
Maak een nieuwe bare-metalmachine of werk de eigenschappen van de bestaande machine bij. Alle door de klant geïnitieerde aanvragen worden geweigerd als de levenscyclus van deze resource wordt beheerd door het systeem.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/bareMetalMachines/{bareMetalMachineName}?api-version=2024-07-01

URI-parameters

Name	In	Vereist	Type	Description
bareMetalMachineName	path	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$	De naam van de bare metalmachine.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
extendedLocation	True	ExtendedLocation	ExtendedLocation vertegenwoordigt de aangepaste Azure-locatie waar de resource wordt gemaakt. De uitgebreide locatie van het cluster dat is gekoppeld aan de resource.
location	True	string	De geografische locatie waar de resource zich bevindt
properties.bmcConnectionString	True	string	De verbindingsreeks voor de beheercontroller voor basisboards, inclusief IP-adres en protocol.
properties.bmcCredentials	True	AdministrativeCredentials	AdministrativeCredentials vertegenwoordigt de beheerdersreferenties voor het apparaat waarvoor verificatie op basis van een wachtwoord is vereist. De referenties van de baseboard-beheercontroller op deze bare-metalcomputer.
properties.bmcMacAddress	True	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	Het MAC-adres van het BMC-apparaat.
properties.bootMacAddress	True	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	Het MAC-adres van een NIC die is verbonden met het PXE-netwerk.
properties.machineDetails	True	string maxLength: 256	De aangepaste gegevens van de klant.
properties.machineName	True	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$	De hostnaam op besturingssysteemniveau die is toegewezen aan deze computer.
properties.machineSkuId	True	string	De unieke interne id van de bare-metalcomputer-SKU.
properties.rackId	True	string (arm-id)	De resource-id van het rek waar deze bare-metalmachine zich bevindt.
properties.rackSlot	True	integer (int64) minimum: 1 maximum: 256	De reksleuf waarin deze bare metalmachine zich bevindt, geordend vanaf de onderkant, dus de laagste sleuf is 1.
properties.serialNumber	True	string minLength: 1 maxLength: 64	Het serienummer van de bare-metalmachine.
properties.machineClusterVersion		string	De clusterversie die tijdens de implementatie of een versie-update op deze machine is toegepast.
tags		object	Resourcetags.

Antwoorden

Name	Type	Description
200 OK	BareMetalMachine	De resource is gemaakt of bijgewerkt.
201 Created	BareMetalMachine	De resource is geaccepteerd voor het maken of bijwerken. Kopteksten Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Create or update bare metal machine

Voorbeeldaanvraag

HTTP

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

{
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/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": "User-provided machine details.",
    "serialNumber": "BM1219XXX"
  }
}

Java

import com.azure.resourcemanager.networkcloud.models.AdministrativeCredentials;
import com.azure.resourcemanager.networkcloud.models.ExtendedLocation;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for BareMetalMachines CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/
     * BareMetalMachines_Create.json
     */
    /**
     * Sample code: Create or update bare metal machine.
     * 
     * @param manager Entry point to NetworkCloudManager.
     */
    public static void
        createOrUpdateBareMetalMachine(com.azure.resourcemanager.networkcloud.NetworkCloudManager manager) {
        manager.bareMetalMachines().define("bareMetalMachineName").withRegion("location")
            .withExistingResourceGroup("resourceGroupName")
            .withExtendedLocation(new ExtendedLocation().withName(
                "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName")
                .withType("CustomLocation"))
            .withBmcConnectionString("bmcconnectionstring")
            .withBmcCredentials(
                new AdministrativeCredentials().withPassword("fakeTokenPlaceholder").withUsername("bmcuser"))
            .withBmcMacAddress("00:00:4f:00:57:00").withBootMacAddress("00:00:4e:00:58:af")
            .withMachineDetails("User-provided machine details.").withMachineName("r01c001")
            .withMachineSkuId("684E-3B16-399E")
            .withRackId(
                "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName")
            .withRackSlot(1L).withSerialNumber("BM1219XXX")
            .withTags(mapOf("key1", "fakeTokenPlaceholder", "key2", "fakeTokenPlaceholder")).create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.networkcloud import NetworkCloudMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-networkcloud
# USAGE
    python bare_metal_machines_create.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetworkCloudMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="123e4567-e89b-12d3-a456-426655440000",
    )

    response = client.bare_metal_machines.begin_create_or_update(
        resource_group_name="resourceGroupName",
        bare_metal_machine_name="bareMetalMachineName",
        bare_metal_machine_parameters={
            "extendedLocation": {
                "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
                "type": "CustomLocation",
            },
            "location": "location",
            "properties": {
                "bmcConnectionString": "bmcconnectionstring",
                "bmcCredentials": {"password": "{password}", "username": "bmcuser"},
                "bmcMacAddress": "00:00:4f:00:57:00",
                "bootMacAddress": "00:00:4e:00:58:af",
                "machineDetails": "User-provided machine details.",
                "machineName": "r01c001",
                "machineSkuId": "684E-3B16-399E",
                "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
                "rackSlot": 1,
                "serialNumber": "BM1219XXX",
            },
            "tags": {"key1": "myvalue1", "key2": "myvalue2"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Create.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetworkcloud_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/networkcloud/armnetworkcloud"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c0a12a75b702054cf1e7fcd8c014d0fc116dea6e/specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Create.json
func ExampleBareMetalMachinesClient_BeginCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetworkcloud.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewBareMetalMachinesClient().BeginCreateOrUpdate(ctx, "resourceGroupName", "bareMetalMachineName", armnetworkcloud.BareMetalMachine{
		Location: to.Ptr("location"),
		Tags: map[string]*string{
			"key1": to.Ptr("myvalue1"),
			"key2": to.Ptr("myvalue2"),
		},
		ExtendedLocation: &armnetworkcloud.ExtendedLocation{
			Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
			Type: to.Ptr("CustomLocation"),
		},
		Properties: &armnetworkcloud.BareMetalMachineProperties{
			BmcConnectionString: to.Ptr("bmcconnectionstring"),
			BmcCredentials: &armnetworkcloud.AdministrativeCredentials{
				Password: to.Ptr("{password}"),
				Username: to.Ptr("bmcuser"),
			},
			BmcMacAddress:  to.Ptr("00:00:4f:00:57:00"),
			BootMacAddress: to.Ptr("00:00:4e:00:58:af"),
			MachineDetails: to.Ptr("User-provided machine details."),
			MachineName:    to.Ptr("r01c001"),
			MachineSKUID:   to.Ptr("684E-3B16-399E"),
			RackID:         to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName"),
			RackSlot:       to.Ptr[int64](1),
			SerialNumber:   to.Ptr("BM1219XXX"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BareMetalMachine = armnetworkcloud.BareMetalMachine{
	// 	Name: to.Ptr("bareMetalMachineName"),
	// 	Type: to.Ptr("Microsoft.NetworkCloud/bareMetalMachines"),
	// 	ID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName"),
	// 	SystemData: &armnetworkcloud.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:27:03.008Z"); return t}()),
	// 		CreatedBy: to.Ptr("identityA"),
	// 		CreatedByType: to.Ptr(armnetworkcloud.CreatedByTypeApplication),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-01-22T13:29:03.001Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("identityB"),
	// 		LastModifiedByType: to.Ptr(armnetworkcloud.CreatedByTypeUser),
	// 	},
	// 	Location: to.Ptr("location"),
	// 	Tags: map[string]*string{
	// 		"key1": to.Ptr("myvalue1"),
	// 		"key2": to.Ptr("myvalue2"),
	// 	},
	// 	ExtendedLocation: &armnetworkcloud.ExtendedLocation{
	// 		Name: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"),
	// 		Type: to.Ptr("CustomLocation"),
	// 	},
	// 	Properties: &armnetworkcloud.BareMetalMachineProperties{
	// 		AssociatedResourceIDs: []*string{
	// 			to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName")},
	// 			BmcConnectionString: to.Ptr("bmcconnectionstring"),
	// 			BmcCredentials: &armnetworkcloud.AdministrativeCredentials{
	// 				Username: to.Ptr("bmcuser"),
	// 			},
	// 			BmcMacAddress: to.Ptr("00:00:4f:00:57:00"),
	// 			BootMacAddress: to.Ptr("00:00:4e:00:58:af"),
	// 			ClusterID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/clusters/clusterName"),
	// 			CordonStatus: to.Ptr(armnetworkcloud.BareMetalMachineCordonStatusUncordoned),
	// 			DetailedStatus: to.Ptr(armnetworkcloud.BareMetalMachineDetailedStatusAvailable),
	// 			DetailedStatusMessage: to.Ptr("DetailedStatusMessage"),
	// 			HardwareInventory: &armnetworkcloud.HardwareInventory{
	// 				AdditionalHostInformation: to.Ptr("Machine specific information..."),
	// 				Interfaces: []*armnetworkcloud.HardwareInventoryNetworkInterface{
	// 					{
	// 						Name: to.Ptr("networkInterfaceName"),
	// 						LinkStatus: to.Ptr("Up"),
	// 						MacAddress: to.Ptr("2C:54:91:88:C9:E3"),
	// 						NetworkInterfaceID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName"),
	// 				}},
	// 			},
	// 			HardwareValidationStatus: &armnetworkcloud.HardwareValidationStatus{
	// 				LastValidationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-30T13:27:03.008Z"); return t}()),
	// 				Result: to.Ptr(armnetworkcloud.BareMetalMachineHardwareValidationResultPass),
	// 			},
	// 			KubernetesNodeName: to.Ptr("node01"),
	// 			KubernetesVersion: to.Ptr("1.28.3"),
	// 			MachineClusterVersion: to.Ptr("3.8.7"),
	// 			MachineDetails: to.Ptr("User-provided machine details."),
	// 			MachineName: to.Ptr("r01c001"),
	// 			MachineRoles: []*string{
	// 				to.Ptr("platform.afo-nc.microsoft.com/management-plane=true")},
	// 				MachineSKUID: to.Ptr("684E-3B16-399E"),
	// 				OamIPv4Address: to.Ptr("192.0.2.1"),
	// 				OamIPv6Address: to.Ptr("0:0:0:0:0:FFFF:7F00:0001"),
	// 				OSImage: to.Ptr("v20220805e"),
	// 				PowerState: to.Ptr(armnetworkcloud.BareMetalMachinePowerStateOn),
	// 				ProvisioningState: to.Ptr(armnetworkcloud.BareMetalMachineProvisioningStateSucceeded),
	// 				RackID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName"),
	// 				RackSlot: to.Ptr[int64](1),
	// 				ReadyState: to.Ptr(armnetworkcloud.BareMetalMachineReadyStateTrue),
	// 				RuntimeProtectionStatus: &armnetworkcloud.RuntimeProtectionStatus{
	// 					DefinitionsLastUpdated: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-28T13:27:03.008Z"); return t}()),
	// 					DefinitionsVersion: to.Ptr("1.2.3"),
	// 					ScanCompletedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-30T13:27:23.103Z"); return t}()),
	// 					ScanScheduledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-10-01T13:00:00.000Z"); return t}()),
	// 					ScanStartedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-30T13:00:03.008Z"); return t}()),
	// 				},
	// 				SecretRotationStatus: []*armnetworkcloud.SecretRotationStatus{
	// 					{
	// 						ExpirePeriodDays: to.Ptr[int64](90),
	// 						LastRotationTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-09-30T13:27:23.103Z"); return t}()),
	// 						RotationPeriodDays: to.Ptr[int64](60),
	// 						SecretArchiveReference: &armnetworkcloud.SecretArchiveReference{
	// 							KeyVaultID: to.Ptr("/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName"),
	// 							SecretName: to.Ptr("ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff"),
	// 							SecretVersion: to.Ptr("02ab6c1f9c0f4982b0632b0d5d74a33b"),
	// 						},
	// 						SecretType: to.Ptr("Bare Metal Machine Identity - console"),
	// 				}},
	// 				SerialNumber: to.Ptr("BM1219XXX"),
	// 				ServiceTag: to.Ptr("ST1219XXX"),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetworkCloud } = require("@azure/arm-networkcloud");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Create a new bare metal machine or update the properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
 *
 * @summary Create a new bare metal machine or update the properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
 * x-ms-original-file: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/stable/2024-07-01/examples/BareMetalMachines_Create.json
 */
async function createOrUpdateBareMetalMachine() {
  const subscriptionId =
    process.env["NETWORKCLOUD_SUBSCRIPTION_ID"] || "123e4567-e89b-12d3-a456-426655440000";
  const resourceGroupName = process.env["NETWORKCLOUD_RESOURCE_GROUP"] || "resourceGroupName";
  const bareMetalMachineName = "bareMetalMachineName";
  const bareMetalMachineParameters = {
    bmcConnectionString: "bmcconnectionstring",
    bmcCredentials: { password: "{password}", username: "bmcuser" },
    bmcMacAddress: "00:00:4f:00:57:00",
    bootMacAddress: "00:00:4e:00:58:af",
    extendedLocation: {
      name: "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName",
      type: "CustomLocation",
    },
    location: "location",
    machineDetails: "User-provided machine details.",
    machineName: "r01c001",
    machineSkuId: "684E-3B16-399E",
    rackId:
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/racks/rackName",
    rackSlot: 1,
    serialNumber: "BM1219XXX",
    tags: { key1: "myvalue1", key2: "myvalue2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new NetworkCloud(credential, subscriptionId);
  const result = await client.bareMetalMachines.beginCreateOrUpdateAndWait(
    resourceGroupName,
    bareMetalMachineName,
    bareMetalMachineParameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:

200

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
  "name": "bareMetalMachineName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/bareMetalMachines",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/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"
    },
    "bmcConnectionString": "bmcconnectionstring",
    "machineDetails": "User-provided machine details.",
    "serialNumber": "BM1219XXX",
    "provisioningState": "Succeeded",
    "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/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": "Up",
          "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName"
        }
      ],
      "additionalHostInformation": "Machine specific information..."
    },
    "detailedStatus": "Available",
    "detailedStatusMessage": "DetailedStatusMessage",
    "serviceTag": "ST1219XXX",
    "kubernetesNodeName": "node01",
    "kubernetesVersion": "1.28.3",
    "machineClusterVersion": "3.8.7",
    "osImage": "v20220805e",
    "oamIpv4Address": "192.0.2.1",
    "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001",
    "hardwareValidationStatus": {
      "result": "Pass",
      "lastValidationTime": "2022-09-30T13:27:03.008Z"
    },
    "associatedResourceIds": [
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName"
    ],
    "machineRoles": [
      "platform.afo-nc.microsoft.com/management-plane=true"
    ],
    "runtimeProtectionStatus": {
      "scanScheduledTime": "2023-10-01T13:00:00.000Z",
      "scanStartedTime": "2023-09-30T13:00:03.008Z",
      "scanCompletedTime": "2023-09-30T13:27:23.103Z",
      "definitionsLastUpdated": "2023-09-28T13:27:03.008Z",
      "definitionsVersion": "1.2.3"
    },
    "secretRotationStatus": [
      {
        "secretType": "Bare Metal Machine Identity - console",
        "lastRotationTime": "2023-09-30T13:27:23.103Z",
        "rotationPeriodDays": 60,
        "expirePeriodDays": 90,
        "secretArchiveReference": {
          "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName",
          "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff",
          "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b"
        }
      }
    ]
  }
}

Statuscode:

201

Azure-AsyncOperation: https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/providers/Microsoft.NetworkCloud/locations/location/operationStatuses/operationId?api-version=2024-07-01

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/bareMetalMachines/bareMetalMachineName",
  "name": "bareMetalMachineName",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/bareMetalMachines",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterExtendedLocationName"
  },
  "properties": {
    "rackId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/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"
    },
    "bmcConnectionString": "bmcconnectionstring",
    "machineDetails": "User-provided machine details.",
    "serialNumber": "BM1219XXX",
    "provisioningState": "Accepted",
    "clusterId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/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": "Up",
          "networkInterfaceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedNetworkFabric/networkDevices/networkDeviceName/networkInterfaces/networkInterfaceName"
        }
      ],
      "additionalHostInformation": "Machine specific information..."
    },
    "detailedStatus": "Available",
    "detailedStatusMessage": "DetailedStatusMessage",
    "serviceTag": "ST1219XXX",
    "kubernetesNodeName": "node01",
    "kubernetesVersion": "1.28.3",
    "machineClusterVersion": "3.8.7",
    "osImage": "v20220805e",
    "oamIpv4Address": "192.0.2.1",
    "oamIpv6Address": "0:0:0:0:0:FFFF:7F00:0001",
    "hardwareValidationStatus": {
      "result": "Pass",
      "lastValidationTime": "2022-09-30T13:27:03.008Z"
    },
    "associatedResourceIds": [
      "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName"
    ],
    "machineRoles": [
      "platform.afo-nc.microsoft.com/management-plane=true"
    ],
    "runtimeProtectionStatus": {
      "scanScheduledTime": "2023-10-01T13:00:00.000Z",
      "scanStartedTime": "2023-09-30T13:00:03.008Z",
      "scanCompletedTime": "2023-09-30T13:27:23.103Z",
      "definitionsLastUpdated": "2023-09-28T13:27:03.008Z",
      "definitionsVersion": "1.2.3"
    },
    "secretRotationStatus": [
      {
        "secretType": "Bare Metal Machine Identity - console",
        "lastRotationTime": "2023-09-30T13:27:23.103Z",
        "rotationPeriodDays": 60,
        "expirePeriodDays": 90,
        "secretArchiveReference": {
          "keyVaultId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.KeyVault/vaults/keyVaultName",
          "secretName": "ffffffff-ffff-ffff-ffff-ffffffffffff-resource-group-cluster-1679871-console-credential-manager-ffffffff",
          "secretVersion": "02ab6c1f9c0f4982b0632b0d5d74a33b"
        }
      }
    ]
  }
}

Definities

Name	Description
AdministrativeCredentials	AdministrativeCredentials vertegenwoordigt de beheerdersreferenties voor het apparaat waarvoor verificatie op basis van een wachtwoord is vereist.
BareMetalMachine	BareMetalMachine vertegenwoordigt de fysieke machine in het rek.
BareMetalMachineCordonStatus	De cordonstatus van de bare metalmachine.
BareMetalMachineDetailedStatus	Hoe gedetailleerder de status van de bare-metalmachine.
BareMetalMachineHardwareValidationResult	Het resultaat van de hardwarevalidatie.
BareMetalMachinePowerState	De energiestatus die is afgeleid van de beheercontroller van het basisbord.
BareMetalMachineProvisioningState	De inrichtingsstatus van de bare-metalmachine.
BareMetalMachineReadyState	De indicator of de bare-metalmachine gereed is voor het ontvangen van workloads.
createdByType	Het type identiteit waarmee de resource is gemaakt.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
ExtendedLocation	ExtendedLocation vertegenwoordigt de aangepaste Azure-locatie waar de resource wordt gemaakt.
HardwareInventory	HardwareInventory vertegenwoordigt de hardwareconfiguratie van deze machine die aan de klant wordt blootgesteld, inclusief informatie die is verkregen uit de model-/sKU-informatie en van de ironische inspector.
HardwareInventoryNetworkInterface	HardwareInventoryNetworkInterface vertegenwoordigt de netwerkinterfacegegevens als onderdeel van een hardware-inventarisatie.
HardwareValidationStatus	HardwareValidationStatus vertegenwoordigt de meest recente hardwarevalidatiegegevens die worden uitgevoerd voor deze bare-metalcomputer.
LldpNeighbor	Typ afgeschaft. Wordt verwijderd in een toekomstige versie. LldpNeighbor vertegenwoordigt de details over het apparaat dat is verbonden met de NIC.
Nic	Typ afgeschaft. Wordt verwijderd in een toekomstige versie. Nic vertegenwoordigt de gegevens van de netwerkinterfacekaart.
RuntimeProtectionStatus	RuntimeProtectionStatus vertegenwoordigt de runtime-beveiligingsstatus van de bare-metalcomputer.
SecretArchiveReference	SecretArchiveReference vertegenwoordigt de verwijzing naar een geheim in een sleutelkluis.
SecretRotationStatus	SecretRotationStatus vertegenwoordigt de status van een geheime rotatie.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

AdministrativeCredentials

Object

AdministrativeCredentials vertegenwoordigt de beheerdersreferenties voor het apparaat waarvoor verificatie op basis van een wachtwoord is vereist.

Name	Type	Description
password	string minLength: 1	Het wachtwoord van de beheerder van het apparaat dat tijdens de initialisatie wordt gebruikt.
username	string minLength: 1	De gebruikersnaam van de beheerder van het apparaat dat tijdens de initialisatie is gebruikt.

BareMetalMachine

Object

BareMetalMachine vertegenwoordigt de fysieke machine in het rek.

Name	Type	Description
extendedLocation	ExtendedLocation	ExtendedLocation vertegenwoordigt de aangepaste Azure-locatie waar de resource wordt gemaakt. De uitgebreide locatie van het cluster dat is gekoppeld aan de resource.
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
location	string	De geografische locatie waar de resource zich bevindt
name	string	De naam van de resource
properties.associatedResourceIds	string[]	De lijst met resource-id's voor de andere Microsoft.NetworkCloud-resources die dit netwerk hebben gekoppeld.
properties.bmcConnectionString	string	De verbindingsreeks voor de beheercontroller voor basisboards, inclusief IP-adres en protocol.
properties.bmcCredentials	AdministrativeCredentials	AdministrativeCredentials vertegenwoordigt de beheerdersreferenties voor het apparaat waarvoor verificatie op basis van een wachtwoord is vereist. De referenties van de baseboard-beheercontroller op deze bare-metalcomputer.
properties.bmcMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	Het MAC-adres van het BMC-apparaat.
properties.bootMacAddress	string pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$	Het MAC-adres van een NIC die is verbonden met het PXE-netwerk.
properties.clusterId	string (arm-id)	De resource-id van het cluster waarmee deze bare-metalcomputer is gekoppeld.
properties.cordonStatus	BareMetalMachineCordonStatus	De cordonstatus van de bare metalmachine.
properties.detailedStatus	BareMetalMachineDetailedStatus	Hoe gedetailleerder de status van de bare-metalmachine.
properties.detailedStatusMessage	string	Het beschrijvende bericht over de huidige gedetailleerde status.
properties.hardwareInventory	HardwareInventory	HardwareInventory vertegenwoordigt de hardwareconfiguratie van deze machine die aan de klant wordt blootgesteld, inclusief informatie die is verkregen uit de model-/sKU-informatie en van de ironische inspector. De hardware-inventarisatie, inclusief informatie die is verkregen uit de model-/sKU-informatie en van de ironische inspector.
properties.hardwareValidationStatus	HardwareValidationStatus	HardwareValidationStatus vertegenwoordigt de meest recente hardwarevalidatiegegevens die worden uitgevoerd voor deze bare-metalcomputer. De details van de meest recente hardwarevalidatie die voor deze bare-metalmachine is uitgevoerd.
properties.hybridAksClustersAssociatedIds	string[]	Veld afgeschaft. Deze velden worden leeg/weggelaten. De lijst met resource-id's voor de HybridAksClusters met knooppunten die worden gehost op deze bare-metalcomputer.
properties.kubernetesNodeName	string	De naam van deze machine die wordt vertegenwoordigd door het hostobject in het Kubernetes-besturingsvlak van het cluster.
properties.kubernetesVersion	string	De versie van Kubernetes die op deze computer wordt uitgevoerd.
properties.machineClusterVersion	string	De clusterversie die tijdens de implementatie of een versie-update op deze machine is toegepast.
properties.machineDetails	string maxLength: 256	De aangepaste gegevens van de klant.
properties.machineName	string pattern: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$	De hostnaam op besturingssysteemniveau die is toegewezen aan deze computer.
properties.machineRoles	string[]	De lijst met rollen die zijn toegewezen aan het clusterknooppunt dat op deze computer wordt uitgevoerd.
properties.machineSkuId	string	De unieke interne id van de bare-metalcomputer-SKU.
properties.oamIpv4Address	string	Het IPv4-adres dat is toegewezen aan de bare-metalcomputer tijdens de clusterimplementatie.
properties.oamIpv6Address	string	Het IPv6-adres dat is toegewezen aan de bare-metalcomputer tijdens de clusterimplementatie.
properties.osImage	string	De installatiekopieën die momenteel zijn ingericht op de besturingssysteemschijf.
properties.powerState	BareMetalMachinePowerState	De energiestatus die is afgeleid van de beheercontroller van het basisbord.
properties.provisioningState	BareMetalMachineProvisioningState	De inrichtingsstatus van de bare-metalmachine.
properties.rackId	string (arm-id)	De resource-id van het rek waar deze bare-metalmachine zich bevindt.
properties.rackSlot	integer (int64) minimum: 1 maximum: 256	De reksleuf waarin deze bare metalmachine zich bevindt, geordend vanaf de onderkant, dus de laagste sleuf is 1.
properties.readyState	BareMetalMachineReadyState	De indicator of de bare-metalmachine gereed is voor het ontvangen van workloads.
properties.runtimeProtectionStatus	RuntimeProtectionStatus	RuntimeProtectionStatus vertegenwoordigt de runtime-beveiligingsstatus van de bare-metalcomputer. De runtimebeveiligingsstatus van de bare-metalcomputer.
properties.secretRotationStatus	SecretRotationStatus[]	De lijst met statussen die de activiteit voor geheimrotatie vertegenwoordigen.
properties.serialNumber	string minLength: 1 maxLength: 64	Het serienummer van de bare-metalmachine.
properties.serviceTag	string	De gedetecteerde waarde van de servicetag van de machine.
properties.virtualMachinesAssociatedIds	string[]	Veld afgeschaft. Deze velden worden leeg/weggelaten. De lijst met resource-id's voor de VirtualMachines die worden gehost op deze bare-metalcomputer.
systemData	systemData	Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
tags	object	Resourcetags.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

BareMetalMachineCordonStatus

Inventarisatie

De cordonstatus van de bare metalmachine.

Waarde	Description
Cordoned
Uncordoned

BareMetalMachineDetailedStatus

Inventarisatie

Hoe gedetailleerder de status van de bare-metalmachine.

Waarde	Description
Available
Deprovisioning
Error
Preparing
Provisioned
Provisioning

BareMetalMachineHardwareValidationResult

Inventarisatie

Het resultaat van de hardwarevalidatie.

Waarde	Description
Fail
Pass

BareMetalMachinePowerState

Inventarisatie

De energiestatus die is afgeleid van de beheercontroller van het basisbord.

Waarde	Description
Off
On

BareMetalMachineProvisioningState

Inventarisatie

De inrichtingsstatus van de bare-metalmachine.

Waarde	Description
Accepted
Canceled
Failed
Provisioning
Succeeded

BareMetalMachineReadyState

Inventarisatie

De indicator of de bare-metalmachine gereed is voor het ontvangen van workloads.

Waarde	Description
False
True

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

ExtendedLocation

Object

ExtendedLocation vertegenwoordigt de aangepaste Azure-locatie waar de resource wordt gemaakt.

Name	Type	Description
name	string	De resource-id van de uitgebreide locatie waarop de resource wordt gemaakt.
type	string	Het uitgebreide locatietype, bijvoorbeeld CustomLocation.

HardwareInventory

Object

HardwareInventory vertegenwoordigt de hardwareconfiguratie van deze machine die aan de klant wordt blootgesteld, inclusief informatie die is verkregen uit de model-/sKU-informatie en van de ironische inspector.

Name	Type	Description
additionalHostInformation	string	Vrije vormgegevens die zijn geëxtraheerd uit de omgeving over deze machine. Deze informatie is afhankelijk van de specifieke hardware en configuratie.
interfaces	HardwareInventoryNetworkInterface[]	De lijst met netwerkinterfaces en bijbehorende details voor de bare-metalcomputer.
nics	Nic[]	Veld afgeschaft. Wordt verwijderd in een toekomstige versie. De lijst met netwerkinterfacekaarten en bijbehorende details voor de bare-metalcomputer.

HardwareInventoryNetworkInterface

Object

HardwareInventoryNetworkInterface vertegenwoordigt de netwerkinterfacegegevens als onderdeel van een hardware-inventarisatie.

Name	Type	Description
linkStatus	string	De huidige status van de koppeling.
macAddress	string	Het MAC-adres dat aan deze interface is gekoppeld.
name	string	De naam van de interface.
networkInterfaceId	string	De resource-id van de netwerkinterface voor de poort op de switch waarmee de interface van deze machine is verbonden.

HardwareValidationStatus

Object

HardwareValidationStatus vertegenwoordigt de meest recente hardwarevalidatiegegevens die worden uitgevoerd voor deze bare-metalcomputer.

Name	Type	Description
lastValidationTime	string (date-time)	De tijdstempel van de uitvoering van de hardwarevalidatie.
result	BareMetalMachineHardwareValidationResult	Het resultaat van de hardwarevalidatie.

LldpNeighbor

Object

Typ afgeschaft. Wordt verwijderd in een toekomstige versie. LldpNeighbor vertegenwoordigt de details over het apparaat dat is verbonden met de NIC.

Name	Type	Description
portDescription	string	De beschrijvende informatie over de poort op het verbonden apparaat.
portName	string	De door het systeem toegewezen naam van de poort op het verbonden apparaat.
systemDescription	string	De beschrijvende informatie over het verbonden apparaat.
systemName	string	De door het systeem toegewezen naam van het verbonden apparaat.

Nic

Object

Typ afgeschaft. Wordt verwijderd in een toekomstige versie. Nic vertegenwoordigt de gegevens van de netwerkinterfacekaart.

Name	Type	Description
lldpNeighbor	LldpNeighbor	Typ afgeschaft. Wordt verwijderd in een toekomstige versie. LldpNeighbor vertegenwoordigt de details over het apparaat dat is verbonden met de NIC. De informatie over het apparaat dat is verbonden met deze NIC.
macAddress	string	Het MAC-adres dat aan deze NIC is gekoppeld.
name	string	De naam van de NIC/interface.

RuntimeProtectionStatus

Object

RuntimeProtectionStatus vertegenwoordigt de runtime-beveiligingsstatus van de bare-metalcomputer.

Name	Type	Description
definitionsLastUpdated	string (date-time)	De tijdstempel waarop de malwaredefinities voor het laatst zijn bijgewerkt.
definitionsVersion	string	De versie van de malwaredefinities.
scanCompletedTime	string (date-time)	De tijdstempel van de laatst voltooide scan of leeg als er nog nooit een scan is geweest.
scanScheduledTime	string (date-time)	De tijdstempel van de laatst geplande scan of leeg als er geen scan is gepland.
scanStartedTime	string (date-time)	De tijdstempel van de laatst gestarte scan of leeg als er nog nooit een scan is geweest.

SecretArchiveReference

Object

SecretArchiveReference vertegenwoordigt de verwijzing naar een geheim in een sleutelkluis.

Name	Type	Description
keyVaultId	string (arm-id)	De resource-id van de sleutelkluis die het geheim bevat.
secretName	string	De naam van het geheim in de sleutelkluis.
secretVersion	string	De versie van het geheim in de sleutelkluis.

SecretRotationStatus

Object

SecretRotationStatus vertegenwoordigt de status van een geheime rotatie.

Name	Type	Description
expirePeriodDays	integer (int64)	Het maximum aantal dagen dat het geheim kan worden gebruikt voordat het moet worden gewijzigd.
lastRotationTime	string (date-time)	De datum en tijd waarop het geheim voor het laatst is gewijzigd.
rotationPeriodDays	integer (int64)	Het aantal dagen dat een geheim bestaat voordat er rotaties worden uitgevoerd.
secretArchiveReference	SecretArchiveReference	SecretArchiveReference vertegenwoordigt de verwijzing naar een geheim in een sleutelkluis. De verwijzing naar het geheim in een sleutelkluis.
secretType	string	De typenaam die wordt gebruikt om het doel van het geheim te identificeren.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.