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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VirtualMachineExtension(name: string, args: VirtualMachineExtensionArgs, opts?: CustomResourceOptions);
@overload
def VirtualMachineExtension(resource_name: str,
args: VirtualMachineExtensionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VirtualMachineExtension(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
vm_name: Optional[str] = None,
publisher: Optional[str] = None,
instance_view: Optional[VirtualMachineExtensionInstanceViewArgs] = None,
location: Optional[str] = None,
protected_settings: Optional[Any] = None,
auto_upgrade_minor_version: Optional[bool] = None,
force_update_tag: 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,
enable_automatic_upgrade: Optional[bool] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var virtualMachineExtensionResource = new AzureNative.Compute.VirtualMachineExtension("virtualMachineExtensionResource", new()
{
ResourceGroupName = "string",
VmName = "string",
Publisher = "string",
InstanceView =
{
{ "name", "string" },
{ "statuses", new[]
{
{
{ "code", "string" },
{ "displayStatus", "string" },
{ "level", "Info" },
{ "message", "string" },
{ "time", "string" },
},
} },
{ "substatuses", new[]
{
{
{ "code", "string" },
{ "displayStatus", "string" },
{ "level", "Info" },
{ "message", "string" },
{ "time", "string" },
},
} },
{ "type", "string" },
{ "typeHandlerVersion", "string" },
},
Location = "string",
ProtectedSettings = "any",
AutoUpgradeMinorVersion = false,
ForceUpdateTag = "string",
Settings = "any",
Tags =
{
{ "string", "string" },
},
Type = "string",
TypeHandlerVersion = "string",
VmExtensionName = "string",
EnableAutomaticUpgrade = false,
});
example, err := compute.NewVirtualMachineExtension(ctx, "virtualMachineExtensionResource", &compute.VirtualMachineExtensionArgs{
ResourceGroupName: "string",
VmName: "string",
Publisher: "string",
InstanceView: map[string]interface{}{
"name": "string",
"statuses": []map[string]interface{}{
map[string]interface{}{
"code": "string",
"displayStatus": "string",
"level": "Info",
"message": "string",
"time": "string",
},
},
"substatuses": []map[string]interface{}{
map[string]interface{}{
"code": "string",
"displayStatus": "string",
"level": "Info",
"message": "string",
"time": "string",
},
},
"type": "string",
"typeHandlerVersion": "string",
},
Location: "string",
ProtectedSettings: "any",
AutoUpgradeMinorVersion: false,
ForceUpdateTag: "string",
Settings: "any",
Tags: map[string]interface{}{
"string": "string",
},
Type: "string",
TypeHandlerVersion: "string",
VmExtensionName: "string",
EnableAutomaticUpgrade: false,
})
var virtualMachineExtensionResource = new VirtualMachineExtension("virtualMachineExtensionResource", VirtualMachineExtensionArgs.builder()
.resourceGroupName("string")
.vmName("string")
.publisher("string")
.instanceView(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.location("string")
.protectedSettings("any")
.autoUpgradeMinorVersion(false)
.forceUpdateTag("string")
.settings("any")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.type("string")
.typeHandlerVersion("string")
.vmExtensionName("string")
.enableAutomaticUpgrade(false)
.build());
virtual_machine_extension_resource = azure_native.compute.VirtualMachineExtension("virtualMachineExtensionResource",
resource_group_name=string,
vm_name=string,
publisher=string,
instance_view={
name: string,
statuses: [{
code: string,
displayStatus: string,
level: Info,
message: string,
time: string,
}],
substatuses: [{
code: string,
displayStatus: string,
level: Info,
message: string,
time: string,
}],
type: string,
typeHandlerVersion: string,
},
location=string,
protected_settings=any,
auto_upgrade_minor_version=False,
force_update_tag=string,
settings=any,
tags={
string: string,
},
type=string,
type_handler_version=string,
vm_extension_name=string,
enable_automatic_upgrade=False)
const virtualMachineExtensionResource = new azure_native.compute.VirtualMachineExtension("virtualMachineExtensionResource", {
resourceGroupName: "string",
vmName: "string",
publisher: "string",
instanceView: {
name: "string",
statuses: [{
code: "string",
displayStatus: "string",
level: "Info",
message: "string",
time: "string",
}],
substatuses: [{
code: "string",
displayStatus: "string",
level: "Info",
message: "string",
time: "string",
}],
type: "string",
typeHandlerVersion: "string",
},
location: "string",
protectedSettings: "any",
autoUpgradeMinorVersion: false,
forceUpdateTag: "string",
settings: "any",
tags: {
string: "string",
},
type: "string",
typeHandlerVersion: "string",
vmExtensionName: "string",
enableAutomaticUpgrade: false,
});
type: azure-native:compute:VirtualMachineExtension
properties:
autoUpgradeMinorVersion: false
enableAutomaticUpgrade: false
forceUpdateTag: string
instanceView:
name: string
statuses:
- code: string
displayStatus: string
level: Info
message: string
time: string
substatuses:
- code: string
displayStatus: string
level: Info
message: string
time: string
type: string
typeHandlerVersion: string
location: string
protectedSettings: any
publisher: string
resourceGroupName: string
settings: any
tags:
string: string
type: string
typeHandlerVersion: string
vmExtensionName: string
vmName: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VirtualMachineExtension resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group.
- Vm
Name string - The name of the virtual machine where the extension should be created or updated.
- Auto
Upgrade boolMinor Version - 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 boolUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- Force
Update stringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- Instance
View Pulumi.Azure Native. Compute. Inputs. Virtual Machine Extension Instance View - The virtual machine extension instance view.
- Location string
- Resource location
- Protected
Settings 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.
- Dictionary<string, string>
- Resource tags
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- Vm
Extension stringName - The name of the virtual machine extension.
- Resource
Group stringName - The name of the resource group.
- Vm
Name string - The name of the virtual machine where the extension should be created or updated.
- Auto
Upgrade boolMinor Version - 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 boolUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- Force
Update stringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- Instance
View VirtualMachine Extension Instance View Args - The virtual machine extension instance view.
- Location string
- Resource location
- Protected
Settings 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.
- map[string]string
- Resource tags
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- Vm
Extension stringName - The name of the virtual machine extension.
- resource
Group StringName - The name of the resource group.
- vm
Name String - The name of the virtual machine where the extension should be created or updated.
- auto
Upgrade BooleanMinor Version - 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 BooleanUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- force
Update StringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- instance
View VirtualMachine Extension Instance View - The virtual machine extension instance view.
- location String
- Resource location
- protected
Settings 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.
- Map<String,String>
- Resource tags
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
- vm
Extension StringName - The name of the virtual machine extension.
- resource
Group stringName - The name of the resource group.
- vm
Name string - The name of the virtual machine where the extension should be created or updated.
- auto
Upgrade booleanMinor Version - 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 booleanUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- force
Update stringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- instance
View VirtualMachine Extension Instance View - The virtual machine extension instance view.
- location string
- Resource location
- protected
Settings 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.
- {[key: string]: string}
- Resource tags
- type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler stringVersion - Specifies the version of the script handler.
- vm
Extension stringName - The name of the virtual machine extension.
- resource_
group_ strname - 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_ boolminor_ version - 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_ boolupgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- force_
update_ strtag - How the extension handler should be forced to update even if the extension configuration has not changed.
- instance_
view VirtualMachine Extension Instance View Args - 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.
- Mapping[str, str]
- Resource tags
- type str
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type_
handler_ strversion - Specifies the version of the script handler.
- vm_
extension_ strname - The name of the virtual machine extension.
- resource
Group StringName - The name of the resource group.
- vm
Name String - The name of the virtual machine where the extension should be created or updated.
- auto
Upgrade BooleanMinor Version - 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 BooleanUpgrade - Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
- force
Update StringTag - How the extension handler should be forced to update even if the extension configuration has not changed.
- instance
View Property Map - The virtual machine extension instance view.
- location String
- Resource location
- protected
Settings 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.
- Map<String>
- Resource tags
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
- vm
Extension StringName - 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
- Provisioning
State 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
- Provisioning
State 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
- provisioning
State 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
- provisioning
State 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
- provisioning
State String - The provisioning state, which only appears in the response.
Supporting Types
InstanceViewStatus, InstanceViewStatusArgs
- Code string
- The status code.
- Display
Status string - The short localizable label for the status.
- Level
Pulumi.
Azure Native. Compute. Status Level Types - 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.
- Display
Status string - The short localizable label for the status.
- Level
Status
Level Types - 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.
- display
Status String - The short localizable label for the status.
- level
Status
Level Types - 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.
- display
Status string - The short localizable label for the status.
- level
Status
Level Types - 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
Status
Level Types - 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.
- display
Status 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, InstanceViewStatusResponseArgs
- Code string
- The status code.
- Display
Status 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.
- Display
Status 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.
- display
Status 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.
- display
Status 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.
- display
Status 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, StatusLevelTypesArgs
- Info
- Info
- Warning
- Warning
- Error
- Error
- Status
Level Types Info - Info
- Status
Level Types Warning - Warning
- Status
Level Types Error - 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, VirtualMachineExtensionInstanceViewArgs
- Name string
- The virtual machine extension name.
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status> - The resource status information.
- Substatuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status> - The resource status information.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- Name string
- The virtual machine extension name.
- Statuses
[]Instance
View Status - The resource status information.
- Substatuses
[]Instance
View Status - The resource status information.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- name String
- The virtual machine extension name.
- statuses
List<Instance
View Status> - The resource status information.
- substatuses
List<Instance
View Status> - The resource status information.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
- name string
- The virtual machine extension name.
- statuses
Instance
View Status[] - The resource status information.
- substatuses
Instance
View Status[] - The resource status information.
- type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler stringVersion - Specifies the version of the script handler.
- name str
- The virtual machine extension name.
- statuses
Sequence[Instance
View Status] - The resource status information.
- substatuses
Sequence[Instance
View Status] - The resource status information.
- type str
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type_
handler_ strversion - 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".
- type
Handler StringVersion - Specifies the version of the script handler.
VirtualMachineExtensionInstanceViewResponse, VirtualMachineExtensionInstanceViewResponseArgs
- Name string
- The virtual machine extension name.
- Statuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> - The resource status information.
- Substatuses
List<Pulumi.
Azure Native. Compute. Inputs. Instance View Status Response> - The resource status information.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- Name string
- The virtual machine extension name.
- Statuses
[]Instance
View Status Response - The resource status information.
- Substatuses
[]Instance
View Status Response - The resource status information.
- Type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- Type
Handler stringVersion - Specifies the version of the script handler.
- name String
- The virtual machine extension name.
- statuses
List<Instance
View Status Response> - The resource status information.
- substatuses
List<Instance
View Status Response> - The resource status information.
- type String
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler StringVersion - Specifies the version of the script handler.
- name string
- The virtual machine extension name.
- statuses
Instance
View Status Response[] - The resource status information.
- substatuses
Instance
View Status Response[] - The resource status information.
- type string
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type
Handler stringVersion - Specifies the version of the script handler.
- name str
- The virtual machine extension name.
- statuses
Sequence[Instance
View Status Response] - The resource status information.
- substatuses
Sequence[Instance
View Status Response] - The resource status information.
- type str
- Specifies the type of the extension; an example is "CustomScriptExtension".
- type_
handler_ strversion - 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".
- type
Handler StringVersion - Specifies the version of the script handler.
Package Details
- Repository
- azure-native-v1 pulumi/pulumi-azure-native
- License
- Apache-2.0