Bicep resource definition
The machines resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.HybridCompute/machines resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridCompute/machines@2021-12-10-preview' = {
identity: {
type: 'SystemAssigned'
}
location: 'string'
name: 'string'
properties: {
agentConfiguration: {}
clientPublicKey: 'string'
cloudMetadata: {}
extensions: [
{
name: 'string'
status: {
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
type: 'string'
typeHandlerVersion: 'string'
}
]
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
mssqlDiscovered: 'string'
osProfile: {
linuxConfiguration: {
patchSettings: {
assessmentMode: 'string'
patchMode: 'string'
}
}
windowsConfiguration: {
patchSettings: {
assessmentMode: 'string'
patchMode: 'string'
}
}
}
osType: 'string'
parentClusterResourceId: 'string'
privateLinkScopeResourceId: 'string'
vmId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.HybridCompute/machines
| Name |
Description |
Value |
| identity |
Identity for the resource. |
Identity |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string (required) |
| properties |
Hybrid Compute Machine properties |
MachineProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
AgentConfiguration
Identity
| Name |
Description |
Value |
| type |
The identity type. |
'SystemAssigned' |
LocationData
| Name |
Description |
Value |
| city |
The city or locality where the resource is located. |
string |
| countryOrRegion |
The country or region where the resource is located |
string |
| district |
The district, state, or province where the resource is located. |
string |
| name |
A canonical name for the geographic or physical location. |
string
Constraints:
Max length = 256 (required) |
MachineExtensionInstanceView
| Name |
Description |
Value |
| name |
The machine extension name. |
string |
| status |
Instance view status. |
MachineExtensionInstanceViewStatus |
| type |
Specifies the type of the extension; an example is "CustomScriptExtension". |
string |
| typeHandlerVersion |
Specifies the version of the script handler. |
string |
MachineExtensionInstanceViewStatus
| Name |
Description |
Value |
| code |
The status code. |
string |
| displayStatus |
The short localizable label for the status. |
string |
| level |
The level code. |
'Error'
'Info'
'Warning' |
| message |
The detailed status message, including for alerts and error messages. |
string |
| time |
The time of the status. |
string |
MachineProperties
| Name |
Description |
Value |
| agentConfiguration |
Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. |
AgentConfiguration |
| clientPublicKey |
Public Key that the client provides to be used during initial resource onboarding |
string |
| cloudMetadata |
The metadata of the cloud environment (Azure/GCP/AWS/OCI...). |
CloudMetadata |
| extensions |
Machine Extensions information |
MachineExtensionInstanceView[] |
| locationData |
Metadata pertaining to the geographic location of the resource. |
LocationData |
| mssqlDiscovered |
Specifies whether any MS SQL instance is discovered on the machine. |
string |
| osProfile |
Specifies the operating system settings for the hybrid machine. |
OSProfile |
| osType |
The type of Operating System (windows/linux). |
string |
| parentClusterResourceId |
The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. |
string |
| privateLinkScopeResourceId |
The resource id of the private link scope this machine is assigned to, if any. |
string |
| vmId |
Specifies the hybrid machine unique ID. |
string
Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
OSProfile
OSProfileLinuxConfiguration
| Name |
Description |
Value |
| patchSettings |
Specifies the patch settings. |
PatchSettings |
OSProfileWindowsConfiguration
| Name |
Description |
Value |
| patchSettings |
Specifies the patch settings. |
PatchSettings |
PatchSettings
| Name |
Description |
Value |
| assessmentMode |
Specifies the assessment mode. |
string |
| patchMode |
Specifies the patch mode. |
string |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
ARM template resource definition
The machines resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.HybridCompute/machines resource, add the following JSON to your template.
{
"type": "Microsoft.HybridCompute/machines",
"apiVersion": "2021-12-10-preview",
"name": "string",
"identity": {
"type": "SystemAssigned"
},
"location": "string",
"properties": {
"agentConfiguration": {
},
"clientPublicKey": "string",
"cloudMetadata": {
},
"extensions": [
{
"name": "string",
"status": {
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
},
"type": "string",
"typeHandlerVersion": "string"
}
],
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
},
"mssqlDiscovered": "string",
"osProfile": {
"linuxConfiguration": {
"patchSettings": {
"assessmentMode": "string",
"patchMode": "string"
}
},
"windowsConfiguration": {
"patchSettings": {
"assessmentMode": "string",
"patchMode": "string"
}
}
},
"osType": "string",
"parentClusterResourceId": "string",
"privateLinkScopeResourceId": "string",
"vmId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HybridCompute/machines
| Name |
Description |
Value |
| apiVersion |
The api version |
'2021-12-10-preview' |
| identity |
Identity for the resource. |
Identity |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string (required) |
| properties |
Hybrid Compute Machine properties |
MachineProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| type |
The resource type |
'Microsoft.HybridCompute/machines' |
AgentConfiguration
Identity
| Name |
Description |
Value |
| type |
The identity type. |
'SystemAssigned' |
LocationData
| Name |
Description |
Value |
| city |
The city or locality where the resource is located. |
string |
| countryOrRegion |
The country or region where the resource is located |
string |
| district |
The district, state, or province where the resource is located. |
string |
| name |
A canonical name for the geographic or physical location. |
string
Constraints:
Max length = 256 (required) |
MachineExtensionInstanceView
| Name |
Description |
Value |
| name |
The machine extension name. |
string |
| status |
Instance view status. |
MachineExtensionInstanceViewStatus |
| type |
Specifies the type of the extension; an example is "CustomScriptExtension". |
string |
| typeHandlerVersion |
Specifies the version of the script handler. |
string |
MachineExtensionInstanceViewStatus
| Name |
Description |
Value |
| code |
The status code. |
string |
| displayStatus |
The short localizable label for the status. |
string |
| level |
The level code. |
'Error'
'Info'
'Warning' |
| message |
The detailed status message, including for alerts and error messages. |
string |
| time |
The time of the status. |
string |
MachineProperties
| Name |
Description |
Value |
| agentConfiguration |
Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. |
AgentConfiguration |
| clientPublicKey |
Public Key that the client provides to be used during initial resource onboarding |
string |
| cloudMetadata |
The metadata of the cloud environment (Azure/GCP/AWS/OCI...). |
CloudMetadata |
| extensions |
Machine Extensions information |
MachineExtensionInstanceView[] |
| locationData |
Metadata pertaining to the geographic location of the resource. |
LocationData |
| mssqlDiscovered |
Specifies whether any MS SQL instance is discovered on the machine. |
string |
| osProfile |
Specifies the operating system settings for the hybrid machine. |
OSProfile |
| osType |
The type of Operating System (windows/linux). |
string |
| parentClusterResourceId |
The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. |
string |
| privateLinkScopeResourceId |
The resource id of the private link scope this machine is assigned to, if any. |
string |
| vmId |
Specifies the hybrid machine unique ID. |
string
Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
OSProfile
OSProfileLinuxConfiguration
| Name |
Description |
Value |
| patchSettings |
Specifies the patch settings. |
PatchSettings |
OSProfileWindowsConfiguration
| Name |
Description |
Value |
| patchSettings |
Specifies the patch settings. |
PatchSettings |
PatchSettings
| Name |
Description |
Value |
| assessmentMode |
Specifies the assessment mode. |
string |
| patchMode |
Specifies the patch mode. |
string |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
The machines resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.HybridCompute/machines resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridCompute/machines@2021-12-10-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
agentConfiguration = {
}
clientPublicKey = "string"
cloudMetadata = {
}
extensions = [
{
name = "string"
status = {
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
type = "string"
typeHandlerVersion = "string"
}
]
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
mssqlDiscovered = "string"
osProfile = {
linuxConfiguration = {
patchSettings = {
assessmentMode = "string"
patchMode = "string"
}
}
windowsConfiguration = {
patchSettings = {
assessmentMode = "string"
patchMode = "string"
}
}
}
osType = "string"
parentClusterResourceId = "string"
privateLinkScopeResourceId = "string"
vmId = "string"
}
}
}
Property Values
Microsoft.HybridCompute/machines
| Name |
Description |
Value |
| identity |
Identity for the resource. |
Identity |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string (required) |
| properties |
Hybrid Compute Machine properties |
MachineProperties |
| tags |
Resource tags |
Dictionary of tag names and values. |
| type |
The resource type |
"Microsoft.HybridCompute/machines@2021-12-10-preview" |
AgentConfiguration
Identity
| Name |
Description |
Value |
| type |
The identity type. |
'SystemAssigned' |
LocationData
| Name |
Description |
Value |
| city |
The city or locality where the resource is located. |
string |
| countryOrRegion |
The country or region where the resource is located |
string |
| district |
The district, state, or province where the resource is located. |
string |
| name |
A canonical name for the geographic or physical location. |
string
Constraints:
Max length = 256 (required) |
MachineExtensionInstanceView
| Name |
Description |
Value |
| name |
The machine extension name. |
string |
| status |
Instance view status. |
MachineExtensionInstanceViewStatus |
| type |
Specifies the type of the extension; an example is "CustomScriptExtension". |
string |
| typeHandlerVersion |
Specifies the version of the script handler. |
string |
MachineExtensionInstanceViewStatus
| Name |
Description |
Value |
| code |
The status code. |
string |
| displayStatus |
The short localizable label for the status. |
string |
| level |
The level code. |
'Error'
'Info'
'Warning' |
| message |
The detailed status message, including for alerts and error messages. |
string |
| time |
The time of the status. |
string |
MachineProperties
| Name |
Description |
Value |
| agentConfiguration |
Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. |
AgentConfiguration |
| clientPublicKey |
Public Key that the client provides to be used during initial resource onboarding |
string |
| cloudMetadata |
The metadata of the cloud environment (Azure/GCP/AWS/OCI...). |
CloudMetadata |
| extensions |
Machine Extensions information |
MachineExtensionInstanceView[] |
| locationData |
Metadata pertaining to the geographic location of the resource. |
LocationData |
| mssqlDiscovered |
Specifies whether any MS SQL instance is discovered on the machine. |
string |
| osProfile |
Specifies the operating system settings for the hybrid machine. |
OSProfile |
| osType |
The type of Operating System (windows/linux). |
string |
| parentClusterResourceId |
The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any. |
string |
| privateLinkScopeResourceId |
The resource id of the private link scope this machine is assigned to, if any. |
string |
| vmId |
Specifies the hybrid machine unique ID. |
string
Constraints:
Min length = 36
Max length = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
OSProfile
OSProfileLinuxConfiguration
| Name |
Description |
Value |
| patchSettings |
Specifies the patch settings. |
PatchSettings |
OSProfileWindowsConfiguration
| Name |
Description |
Value |
| patchSettings |
Specifies the patch settings. |
PatchSettings |
PatchSettings
| Name |
Description |
Value |
| assessmentMode |
Specifies the assessment mode. |
string |
| patchMode |
Specifies the patch mode. |
string |
