ArmNetworkCloudModelFactory.NetworkCloudBareMetalMachineData Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public static Azure.ResourceManager.NetworkCloud.NetworkCloudBareMetalMachineData NetworkCloudBareMetalMachineData(Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, string bmcConnectionString = default, Azure.ResourceManager.NetworkCloud.Models.AdministrativeCredentials bmcCredentials = default, string bmcMacAddress = default, string bootMacAddress = default, string machineDetails = default, string machineName = default, string machineSkuId = default, Azure.Core.ResourceIdentifier rackId = default, long rackSlot = 0, string serialNumber = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.NetworkCloudActionState> actionStates = default, System.Collections.Generic.IEnumerable<Azure.Core.ResourceIdentifier> associatedResourceIds = default, string bmcIpv4Address = default, string bmcIpv6Address = default, Azure.ResourceManager.NetworkCloud.Models.NetworkCloudCertificateInfo caCertificate = default, Azure.Core.ResourceIdentifier clusterId = default, Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineCordonStatus? cordonStatus = default, Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineDetailedStatus? detailedStatus = default, string detailedStatusMessage = default, Azure.ResourceManager.NetworkCloud.Models.HardwareInventory hardwareInventory = default, Azure.ResourceManager.NetworkCloud.Models.HardwareValidationStatus hardwareValidationStatus = default, System.Collections.Generic.IEnumerable<string> hybridAksClustersAssociatedIds = default, string kubernetesNodeName = default, string kubernetesVersion = default, string machineClusterVersion = default, System.Collections.Generic.IEnumerable<string> machineRoles = default, System.Net.IPAddress oamIPv4Address = default, string oamIPv6Address = default, string osImage = default, Azure.ResourceManager.NetworkCloud.Models.BareMetalMachinePowerState? powerState = default, Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineReadyState? readyState = default, Azure.ResourceManager.NetworkCloud.Models.RuntimeProtectionStatus runtimeProtectionStatus = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.NetworkCloud.Models.SecretRotationStatus> secretRotationStatus = default, string serviceTag = default, System.Collections.Generic.IEnumerable<string> virtualMachinesAssociatedIds = default, Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineProvisioningState? provisioningState = default, Azure.ETag? eTag = default, Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation extendedLocation = default);
static member NetworkCloudBareMetalMachineData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * string * Azure.ResourceManager.NetworkCloud.Models.AdministrativeCredentials * string * string * string * string * string * Azure.Core.ResourceIdentifier * int64 * string * seq<Azure.ResourceManager.NetworkCloud.Models.NetworkCloudActionState> * seq<Azure.Core.ResourceIdentifier> * string * string * Azure.ResourceManager.NetworkCloud.Models.NetworkCloudCertificateInfo * Azure.Core.ResourceIdentifier * Nullable<Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineCordonStatus> * Nullable<Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineDetailedStatus> * string * Azure.ResourceManager.NetworkCloud.Models.HardwareInventory * Azure.ResourceManager.NetworkCloud.Models.HardwareValidationStatus * seq<string> * string * string * string * seq<string> * System.Net.IPAddress * string * string * Nullable<Azure.ResourceManager.NetworkCloud.Models.BareMetalMachinePowerState> * Nullable<Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineReadyState> * Azure.ResourceManager.NetworkCloud.Models.RuntimeProtectionStatus * seq<Azure.ResourceManager.NetworkCloud.Models.SecretRotationStatus> * string * seq<string> * Nullable<Azure.ResourceManager.NetworkCloud.Models.BareMetalMachineProvisioningState> * Nullable<Azure.ETag> * Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation -> Azure.ResourceManager.NetworkCloud.NetworkCloudBareMetalMachineData
Public Shared Function NetworkCloudBareMetalMachineData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional bmcConnectionString As String = Nothing, Optional bmcCredentials As AdministrativeCredentials = Nothing, Optional bmcMacAddress As String = Nothing, Optional bootMacAddress As String = Nothing, Optional machineDetails As String = Nothing, Optional machineName As String = Nothing, Optional machineSkuId As String = Nothing, Optional rackId As ResourceIdentifier = Nothing, Optional rackSlot As Long = 0, Optional serialNumber As String = Nothing, Optional actionStates As IEnumerable(Of NetworkCloudActionState) = Nothing, Optional associatedResourceIds As IEnumerable(Of ResourceIdentifier) = Nothing, Optional bmcIpv4Address As String = Nothing, Optional bmcIpv6Address As String = Nothing, Optional caCertificate As NetworkCloudCertificateInfo = Nothing, Optional clusterId As ResourceIdentifier = Nothing, Optional cordonStatus As Nullable(Of BareMetalMachineCordonStatus) = Nothing, Optional detailedStatus As Nullable(Of BareMetalMachineDetailedStatus) = Nothing, Optional detailedStatusMessage As String = Nothing, Optional hardwareInventory As HardwareInventory = Nothing, Optional hardwareValidationStatus As HardwareValidationStatus = Nothing, Optional hybridAksClustersAssociatedIds As IEnumerable(Of String) = Nothing, Optional kubernetesNodeName As String = Nothing, Optional kubernetesVersion As String = Nothing, Optional machineClusterVersion As String = Nothing, Optional machineRoles As IEnumerable(Of String) = Nothing, Optional oamIPv4Address As IPAddress = Nothing, Optional oamIPv6Address As String = Nothing, Optional osImage As String = Nothing, Optional powerState As Nullable(Of BareMetalMachinePowerState) = Nothing, Optional readyState As Nullable(Of BareMetalMachineReadyState) = Nothing, Optional runtimeProtectionStatus As RuntimeProtectionStatus = Nothing, Optional secretRotationStatus As IEnumerable(Of SecretRotationStatus) = Nothing, Optional serviceTag As String = Nothing, Optional virtualMachinesAssociatedIds As IEnumerable(Of String) = Nothing, Optional provisioningState As Nullable(Of BareMetalMachineProvisioningState) = Nothing, Optional eTag As Nullable(Of ETag) = Nothing, Optional extendedLocation As ExtendedLocation = Nothing) As NetworkCloudBareMetalMachineData
Parameters
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- String
The name of the resource.
- resourceType
- ResourceType
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
- systemData
- SystemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
- tags
- IDictionary<String,String>
Resource tags.
- location
- AzureLocation
The geo-location where the resource lives.
- bmcConnectionString
- String
The connection string for the baseboard management controller including IP address and protocol.
- bmcCredentials
- AdministrativeCredentials
The credentials of the baseboard management controller on this bare metal machine.
- bmcMacAddress
- String
The MAC address of the BMC device.
- bootMacAddress
- String
The MAC address of a NIC connected to the PXE network.
- machineDetails
- String
The custom details provided by the customer.
- machineName
- String
The OS-level hostname assigned to this machine.
- machineSkuId
- String
The unique internal identifier of the bare metal machine SKU.
- rackId
- ResourceIdentifier
The resource ID of the rack where this bare metal machine resides.
- rackSlot
- Int64
The rack slot in which this bare metal machine is located, ordered from the bottom up i.e. the lowest slot is 1.
- serialNumber
- String
The serial number of the bare metal machine.
- actionStates
- IEnumerable<NetworkCloudActionState>
The current state of any in progress or completed actions. The most recent known instance of each action type is shown.
- associatedResourceIds
- IEnumerable<ResourceIdentifier>
The list of resource IDs for the other Microsoft.NetworkCloud resources that have attached this network.
- bmcIpv4Address
- String
The IPv4 address of the BMC interface for the bare metal machine.
- bmcIpv6Address
- String
The IPv6 address of the BMC interface for the bare metal machine.
- caCertificate
- NetworkCloudCertificateInfo
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.
- clusterId
- ResourceIdentifier
The resource ID of the cluster this bare metal machine is associated with.
- cordonStatus
- Nullable<BareMetalMachineCordonStatus>
The cordon status of the bare metal machine.
- detailedStatus
- Nullable<BareMetalMachineDetailedStatus>
The more detailed status of the bare metal machine.
- detailedStatusMessage
- String
The descriptive message about the current detailed status.
- hardwareInventory
- HardwareInventory
The hardware inventory, including information acquired from the model/sku information and from the ironic inspector.
- hardwareValidationStatus
- HardwareValidationStatus
The details of the latest hardware validation performed for this bare metal machine.
- hybridAksClustersAssociatedIds
- IEnumerable<String>
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.
- kubernetesNodeName
- String
The name of this machine represented by the host object in the Cluster's Kubernetes control plane.
- kubernetesVersion
- String
The version of Kubernetes running on this machine.
- machineClusterVersion
- String
The cluster version that has been applied to this machine during deployment or a version update.
- machineRoles
- IEnumerable<String>
The list of roles that are assigned to the cluster node running on this machine.
- oamIPv4Address
- IPAddress
The IPv4 address that is assigned to the bare metal machine during the cluster deployment.
- oamIPv6Address
- String
The IPv6 address that is assigned to the bare metal machine during the cluster deployment.
- osImage
- String
The image that is currently provisioned to the OS disk.
- powerState
- Nullable<BareMetalMachinePowerState>
The power state derived from the baseboard management controller.
- readyState
- Nullable<BareMetalMachineReadyState>
The indicator of whether the bare metal machine is ready to receive workloads.
- runtimeProtectionStatus
- RuntimeProtectionStatus
The runtime protection status of the bare metal machine.
- secretRotationStatus
- IEnumerable<SecretRotationStatus>
The list of statuses that represent secret rotation activity.
- serviceTag
- String
The discovered value of the machine's service tag.
- virtualMachinesAssociatedIds
- IEnumerable<String>
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.
- provisioningState
- Nullable<BareMetalMachineProvisioningState>
The provisioning state of the bare metal machine.
"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.").
- extendedLocation
- Azure.ResourceManager.NetworkCloud.Models.ExtendedLocation
The extended location of the resource. This property is required when creating the resource.
Returns
A new NetworkCloudBareMetalMachineData instance for mocking.
Exceptions
bmcConnectionString, bmcCredentials, bmcMacAddress, bootMacAddress, machineDetails, machineName, machineSkuId, rackId or serialNumber is null.