Azure Native v1.102.0, May 2 23

azure-native.compute.VirtualMachineExtension

Explore with Pulumi AI

Describes a Virtual Machine Extension. API Version: 2021-03-01.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:compute:VirtualMachineExtension myresource1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}

Create VirtualMachineExtension Resource

new VirtualMachineExtension(name: string, args: VirtualMachineExtensionArgs, opts?: CustomResourceOptions);

@overload
def VirtualMachineExtension(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            auto_upgrade_minor_version: Optional[bool] = None,
                            enable_automatic_upgrade: Optional[bool] = None,
                            force_update_tag: Optional[str] = None,
                            instance_view: Optional[VirtualMachineExtensionInstanceViewArgs] = None,
                            location: Optional[str] = None,
                            protected_settings: Optional[Any] = None,
                            publisher: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            settings: Optional[Any] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            type: Optional[str] = None,
                            type_handler_version: Optional[str] = None,
                            vm_extension_name: Optional[str] = None,
                            vm_name: Optional[str] = None)
@overload
def VirtualMachineExtension(resource_name: str,
                            args: VirtualMachineExtensionArgs,
                            opts: Optional[ResourceOptions] = None)

func NewVirtualMachineExtension(ctx *Context, name string, args VirtualMachineExtensionArgs, opts ...ResourceOption) (*VirtualMachineExtension, error)

public VirtualMachineExtension(string name, VirtualMachineExtensionArgs args, CustomResourceOptions? opts = null)

public VirtualMachineExtension(String name, VirtualMachineExtensionArgs args)
public VirtualMachineExtension(String name, VirtualMachineExtensionArgs args, CustomResourceOptions options)

type: azure-native:compute:VirtualMachineExtension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VirtualMachineExtensionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args VirtualMachineExtensionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VirtualMachineExtensionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VirtualMachineExtensionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VirtualMachineExtensionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

VirtualMachineExtension Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The VirtualMachineExtension resource accepts the following input properties:

ResourceGroupName string: The name of the resource group.
VmName string: The name of the virtual machine where the extension should be created or updated.
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 bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
ForceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
InstanceView Pulumi.AzureNative.Compute.Inputs.VirtualMachineExtensionInstanceViewArgs: The virtual machine extension instance view.
Location string: Resource location
ProtectedSettings object: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
Publisher string: The name of the extension handler publisher.
Settings object: Json formatted public settings for the extension.
Tags Dictionary<string, string>: Resource tags
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.
VmExtensionName string: The name of the virtual machine extension.

ResourceGroupName string: The name of the resource group.
VmName string: The name of the virtual machine where the extension should be created or updated.
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 bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
ForceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
InstanceView VirtualMachineExtensionInstanceViewArgs: The virtual machine extension instance view.
Location string: Resource location
ProtectedSettings interface{}: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
Publisher string: The name of the extension handler publisher.
Settings interface{}: Json formatted public settings for the extension.
Tags map[string]string: Resource tags
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.
VmExtensionName string: The name of the virtual machine extension.

resourceGroupName String: The name of the resource group.
vmName String: The name of the virtual machine where the extension should be created or updated.
autoUpgradeMinorVersion Boolean: 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 Boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag String: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView VirtualMachineExtensionInstanceViewArgs: The virtual machine extension instance view.
location String: Resource location
protectedSettings Object: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
publisher String: The name of the extension handler publisher.
settings Object: Json formatted public settings for the extension.
tags Map<String,String>: Resource tags
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.
vmExtensionName String: The name of the virtual machine extension.

resourceGroupName string: The name of the resource group.
vmName string: The name of the virtual machine where the extension should be created or updated.
autoUpgradeMinorVersion boolean: 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 boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag string: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView VirtualMachineExtensionInstanceViewArgs: The virtual machine extension instance view.
location string: Resource location
protectedSettings any: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
publisher string: The name of the extension handler publisher.
settings any: Json formatted public settings for the extension.
tags {[key: string]: string}: Resource tags
type string: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string: Specifies the version of the script handler.
vmExtensionName string: The name of the virtual machine extension.

resource_group_name str: The name of the resource group.
vm_name str: The name of the virtual machine where the extension should be created or updated.
auto_upgrade_minor_version 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.
enable_automatic_upgrade bool: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
force_update_tag str: How the extension handler should be forced to update even if the extension configuration has not changed.
instance_view VirtualMachineExtensionInstanceViewArgs: The virtual machine extension instance view.
location str: Resource location
protected_settings Any: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
publisher str: The name of the extension handler publisher.
settings Any: Json formatted public settings for the extension.
tags Mapping[str, str]: Resource tags
type str: Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version str: Specifies the version of the script handler.
vm_extension_name str: The name of the virtual machine extension.

resourceGroupName String: The name of the resource group.
vmName String: The name of the virtual machine where the extension should be created or updated.
autoUpgradeMinorVersion Boolean: 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 Boolean: Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
forceUpdateTag String: How the extension handler should be forced to update even if the extension configuration has not changed.
instanceView Property Map: The virtual machine extension instance view.
location String: Resource location
protectedSettings Any: The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.
publisher String: The name of the extension handler publisher.
settings Any: Json formatted public settings for the extension.
tags Map<String>: Resource tags
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.
vmExtensionName String: The name of the virtual machine extension.

