Bicep resource definition
The machines/extensions 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/extensions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.HybridCompute/machines/extensions@2024-07-31-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
autoUpgradeMinorVersion: bool
enableAutomaticUpgrade: bool
forceUpdateTag: 'string'
instanceView: {
name: 'string'
status: {
code: 'string'
displayStatus: 'string'
level: 'string'
message: 'string'
time: 'string'
}
type: 'string'
typeHandlerVersion: 'string'
}
protectedSettings: {
{customized property}: any(...)
}
publisher: 'string'
settings: {
{customized property}: any(...)
}
type: 'string'
typeHandlerVersion: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
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 |
MachineExtensionProperties
| Name |
Description |
Value |
| autoUpgradeMinorVersion |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
bool |
| enableAutomaticUpgrade |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. |
bool |
| forceUpdateTag |
How the extension handler should be forced to update even if the extension configuration has not changed. |
string |
| instanceView |
The machine extension instance view. |
MachineExtensionInstanceView |
| protectedSettings |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
MachineExtensionPropertiesProtectedSettings |
| publisher |
The name of the extension handler publisher. |
string |
| settings |
Json formatted public settings for the extension. |
MachineExtensionPropertiesSettings |
| type |
Specifies the type of the extension; an example is "CustomScriptExtension". |
string |
| typeHandlerVersion |
Specifies the version of the script handler. |
string |
MachineExtensionPropertiesProtectedSettings
MachineExtensionPropertiesSettings
Microsoft.HybridCompute/machines/extensions
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string (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 |
Describes Machine Extension Properties. |
MachineExtensionProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
ARM template resource definition
The machines/extensions 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/extensions resource, add the following JSON to your template.
{
"type": "Microsoft.HybridCompute/machines/extensions",
"apiVersion": "2024-07-31-preview",
"name": "string",
"location": "string",
"properties": {
"autoUpgradeMinorVersion": "bool",
"enableAutomaticUpgrade": "bool",
"forceUpdateTag": "string",
"instanceView": {
"name": "string",
"status": {
"code": "string",
"displayStatus": "string",
"level": "string",
"message": "string",
"time": "string"
},
"type": "string",
"typeHandlerVersion": "string"
},
"protectedSettings": {
"{customized property}": {}
},
"publisher": "string",
"settings": {
"{customized property}": {}
},
"type": "string",
"typeHandlerVersion": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
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 |
MachineExtensionProperties
| Name |
Description |
Value |
| autoUpgradeMinorVersion |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
bool |
| enableAutomaticUpgrade |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. |
bool |
| forceUpdateTag |
How the extension handler should be forced to update even if the extension configuration has not changed. |
string |
| instanceView |
The machine extension instance view. |
MachineExtensionInstanceView |
| protectedSettings |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
MachineExtensionPropertiesProtectedSettings |
| publisher |
The name of the extension handler publisher. |
string |
| settings |
Json formatted public settings for the extension. |
MachineExtensionPropertiesSettings |
| type |
Specifies the type of the extension; an example is "CustomScriptExtension". |
string |
| typeHandlerVersion |
Specifies the version of the script handler. |
string |
MachineExtensionPropertiesProtectedSettings
MachineExtensionPropertiesSettings
Microsoft.HybridCompute/machines/extensions
| Name |
Description |
Value |
| apiVersion |
The api version |
'2024-07-31-preview' |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string (required) |
| properties |
Describes Machine Extension Properties. |
MachineExtensionProperties |
| tags |
Resource tags |
Dictionary of tag names and values. See Tags in templates |
| type |
The resource type |
'Microsoft.HybridCompute/machines/extensions' |
Kullanım Örnekleri
The machines/extensions 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/extensions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.HybridCompute/machines/extensions@2024-07-31-preview"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
autoUpgradeMinorVersion = bool
enableAutomaticUpgrade = bool
forceUpdateTag = "string"
instanceView = {
name = "string"
status = {
code = "string"
displayStatus = "string"
level = "string"
message = "string"
time = "string"
}
type = "string"
typeHandlerVersion = "string"
}
protectedSettings = {
{customized property} = ?
}
publisher = "string"
settings = {
{customized property} = ?
}
type = "string"
typeHandlerVersion = "string"
}
}
}
Property Values
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 |
MachineExtensionProperties
| Name |
Description |
Value |
| autoUpgradeMinorVersion |
Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. |
bool |
| enableAutomaticUpgrade |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. |
bool |
| forceUpdateTag |
How the extension handler should be forced to update even if the extension configuration has not changed. |
string |
| instanceView |
The machine extension instance view. |
MachineExtensionInstanceView |
| protectedSettings |
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. |
MachineExtensionPropertiesProtectedSettings |
| publisher |
The name of the extension handler publisher. |
string |
| settings |
Json formatted public settings for the extension. |
MachineExtensionPropertiesSettings |
| type |
Specifies the type of the extension; an example is "CustomScriptExtension". |
string |
| typeHandlerVersion |
Specifies the version of the script handler. |
string |
MachineExtensionPropertiesProtectedSettings
MachineExtensionPropertiesSettings
Microsoft.HybridCompute/machines/extensions
| Name |
Description |
Value |
| location |
The geo-location where the resource lives |
string (required) |
| name |
The resource name |
string (required) |
| parent_id |
The ID of the resource that is the parent for this resource. |
ID for resource of type: machines |
| properties |
Describes Machine Extension Properties. |
MachineExtensionProperties |
| tags |
Resource tags |
Dictionary of tag names and values. |
| type |
The resource type |
"Microsoft.HybridCompute/machines/extensions@2024-07-31-preview" |