VirtualMachineExtension Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
VirtualMachineExtension.
public class VirtualMachineExtension : Azure.Provisioning.Primitives.ProvisionableResource
type VirtualMachineExtension = class
inherit ProvisionableResource
Public Class VirtualMachineExtension
Inherits ProvisionableResource
- Inheritance
-
VirtualMachineExtension
Constructors
| Name | Description |
|---|---|
| VirtualMachineExtension(String, String) |
Creates a new VirtualMachineExtension. |
Properties
| Name | Description |
|---|---|
| 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. |
| BicepIdentifier |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct) |
| BicepMetadata |
Gets the Bicep metadata for this resource, including decorators and conditions. (Inherited from ProvisionableResource) |
| DependsOn |
Declares explicit dependencies on other resources. (Inherited from ProvisionableResource) |
| EnableAutomaticUpgrade |
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. |
| ExtensionType |
Specifies the type of the extension; an example is "CustomScriptExtension". |
| ForceUpdateTag |
How the extension handler should be forced to update even if the extension configuration has not changed. |
| Id |
Gets the Id. |
| InstanceView |
The virtual machine extension instance view. |
| IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource) |
| KeyVaultProtectedSettings |
The extensions protected settings that are passed by reference, and consumed from key vault. |
| Location |
Gets or sets the Location. |
| Name |
The name of the virtual machine extension. |
| Parent |
Gets or sets a reference to the parent VirtualMachine. |
| ProtectedSettings |
The extension can contain either protectedSettings or
protectedSettingsFromKeyVault or no protected settings at all.
To assign an object to this property use
System.BinaryData.FromObjectAsJson |
| ProvisionAfterExtensions |
Collection of extension names after which this extension needs to be provisioned. |
| ProvisioningState |
The provisioning state, which only appears in the response. |
| Publisher |
The name of the extension handler publisher. |
| ResourceType |
Gets the type of the resource. (Inherited from ProvisionableResource) |
| ResourceVersion |
Gets or sets the version of the resource. (Inherited from ProvisionableResource) |
| Settings |
Json formatted public settings for the extension.
To assign an object to this property use
System.BinaryData.FromObjectAsJson |
| SuppressFailures |
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. |
| SystemData |
Gets the SystemData. |
| Tags |
Gets or sets the Tags. |
| TypeHandlerVersion |
Specifies the version of the script handler. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
| IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
| IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
| IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
| IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
| IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
| IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |
Extension Methods
| Name | Description |
|---|---|
| ToBicepExpression(IBicepValue) |
Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy. |