Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-02-19-preview
- 2025-01-13
- 2024-11-10-preview
- 2024-09-10-preview
- 2024-07-31-preview
- 2024-07-10
- 2024-05-20-preview
- 2024-03-31-preview
- 2023-10-03-preview
- 2023-06-20-preview
- 2023-03-15-preview
- 2022-12-27
- 2022-12-27-preview
- 2022-11-10
- 2022-08-11-preview
- 2022-05-10-preview
- 2022-03-10
- 2021-12-10-preview
- 2021-06-10-preview
- 2021-05-20
- 2021-05-17-preview
- 2021-04-22-preview
- 2021-03-25-preview
- 2021-01-28-preview
- 2020-08-15-preview
- 2020-08-02
- 2020-07-30-preview
- 2019-12-12
- 2019-08-02-preview
- 2019-03-18-preview
Bicep resource definition
The machines resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HybridCompute/machines resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridCompute/machines@2022-03-10' = {
identity: {
type: 'SystemAssigned'
}
location: 'string'
name: 'string'
properties: {
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'
serviceStatuses: {
extensionService: {
startupType: 'string'
status: 'string'
}
guestConfigurationService: {
startupType: 'string'
status: '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 |
CloudMetadata
| Name | Description | Value |
|---|
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 |
|---|---|---|
| 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 |
| serviceStatuses | Statuses of dependent services that are reported back to ARM. | ServiceStatuses |
| 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
| Name | Description | Value |
|---|---|---|
| linuxConfiguration | Specifies the linux configuration for update management. | OSProfileLinuxConfiguration |
| windowsConfiguration | Specifies the windows configuration for update management. | OSProfileWindowsConfiguration |
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. | 'AutomaticByPlatform' 'ImageDefault' |
| patchMode | Specifies the patch mode. | 'AutomaticByOS' 'AutomaticByPlatform' 'ImageDefault' 'Manual' |
ServiceStatus
| Name | Description | Value |
|---|---|---|
| startupType | The behavior of the service when the Arc-enabled machine starts up. | string |
| status | The current status of the service. | string |
ServiceStatuses
| Name | Description | Value |
|---|---|---|
| extensionService | The state of the extension service on the Arc-enabled machine. | ServiceStatus |
| guestConfigurationService | The state of the guest configuration service on the Arc-enabled machine. | ServiceStatus |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Hybrid Compute Machine | AVM Resource Module for Hybrid Compute Machine |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create a Linux VM from a gallery image on Azure Stack HCI | This template creates a simple Linux VM from the referenced custom image on Azure Stack HCI version 23H2+ |
| Create a VM from the referenced image on Azure Stack HCI | This template creates a simple Windows VM from the referenced Azure Marketplace image on Azure Stack HCI version 23H2+ |
ARM template resource definition
The machines resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HybridCompute/machines resource, add the following JSON to your template.
{
"type": "Microsoft.HybridCompute/machines",
"apiVersion": "2022-03-10",
"name": "string",
"identity": {
"type": "SystemAssigned"
},
"location": "string",
"properties": {
"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",
"serviceStatuses": {
"extensionService": {
"startupType": "string",
"status": "string"
},
"guestConfigurationService": {
"startupType": "string",
"status": "string"
}
},
"vmId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HybridCompute/machines
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2022-03-10' |
| 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' |
CloudMetadata
| Name | Description | Value |
|---|
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 |
|---|---|---|
| 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 |
| serviceStatuses | Statuses of dependent services that are reported back to ARM. | ServiceStatuses |
| 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
| Name | Description | Value |
|---|---|---|
| linuxConfiguration | Specifies the linux configuration for update management. | OSProfileLinuxConfiguration |
| windowsConfiguration | Specifies the windows configuration for update management. | OSProfileWindowsConfiguration |
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. | 'AutomaticByPlatform' 'ImageDefault' |
| patchMode | Specifies the patch mode. | 'AutomaticByOS' 'AutomaticByPlatform' 'ImageDefault' 'Manual' |
ServiceStatus
| Name | Description | Value |
|---|---|---|
| startupType | The behavior of the service when the Arc-enabled machine starts up. | string |
| status | The current status of the service. | string |
ServiceStatuses
| Name | Description | Value |
|---|---|---|
| extensionService | The state of the extension service on the Arc-enabled machine. | ServiceStatus |
| guestConfigurationService | The state of the guest configuration service on the Arc-enabled machine. | ServiceStatus |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create a Linux VM from a gallery image on Azure Stack HCI |
This template creates a simple Linux VM from the referenced custom image on Azure Stack HCI version 23H2+ |
| Create a VM from the referenced image on Azure Stack HCI |
This template creates a simple Windows VM from the referenced Azure Marketplace image on Azure Stack HCI version 23H2+ |
Terraform (AzAPI provider) resource definition
The machines resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.HybridCompute/machines resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridCompute/machines@2022-03-10"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
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"
serviceStatuses = {
extensionService = {
startupType = "string"
status = "string"
}
guestConfigurationService = {
startupType = "string"
status = "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@2022-03-10" |
CloudMetadata
| Name | Description | Value |
|---|
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 |
|---|---|---|
| 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 |
| serviceStatuses | Statuses of dependent services that are reported back to ARM. | ServiceStatuses |
| 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
| Name | Description | Value |
|---|---|---|
| linuxConfiguration | Specifies the linux configuration for update management. | OSProfileLinuxConfiguration |
| windowsConfiguration | Specifies the windows configuration for update management. | OSProfileWindowsConfiguration |
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. | 'AutomaticByPlatform' 'ImageDefault' |
| patchMode | Specifies the patch mode. | 'AutomaticByOS' 'AutomaticByPlatform' 'ImageDefault' 'Manual' |
ServiceStatus
| Name | Description | Value |
|---|---|---|
| startupType | The behavior of the service when the Arc-enabled machine starts up. | string |
| status | The current status of the service. | string |
ServiceStatuses
| Name | Description | Value |
|---|---|---|
| extensionService | The state of the extension service on the Arc-enabled machine. | ServiceStatus |
| guestConfigurationService | The state of the guest configuration service on the Arc-enabled machine. | ServiceStatus |
TrackedResourceTags
| Name | Description | Value |
|---|