Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
- Latest
- Förhandsversion 2025-02-19
- 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@2024-07-31-preview' = {
identity: {
type: 'SystemAssigned'
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
agentUpgrade: {
correlationId: 'string'
desiredVersion: 'string'
enableAutomaticUpgrade: bool
}
clientPublicKey: 'string'
cloudMetadata: {}
extensions: [
{
name: 'string'
status: {
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
type: 'string'
typeHandlerVersion: 'string'
}
]
licenseProfile: {
esuProfile: {
assignedLicense: {
location: 'string'
properties: {
licenseDetails: {
edition: 'string'
processors: int
state: 'string'
target: 'string'
type: 'string'
volumeLicenseDetails: [
{
invoiceId: 'string'
programYear: 'string'
}
]
}
licenseType: 'string'
tenantId: 'string'
}
tags: {
{customized property}: 'string'
}
}
licenseAssignmentState: 'string'
}
}
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
mssqlDiscovered: 'string'
osProfile: {
linuxConfiguration: {
patchSettings: {
assessmentMode: 'string'
enableHotpatching: bool
patchMode: 'string'
}
}
windowsConfiguration: {
patchSettings: {
assessmentMode: 'string'
enableHotpatching: bool
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
AgentUpgrade
| Name | Description | Value |
|---|---|---|
| correlationId | The correlation ID associated with an agent upgrade operation. | 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}$ |
| desiredVersion | Specifies the version info w.r.t AgentUpgrade for the machine. | string |
| enableAutomaticUpgrade | Specifies if the machine's agent should be upgraded | bool |
CloudMetadata
| Name | Description | Value |
|---|
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
License
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| properties | Hybrid Compute License properties | LicenseProperties |
| tags | Resource tags. | TrackedResourceTags |
LicenseDetails
| Name | Description | Value |
|---|---|---|
| edition | Describes the edition of the license. The values are either Standard or Datacenter. | 'Datacenter' 'Standard' |
| processors | Describes the number of processors. | int |
| state | Describes the state of the license. | 'Activated' 'Deactivated' |
| target | Describes the license target server. | 'Windows Server 2012 R2' 'Windows Server 2012' |
| type | Describes the license core type (pCore or vCore). | 'pCore' 'vCore' |
| volumeLicenseDetails | A list of volume license details. | VolumeLicenseDetails[] |
LicenseProfileMachineInstanceView
| Name | Description | Value |
|---|---|---|
| esuProfile | Properties for the Machine ESU profile. | LicenseProfileMachineInstanceViewEsuProperties |
LicenseProfileMachineInstanceViewEsuProperties
| Name | Description | Value |
|---|---|---|
| assignedLicense | The assigned license resource. | License |
| licenseAssignmentState | Describes the license assignment state (Assigned or NotAssigned). | 'Assigned' 'NotAssigned' |
LicenseProperties
| Name | Description | Value |
|---|---|---|
| licenseDetails | Describes the properties of a License. | LicenseDetails |
| licenseType | The type of the license resource. | 'ESU' |
| tenantId | Describes the tenant id. | string |
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 |
|---|---|---|
| agentUpgrade | The info of the machine w.r.t Agent Upgrade | AgentUpgrade |
| 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 (deprecated field) | MachineExtensionInstanceView[] |
| licenseProfile | Specifies the License related properties for a machine. | LicenseProfileMachineInstanceView |
| 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}$ |
Microsoft.HybridCompute/machines
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. | Identity |
| kind | Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. | 'AVS' 'AWS' 'EPS' 'GCP' 'HCI' 'SCVMM' 'VMware' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 54 Pattern = ^[a-zA-Z0-9-_\.]{1,54}$ (required) |
| properties | Hybrid Compute Machine properties | MachineProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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' |
| enableHotpatching | Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. | bool |
| 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 |
|---|
TrackedResourceTags
| Name | Description | Value |
|---|
VolumeLicenseDetails
| Name | Description | Value |
|---|---|---|
| invoiceId | The invoice id for the volume license. | string |
| programYear | Describes the program year the volume license is for. | 'Year 1' 'Year 2' 'Year 3' |
Användningsexempel
Azure-verifierade moduler
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": "2024-07-31-preview",
"name": "string",
"identity": {
"type": "SystemAssigned"
},
"kind": "string",
"location": "string",
"properties": {
"agentUpgrade": {
"correlationId": "string",
"desiredVersion": "string",
"enableAutomaticUpgrade": "bool"
},
"clientPublicKey": "string",
"cloudMetadata": {
},
"extensions": [
{
"name": "string",
"status": {
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
},
"type": "string",
"typeHandlerVersion": "string"
}
],
"licenseProfile": {
"esuProfile": {
"assignedLicense": {
"location": "string",
"properties": {
"licenseDetails": {
"edition": "string",
"processors": "int",
"state": "string",
"target": "string",
"type": "string",
"volumeLicenseDetails": [
{
"invoiceId": "string",
"programYear": "string"
}
]
},
"licenseType": "string",
"tenantId": "string"
},
"tags": {
"{customized property}": "string"
}
},
"licenseAssignmentState": "string"
}
},
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
},
"mssqlDiscovered": "string",
"osProfile": {
"linuxConfiguration": {
"patchSettings": {
"assessmentMode": "string",
"enableHotpatching": "bool",
"patchMode": "string"
}
},
"windowsConfiguration": {
"patchSettings": {
"assessmentMode": "string",
"enableHotpatching": "bool",
"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
AgentUpgrade
| Name | Description | Value |
|---|---|---|
| correlationId | The correlation ID associated with an agent upgrade operation. | 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}$ |
| desiredVersion | Specifies the version info w.r.t AgentUpgrade for the machine. | string |
| enableAutomaticUpgrade | Specifies if the machine's agent should be upgraded | bool |
CloudMetadata
| Name | Description | Value |
|---|
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
License
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| properties | Hybrid Compute License properties | LicenseProperties |
| tags | Resource tags. | TrackedResourceTags |
LicenseDetails
| Name | Description | Value |
|---|---|---|
| edition | Describes the edition of the license. The values are either Standard or Datacenter. | 'Datacenter' 'Standard' |
| processors | Describes the number of processors. | int |
| state | Describes the state of the license. | 'Activated' 'Deactivated' |
| target | Describes the license target server. | 'Windows Server 2012 R2' 'Windows Server 2012' |
| type | Describes the license core type (pCore or vCore). | 'pCore' 'vCore' |
| volumeLicenseDetails | A list of volume license details. | VolumeLicenseDetails[] |
LicenseProfileMachineInstanceView
| Name | Description | Value |
|---|---|---|
| esuProfile | Properties for the Machine ESU profile. | LicenseProfileMachineInstanceViewEsuProperties |
LicenseProfileMachineInstanceViewEsuProperties
| Name | Description | Value |
|---|---|---|
| assignedLicense | The assigned license resource. | License |
| licenseAssignmentState | Describes the license assignment state (Assigned or NotAssigned). | 'Assigned' 'NotAssigned' |
LicenseProperties
| Name | Description | Value |
|---|---|---|
| licenseDetails | Describes the properties of a License. | LicenseDetails |
| licenseType | The type of the license resource. | 'ESU' |
| tenantId | Describes the tenant id. | string |
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 |
|---|---|---|
| agentUpgrade | The info of the machine w.r.t Agent Upgrade | AgentUpgrade |
| 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 (deprecated field) | MachineExtensionInstanceView[] |
| licenseProfile | Specifies the License related properties for a machine. | LicenseProfileMachineInstanceView |
| 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}$ |
Microsoft.HybridCompute/machines
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-07-31-preview' |
| identity | Identity for the resource. | Identity |
| kind | Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. | 'AVS' 'AWS' 'EPS' 'GCP' 'HCI' 'SCVMM' 'VMware' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 54 Pattern = ^[a-zA-Z0-9-_\.]{1,54}$ (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' |
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' |
| enableHotpatching | Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. | bool |
| 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 |
|---|
TrackedResourceTags
| Name | Description | Value |
|---|
VolumeLicenseDetails
| Name | Description | Value |
|---|---|---|
| invoiceId | The invoice id for the volume license. | string |
| programYear | Describes the program year the volume license is for. | 'Year 1' 'Year 2' 'Year 3' |
Användningsexempel
Azure-snabbstartsmallar
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@2024-07-31-preview"
name = "string"
identity = {
type = "SystemAssigned"
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
agentUpgrade = {
correlationId = "string"
desiredVersion = "string"
enableAutomaticUpgrade = bool
}
clientPublicKey = "string"
cloudMetadata = {
}
extensions = [
{
name = "string"
status = {
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
type = "string"
typeHandlerVersion = "string"
}
]
licenseProfile = {
esuProfile = {
assignedLicense = {
location = "string"
properties = {
licenseDetails = {
edition = "string"
processors = int
state = "string"
target = "string"
type = "string"
volumeLicenseDetails = [
{
invoiceId = "string"
programYear = "string"
}
]
}
licenseType = "string"
tenantId = "string"
}
tags = {
{customized property} = "string"
}
}
licenseAssignmentState = "string"
}
}
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
mssqlDiscovered = "string"
osProfile = {
linuxConfiguration = {
patchSettings = {
assessmentMode = "string"
enableHotpatching = bool
patchMode = "string"
}
}
windowsConfiguration = {
patchSettings = {
assessmentMode = "string"
enableHotpatching = bool
patchMode = "string"
}
}
}
osType = "string"
parentClusterResourceId = "string"
privateLinkScopeResourceId = "string"
serviceStatuses = {
extensionService = {
startupType = "string"
status = "string"
}
guestConfigurationService = {
startupType = "string"
status = "string"
}
}
vmId = "string"
}
}
}
Property Values
AgentUpgrade
| Name | Description | Value |
|---|---|---|
| correlationId | The correlation ID associated with an agent upgrade operation. | 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}$ |
| desiredVersion | Specifies the version info w.r.t AgentUpgrade for the machine. | string |
| enableAutomaticUpgrade | Specifies if the machine's agent should be upgraded | bool |
CloudMetadata
| Name | Description | Value |
|---|
Identity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'SystemAssigned' |
License
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| properties | Hybrid Compute License properties | LicenseProperties |
| tags | Resource tags. | TrackedResourceTags |
LicenseDetails
| Name | Description | Value |
|---|---|---|
| edition | Describes the edition of the license. The values are either Standard or Datacenter. | 'Datacenter' 'Standard' |
| processors | Describes the number of processors. | int |
| state | Describes the state of the license. | 'Activated' 'Deactivated' |
| target | Describes the license target server. | 'Windows Server 2012 R2' 'Windows Server 2012' |
| type | Describes the license core type (pCore or vCore). | 'pCore' 'vCore' |
| volumeLicenseDetails | A list of volume license details. | VolumeLicenseDetails[] |
LicenseProfileMachineInstanceView
| Name | Description | Value |
|---|---|---|
| esuProfile | Properties for the Machine ESU profile. | LicenseProfileMachineInstanceViewEsuProperties |
LicenseProfileMachineInstanceViewEsuProperties
| Name | Description | Value |
|---|---|---|
| assignedLicense | The assigned license resource. | License |
| licenseAssignmentState | Describes the license assignment state (Assigned or NotAssigned). | 'Assigned' 'NotAssigned' |
LicenseProperties
| Name | Description | Value |
|---|---|---|
| licenseDetails | Describes the properties of a License. | LicenseDetails |
| licenseType | The type of the license resource. | 'ESU' |
| tenantId | Describes the tenant id. | string |
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 |
|---|---|---|
| agentUpgrade | The info of the machine w.r.t Agent Upgrade | AgentUpgrade |
| 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 (deprecated field) | MachineExtensionInstanceView[] |
| licenseProfile | Specifies the License related properties for a machine. | LicenseProfileMachineInstanceView |
| 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}$ |
Microsoft.HybridCompute/machines
| Name | Description | Value |
|---|---|---|
| identity | Identity for the resource. | Identity |
| kind | Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc. | 'AVS' 'AWS' 'EPS' 'GCP' 'HCI' 'SCVMM' 'VMware' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 Max length = 54 Pattern = ^[a-zA-Z0-9-_\.]{1,54}$ (required) |
| properties | Hybrid Compute Machine properties | MachineProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HybridCompute/machines@2024-07-31-preview" |
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' |
| enableHotpatching | Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. | bool |
| 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 |
|---|
TrackedResourceTags
| Name | Description | Value |
|---|
VolumeLicenseDetails
| Name | Description | Value |
|---|---|---|
| invoiceId | The invoice id for the volume license. | string |
| programYear | Describes the program year the volume license is for. | 'Year 1' 'Year 2' 'Year 3' |