Microsoft.BareMetalInfrastructure (preview:2020-08-06)

2025/09/26 • 9 new, 9 deleted methods

AzureBareMetalInstances_Start (new)
Description :  The operation to start an AzureBareMetal instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Restart (new)
Description :  The operation to restart an AzureBareMetal instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Shutdown (new)
Description :  The operation to shutdown an AzureBareMetal instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/shutdown
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_ListBySubscription (new)
Description :  Gets a list of AzureBareMetal instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Azure BareMetal instances. ,
Required: False ,
}
[
{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of AzureBareMetal instances. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_List (new)
Description :  Gets a list of AzureBareMetal instances in the specified subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Azure BareMetal instances. ,
Required: False ,
}
[
{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of AzureBareMetal instances. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (new)
Description :  Gets a list of AzureBareMetal management operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BareMetalInfrastructure/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AzureBareMetal operations ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service. ,
Required: False ,
}
string ,
display:
{
Description: Displayed AzureBareMetal operation information ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with "Microsoft" for 1st party services. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the “name” section. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views. ,
Required: False ,
}
string ,
origin:
{
Description: The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system' ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: indicates whether an operation is a data action or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Get (new)
Description :  Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Delete (new)
Description :  Deletes a Azure BareMetal instance with the specified subscription, resource group, and instance name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Update (new)
Description :  Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
tagsParameter:
{
Description: Request body that only contains the new Tags field ,
Required: True ,
}
{
tags:
{
Description: Tags field of the AzureBareMetal instance. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Start (removed)
Description :  The operation to start an AzureBareMetal instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/start
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Restart (removed)
Description :  The operation to restart an AzureBareMetal instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/restart
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Shutdown (removed)
Description :  The operation to shutdown an AzureBareMetal instance
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}/shutdown
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_ListBySubscription (removed)
Description :  Gets a list of AzureBareMetal instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Azure BareMetal instances. ,
Required: False ,
}
[
{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of AzureBareMetal instances. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_List (removed)
Description :  Gets a list of AzureBareMetal instances in the specified subscription and resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of Azure BareMetal instances. ,
Required: False ,
}
[
{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of AzureBareMetal instances. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Operations_List (removed)
Description :  Gets a list of AzureBareMetal management operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.BareMetalInfrastructure/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of AzureBareMetal operations ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service. ,
Required: False ,
}
string ,
display:
{
Description: Displayed AzureBareMetal operation information ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. This form is also expected to include the publisher/company responsible. Use Title Casing. Begin with "Microsoft" for 1st party services. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. This form should match the public documentation for the resource provider. Use Title Casing. For examples, refer to the “name” section. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation as shown to the user. This name should be concise (to fit in drop downs), but clear (self-documenting). Use Title Casing and include the entity/resource to which it applies. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation as shown to the user. This description should be thorough, yet concise. It will be used in tool-tips and detailed views. ,
Required: False ,
}
string ,
origin:
{
Description: The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is 'user,system' ,
Required: False ,
}
string ,
}
,
isDataAction:
{
Description: indicates whether an operation is a data action or not. ,
Required: False ,
}
boolean ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Get (removed)
Description :  Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Delete (removed)
Description :  Deletes a Azure BareMetal instance with the specified subscription, resource group, and instance name.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AzureBareMetalInstances_Update (removed)
Description :  Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
azureBareMetalInstanceName:
{
Description: Name of the Azure BareMetal on Azure instance. ,
Required: True ,
}
string ,
tagsParameter:
{
Description: Request body that only contains the new Tags field ,
Required: True ,
}
{
tags:
{
Description: Tags field of the AzureBareMetal instance. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: AzureBareMetal instance properties ,
Required: False ,
}
{
hardwareProfile:
{
Description: Specifies the hardware settings for the AzureBareMetal instance. ,
Required: False ,
}
{
hardwareType:
{
Description: Name of the hardware type (vendor and/or their product name) ,
Enum:
{
Cisco_UCS: No description available. ,
HPE: No description available. ,
}
,
Required: False ,
}
enum ,
azureBareMetalInstanceSize:
{
Description: Specifies the AzureBareMetal instance SKU. ,
Enum:
{
S72m: No description available. ,
S144m: No description available. ,
S72: No description available. ,
S144: No description available. ,
S192: No description available. ,
S192m: No description available. ,
S192xm: No description available. ,
S96: No description available. ,
S112: No description available. ,
S224: No description available. ,
S224m: No description available. ,
S224om: No description available. ,
S224oo: No description available. ,
S224oom: No description available. ,
S224ooo: No description available. ,
S384: No description available. ,
S384m: No description available. ,
S384xm: No description available. ,
S384xxm: No description available. ,
S448: No description available. ,
S448m: No description available. ,
S448om: No description available. ,
S448oo: No description available. ,
S448oom: No description available. ,
S448ooo: No description available. ,
S576m: No description available. ,
S576xm: No description available. ,
S672: No description available. ,
S672m: No description available. ,
S672om: No description available. ,
S672oo: No description available. ,
S672oom: No description available. ,
S672ooo: No description available. ,
S768: No description available. ,
S768m: No description available. ,
S768xm: No description available. ,
S896: No description available. ,
S896m: No description available. ,
S896om: No description available. ,
S896oo: No description available. ,
S896oom: No description available. ,
S896ooo: No description available. ,
S960m: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
storageProfile:
{
Description: Specifies the storage settings for the AzureBareMetal instance disks. ,
Required: False ,
}
{
nfsIpAddress:
{
Description: IP Address to connect to storage. ,
Required: False ,
}
string ,
osDisks:
{
Description: Specifies information about the operating system disk used by baremetal instance. ,
Required: False ,
}
[
{
name:
{
Description: The disk name. ,
Required: False ,
}
string ,
diskSizeGB:
{
Description: Specifies the size of an empty data disk in gigabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
lun:
{
Description: Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
osProfile:
{
Description: Specifies the operating system settings for the AzureBareMetal instance. ,
Required: False ,
}
{
computerName:
{
Description: Specifies the host OS name of the AzureBareMetal instance. ,
Required: False ,
}
string ,
osType:
{
Description: This property allows you to specify the type of the OS. ,
Required: False ,
}
string ,
version:
{
Description: Specifies version of operating system. ,
Required: False ,
}
string ,
sshPublicKey:
{
Description: Specifies the SSH public key used to access the operating system. ,
Required: False ,
}
string ,
}
,
networkProfile:
{
Description: Specifies the network settings for the AzureBareMetal instance. ,
Required: False ,
}
{
networkInterfaces:
{
Description: Specifies the network interfaces for the AzureBareMetal instance. ,
Required: False ,
}
[
{
ipAddress:
{
Description: Specifies the IP address of the network interface. ,
Required: False ,
}
string ,
}
,
]
,
circuitId:
{
Description: Specifies the circuit id for connecting to express route. ,
Required: False ,
}
string ,
}
,
azureBareMetalInstanceId:
{
Description: Specifies the AzureBareMetal instance unique ID. ,
Required: False ,
}
string ,
powerState:
{
Description: Resource power state ,
Enum:
{
starting: No description available. ,
started: No description available. ,
stopping: No description available. ,
stopped: No description available. ,
restarting: No description available. ,
unknown: No description available. ,
}
,
Required: False ,
}
enum ,
proximityPlacementGroup:
{
Description: Resource proximity placement group ,
Required: False ,
}
string ,
hwRevision:
{
Description: Hardware revision of an AzureBareMetal instance ,
Required: False ,
}
string ,
partnerNodeId:
{
Description: ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance ,
Required: False ,
}
string ,
provisioningState:
{
Description: State of provisioning of the AzureBareMetalInstance ,
Enum:
{
Accepted: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Deleting: No description available. ,
Migrating: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error details. ,
Required: False ,
}
{
code:
{
Description: Service specific error code which serves as the substatus for the HTTP error code. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error. ,
Required: False ,
}
string ,
details:
{
Description: Internal error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}