Outputs

All input properties are implicitly available as output properties. Additionally, the VirtualMachineExtension resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name
ProvisioningState string: The provisioning state, which only appears in the response.

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name
ProvisioningState string: The provisioning state, which only appears in the response.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name
provisioningState String: The provisioning state, which only appears in the response.

id string: The provider-assigned unique ID for this managed resource.
name string: Resource name
provisioningState string: The provisioning state, which only appears in the response.

id str: The provider-assigned unique ID for this managed resource.
name str: Resource name
provisioning_state str: The provisioning state, which only appears in the response.

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name
provisioningState String: The provisioning state, which only appears in the response.

Supporting Types

InstanceViewStatus

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level Pulumi.AzureNative.Compute.StatusLevelTypes: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level StatusLevelTypes: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level StatusLevelTypes: The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

code string: The status code.
displayStatus string: The short localizable label for the status.
level StatusLevelTypes: The level code.
message string: The detailed status message, including for alerts and error messages.
time string: The time of the status.

code str: The status code.
display_status str: The short localizable label for the status.
level StatusLevelTypes: The level code.
message str: The detailed status message, including for alerts and error messages.
time str: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level "Info" | "Warning" | "Error": The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

InstanceViewStatusResponse

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level string: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

Code string: The status code.
DisplayStatus string: The short localizable label for the status.
Level string: The level code.
Message string: The detailed status message, including for alerts and error messages.
Time string: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level String: The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

code string: The status code.
displayStatus string: The short localizable label for the status.
level string: The level code.
message string: The detailed status message, including for alerts and error messages.
time string: The time of the status.

code str: The status code.
display_status str: The short localizable label for the status.
level str: The level code.
message str: The detailed status message, including for alerts and error messages.
time str: The time of the status.

code String: The status code.
displayStatus String: The short localizable label for the status.
level String: The level code.
message String: The detailed status message, including for alerts and error messages.
time String: The time of the status.

StatusLevelTypes

Info: Info
Warning: Warning
Error: Error

StatusLevelTypesInfo: Info
StatusLevelTypesWarning: Warning
StatusLevelTypesError: Error

Info: Info
Warning: Warning
Error: Error

Info: Info
Warning: Warning
Error: Error

INFO: Info
WARNING: Warning
ERROR: Error

"Info": Info
"Warning": Warning
"Error": Error

VirtualMachineExtensionInstanceView

Name string: The virtual machine extension name.
Statuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatus>: The resource status information.
Substatuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatus>: The resource status information.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

Name string: The virtual machine extension name.
Statuses []InstanceViewStatus: The resource status information.
Substatuses []InstanceViewStatus: The resource status information.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

name String: The virtual machine extension name.
statuses List<InstanceViewStatus>: The resource status information.
substatuses List<InstanceViewStatus>: The resource status information.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.

name string: The virtual machine extension name.
statuses InstanceViewStatus[]: The resource status information.
substatuses InstanceViewStatus[]: The resource status information.
type string: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string: Specifies the version of the script handler.

name str: The virtual machine extension name.
statuses Sequence[InstanceViewStatus]: The resource status information.
substatuses Sequence[InstanceViewStatus]: The resource status information.
type str: Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version str: Specifies the version of the script handler.

name String: The virtual machine extension name.
statuses List<Property Map>: The resource status information.
substatuses List<Property Map>: The resource status information.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.

VirtualMachineExtensionInstanceViewResponse

Name string: The virtual machine extension name.
Statuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse>: The resource status information.
Substatuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse>: The resource status information.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

Name string: The virtual machine extension name.
Statuses []InstanceViewStatusResponse: The resource status information.
Substatuses []InstanceViewStatusResponse: The resource status information.
Type string: Specifies the type of the extension; an example is "CustomScriptExtension".
TypeHandlerVersion string: Specifies the version of the script handler.

name String: The virtual machine extension name.
statuses List<InstanceViewStatusResponse>: The resource status information.
substatuses List<InstanceViewStatusResponse>: The resource status information.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.

name string: The virtual machine extension name.
statuses InstanceViewStatusResponse[]: The resource status information.
substatuses InstanceViewStatusResponse[]: The resource status information.
type string: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion string: Specifies the version of the script handler.

name str: The virtual machine extension name.
statuses Sequence[InstanceViewStatusResponse]: The resource status information.
substatuses Sequence[InstanceViewStatusResponse]: The resource status information.
type str: Specifies the type of the extension; an example is "CustomScriptExtension".
type_handler_version str: Specifies the version of the script handler.

name String: The virtual machine extension name.
statuses List<Property Map>: The resource status information.
substatuses List<Property Map>: The resource status information.
type String: Specifies the type of the extension; an example is "CustomScriptExtension".
typeHandlerVersion String: Specifies the version of the script handler.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0