forked from Azure/bicep-registry-modules
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
168 additions
and
161 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,165 @@ | ||
# Virtual Machine Extensions `[Microsoft.Compute/virtualMachines/extensions]` | ||
|
||
This module deploys a Virtual Machine Extension. | ||
|
||
## Navigation | ||
|
||
- [Resource Types](#Resource-Types) | ||
- [Parameters](#Parameters) | ||
- [Outputs](#Outputs) | ||
- [Cross-referenced modules](#Cross-referenced-modules) | ||
|
||
## Resource Types | ||
|
||
| Resource Type | API Version | | ||
| :-- | :-- | | ||
| `Microsoft.Compute/virtualMachines/extensions` | [2022-11-01](https://learn.microsoft.com/en-us/azure/templates/Microsoft.Compute/2022-11-01/virtualMachines/extensions) | | ||
|
||
## Parameters | ||
|
||
**Required parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`autoUpgradeMinorVersion`](#parameter-autoupgrademinorversion) | bool | 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. | | ||
| [`enableAutomaticUpgrade`](#parameter-enableautomaticupgrade) | bool | Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. | | ||
| [`name`](#parameter-name) | string | The name of the virtual machine extension. | | ||
| [`publisher`](#parameter-publisher) | string | The name of the extension handler publisher. | | ||
| [`type`](#parameter-type) | string | Specifies the type of the extension; an example is "CustomScriptExtension". | | ||
| [`typeHandlerVersion`](#parameter-typehandlerversion) | string | Specifies the version of the script handler. | | ||
|
||
**Conditional parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`virtualMachineName`](#parameter-virtualmachinename) | string | The name of the parent virtual machine that extension is provisioned for. Required if the template is used in a standalone deployment. | | ||
|
||
**Optional parameters** | ||
|
||
| Parameter | Type | Description | | ||
| :-- | :-- | :-- | | ||
| [`enableDefaultTelemetry`](#parameter-enabledefaulttelemetry) | bool | Enable telemetry via a Globally Unique Identifier (GUID). | | ||
| [`forceUpdateTag`](#parameter-forceupdatetag) | string | How the extension handler should be forced to update even if the extension configuration has not changed. | | ||
| [`location`](#parameter-location) | string | The location the extension is deployed to. | | ||
| [`protectedSettings`](#parameter-protectedsettings) | secureObject | Any object that contains the extension specific protected settings. | | ||
| [`settings`](#parameter-settings) | object | Any object that contains the extension specific settings. | | ||
| [`supressFailures`](#parameter-supressfailures) | bool | Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. | | ||
| [`tags`](#parameter-tags) | object | Tags of the resource. | | ||
|
||
### Parameter: `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. | ||
|
||
- Required: Yes | ||
- Type: bool | ||
|
||
### Parameter: `enableAutomaticUpgrade` | ||
|
||
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. | ||
|
||
- Required: Yes | ||
- Type: bool | ||
|
||
### Parameter: `name` | ||
|
||
The name of the virtual machine extension. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `publisher` | ||
|
||
The name of the extension handler publisher. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `type` | ||
|
||
Specifies the type of the extension; an example is "CustomScriptExtension". | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `typeHandlerVersion` | ||
|
||
Specifies the version of the script handler. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `virtualMachineName` | ||
|
||
The name of the parent virtual machine that extension is provisioned for. Required if the template is used in a standalone deployment. | ||
|
||
- Required: Yes | ||
- Type: string | ||
|
||
### Parameter: `enableDefaultTelemetry` | ||
|
||
Enable telemetry via a Globally Unique Identifier (GUID). | ||
|
||
- Required: No | ||
- Type: bool | ||
- Default: `True` | ||
|
||
### Parameter: `forceUpdateTag` | ||
|
||
How the extension handler should be forced to update even if the extension configuration has not changed. | ||
|
||
- Required: No | ||
- Type: string | ||
- Default: `''` | ||
|
||
### Parameter: `location` | ||
|
||
The location the extension is deployed to. | ||
|
||
- Required: No | ||
- Type: string | ||
- Default: `[resourceGroup().location]` | ||
|
||
### Parameter: `protectedSettings` | ||
|
||
Any object that contains the extension specific protected settings. | ||
|
||
- Required: No | ||
- Type: secureObject | ||
- Default: `{}` | ||
|
||
### Parameter: `settings` | ||
|
||
Any object that contains the extension specific settings. | ||
|
||
- Required: No | ||
- Type: object | ||
- Default: `{}` | ||
|
||
### Parameter: `supressFailures` | ||
|
||
Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. | ||
|
||
- Required: No | ||
- Type: bool | ||
- Default: `False` | ||
|
||
### Parameter: `tags` | ||
|
||
Tags of the resource. | ||
|
||
- Required: No | ||
- Type: object | ||
|
||
|
||
## Outputs | ||
|
||
| Output | Type | Description | | ||
| :-- | :-- | :-- | | ||
| `location` | string | The location the resource was deployed into. | | ||
| `name` | string | The name of the extension. | | ||
| `resourceGroupName` | string | The name of the Resource Group the extension was created in. | | ||
| `resourceId` | string | The resource ID of the extension. | | ||
|
||
## Cross-referenced modules | ||
|
||
_None_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
128 changes: 0 additions & 128 deletions
128
avm/res/compute/virtual-machine/protected-item/main.json
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.