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.
Bicep resource definition
The machines/applications 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/applications resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridCompute/machines/applications@2026-09-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
communityGalleryApplicationId: 'string'
configurationReference: 'string'
order: int
packageReferenceId: 'string'
sharedGalleryApplicationId: 'string'
treatFailureAsDeploymentFailure: bool
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.HybridCompute/machines/applications
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$ (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: machines |
| properties | The VM application properties. | VmApplicationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
TrackedResourceTags
| Name | Description | Value |
|---|
VmApplicationProperties
| Name | Description | Value |
|---|---|---|
| communityGalleryApplicationId | The identifier of a community gallery application version. Use /communityGalleries/{communityGalleryPublicName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and sharedGalleryApplicationId. |
string |
| configurationReference | The URI of configuration data that replaces the package's default configuration. | string |
| order | The order in which the application is installed. | int |
| packageReferenceId | The resource ID of the gallery application version. The version name can be latest or a specific version. This property is mutually exclusive with sharedGalleryApplicationId and communityGalleryApplicationId. |
string |
| sharedGalleryApplicationId | The identifier of a direct shared gallery application version. Use /sharedGalleries/{sharedGalleryUniqueName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and communityGalleryApplicationId. |
string |
| treatFailureAsDeploymentFailure | Indicates whether an application operation failure causes the deployment to fail. | bool |
ARM template resource definition
The machines/applications 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.
Usage Examples
Resource format
To create a Microsoft.HybridCompute/machines/applications resource, add the following JSON to your template.
{
"type": "Microsoft.HybridCompute/machines/applications",
"apiVersion": "2026-09-01",
"name": "string",
"location": "string",
"properties": {
"communityGalleryApplicationId": "string",
"configurationReference": "string",
"order": "int",
"packageReferenceId": "string",
"sharedGalleryApplicationId": "string",
"treatFailureAsDeploymentFailure": "bool"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.HybridCompute/machines/applications
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-09-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$ (required) |
| properties | The VM application properties. | VmApplicationProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.HybridCompute/machines/applications' |
TrackedResourceTags
| Name | Description | Value |
|---|
VmApplicationProperties
| Name | Description | Value |
|---|---|---|
| communityGalleryApplicationId | The identifier of a community gallery application version. Use /communityGalleries/{communityGalleryPublicName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and sharedGalleryApplicationId. |
string |
| configurationReference | The URI of configuration data that replaces the package's default configuration. | string |
| order | The order in which the application is installed. | int |
| packageReferenceId | The resource ID of the gallery application version. The version name can be latest or a specific version. This property is mutually exclusive with sharedGalleryApplicationId and communityGalleryApplicationId. |
string |
| sharedGalleryApplicationId | The identifier of a direct shared gallery application version. Use /sharedGalleries/{sharedGalleryUniqueName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and communityGalleryApplicationId. |
string |
| treatFailureAsDeploymentFailure | Indicates whether an application operation failure causes the deployment to fail. | bool |
Terraform (AzAPI provider) resource definition
The machines/applications 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/applications resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridCompute/machines/applications@2026-09-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
communityGalleryApplicationId = "string"
configurationReference = "string"
order = int
packageReferenceId = "string"
sharedGalleryApplicationId = "string"
treatFailureAsDeploymentFailure = bool
}
}
}
Property Values
Microsoft.HybridCompute/machines/applications
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[A-Za-z0-9](?:[A-Za-z0-9_.-]{0,78}[A-Za-z0-9_-])?$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: machines |
| properties | The VM application properties. | VmApplicationProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.HybridCompute/machines/applications@2026-09-01" |
TrackedResourceTags
| Name | Description | Value |
|---|
VmApplicationProperties
| Name | Description | Value |
|---|---|---|
| communityGalleryApplicationId | The identifier of a community gallery application version. Use /communityGalleries/{communityGalleryPublicName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and sharedGalleryApplicationId. |
string |
| configurationReference | The URI of configuration data that replaces the package's default configuration. | string |
| order | The order in which the application is installed. | int |
| packageReferenceId | The resource ID of the gallery application version. The version name can be latest or a specific version. This property is mutually exclusive with sharedGalleryApplicationId and communityGalleryApplicationId. |
string |
| sharedGalleryApplicationId | The identifier of a direct shared gallery application version. Use /sharedGalleries/{sharedGalleryUniqueName}/applications/{applicationName}/versions/{versionName}, where the version name can be latest or a specific version. This property is mutually exclusive with packageReferenceId and communityGalleryApplicationId. |
string |
| treatFailureAsDeploymentFailure | Indicates whether an application operation failure causes the deployment to fail. | bool |